5.2 - Multi-Value Info Options
A multi-value Info option accepts a list of one or more values. Supplying zero values causes an error.
Info Option -AF (-ArchiveFormat) (Aliases: -FileFormat, -ExternalFormat) :
(Alias: :ref:`-FF <FF>`|-FileFormat), describes how a data file has been packaged or compressed. Recognized values:
‘BI’ |
binary (COS) blocked |
‘C1’ or ‘CH’ |
ASCII/character blocked |
‘TAR’ |
tarred |
‘Z’ |
compressed |
‘GZ’ |
gzipped |
‘BZ2’ |
bzip2-compressed |
Combine values in processing order, e.g., ‘C1.TAR.GZ’ = COS ASCII blocked, then tarred, then gzipped. Maximum total length is 20 characters.
Info Option -BD (-BeginDate) :
the earliest date covered by the data, for a group, the whole dataset, or a version control record.
Info Option -BF (-BackupFlag) :
controls whether and how a dataset or group is backed up to Quasar. Values:
‘N’ |
no auto-backup (dataset default) |
‘P’ |
inherit the setting from the parent (group default; index 0 inherits from the dataset) |
‘B’ |
back up files only |
‘D’ |
back up files and create a disaster recovery copy |
Info Option -BP (-BatchProcess) (Aliases: -d, -DelayedMode) :
defers execution:
Info Option -BS (-BackStatus) :
the current Quasar backup state for a file:
‘A’ |
archived to Quasar (complete) |
‘T’ |
tar file created, awaiting upload |
‘N’ |
record created, awaiting tar |
Info Option -BT (-BeginTime) :
the time component of the data start, for a group, the whole dataset, or a version control record.
Info Option -DA (-DataAccess) (Aliases: -DataAccessflag, -FileListFlag) :
(Alias: -DataAccessFlag|-FileListFlag), controls which file list views are displayed at the dataset and/or top group level:
‘B’ |
both complete and faceted |
‘C’ |
complete list only (default) |
‘F’ |
faceted list only |
‘N’ |
none (no file list shown) |
Info Option -DB (-Debug) :
enables debug logging. Up to 3 values may be given: debug level (required), log file path, and log file name. The level can be a single integer (e.g., 1000) or a range (e.g., 200-1000). Defaults: log path ‘$DSSHOME/dssdb/log’, file name ‘mydss.dbg’.
Info Option -DE (-Description) (Aliases: -Desc, -Note, -FileDesc, -FileDescription) :
(Alias: -Desc|-Note|-FileDesc|-FileDescription), a free-text description for a data file or version record. Multi-line values are supported in input files (-IF). Quote values containing spaces on the command line. With version control actions (-SV), this becomes the version note.
Info Option -DF (-DataFormat) (Aliases: -TF, -ContentFormat) :
(Alias: -TF|-ContentFormat), the scientific format of the data content (e.g., NetCDF, IMMA, BINARY). A dataset-level default can be set via -SD and is applied automatically when no format is specified at archive time.
Info Option -DN (-DOINumber) (Aliases: -DOI, -DOIName) :
the Digital Object Identifier assigned to a dataset version, providing a stable, citable reference.
Info Option -DO (-DisplayOrder) :
explicit display position indices for files within a group or across the dataset. Overridden by -RO (-ResetOrder) when both are present.
Info Option -ED (-EndDate) :
the latest date covered by the data, for a group, the whole dataset, or a version control record.
Info Option -ET (-EndTime) :
the time component of the data end, for a group, the whole dataset, or a version control record.
Info Option -EV (-ExternalVersion) :
the human-readable version label shown publicly for a dataset (e.g., ‘2.0’). Empty by default.
Info Option -FD (-FileDate) :
the calendar date a data file was last modified.
Info Option -FF (-FileFlag) :
specifies whether an entry represents a regular file (‘F’) or a directory path (‘P’).
Info Option -FS (-FileStatus) :
the access level of a file: ‘P’ (public, visible to all users) or ‘I’ (internal, visible to specialists only).
Info Option -FT (-FileTime) :
the time of day a data file was last modified.
Info Option -GI (-GroupIndex) :
assigns files to a specific group within a dataset. Groups must be created first via -SG (-SetGroup). Use 1, 2, 3, … for specific groups; 0 means no group assignment (default).
When omitted for -AS or -AW, dsarch attempts to assign groups automatically by matching file names against patterns stored in GDEXDB.
Info Option -GL (-GroupLevel) :
the number of group nesting levels displayed on the web interface. Defaults to 2. A value of -2 shows one level initially, expanding to two when subgroups are present.
Info Option -GN (-GroupName) (Alias: -GroupID) :
a short human-readable identifier for a group (up to 20 characters). Set via -SG (-SetGroup). Names can be used wherever group indices are accepted, and appear on file list webpages.
Info Option -GP (-GroupPattern) :
wildcard patterns that dsarch uses to automatically assign files to the right group during archiving. Stored per group via -SG.
Info Option -GT (-GroupType) (Alias: -GroupDataType) :
the access level for a group: ‘P’ (public) or ‘I’ (internal). Changing from P to I recursively marks all nested subgroups and their Web files as internal.
Info Option -HF (-HelpFile) :
the destination names for Help files on the GDEX Server. Defaults to the local file names from -LF unless overridden explicitly.
Info Option -HT (-HelpFileType) (Alias: -HelpType) :
the category of a Help file: ‘D’ (Document) or ‘S’ (Software). One value applies to all files in the batch.
Info Option -ID (-InitialDate) :
the original publication or release date of a Help, Document, or Software file.
Info Option -IF (-InputFile) :
one or more input file names provided on the command line. Each file name must start with the dataset number (format ‘dNNNNNN.*’) and match the -DS value. This naming rule is a safeguard against accidentally running an action on the wrong dataset.
Input file format rules:
Lines beginning with ‘#’ are comments and are ignored.
Option names may be short, long, or alias forms.
Action/Mode options: OptionName<!> (marker changeable via -AO)
Single-value assignments: OptionName<=>Value, one per line (delimiter changeable via -ES; default ‘<=>’)
Multi-value (tabular) assignments: a title row followed by data rows, with columns separated by ‘<:>’ (changeable via -DV).
Tabular data ends at EOF or when a new title line or single-value assignment is encountered.
If the last column contains multi-line text, append the separator to every row (including the title line).
Info Option -IV (-InternalVersion) :
a minor revision counter within the same DOI. Increments when data are updated without changing the DOI itself. Starts at 1 when a new DOI record is created.
Info Option -KV (-KeyValue) :
custom key/value metadata pairs for a dataset. Use -SD to set them and -GD to view them. Keys: up to 40 characters; values: up to 128 characters.
Set a pair:
View a specific key:
View all pairs:
Info Option -LC (-Location) (Alias: -LocationFlag) :
where the file resides:
‘C’ |
CGD data path |
‘G’ |
Glade Disk (NCAR HPC file system) |
‘O’ |
bOreas |
‘B’ |
both Glade and bOreas |
‘R’ |
remote URL (Help files only) |
At the dataset level (as the online access location), only ‘G’ or ‘O’ are valid.
Info Option -LF (-LocalFile) (Aliases: -LocFile, -SourceFile) :
the local source files to archive via -AS, -AW, or -AH. UNIX wildcards (‘*’, ‘?’) are accepted on the command line. Use absolute or relative paths for files outside the current directory.
Info Option -MC (-MD5Checksum) :
the MD5 checksum of a data file on the GDEX Server, used for integrity verification.
Info Option -ML (-MetaLink) (Alias: -MetadataLink) :
a URL pointing to the content metadata page for a dataset, group, or file. Normally set automatically by gatherxml when -GX is used. A custom value may be provided and will take precedence over the auto-generated link.
Info Option -ND (-NoteDocument) (Aliases: -DocumentNote, -DescDocument) :
a brief description of the documentation available for a dataset.
Info Option -NI (-NoteInternal) (Aliases: -InternalNote, -DescInternal, -DI) :
(Alias: -InternalNote|-DescInternal|-DI), an internal note about a group’s or dataset’s data, visible to specialists only.
Info Option -NS (-NoteSoftware) (Aliases: -SoftwareNote, -DescSoftware) :
a description of any software tools or scripts associated with a dataset.
Info Option -NW (-NoteWeb) (Aliases: -WebNote, -DescWeb, -DW) :
a public-facing description of the web-accessible data for a group or the dataset as a whole.
Info Option -OB (-OrderBy) (Alias: -OrderByPattern) :
a date/time pattern that guides temporal sorting when combined with -ON. For example, ‘YYYYmon’ sorts by 4-digit year followed by 3-letter month abbreviation.
Info Option -OD (-OriginDataset) :
the dataset the files are being moved from when using -MV (-MoveFile).
Info Option -OG (-OriginGroup) :
the existing group indices to be renumbered by -CG (-ChangeGroup).
Info Option -OT (-OriginType) :
the source file type when converting between types (e.g., Web to Saved) during a -MV (-MoveFile) operation.
Info Option -PI (-ParentIndex) (Alias: -ParentGroupIndex) :
the index of the parent group for a subgroup. Groups can be nested to any depth.
Info Option -QF (-QuasarFile) :
the name of the Quasar backup (tar) file, required for -AQ (-ArchiveQuasarFile).
Info Option -QT (-QuasarFileType) (Aliases: -QuasarType, -BackupType) :
the backup scope: ‘B’ (backup only) or ‘D’ (backup plus disaster recovery copy).
Info Option -RF (-OriginFile) :
the source file names for -MV (-MoveFile) when they differ from the destination names given via -SF, -WF, or -HF.
Info Option -SF (-SavedFile) :
the destination names for Saved files on the GDEX Server. For -AS (-ArchiveSavedFile), defaults to the local file names from -LF unless specified explicitly.
Info Option -SP (-SavedPath) :
the directory path for Saved files, relative to the Saved data home directory. For -AS, the dataset or group’s stored path is used by default. For -SG and -SD, this value is written to GDEXDB.
Keeping Saved paths accurate is important: NCAR users browse data through ‘gdexls’ using these paths. Each top-level group should map to one directory, with one subdirectory per subgroup level, mirroring the physical layout.
Info Option -SR (-Source) :
the person, team, or organization that contributed or produced a Help file.
Info Option -ST (-SavedFileType) (Aliases: -SavedType, -SavedArchiveType) :
the role of a Saved file:
‘P’ |
Primary (main dataset file) |
‘R’ |
Original (source/raw copy) |
‘W’ |
Work (working/intermediate file) |
‘S’ |
Scratch (temporary file) |
‘V’ |
Version-controlled (locked under DOI) |
One value applies to all files in the batch.
Info Option -SZ (-Size) :
the file size in bytes. Measured automatically from local files during archiving; provide explicitly to override.
Info Option -TG (-TopGroupIndex) (Alias: -TopGroup) :
the index of the outermost (top-level) group that a Saved or Web file belongs to within a group hierarchy.
Info Option -TI (-Title) :
the display title for a dataset or group. Dataset titles cannot be changed through dsarch — use the Metadata Editor instead.
Info Option -TL (-ThreddLink) :
a URL to the THREDDS Catalog page for a specific file. Set to ‘Y’ to indicate that THREDDS Catalog information has been gathered.
Info Option -VI (-VersionIndex) :
the numeric identifier of a specific DOI/Version control record for a dataset.
Info Option -VT (-VersionStatus) :
the life cycle state of a version control record: ‘A’ (Active), ‘P’ (Pending — no DOI yet), or ‘H’ (History — terminated).
Info Option -WF (-WebFile) :
the destination names for Web files on the GDEX Server. For -AW (-ArchiveWebFile), defaults to the local file names from -LF unless specified explicitly.
Info Option -WH (-WebHome) (Alias: -WebDataHome) :
an alternative Web data home directory for a dataset. Stored in GDEXDB via -SD (-SetDataset).
Info Option -WP (-WebPath) :
the directory path for Web files, relative to the Web data home directory. For -AW, the dataset or group’s stored path is used by default. For -SG and -SD, this value is written to GDEXDB.
Keeping Web paths accurate is important: NCAR users browse data through ‘gdexls’ using these paths. Each top-level group should map to one directory, with one subdirectory per subgroup level, mirroring the physical layout.
Info Option -WT (-WebFileType) (Aliases: -WebType, -WebArchiveType) :
the accessibility of a Web file: ‘D’ (public data) or ‘N’ (NCAR internal data only). One value applies to all files in the batch.
Info Option -WU (-WebURL) (Aliases: -URL, -WebAddress) :
the full URL of a Help file hosted remotely (e.g., on GitHub). Use with -SH (-SetHelpFile) to register the file in GDEXDB without a local copy on the GDEX Server.