IREG(1)

🎀 NAME 🎀

okay so this is ireg — an iRODS iCommand, and it lives on the IREG(1) User Commands manual page. bestie, we're registering files into iRODS, and yes it's a whole vibe 💖

✨ SYNOPSIS ✨

ireg [-hfrkKvV] [--repl] [-D dataType] [-R resource]

💖 DESCRIPTION 💖

physicalFilePath, irodsPath

Register a file or a directory of files and subdirectory into iRODS. The file or the directory of files must already exist on the server where the resource is located. The full path must be supplied for both the physicalFilePath and the irodsPath. no shortcuts, bestie 😌

With the -r option, the entire content beneath the physicalFilePath (files and subdirectories) will be recursively registered beneath the irodsPath. For example, the command:

ireg -r /tmp/src1 /tempZone/home/myUser/src1

grafts all files and subdirectories beneath the directory /tmp/src1 to the collection /tempZone/home/myUser/src1. slay 🦋

By default, only rodsAdmin users are allowed to register files or directories. More permissive registration policies can be set in the server's rule base using the acNoChkFilePathPerm() rule.

bestie PSA 🚨 It is considered best practice for the target resource be a single local storage resource. A side effect of not following this best practice could be unwanted extra replicas of a mounted collection or other structured file. Registered files should be well-understood by the administrator so the line between iRODS-managed data and user-managed data can be properly maintained. iykyk 💅

✨ Options are: ✨

• -R — resource — specifies the target storage resource. This can also be specified in your environment or via a rule set up by the administrator.
• -r — recursive — recursively register all directories and files in physicalFilePath.
• -f — Force. If the target collection already exists, register the files and subdirectories that have not already been registered in the directory.
• -k — calculate a checksum on the iRODS client and store with the file details.
• -K — calculate a checksum on the iRODS server and store with the file details.
• --repl — register the physical path as a replica.
• --exclude-from filename — don't register files matching patterns contained in the specified file. The file must be readable on the server where the resource is located and must be an absolute pathname.
• -v — verbose.
• -V — Very verbose.
• -h — this help.

oh and real talk: the synopsis also has -D dataType — the original options list doesn't give it its own description, so I'm not inventing one, iykyk 💀

okay that's the page, bestie 🫶 — this ireg is from iRODS Version 5.0.2, the source/version footer is ireg iRODS-5.0.2, the date is January 1980, and the manual page is IREG(1). periodt 💅