4 - MODE OPTIONS
Mode options adjust how an Action option behaves. They are all optional and take no values — simply include the flag to activate the behavior.
Mode Option -BG (-BackGround) (Alias: -b) :
runs the action as a background process, suppressing all screen output and error messages.
Mode Option -CL (-CleanLocal) (Aliases: -CleanLocFile, -CleanLocalFile) :
deletes local source files once all have been successfully archived by -AS or -AW. Pair with -DD (-DeleteDir) to also clean up any empty local directories.
Mode Option -DX (-DeleteXML) :
calls dcm to delete content metadata for the specified Web files. With -SW (-SetWebFile), it explicitly removes metadata; with -DL (-Delete) when Web files are specified, this happens automatically.
Mode Option -EM (-EmailNotice) :
sends the executing specialist an email when an action finishes or fails. Applies to -AS, -AW, -AH, -AQ, -SS, -SW, -SH, -SQ, -RQ, -MV, and -DL. The email includes a brief summary and any errors encountered. Ignored when -d (-BP) is present.
Tip: when archiving many files, consolidate them into a single input file and include -EM once — only one email is sent regardless of file count.
Mode Option -FO (-FormatOutput) :
aligns GET action output into fixed-width columns, making results easier to read at a glance.
Mode Option -GF (-GrowingFile) (Alias: -GrowingDataFile) :
lifts the DOI/Version control lock on Web files so that -AW (-ArchiveWebFile) can overwrite them. Use this when a file is actively being appended to and must be updated in place. When dsupdt drives -AW, growing files are detected and handled automatically.
Mode Option -GX (-GatherXML) (Alias: -Grid2XML) :
calls gatherxml to extract and record content metadata for archived Web files. For -MV (-MoveFile), metadata is transferred to the new file name automatically via rcm — -GX is not needed for moves.
Mode Option -GZ (-GMTZone) (Aliases: -GMT, -GreenwichZone, -UTC) :
records archiving timestamps in GMT instead of local time.
Mode Option -KM (-KeepMetadata) (Alias: -KeepMeta) :
preserves the content metadata record when a Web file is converted to a Saved file via -MV with -TS.
Mode Option -KP (-KeepPath) (Alias: -KeepLocalPath) :
preserves local file paths as-is on the GDEX Server during -AS, -AW, and -AH. When -KP is active, -SP and -WP are ignored. -KP is also ignored when destination file names are provided explicitly via -SF, -WF, or -HF.
Mode Option -MD (-MyDataset) :
bypasses the dataset ownership check, allowing any specialist to modify records in GDEXDB for any dataset.
Mode Option -NE (-NoEmail) :
suppresses the automatic failure email notification.
Mode Option -NT (-NoTrim) :
skips stripping leading/trailing spaces and inline comments from input values. Use this to speed up processing of large input files.
Mode Option -NV (-NewVersion) :
required to create a new DOI/Version control record when using -SV (-SetVersion).
Mode Option -OE (-OverrideExist) :
allows an existing file on the GDEX Server to be overwritten at the target path. Without this flag, archiving fails if the destination already exists.
Mode Option -PE (-ShowPeriod) :
adds data period information (begin/end dates and times) for the dataset and any specified groups to the output of -GD (-GetDataset).
Mode Option -RA (-RetryArchive) :
deprecated; has no effect and may be removed in a future version.
Mode Option -RD (-RemoveDir) (Aliases: -RemoveDirectory, -RemoveEmptyDir) :
(Alias: -RemoveDirectory|-RemoveEmptyDir), removes any directories that become empty after file changes from -DL, -SS, or -SW.
To clean up empty directories without modifying files, run -SS or -SW with -RD and no file names; dsarch will prune empty Web or Saved directories for the specified dataset and groups.
Mode Option -RG (-RecursiveGroup) (Alias: -RepeatGroup) :
descends into subgroups recursively when used with -GG, -GS, or -GW, gathering all nested records. A group index must be provided via -GI for this to take effect.
Mode Option -RN (-RelativeName) (Aliases: -RelativePathName, -RelativeFileName) :
returns file names as relative paths (relative to the dataset or group’s Saved or Web path) in the output of -GS and -GW.
Mode Option -RO (-ResetOrder) (Alias: -Reorder) :
sets display order indices to match the order files are listed when passed to -SS, -SW, -SH, or -SQ. To set explicit indices instead, use -DO (-DisplayOrder).
For sorting files by field values across an entire dataset or individual groups, use -ON (-OrderNames).
Mode Option -RS (-GXRSOptions) :
passes the R and S flags to gatherxml to speed up metadata evaluation. Use alongside -GX (-GatherXML).
Mode Option -RT (-ResetTIndex) (Alias: -ResetTopGroup) :
recalculates and resets the top-level group index stored in Saved or Web file records for the dataset and any specified groups.
Mode Option -SC (-SetChecksum) :
calculates MD5 checksums for data files on the GDEX Server and stores them in GDEXDB for integrity verification.
Mode Option -TO (-TarOnly) :
builds the Quasar tar file locally without uploading it to the Globus Quasar Server. Useful for testing. Used with -AQ.
Mode Option -TS (-ToSaved) (Aliases: -ToSavedFile, -MovedToSaved) :
used with -MV (-MoveFile) to move Web files to Saved files.
Mode Option -TT (-TotalSummary) :
appends file count and size totals to the output of -GS (-GetSavedFile) and -GW (-GetWebFile).
Mode Option -TW (-ToWeb) (Aliases: -ToWebFile, -MovedToWeb) :
used with -MV (-MoveFile) to move Saved files to Web files.
Mode Option -UZ (-UnzipData) (Aliases: -Uncompress, -UncompressData, -Unzip) :
decompresses files during archiving. The tool is selected by extension:
Mode Option -WC (-WithChecksum) (Aliases: -ValidateChecksum, -WithMD5, -ValidateMD5) :
adds MD5 checksum verification on top of size checks when validating data files on the GDEX Server.
Mode Option -WM (-WithMetadata) (Alias: -WithMeta) :
triggers a fresh gatherxml run at the dataset or group level when used with -SD (-SetDataset) or -SG (-SetGroup).
Mode Option -WN (-WithFileNumber) (Alias: -WithNumber) :
recomputes and updates Saved/Web file counts for the dataset and any specified groups. With -GD (-GetDataset), the counts are calculated on the fly and included in the output.
Mode Option -WS (-WithFileSize) :
rechecks Web file sizes and timestamps for provided web files with -WF (-WebFile), and updates them into GDEXDB This Mode option works with action -SW (SetWebFile) only.
Mode Option -XC (-CrossCopy) :
Mode Option -XM (-CrossMove) :
like -XC but moves instead of copying — the original file is deleted once the destination copy is confirmed.
Mode Option -ZD (-ZipData) (Aliases: -Compress, -CompressData, -Zip) :
compresses files during -AS or -AW. The compression tool is selected by the format given via -AF: ‘gzip’ for ‘GZ’, ‘compress’ for ‘Z’, ‘zip’ for ‘ZIP’, ‘bzip’ for ‘BZ2’. Files already in the target format are skipped. Files compressed in a different format are decompressed first (using the tool matched by extension: ‘.gz’, ‘.Z’, ‘.zip’, or ‘.bz2’) before being recompressed into the target format.