rda-python-dsarch 2.0.12__py3-none-any.whl → 2.0.15__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. rda_python_dsarch/dsarch.usg +1109 -940
  2. {rda_python_dsarch-2.0.12.dist-info → rda_python_dsarch-2.0.15.dist-info}/METADATA +4 -2
  3. {rda_python_dsarch-2.0.12.dist-info → rda_python_dsarch-2.0.15.dist-info}/RECORD +7 -7
  4. {rda_python_dsarch-2.0.12.dist-info → rda_python_dsarch-2.0.15.dist-info}/WHEEL +0 -0
  5. {rda_python_dsarch-2.0.12.dist-info → rda_python_dsarch-2.0.15.dist-info}/entry_points.txt +0 -0
  6. {rda_python_dsarch-2.0.12.dist-info → rda_python_dsarch-2.0.15.dist-info}/licenses/LICENSE +0 -0
  7. {rda_python_dsarch-2.0.12.dist-info → rda_python_dsarch-2.0.15.dist-info}/top_level.txt +0 -0
rda_python_dsarch/dsarch.usg CHANGED
@@ -1,79 +1,97 @@
1
1
 
2
2
  1 INTRODUCTION
3
3
 
4
- 'dsarch' is the primary tool for archiving geoscience data onto CISL's Geoscience
5
- Data Exchange (GDEX) Servers. It records metadata about each dataset — file names,
6
- data periods, file counts, and sizes — in the Geoscience Data Exchange Database
7
- (GDEXDB). Datasets can be placed under DOI/Version control by assigning a Digital
8
- Object Identifier (DOI), which links all web data files to a specific version for
9
- citation and long-term reference. Archived files can be organized into sub-products
10
- called groups, which nest to any depth. All metadata stored in GDEXDB can be
11
- retrieved and updated through 'dsarch' as well.
12
-
13
- Before using 'dsarch', a dataset must first be registered in GDEXDB through
14
- Metadata Manager (https://gdex.ucar.edu/metaman/). Once registered,
15
- 'dsarch' can perform the following major functions:
16
- - Set up a dataset and its groups/subgroups in GDEXDB to prepare it for
17
- data archiving
4
+ 'dsarch' is the primary tool for archiving geoscience data onto CISL's
5
+ Geoscience Data Exchange (GDEX) Servers. It records metadata for every
6
+ dataset — file names, data periods, file counts, and sizes — in the
7
+ Geoscience Data Exchange Database (GDEXDB). Datasets can be placed under
8
+ DOI/Version control by assigning a Digital Object Identifier (DOI) that
9
+ links all web data files to a specific version for citation and long-term
10
+ reference. Files can be organized into nested sub-products called groups.
11
+ Any metadata stored in GDEXDB can also be retrieved or updated through
12
+ 'dsarch'.
13
+
14
+ A few terms used throughout this document:
15
+ GDEX - Geoscience Data Exchange, NCAR's data publication platform
16
+ GDEXDB - the metadata database backing GDEX
17
+ Specialist - an authorized owner who manages a dataset
18
+ dNNNNNN - a dataset number; six digits prefixed with 'd' (e.g., d260001)
19
+ Group - a named sub-product within a dataset; groups can be nested
20
+ Saved file - an archived file kept for internal use or NCAR users
21
+ Web file - an archived file published on the GDEX Web Server
22
+ Help file - documentation or software file (Document or Software)
23
+ Quasar - the Globus Quasar Server used for long-term tape backup
24
+
25
+ Before using 'dsarch', register the dataset in GDEXDB through Metadata
26
+ Manager (https://gdex.ucar.edu/metaman/). Once registered, 'dsarch' can
27
+ perform the following major functions:
28
+ - Set up a dataset and its groups/subgroups in GDEXDB to prepare it
29
+ for data archiving
18
30
  - Add, update, and terminate DOI/Version controls for a given dataset
19
- - Archive data files by copying them from the working area to GDEX Servers
31
+ - Archive data files by copying them from the working area to GDEX
32
+ Servers
20
33
  - Call 'gatherxml' to evaluate file content metadata for archived files
21
- - Cross-archive data files by duplicating them between Object Stores and GDEX
34
+ - Cross-archive data files by duplicating them between bOreas and GDEX
22
35
  Data Disk Servers
23
36
  - Save file information for archived data into GDEXDB
24
37
  - Retrieve dataset, group, and file information stored in GDEXDB
25
- - Move data files from one dataset or group to another, or to a different
26
- location within the same dataset
27
- - Tar file lists from one or more datasets and back them up onto the Globus
28
- Quasar Server, with an optional disaster recovery copy
38
+ - Move data files from one dataset or group to another, or to a
39
+ different location within the same dataset
40
+ - Tar file lists from one or more datasets and back them up onto the
41
+ Globus Quasar Server, with an optional disaster recovery copy
29
42
  - Restore damaged data files from the Quasar backup server
30
43
  - Remove files from GDEX Servers
31
- - Automatically resume interrupted 'dsarch' commands using records in GDEXDB
44
+ - Automatically resume interrupted 'dsarch' commands using records in
45
+ GDEXDB
32
46
  - Regenerate filelist and main webpages on demand after dataset changes
33
47
 
34
- The dataset flag -UD (-UseDSARCH) must be set to at least 'Y' before 'dsarch'
35
- can archive files or write to GDEXDB. This flag also controls file list
36
- publication: setting it to 'P' or 'W' publishes file lists for GDEX Server data
37
- files, making them visible in the dataset's user interface on the GDEX Web Server.
38
- See the -SD (-SetDataset) action and -UD (-UseDSARCH) option descriptions for
39
- details.
40
-
41
- When a file is moved and its name or path changes, 'dsarch' records the new name
42
- as the primary entry in GDEXDB and retains the original as a linked alias. Both
43
- names resolve to the same file for usage tracking. Always use 'dsarch' — not
44
- system move commands — to move data files, so that GDEXDB stays accurate.
45
-
46
- Use the companion utility 'dsquasar' to back up archived data files to the
47
- Globus Quasar Server. 'dsquasar' finds files not yet backed up, assembles
48
- input file lists (targeting 1-3 GB per list), and calls 'dsarch' to package
49
- and upload them as tar files to the Quasar server.
50
-
51
- 'dsarch' includes safeguards to prevent accidental operations on the wrong
52
- dataset. Input files must be named starting with the dataset number in the
53
- format 'dNNNNNN.*', where '*' matches one or more valid filename characters.
54
- 'dsarch' also checks that the specialist running it is an authorized owner of
55
- the dataset; if not, execution stops — unless Mode option -MD (-MyDataset) is
56
- supplied, which overrides the ownership check.
57
-
58
- If an archive action (-AW, -AS, -AH, -AQ) fails because of a storage system
59
- outage, 'dsarch' will automatically retry it once the system recovers. This
60
- retry behavior is only enabled when option -BP (-d) is used to submit the
61
- action as a background batch process; the retry state is tracked in GDEXDB.
62
-
63
- Once added, a DOI/Version control record cannot be removed, but it can be
64
- terminated when a dataset is retired and its data are no longer current. Even
65
- after termination, the file list can be reconstructed from the retained DOI
66
- records. Files under DOI/Version control are locked — they cannot be moved or
67
- deleted — though new files may still be added to operational datasets. Archived
68
- data files are also immutable unless new data are appended to them.
69
-
70
- Only Web data files are placed under DOI/Version control. Saved data staged on
71
- disk for internal use or NCAR user access is not version-controlled and remains
72
- the responsibility of the dataset owner.
73
-
74
- This document first covers general 'dsarch' usage, then describes each Action
75
- option in detail, followed by Mode and Information (Info for short) options.
76
- Examples are provided throughout each section.
48
+ The dataset flag -UD (-UseDSARCH) must be set to at least 'Y' before
49
+ 'dsarch' can archive files or write to GDEXDB. This flag also controls
50
+ file list publication: setting it to 'P' or 'W' publishes file lists for
51
+ GDEX Server data files, making them visible in the dataset's user
52
+ interface on the GDEX Web Server. See the -SD (-SetDataset) action and
53
+ the -UD (-UseDSARCH) option for details.
54
+
55
+ When a file is moved and its name or path changes, 'dsarch' records the
56
+ new name as the primary entry in GDEXDB and retains the original as a
57
+ linked alias. Both names resolve to the same file for usage tracking.
58
+ Always use 'dsarch' — not system move commands — to move data files, so
59
+ that GDEXDB stays accurate.
60
+
61
+ Use the companion utility 'dsquasar' to back up archived data files to
62
+ the Globus Quasar Server. 'dsquasar' finds files not yet backed up,
63
+ assembles input file lists (targeting 1-3 GB per list), and calls
64
+ 'dsarch' to package and upload them as tar files to the Quasar server.
65
+
66
+ 'dsarch' includes safeguards to prevent accidental operations on the
67
+ wrong dataset. Input files must be named starting with the dataset
68
+ number in the format 'dNNNNNN.*', where '*' matches one or more valid
69
+ filename characters. 'dsarch' also verifies that the specialist running
70
+ it is an authorized owner of the dataset; if not, execution stops —
71
+ unless Mode option -MD (-MyDataset) is supplied, which overrides the
72
+ ownership check.
73
+
74
+ If an archive action (-AW, -AS, -AH, -AQ) fails due to a storage system
75
+ outage, 'dsarch' automatically retries it once the system recovers.
76
+ Retry behavior is enabled only when option -BP (-d) is used to submit
77
+ the action as a background batch process; the retry state is tracked in
78
+ GDEXDB.
79
+
80
+ Once added, a DOI/Version control record cannot be removed, but it can
81
+ be terminated when a dataset is retired and its data are no longer
82
+ current. Even after termination, the file list can be reconstructed from
83
+ the retained DOI records. Files under DOI/Version control are locked —
84
+ they cannot be moved or deleted — though new files may still be added to
85
+ operational datasets. Archived data files are also immutable unless new
86
+ data are appended to them.
87
+
88
+ Only Web data files are placed under DOI/Version control. Saved data
89
+ staged on disk for internal use or NCAR user access is not version-
90
+ controlled and remains the responsibility of the dataset owner.
91
+
92
+ This document first covers general 'dsarch' usage, then describes each
93
+ Action option in detail, followed by Mode and Information (Info for
94
+ short) options. Examples are provided throughout each section.
77
95
 
78
96
 
79
97
  2 GENERAL DSARCH USAGE
@@ -82,96 +100,108 @@ Examples are provided throughout each section.
82
100
  or
83
101
  dsarch [-(IF|InputFile)] InputFileNames
84
102
 
85
- Brackets [] indicate optional elements. A pipe '|' within parentheses, as in
86
- (A|B), means either A or B may be used. Options fall into three categories:
87
- Action options - specify what task to execute
103
+ Brackets [] indicate optional elements. A pipe '|' within parentheses,
104
+ as in (A|B), means either A or B may be used. Options fall into three
105
+ categories:
106
+ Action options - specify the task to execute
88
107
  Mode options - modify how an action behaves
89
108
  Info options - supply values to the action
90
109
 
91
110
  Options may be given in short or long form (e.g., -DS or -Dataset). Some
92
111
  options have alias names; for example, -UseRDADB is an alias for -UD
93
- (-UseDSARCH). Option names are case-insensitive,
94
- but values following Info options are case-sensitive.
95
-
96
- Option -DS specifies the dataset number. It is listed separately because most
97
- actions require it. When -DS is the first argument after 'dsarch', the option
98
- name itself may be omitted — just supply the dataset number directly.
99
-
100
- Specify exactly one Action option per 'dsarch' invocation. Each action has its
101
- own set of required and optional Info options, and may accept specific Mode
102
- options that adjust its behavior.
103
-
104
- All options except -IF (-InputFile) may be given either on the command line or
105
- in input files. Input file names are specified via -IF and can only be supplied
106
- on the command line. See the -IF option description for details on how to
107
- format options in input files. One or more input files may be combined with
108
- command-line options. The -IF option name itself may be omitted when a single
109
- input file is given on the command line and all action and option information
110
- is contained within that file.
112
+ (-UseDSARCH). Option names are case-insensitive, but values following
113
+ Info options are case-sensitive.
114
+
115
+ Option -DS specifies the dataset number. It is listed separately because
116
+ most actions require it. When -DS is the first argument after 'dsarch',
117
+ the option name itself may be omitted — just supply the dataset number
118
+ directly.
119
+
120
+ Specify exactly one Action option per 'dsarch' invocation. Each action
121
+ has its own set of required and optional Info options, and may accept
122
+ specific Mode options that adjust its behavior.
123
+
124
+ All options except -IF (-InputFile) may be given either on the command
125
+ line or in input files. Input file names are specified via -IF and can
126
+ only be supplied on the command line. See the -IF option description for
127
+ details on how to format options in input files. One or more input files
128
+ may be combined with command-line options. The -IF option name itself
129
+ may be omitted when a single input file is given on the command line and
130
+ all action and option information is contained within that file.
111
131
 
112
132
  Info options used with GET actions serve as query filters. Four special
113
- characters enable more precise filtering — they must be quoted or escaped
114
- on the command line to prevent shell interpretation:
115
- '!' - exclude matches; must appear immediately after the option name
116
- (may need escaping as '\!' in some shells due to history expansion)
117
- '<' - less-than comparison on the following value
118
- '>' - greater-than comparison on the following value
133
+ characters enable more precise filtering — they must be quoted or
134
+ escaped on the command line to prevent shell interpretation:
135
+ '!' - exclude matches; must appear immediately after the option name
136
+ (may need escaping as '\!' in some shells due to history
137
+ expansion)
138
+ '<' - less-than comparison on the following value
139
+ '>' - greater-than comparison on the following value
119
140
  '<>' - range between two values
120
141
 
121
- Combining '!' and '<' as "'!' '<' OptionValue" expresses a 'greater than or
122
- equal to OptionValue' condition.
142
+ Combining '!' and '<' as "'!' '<' OptionValue" expresses a 'greater than
143
+ or equal to OptionValue' condition.
123
144
 
124
145
  The description of an individual option is shown when 'dsarch' is run as
125
146
 
126
147
  dsarch [Option] -(h|help) [Option]
127
148
 
128
- The description is shown for the option placed either before or after -(h|help).
129
- If no option is given, or 'dsarch' is run without arguments, the full document
130
- is displayed using the UNIX 'more' utility.
149
+ The description is shown for the option placed either before or after
150
+ -(h|help). If no option is given, or 'dsarch' is run without arguments,
151
+ the full document is displayed using the UNIX 'more' utility. A hard
152
+ copy of this document can be printed from the saved file, dsarch.usg,
153
+ in the rda_python_dsarch Python package.
131
154
 
132
155
  #The online version of this document is available at
133
- #https://gdex-docs-dsarch.readthedocs.io/en/latest/index.html
156
+ #https://gdex-docs-dsarch.readthedocs.io
134
157
 
135
158
 
136
159
  3 ACTION OPTIONS
137
160
 
138
- Action options tell 'dsarch' what to do. They take no values. Some actions
139
- perform a single task; others bundle multiple tasks together and may trigger
140
- additional steps when certain Mode options are present. Only one Action option
141
- may be specified per execution.
142
-
143
- Write actions require the -UD (-UseDSARCH) flag to be set to 'Y', 'I', 'P',
144
- or 'W' for the target dataset before they can modify GDEXDB. Read actions
145
- have no such requirement.
146
-
147
- Actions are grouped into seven categories based on the information they handle:
148
- Dataset Actions - create, modify and retrieve dataset information in GDEXDB
149
- DOI/Version Actions - add, modify, view and terminate DOI/Version control for
150
- a given dataset
151
- Group Actions - create, delete, modify and retrieve group information in
152
- GDEXDB, of a given dataset
153
- File Actions - archive local data files as Saved/Web/Help files; move
154
- and delete archived files on GDEX Server; create, delete,
155
- modify and retrieve information of archived files in
156
- GDEXDB, of a given dataset, and groups if specified
157
- All Info Actions - create, modify and retrieve all information, of dataset,
158
- groups and files of a given dataset in GDEXDB
161
+ Action options tell 'dsarch' what to do. They take no values. Some
162
+ actions perform a single task; others bundle multiple tasks together and
163
+ may trigger additional steps when certain Mode options are present. Only
164
+ one Action option may be specified per execution.
165
+
166
+ Write actions require the -UD (-UseDSARCH) flag to be set to 'Y', 'I',
167
+ 'P', or 'W' for the target dataset before they can modify GDEXDB. Read
168
+ actions have no such requirement.
169
+
170
+ Actions are grouped into seven categories based on the information they
171
+ handle:
172
+ Dataset Actions - create, modify and retrieve dataset information
173
+ in GDEXDB
174
+ DOI/Version Actions - add, modify, view and terminate DOI/Version
175
+ control for a given dataset
176
+ Group Actions - create, delete, modify and retrieve group
177
+ information in GDEXDB, of a given dataset
178
+ File Actions - archive local data files as Saved/Web/Help files;
179
+ move and delete archived files on GDEX Server;
180
+ create, delete, modify and retrieve information
181
+ of archived files in GDEXDB, of a given dataset,
182
+ and groups if specified
183
+ All Info Actions - create, modify and retrieve all information, of
184
+ dataset, groups and files of a given dataset in
185
+ GDEXDB
159
186
  Webpage Actions - regenerate dataset main and filelist webpages
160
187
 
161
188
 
162
189
  3.1 Dataset Actions
163
190
 
164
- Use the following actions to read or update a dataset's record in GDEXDB:
165
- Set Dataset Information - update properties of an existing dataset record
191
+ Use the following actions to read or update a dataset's record in
192
+ GDEXDB:
193
+ Set Dataset Information - update properties of an existing dataset
194
+ record
166
195
  Get Dataset Information - retrieve and display dataset record fields
167
196
 
168
197
  3.1.1 Set Dataset Information
169
- -SD or -SetDataset, updates properties of an existing dataset record in
170
- GDEXDB — such as paths, file count limits, access flags, and data periods.
198
+ -SD or -SetDataset, updates properties of an existing dataset record
199
+ in GDEXDB — such as paths, file count limits, access flags, and data
200
+ periods.
171
201
 
172
202
  dsarch [-(DS|Dataset)] dNNNNNN [-](SD|SetDataset) [Mode Options]
173
203
  [-(UD|UseDSARCH) UseDSARCHFlag] # Y, P, W, I, or N
174
- [-(LC|Location) AccessLocationFlag] # C - CGD, G - Glade, O - Object Store
204
+ [-(LC|Location) AccessLocationFlag] # C - CGD, G - Glade, O - bOreas
175
205
  [-(BF|BackupFlag) QuasarBackupFlag] # B - Backup, D - Backup & Drdata
176
206
  [-(DA|AccessFlag) DataAccessFlags] # B - Both, C - Complete, F - Faceted, or N - No
177
207
  [-(DF|DataFormat) DataFormat] # BINARY, ASCII, NetCDF and etc.
@@ -196,34 +226,36 @@ Actions are grouped into seven categories based on the information they handle:
196
226
  [-(ED|EndDate) EndOnDates]
197
227
  [-(ET|EndTime) EndOnTimes]
198
228
 
199
- Mode options that can be specified for this action:
200
- -(MD|MyDataset) - allows any specialist to set GDEXDB information,
201
- regardless of dataset ownership
202
- -(NT|NoTrim) - skips trimming of spaces and comments from input
203
- values, speeding up input file processing
204
- -(RT|ResetTGroup) - resets the top group index for all Saved/Web file
205
- records
206
- -(WM|WithMetadata) - re-gathers Web file content metadata at dataset level
229
+ Available mode options:
230
+ -(MD|MyDataset) - allows any specialist to set GDEXDB
231
+ information, regardless of dataset ownership
232
+ -(NT|NoTrim) - skips trimming of spaces and comments from
233
+ input values, speeding up input file
234
+ processing
235
+ -(RT|ResetTGroup) - resets the top group index for all Saved/Web
236
+ file records
237
+ -(WM|WithMetadata) - re-gathers Web file content metadata at
238
+ dataset level
207
239
  -(WN|WithFileNumber) - re-evaluates and resets file counts
208
240
 
209
- Dataset numbers are normally created via the Metadata Manager (MM). Action
210
- -SD modifies the dataset record and any associated group data periods.
211
- Data periods for groups can be modified by 'dsarch', but must be created
212
- or removed through MM.
241
+ Dataset numbers are normally created via the Metadata Manager. Action
242
+ -SD modifies the dataset record and any associated group data
243
+ periods. Data periods for groups can be modified in 'dsarch', but
244
+ must be created or removed through Metadata Manager.
213
245
 
214
- The web file access location flag is set via -LC (-Location). The default
215
- is 'G' (Glade Disk) when any web data files exist. The default becomes 'O'
216
- if all web files reside on Object Store, or 'C' if all are at the CGD data
217
- path.
246
+ The web file access location flag is set via -LC (-Location). The
247
+ default is 'G' (Glade Disk) when any web data files exist. The default
248
+ becomes 'O' if all web files reside on bOreas, or 'C' if all are at
249
+ the CGD data path.
218
250
 
219
- For example, to set the UseDSARCH flag, reset file counts and data size, and
220
- set the beginning data date for dataset d744004:
251
+ For example, to set the UseDSARCH flag, reset file counts and data
252
+ size, and set the beginning data date for dataset d744004:
221
253
 
222
254
  dsarch d744004 SD -WN -UD Y -BD 1999-07-01
223
255
 
224
256
  3.1.2 Get Dataset Information
225
- -GD or -GetDataset, reads and displays dataset record fields from GDEXDB
226
- for the specified dataset.
257
+ -GD or -GetDataset, reads and displays dataset record fields from
258
+ GDEXDB for the specified dataset.
227
259
 
228
260
  dsarch [-(DS|Dataset)] dNNNNNN [-](GD|GetDataset) [Mode Options]
229
261
  [-(FN|FieldNames) FieldNameString]
@@ -231,14 +263,14 @@ Actions are grouped into seven categories based on the information they handle:
231
263
  [-(OF|OutputFile) OutputFileName]
232
264
  [-(DB|Debug) DebugModeInfo]
233
265
 
234
- Mode options that can be specified for this action:
266
+ Available mode options:
235
267
  -(FO|FormatOutput) - formats each column to a uniform fixed width
236
- -(PE|ShowPeriod) - includes associated period information for the dataset
237
- and any groups
268
+ -(PE|ShowPeriod) - includes associated period information for the
269
+ dataset and any groups
238
270
  -(WN|WithFileNumber) - gathers and displays Saved/Web file counts
239
271
 
240
- Use -FN (-FieldNames) to select which dataset fields to include. Defaults
241
- to 'SWFULQ'. Use -FN ALL to retrieve every available field.
272
+ Use -FN (-FieldNames) to select which dataset fields to include.
273
+ Defaults to 'SWFULQ'. Use -FN ALL to retrieve every available field.
242
274
 
243
275
  Valid dataset field names and their corresponding Info options:
244
276
 
@@ -266,8 +298,8 @@ Actions are grouped into seven categories based on the information they handle:
266
298
  X -(ED|EndDate) date data end for dataset/group
267
299
  Y -(ET|EndTime) time data end for dataset/group
268
300
 
269
- Use -OF (-OutputFile) to save the retrieved information to a file. Without
270
- it, results are displayed on screen.
301
+ Use -OF (-OutputFile) to save the retrieved information to a file.
302
+ Without it, results are displayed on screen.
271
303
 
272
304
  For example, to retrieve all dataset fields for d260001 and save to a file:
273
305
 
@@ -293,15 +325,15 @@ GroupIndex<:>BeginDate<:>EndDate<:>BeginTime<:>EndTime<:>
293
325
 
294
326
  3.2 DOI/Version Actions
295
327
 
296
- DOI/Version controls establish citable, versioned snapshots of a dataset.
297
- Manage them with the following actions:
328
+ DOI/Version controls establish citable, versioned snapshots of a
329
+ dataset. Manage them with the following actions:
298
330
  Set Version Control - create or update a DOI/Version control record
299
331
  Get Version Control - retrieve DOI/Version control record details
300
332
  Terminate Version Control - close an active DOI/Version control record
301
333
 
302
334
  3.2.1 Set Version Control
303
- -SV or -SetVersion, creates a new or updates an existing DOI/Version control
304
- record for the specified dataset.
335
+ -SV or -SetVersion, creates a new or updates an existing DOI/Version
336
+ control record for the specified dataset.
305
337
 
306
338
  dsarch [-(DS|Dataset)] dNNNNNN [-](SV|SetVersion) [Mode Options]
307
339
  [-(VI|VersionIndex) VersionIndex]
@@ -315,45 +347,47 @@ GroupIndex<:>BeginDate<:>EndDate<:>BeginTime<:>EndTime<:>
315
347
  [-(ET|EndTime) VersionEndTime]
316
348
  [-(DE|Description) VersionNote]
317
349
 
318
- Mode options that can be specified for this action:
350
+ Available mode options:
319
351
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
320
352
  regardless of dataset ownership
321
353
  -(NT|NoTrim) - skips trimming of spaces and comments from input
322
354
  values, speeding up input file processing
323
355
  -(NV|NewVersion) - adds a new version control record to GDEXDB
324
356
 
325
- If a version index is provided and already exists in GDEXDB, the record is
326
- modified. A new record is created when no index is given (or it is 0) and Mode
327
- option -NV (-NewVersion) is present.
357
+ If a version index is provided and already exists in GDEXDB, the
358
+ record is updated. A new record is created when no index is given (or
359
+ it is 0) and Mode option -NV (-NewVersion) is present.
328
360
 
329
- A newly created record with no DOI number is in Pending status and can only
330
- transition to Active once a DOI number is supplied. When an active record is
331
- created with a new DOI number, the version control index is auto-generated.
361
+ A newly created record with no DOI number is in Pending status and
362
+ can only transition to Active once a DOI number is supplied. When an
363
+ active record is created with a new DOI number, the version control
364
+ index is auto-generated.
332
365
 
333
366
  For example, to place d999009 under DOI/Version control:
334
367
 
335
368
  dsarch d999009 SV -NV -DN DOINumber
336
369
 
337
- If the data of d999009 are substantially updated to a new version, run the
338
- same command with a new DOI number. The previous active record is automatically
339
- moved to History status and its DOI is superseded. Only one active version
340
- control record may exist per dataset.
370
+ If d999009's data are substantially updated to a new version, run the
371
+ same command with a new DOI number. The previous active record is
372
+ automatically moved to History status and its DOI is superseded. Only
373
+ one active version control record may exist per dataset.
341
374
 
342
- For minimal data changes under the same DOI, run the same command with the
343
- existing DOI number to create a new internal version index. The previous
344
- record is again moved to History.
375
+ For minimal data changes under the same DOI, run the same command
376
+ with the existing DOI number to create a new internal version index.
377
+ The previous record is again moved to History.
345
378
 
346
- One common minimal-change case is replacing erroneous Web files. First, move
347
- the affected files to different names using Action -MV (their type is
348
- automatically set to 'V' for Version-controlled). Optionally create a new
349
- internal version at this point, then archive the replacement Web files.
379
+ One common minimal-change case is replacing erroneous Web files.
380
+ First, move the affected files to different names using Action -MV
381
+ (their type is automatically set to 'V' for Version-controlled).
382
+ Optionally create a new internal version at this point, then archive
383
+ the replacement Web files.
350
384
 
351
- Note: Various GDEX use cases are outlined above. Review them so that DOIs in
352
- the GDEX are handled consistently.
385
+ Note: Review the use cases above to ensure DOIs in GDEX are handled
386
+ consistently.
353
387
 
354
388
  3.2.2 Get Version Control
355
- -GV or -GetVersion, retrieves DOI/Version control records from GDEXDB for a
356
- given dataset.
389
+ -GV or -GetVersion, retrieves DOI/Version control records from GDEXDB
390
+ for a given dataset.
357
391
 
358
392
  dsarch [-(DS|Dataset)] dNNNNNN [-](GV|GetVersion) [Mode Option]
359
393
  [-(FN|FieldNames) FieldNameString]
@@ -361,11 +395,12 @@ GroupIndex<:>BeginDate<:>EndDate<:>BeginTime<:>EndTime<:>
361
395
  [-(OF|OutputFile) OutputFileName]
362
396
  [-(DB|Debug) DebugModeInfo]
363
397
 
364
- Mode option that can be specified for this action:
398
+ Available mode option:
365
399
  -(FO|FormatOutput) - formats each column to a uniform fixed width
366
400
 
367
- Use -FN (-FieldNames) to specify which version control fields to retrieve.
368
- Defaults to 'VIEDSJX'. Use -FN ALL to retrieve all available fields.
401
+ Use -FN (-FieldNames) to specify which version control fields to
402
+ retrieve. Defaults to 'VIEDSJX'. Use -FN ALL to retrieve all
403
+ available fields.
369
404
 
370
405
  Valid version control field names and their corresponding Info options:
371
406
 
@@ -381,8 +416,8 @@ GroupIndex<:>BeginDate<:>EndDate<:>BeginTime<:>EndTime<:>
381
416
  Y -(ET|EndTime) time the terminated version control ends by
382
417
  N -(DE|Description) note for the version control record
383
418
 
384
- Use -OF (-OutputFile) to save the retrieved information to a file. Without
385
- it, results are displayed on screen.
419
+ Use -OF (-OutputFile) to save the retrieved information to a file.
420
+ Without it, results are displayed on screen.
386
421
 
387
422
  For example, to retrieve all version control fields for d132000 and save to a file:
388
423
 
@@ -395,25 +430,27 @@ VersionIndex<:>InternalVersion<:>ExternalVersion<:>DOINumber<:>VersionStatus<:>B
395
430
 
396
431
 
397
432
  3.2.3 Terminate Version Control
398
- -TV or -TerminateVersion, closes a version control record in GDEXDB for the
399
- specified dataset, marking it as history or removing it if still pending.
433
+ -TV or -TerminateVersion, closes a version control record in GDEXDB
434
+ for the specified dataset, marking it as history or removing it if
435
+ still pending.
400
436
 
401
437
  dsarch [-(DS|Dataset)] dNNNNNN [-](TV|TerminateVersion) [Mode Options]
402
438
  -(VI|VersionIndex) VersionIndex
403
439
  [-(LN|LoginName) LoginAccountName]
404
440
  [-(DB|Debug) DebugModeInfo]
405
441
 
406
- Mode options that can be specified for this action:
442
+ Available mode options:
407
443
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
408
444
  regardless of dataset ownership
409
445
  -(NT|NoTrim) - skips trimming of spaces and comments from input
410
446
  values, speeding up input file processing
411
447
 
412
- Provide the version index via -VI and the dataset number via -DS. Termination
413
- is blocked if any Web files are still linked to that version. To work around
414
- this, first list those files using -GW (-GetWebFile), then either reassign
415
- their version index (to 0 or another value) or convert them to Saved files;
416
- only then can the version be terminated.
448
+ Provide the version index via -VI and the dataset number via -DS.
449
+ Termination is blocked if any Web files are still linked to that
450
+ version. To resolve this, first list those files using -GW
451
+ (-GetWebFile), then either reassign their version index (to 0 or
452
+ another value) or convert them to Saved files; only then can the
453
+ version be terminated.
417
454
 
418
455
  For example, to terminate version index 5 of d999009:
419
456
 
@@ -425,16 +462,17 @@ VersionIndex<:>InternalVersion<:>ExternalVersion<:>DOINumber<:>VersionStatus<:>B
425
462
 
426
463
  3.3 Group Actions
427
464
 
428
- Groups organize a dataset's files into named sub-products. Use the following
429
- actions to manage group records in GDEXDB:
465
+ Groups organize a dataset's files into named sub-products. Use the
466
+ following actions to manage group records in GDEXDB:
430
467
  Set Group Information - create or update group records
431
468
  Get Group Information - list and filter existing group records
432
469
  Delete Group Information - remove one or more group records
433
470
  Change Group Information - renumber group indices
434
471
 
435
472
  3.3.1 Set Group Information
436
- -SG or -SetGroup, creates new or updates existing group records in GDEXDB
437
- for the specified dataset. Multiple records can be processed in one run.
473
+ -SG or -SetGroup, creates new or updates existing group records in
474
+ GDEXDB for the specified dataset. Multiple records can be processed
475
+ in one run.
438
476
 
439
477
  dsarch [-(DS|Dataset)] dNNNNNN [-](SG|SetGroup) [Mode Options]
440
478
  [-(GI|GroupIndex) GroupIndices] # mandatory for new groups
@@ -453,26 +491,29 @@ VersionIndex<:>InternalVersion<:>ExternalVersion<:>DOINumber<:>VersionStatus<:>B
453
491
  [-(LN|LoginName) LoginAccountName]
454
492
  [-(DB|Debug) DebugModeInfo]
455
493
 
456
- Mode options that can be specified for this action:
457
- -(MD|MyDataset) - allows any specialist to set GDEXDB information,
458
- regardless of dataset ownership
459
- -(NT|NoTrim) - skips trimming of spaces and comments from input
460
- values, speeding up input file processing
461
- -(RT|ResetTGroup) - resets the top group index for Saved/Web file records
462
- in the affected group
463
- -(WM|WithMetadata) - re-gathers Web file content metadata at the group level
464
- -(WN|WithFileNumber) - re-evaluates and resets Saved/Web file counts for the
465
- affected groups
466
-
467
- If the group index already exists in GDEXDB, the record is updated; otherwise
468
- a new group is created. New groups require a unique index.
469
-
470
- To create a subgroup, set a parent index via -PI (-ParentIndex). Groups can
471
- be nested to any depth. By default, three levels are shown on group list
472
- webpages; adjust this with -GL (-GroupLevel) via -SD (-SetDataset).
473
-
474
- Changing a group's type from P (public) to I (internal) automatically marks
475
- all its subgroups and associated Saved/Web files as internal too.
494
+ Available mode options:
495
+ -(MD|MyDataset) - allows any specialist to set GDEXDB
496
+ information, regardless of dataset ownership
497
+ -(NT|NoTrim) - skips trimming of spaces and comments from
498
+ input values, speeding up input file
499
+ processing
500
+ -(RT|ResetTGroup) - resets the top group index for Saved/Web file
501
+ records in the affected group
502
+ -(WM|WithMetadata) - re-gathers Web file content metadata at the
503
+ group level
504
+ -(WN|WithFileNumber) - re-evaluates and resets Saved/Web file counts
505
+ for the affected groups
506
+
507
+ If the group index already exists in GDEXDB, the record is updated;
508
+ otherwise a new group is created. New groups require a unique index.
509
+
510
+ To create a subgroup, set a parent index via -PI (-ParentIndex).
511
+ Groups can be nested to any depth. By default, three levels are shown
512
+ on group list webpages; adjust this with -GL (-GroupLevel) via -SD
513
+ (-SetDataset).
514
+
515
+ Changing a group's type from P (public) to I (internal) automatically
516
+ marks all its subgroups and associated Saved/Web files as internal too.
476
517
 
477
518
  For example, to set multiple group records for d744004 using an input file:
478
519
 
@@ -507,13 +548,14 @@ QSCAT observations.<:>
507
548
  [-(OF|OutputFile) OutputFileName]
508
549
  [-(DB|Debug) DebugModeInfo]
509
550
 
510
- Mode options that can be specified for this action:
551
+ Available mode options:
511
552
  -(FO|FormatOutput) - formats each column to a uniform fixed width
512
- -(RG|RecursiveGroup) - gathers subgroups recursively for a given group index
553
+ -(RG|RecursiveGroup) - gathers subgroups recursively for a given
554
+ group index
513
555
  -(WN|WithFileNumber) - gathers and displays file counts for groups
514
556
 
515
- Use -FN (-FieldNames) to specify which group fields to retrieve. Defaults
516
- to 'IGXTQSW'. Use -FN ALL for all available fields.
557
+ Use -FN (-FieldNames) to specify which group fields to retrieve.
558
+ Defaults to 'IGXTQSW'. Use -FN ALL for all available fields.
517
559
 
518
560
  Valid group field names and their corresponding Info options:
519
561
 
@@ -532,11 +574,11 @@ QSCAT observations.<:>
532
574
  D -(NW|NoteWeb) group description of data on GDEX Server
533
575
  N -(NI|NoteInternal) group description of internal HPSS data
534
576
 
535
- Results can be filtered by group index (-GI), name (-GN), or parent index
536
- (-PI). The -GN option accepts the '%' wildcard.
577
+ Results can be filtered by group index (-GI), name (-GN), or parent
578
+ index (-PI). The -GN option accepts the '%' wildcard.
537
579
 
538
- For example, to retrieve the default group fields and file counts for groups
539
- 1 and 2 of d260001:
580
+ For example, to retrieve the default group fields and file counts for
581
+ groups 1 and 2 of d260001:
540
582
 
541
583
  dsarch d260001 GG -WN -GI 1 2
542
584
 
@@ -551,30 +593,31 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
551
593
 
552
594
 
553
595
  3.3.3 Delete Group Information
554
- -DG or -DeleteGroup, removes one or more group records from GDEXDB for the
555
- specified dataset.
596
+ -DG or -DeleteGroup, removes one or more group records from GDEXDB
597
+ for the specified dataset.
556
598
 
557
599
  dsarch [-(DS|Dataset)] dNNNNNN [-](DG|DeleteGroup) [Mode Options]
558
600
  -(GI|GroupIndex) GroupIndices
559
601
  [-(LN|LoginName) LoginAccountName]
560
602
  [-(DB|Debug) DebugModeInfo]
561
603
 
562
- Mode options that can be specified for this action:
563
- -(MD|MyDataset) - allows any specialist to set GDEXDB information,
564
- regardless of dataset ownership
565
- -(NT|NoTrim) - skips trimming of spaces and comments from input
566
- values, speeding up input file processing
567
- -(RT|ResetTGroup) - resets the top group index for file records in the
568
- affected group
569
- -(WN|WithFileNumber) - re-evaluates and resets file counts for the affected
570
- groups
571
-
572
- Specify groups by index via -GI and the dataset via -DS. Deletion is blocked
573
- if a group still contains subgroups or data files. To delete a non-empty
574
- group, first retrieve its files with -GS (-GetSavedFile) or -GW
575
- (-GetWebFile), then either move them to another group via -CG (-ChangeGroup),
576
- reset their group index to 0, or remove them with -DL (-Delete). Once empty,
577
- the group can be deleted.
604
+ Available mode options:
605
+ -(MD|MyDataset) - allows any specialist to set GDEXDB
606
+ information, regardless of dataset ownership
607
+ -(NT|NoTrim) - skips trimming of spaces and comments from
608
+ input values, speeding up input file
609
+ processing
610
+ -(RT|ResetTGroup) - resets the top group index for file records in
611
+ the affected group
612
+ -(WN|WithFileNumber) - re-evaluates and resets file counts for the
613
+ affected groups
614
+
615
+ Specify groups by index via -GI and the dataset via -DS. Deletion is
616
+ blocked if a group still contains subgroups or data files. To delete
617
+ a non-empty group, first retrieve its files with -GS (-GetSavedFile)
618
+ or -GW (-GetWebFile), then either move them to another group via -CG
619
+ (-ChangeGroup), reset their group index to 0, or remove them with
620
+ -DL (-Delete). Once empty, the group can be deleted.
578
621
 
579
622
  For example, to delete group indices 2 and 3 of d744004:
580
623
 
@@ -582,8 +625,9 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
582
625
 
583
626
 
584
627
  3.3.4 Change Group Information
585
- -CG or -ChangeGroup, renumbers group indices for the specified dataset,
586
- mapping each original index (via -OG) to a new value (via -GI).
628
+ -CG or -ChangeGroup, renumbers group indices for the specified
629
+ dataset, mapping each original index (via -OG) to a new value (via
630
+ -GI).
587
631
 
588
632
  dsarch [-(DS|dataset)] dNNNNNN [-](CG|ChangeGroup) [Mode Options]
589
633
  -(OG|OriginGroup) OriginalGroupIndices
@@ -591,19 +635,20 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
591
635
  [-(LN|LoginName) LoginAccountName]
592
636
  [-(DB|Debug) DebugModeInfo]
593
637
 
594
- Mode options that can be specified for this action:
595
- -(MD|MyDataset) - allows any specialist to set GDEXDB information,
596
- regardless of dataset ownership
597
- -(NT|NoTrim) - skips trimming of spaces and comments from input
598
- values, speeding up input file processing
599
- -(RT|ResetTGroup) - resets the top group index for file records in the
600
- affected group
601
- -(WN|WithFileNumber) - re-evaluates and resets file counts for the affected
602
- groups
638
+ Available mode options:
639
+ -(MD|MyDataset) - allows any specialist to set GDEXDB
640
+ information, regardless of dataset ownership
641
+ -(NT|NoTrim) - skips trimming of spaces and comments from
642
+ input values, speeding up input file
643
+ processing
644
+ -(RT|ResetTGroup) - resets the top group index for file records in
645
+ the affected group
646
+ -(WN|WithFileNumber) - re-evaluates and resets file counts for the
647
+ affected groups
603
648
 
604
- Both -OG (-OriginGroup) and -GI (-GroupIndex) are required. All Saved and
605
- Web file records linked to the original indices are updated to the new
606
- values. The original indices must already exist in GDEXDB.
649
+ Both -OG (-OriginGroup) and -GI (-GroupIndex) are required. All Saved
650
+ and Web file records linked to the original indices are updated to
651
+ the new values. The original indices must already exist in GDEXDB.
607
652
 
608
653
  For example, to reassign group indices 1 and 2 to 2 and 3 for d744004:
609
654
 
@@ -615,32 +660,38 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
615
660
  This section covers the full lifecycle of files in GDEXDB: archiving,
616
661
  querying, moving, and deleting Saved, Web, Help, and Quasar files.
617
662
  Available actions:
618
- Set Saved File Information - create or modify Saved file records in GDEXDB
663
+ Set Saved File Information - create or modify Saved file records in
664
+ GDEXDB
619
665
  Get Saved File Information - retrieve Saved file records from GDEXDB
620
- Set Web File Information - create or modify Web file records in GDEXDB
666
+ Set Web File Information - create or modify Web file records in
667
+ GDEXDB
621
668
  Get Web File Information - retrieve Web file records from GDEXDB
622
- Set Help File Information - create or modify Help file records in GDEXDB
669
+ Set Help File Information - create or modify Help file records in
670
+ GDEXDB
623
671
  Get Help File Information - retrieve Help file records from GDEXDB
624
- Set Quasar File Information - create or modify Quasar backup file records
625
- Get Quasar File Information - retrieve Quasar backup file records from GDEXDB
626
- Archive Saved Files - archive local files as Saved files and record
627
- their information in GDEXDB
628
- Archive Web Files - archive local files as Web files and record
629
- their information in GDEXDB
630
- Archive Help Files - archive local files as Help files and record
631
- their information in GDEXDB
632
- Backup Quasar Files - tar and upload files to the Globus Quasar Server
633
- Restore Quasar Files - retrieve Quasar tar files and restore missing
634
- Saved or Web files
635
- Move Saved/Web/Help/Quasar Files - move files between datasets, groups,
636
- or file types
637
- Delete Saved/Web/Help/Quasar Files - delete files and remove their GDEXDB
638
- records
672
+ Set Quasar File Information - create or modify Quasar backup file
673
+ records
674
+ Get Quasar File Information - retrieve Quasar backup file records from
675
+ GDEXDB
676
+ Archive Saved Files - archive local files as Saved files and
677
+ record their information in GDEXDB
678
+ Archive Web Files - archive local files as Web files and
679
+ record their information in GDEXDB
680
+ Archive Help Files - archive local files as Help files and
681
+ record their information in GDEXDB
682
+ Backup Quasar Files - tar and upload files to the Globus
683
+ Quasar Server
684
+ Restore Quasar Files - retrieve Quasar tar files and restore
685
+ missing Saved or Web files
686
+ Move Saved/Web/Help/Quasar Files - move files between datasets,
687
+ groups, or file types
688
+ Delete Saved/Web/Help/Quasar Files - delete files and remove their
689
+ GDEXDB records
639
690
 
640
691
  3.4.1 Set Saved File Information
641
- -SS or -SetSavedFile (Alias: -SetSaved), creates new or updates existing
642
- Saved file records in GDEXDB for the specified dataset. Multiple records
643
- can be processed in a single run.
692
+ -SS or -SetSavedFile (Alias: -SetSaved), creates new or updates
693
+ existing Saved file records in GDEXDB for the specified dataset.
694
+ Multiple records can be processed in a single run.
644
695
 
645
696
  dsarch [-(DS|Dataset)] dNNNNNN [-](SS|SetSavedFile) [Mode Options]
646
697
  [-(SF|SavedFile) SavedFileNames]
@@ -667,36 +718,39 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
667
718
  [-(BP|BatchProcess) [BatchControlInfo]]
668
719
  [-(DB|Debug) DebugModeInfo]
669
720
 
670
- Mode options that can be specified for this action:
671
- -(BG|BackGround) - runs in background; suppresses screen output and errors
672
- -(EM|EMailNotice) - sends an email summary (including any errors) when the
673
- action completes or aborts
721
+ Available mode options:
722
+ -(BG|BackGround) - runs in background; suppresses screen output and
723
+ errors
724
+ -(EM|EMailNotice) - sends an email summary (including any errors)
725
+ when the action completes or aborts
674
726
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
675
727
  regardless of dataset ownership
676
728
  -(NE|NoEmail) - suppresses email notification on failure
677
729
  -(NT|NoTrim) - skips trimming of spaces and comments from input
678
730
  values, speeding up input file processing
679
731
  -(RD|RemoveDir) - removes empty directories after file changes
680
- -(RO|ResetOrder) - resets display order indices to match the order files
681
- are given per -SF. Alternatively, use -ON (-OrderNames)
682
- to reorder all files in the dataset and affected groups
683
- -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX Server and
684
- saves them to GDEXDB
732
+ -(RO|ResetOrder) - resets display order indices to match the order
733
+ files are given per -SF. Alternatively, use -ON
734
+ (-OrderNames) to reorder all files in the dataset
735
+ and affected groups
736
+ -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX
737
+ Server and saves them to GDEXDB
685
738
 
686
739
  Saved file names must be provided via -SF (-SavedFile) unless -ON
687
- (-OrderNames) is used to reorder files. The number of values supplied to
688
- other Info options must match the number of file names, except for options
689
- that accept a single shared value, such as -GI (-GroupIndex), -AF
690
- (-ArchiveFormat), -DF (-DataFormat), and -ST (-SavedFileType).
740
+ (-OrderNames) is used to reorder files. The number of values supplied
741
+ to other Info options must match the number of file names, except for
742
+ options that accept a single shared value, such as -GI (-GroupIndex),
743
+ -AF (-ArchiveFormat), -DF (-DataFormat), and -ST (-SavedFileType).
691
744
 
692
- If no group index is specified and -PO (-PatternOffset) is present, file
693
- names are matched against group patterns saved via -SG (-SetGroup) to
694
- determine the group index automatically.
745
+ If no group index is specified and -PO (-PatternOffset) is present,
746
+ file names are matched against group patterns saved via -SG
747
+ (-SetGroup) to determine the group index automatically.
695
748
 
696
749
 
697
750
  3.4.2 Get Saved File Information
698
- -GS or -GetSavedFile (Alias: -GetSaved), retrieves Saved file records from
699
- GDEXDB for the specified dataset, optionally filtered by file name.
751
+ -GS or -GetSavedFile (Alias: -GetSaved), retrieves Saved file records
752
+ from GDEXDB for the specified dataset, optionally filtered by file
753
+ name.
700
754
 
701
755
  dsarch [-(DS|Dataset)] dNNNNNN -(GS|GetSavedFile) [Mode Options]
702
756
  [-(FN|FieldNames) FieldNameString]
@@ -714,15 +768,15 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
714
768
  [-(OF|OutputFile) OutputFileName]
715
769
  [-(DB|Debug) DebugModeInfo]
716
770
 
717
- Mode options that can be specified for this action:
771
+ Available mode options:
718
772
  -(FO|FormatOutput) - formats each column to a uniform fixed width
719
- -(RG|RecursiveGroup) - gathers files in subgroups recursively for a given
720
- group index
721
- -(RN|RelativeName) - returns file names with paths relative to the Saved
722
- path of the dataset or group
773
+ -(RG|RecursiveGroup) - gathers files in subgroups recursively for a
774
+ given group index
775
+ -(RN|RelativeName) - returns file names with paths relative to the
776
+ Saved path of the dataset or group
723
777
 
724
- Use -FN (-FieldNames) to specify which Saved file fields to retrieve. Defaults
725
- to 'FINMTHS'. Use -FN ALL for all available fields.
778
+ Use -FN (-FieldNames) to specify which Saved file fields to retrieve.
779
+ Defaults to 'FINMTHS'. Use -FN ALL for all available fields.
726
780
 
727
781
  Valid Saved file field names and their corresponding Info options:
728
782
 
@@ -746,19 +800,20 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
746
800
  K -(FT|FileTime) time data last modified at
747
801
  D -(DE|Description) Saved file descriptions
748
802
 
749
- A dataset number is required unless Saved file names are provided. If file
750
- names match multiple datasets and no dataset number is given, an error prompts
751
- the specialist to specify one and rerun. Incomplete file paths are expanded
752
- relative to the dataset Saved Home Directory.
803
+ A dataset number is required unless Saved file names are provided. If
804
+ file names match multiple datasets and no dataset number is given, an
805
+ error prompts the specialist to specify one and rerun. Incomplete
806
+ file paths are expanded relative to the dataset Saved Home Directory.
753
807
 
754
- Results can be filtered by archive type (-ST), group (-GI or -GN), and
755
- description (-DE). The -SF, -GN, and -DE options accept the '%' wildcard.
808
+ Results can be filtered by archive type (-ST), group (-GI or -GN),
809
+ and description (-DE). The -SF, -GN, and -DE options accept the '%'
810
+ wildcard.
756
811
 
757
812
 
758
813
  3.4.3 Set Web File Information
759
- -SW or -SetWebFile (Alias: -SetWeb), creates new or updates existing Web file
760
- records in GDEXDB for the specified dataset. Multiple records can be
761
- processed in a single run.
814
+ -SW or -SetWebFile (Alias: -SetWeb), creates new or updates existing
815
+ Web file records in GDEXDB for the specified dataset. Multiple
816
+ records can be processed in a single run.
762
817
 
763
818
  dsarch [-(DS|Dataset)] dNNNNNN -(SW|SetWebFile) [Mode Options]
764
819
  [-(WF|WebFile) webFileNames]
@@ -788,44 +843,49 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
788
843
  [-(BP|BatchProcess) [BatchControlInfo]]
789
844
  [-(DB|Debug) DebugModeInfo]
790
845
 
791
- Mode options that can be specified for this action:
792
- -(BG|BackGround) - runs in background; suppresses screen output and errors
793
- -(DX|DeleteXML) - calls 'dcm' to delete content metadata for the specified
794
- Web files
795
- -(EM|EMailNotice) - sends an email summary (including any errors) when the
796
- action completes or aborts
797
- -(GX|GatherXML) - calls 'gatherxml' to evaluate file content metadata
846
+ Available mode options:
847
+ -(BG|BackGround) - runs in background; suppresses screen output and
848
+ errors
849
+ -(DX|DeleteXML) - calls 'dcm' to delete content metadata for the
850
+ specified Web files
851
+ -(EM|EMailNotice) - sends an email summary (including any errors)
852
+ when the action completes or aborts
853
+ -(GX|GatherXML) - calls 'gatherxml' to evaluate file content
854
+ metadata
798
855
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
799
856
  regardless of dataset ownership
800
857
  -(NE|NoEmail) - suppresses email notification on failure
801
858
  -(NT|NoTrim) - skips trimming of spaces and comments from input
802
859
  values, speeding up input file processing
803
860
  -(RD|RemoveDir) - removes empty web directories after file changes
804
- -(RO|ResetOrder) - resets display order indices to match the order files are
805
- given per -WF. Alternatively, use -ON (-OrderNames) to
806
- reorder all files in the dataset and affected groups
861
+ -(RO|ResetOrder) - resets display order indices to match the order
862
+ files are given per -WF. Alternatively, use -ON
863
+ (-OrderNames) to reorder all files in the dataset
864
+ and affected groups
807
865
  -(RS|GXRSOptions) - passes options R and S to 'gatherxml' for faster
808
866
  processing, used with -GX (-GatherXML)
809
- -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX Server and
810
- saves them to GDEXDB
867
+ -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX
868
+ Server and saves them to GDEXDB
811
869
 
812
- Web file names must be provided via -WF (-WebFile) unless -ON (-OrderNames)
813
- is used to reorder files. The number of values supplied to other Info options
814
- must match the number of file names, except for options that accept a single
815
- shared value, such as -GI (-GroupIndex), -AF (-ArchiveFormat), -DF
816
- (-DataFormat), and -WT (-WebFileType).
870
+ Web file names must be provided via -WF (-WebFile) unless -ON
871
+ (-OrderNames) is used to reorder files. The number of values supplied
872
+ to other Info options must match the number of file names, except
873
+ for options that accept a single shared value, such as -GI
874
+ (-GroupIndex), -AF (-ArchiveFormat), -DF (-DataFormat), and -WT
875
+ (-WebFileType).
817
876
 
818
- If no group index is specified and -PO (-PatternOffset) is present, file
819
- names are matched against group patterns saved via -SG (-SetGroup) to
820
- determine the group index automatically.
877
+ If no group index is specified and -PO (-PatternOffset) is present,
878
+ file names are matched against group patterns saved via -SG
879
+ (-SetGroup) to determine the group index automatically.
821
880
 
822
- The file status may be set to P (public) or I (internal) for data types D,
823
- N, O, and S. Files assigned to an internal group are automatically set to I.
881
+ The file status may be set to P (public) or I (internal) for data
882
+ types D, N, O, and S. Files assigned to an internal group are
883
+ automatically set to I.
824
884
 
825
885
 
826
886
  3.4.4 Get Web File Information
827
- -GW or -GetWebFile (Alias: -GetWeb), retrieves Web file records from GDEXDB
828
- for the specified dataset, optionally filtered by file name.
887
+ -GW or -GetWebFile (Alias: -GetWeb), retrieves Web file records from
888
+ GDEXDB for the specified dataset, optionally filtered by file name.
829
889
 
830
890
  dsarch [-(DS|Dataset)] dNNNNNN -(GW|GetWebFile) [Mode Options]
831
891
  [-(FN|FieldNames) FieldNameString]
@@ -843,15 +903,15 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
843
903
  [-(OF|OutputFile) OutputFileName]
844
904
  [-(DB|Debug) DebugModeInfo]
845
905
 
846
- Mode options that can be specified for this action:
906
+ Available mode options:
847
907
  -(FO|FormatOutput) - formats each column to a uniform fixed width
848
- -(RG|RecursiveGroup) - gathers files in subgroups recursively for a given
849
- group index
850
- -(RN|RelativeName) - returns file names with paths relative to the Web path
851
- of the dataset or group
908
+ -(RG|RecursiveGroup) - gathers files in subgroups recursively for a
909
+ given group index
910
+ -(RN|RelativeName) - returns file names with paths relative to the
911
+ Web path of the dataset or group
852
912
 
853
- Use -FN (-FieldNames) to specify which Web file fields to retrieve. Defaults
854
- to 'FINMTHS'. Use -FN ALL for all available fields.
913
+ Use -FN (-FieldNames) to specify which Web file fields to retrieve.
914
+ Defaults to 'FINMTHS'. Use -FN ALL for all available fields.
855
915
 
856
916
  Valid Web file field names and their corresponding Info options:
857
917
 
@@ -877,16 +937,17 @@ d260001-G2: DS-552780725 DC-522 WC-522 SS-465789806 SC-51
877
937
  E -(TL|ThreddLink) a link to Thredd Catalog page at the file level
878
938
  D -(DE|Description) Web file descriptions
879
939
 
880
- A dataset number is required unless Web file names are provided. If file
881
- names match multiple datasets and no dataset number is given, an error prompts
882
- the specialist to specify one and rerun. Incomplete file paths are expanded
883
- relative to the dataset Web Home Directory.
940
+ A dataset number is required unless Web file names are provided. If
941
+ file names match multiple datasets and no dataset number is given,
942
+ an error prompts the specialist to specify one and rerun. Incomplete
943
+ file paths are expanded relative to the dataset Web Home Directory.
884
944
 
885
- Results can be filtered by archive type (-WT), group (-GI or -GN), and
886
- description (-DE). The -WF, -GN, and -DE options accept the '%' wildcard.
945
+ Results can be filtered by archive type (-WT), group (-GI or -GN),
946
+ and description (-DE). The -WF, -GN, and -DE options accept the '%'
947
+ wildcard.
887
948
 
888
- For example, to retrieve the default Web file fields for d540000, filtered
889
- to Data type and file names containing '200':
949
+ For example, to retrieve the default Web file fields for d540000,
950
+ filtered to Data type and file names containing '200':
890
951
 
891
952
  dsarch d540000 GW -WT D -WF %200%
892
953
 
@@ -901,9 +962,10 @@ IMMA_2.4_2006.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>1119821824<:>
901
962
  IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
902
963
 
903
964
  3.4.5 Set Help File Information
904
- -SH or -SetHelpFile (Alias: -SetHelp), creates new or updates existing Help
905
- file records (Documents and Software) in GDEXDB for the specified dataset.
906
- Multiple records can be processed in a single run.
965
+ -SH or -SetHelpFile (Alias: -SetHelp), creates new or updates
966
+ existing Help file records (Documents and Software) in GDEXDB for
967
+ the specified dataset. Multiple records can be processed in a single
968
+ run.
907
969
 
908
970
  dsarch [-(DS|Dataset)] dNNNNNN -(SH|SetHelpFile) [Mode Options]
909
971
  [-(HF|HelpFile) HelpFileNames]
@@ -927,33 +989,36 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
927
989
  [-(LN|LoginName) LoginAccountName]
928
990
  [-(DB|Debug) DebugModeInfo]
929
991
 
930
- Mode options that can be specified for this action:
931
- -(BG|BackGround) - runs in background; suppresses screen output and errors
932
- -(EM|EMailNotice) - sends an email summary (including any errors) when the
933
- action completes or aborts
992
+ Available mode options:
993
+ -(BG|BackGround) - runs in background; suppresses screen output and
994
+ errors
995
+ -(EM|EMailNotice) - sends an email summary (including any errors)
996
+ when the action completes or aborts
934
997
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
935
998
  regardless of dataset ownership
936
999
  -(NE|NoEmail) - suppresses email notification on failure
937
1000
  -(NT|NoTrim) - skips trimming of spaces and comments from input
938
1001
  values, speeding up input file processing
939
- -(RO|ResetOrder) - resets display order indices to match the order files
940
- are provided
941
- -(SC|SetChecksum) - computes MD5 checksums for Help files and saves them
942
- to GDEXDB
1002
+ -(RO|ResetOrder) - resets display order indices to match the order
1003
+ files are provided
1004
+ -(SC|SetChecksum) - computes MD5 checksums for Help files and saves
1005
+ them to GDEXDB
943
1006
 
944
- Help file names must be provided via -HF (-HelpFile) unless -ON (-OrderNames)
945
- is used to reorder files. The number of values supplied to other Info options
946
- must match the number of file names, except for options that accept a single
947
- shared value, such as -AF, -DF, and -HT (-HelpFileType).
1007
+ Help file names must be provided via -HF (-HelpFile) unless -ON
1008
+ (-OrderNames) is used to reorder files. The number of values supplied
1009
+ to other Info options must match the number of file names, except
1010
+ for options that accept a single shared value, such as -AF, -DF, and
1011
+ -HT (-HelpFileType).
948
1012
 
949
- For remotely hosted Help files (e.g., on GitHub), provide the full URL via
950
- -WU (-WebURL) to add a record without a local copy on the GDEX Server.
1013
+ For remotely hosted Help files (e.g., on GitHub), provide the full
1014
+ URL via -WU (-WebURL) to register the file in GDEXDB without a local
1015
+ copy on the GDEX Server.
951
1016
 
952
1017
 
953
1018
  3.4.6 Get Help File Information
954
- -GH or -GetHelpFile (Alias: -GetHelp), retrieves Help file records (Documents
955
- and Software) from GDEXDB for the specified dataset, optionally filtered by
956
- file name.
1019
+ -GH or -GetHelpFile (Alias: -GetHelp), retrieves Help file records
1020
+ (Documents and Software) from GDEXDB for the specified dataset,
1021
+ optionally filtered by file name.
957
1022
 
958
1023
  dsarch [-(DS|Dataset)] dNNNNNN -(GH|GetHelpFile) [Mode Options]
959
1024
  [-(FN|FieldNames) FieldNameString]
@@ -969,11 +1034,11 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
969
1034
  [-(OF|OutputFile) OutputFileName]
970
1035
  [-(DB|Debug) DebugModeInfo]
971
1036
 
972
- Mode option that can be specified for this action:
1037
+ Available mode option:
973
1038
  -(FO|FormatOutput) - formats each column to a uniform fixed width
974
1039
 
975
- Use -FN (-FieldNames) to specify which Help file fields to retrieve. Defaults
976
- to 'FINMTHSU'. Use -FN ALL for all available fields.
1040
+ Use -FN (-FieldNames) to specify which Help file fields to retrieve.
1041
+ Defaults to 'FINMTHSU'. Use -FN ALL for all available fields.
977
1042
 
978
1043
  Valid Help file field names and their corresponding Info options:
979
1044
 
@@ -994,17 +1059,17 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
994
1059
  U -(WU|WebURL) a full URL for a remote help file
995
1060
  D -(DE|Description) file descriptions
996
1061
 
997
- A dataset number is required unless Help file names are provided. If file
998
- names match multiple datasets and no dataset number is given, an error prompts
999
- the specialist to specify one and rerun.
1062
+ A dataset number is required unless Help file names are provided. If
1063
+ file names match multiple datasets and no dataset number is given,
1064
+ an error prompts the specialist to specify one and rerun.
1000
1065
 
1001
- Results can be filtered by type (-HT) and description (-DE). Both -HF and
1002
- -DE accept the '%' wildcard.
1066
+ Results can be filtered by type (-HT) and description (-DE). Both
1067
+ -HF and -DE accept the '%' wildcard.
1003
1068
 
1004
1069
  3.4.7 Set Quasar File Information
1005
- -SQ or -SetQuasarFile (Alias: -SetQuasar), updates Quasar backup file records
1006
- in GDEXDB for the specified dataset. Multiple records can be processed per
1007
- execution.
1070
+ -SQ or -SetQuasarFile (Alias: -SetQuasar), updates Quasar backup
1071
+ file records in GDEXDB for the specified dataset. Multiple records
1072
+ can be processed per execution.
1008
1073
 
1009
1074
  dsarch [-(DS|Dataset)] dNNNNNN [-](SQ|SetQuasarFile) [Mode Options]
1010
1075
  [-(QF|QuasarFile) QuasarFileNames]
@@ -1025,28 +1090,31 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1025
1090
  [-(BP|BatchProcess) [BatchControlInfo]]
1026
1091
  [-(DB|Debug) DebugModeInfo]
1027
1092
 
1028
- Mode options that can be specified for this action:
1029
- -(BG|BackGround) - runs in background; suppresses screen output and errors
1093
+ Available mode options:
1094
+ -(BG|BackGround) - runs in background; suppresses screen output and
1095
+ errors
1030
1096
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1031
1097
  regardless of dataset ownership
1032
1098
  -(NE|NoEmail) - suppresses email notification on failure
1033
1099
  -(NT|NoTrim) - skips trimming of spaces and comments from input
1034
1100
  values, speeding up input file processing
1035
- -(RO|ResetOrder) - resets display order indices to match the order files
1036
- are given per -QF. Alternatively, use -ON (-OrderNames)
1037
- to reorder all files in the dataset
1038
- -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX Server and
1039
- saves them to GDEXDB
1101
+ -(RO|ResetOrder) - resets display order indices to match the order
1102
+ files are given per -QF. Alternatively, use -ON
1103
+ (-OrderNames) to reorder all files in the dataset
1104
+ -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX
1105
+ Server and saves them to GDEXDB
1040
1106
 
1041
1107
  Quasar file names must be provided via -QF (-QuasarFile) unless -ON
1042
- (-OrderNames) is used to reorder files. The number of values supplied to other
1043
- Info options must match the number of file names, except for options that
1044
- accept a single shared value, such as -AF, -DF, and -QT (-QuasarFileType).
1108
+ (-OrderNames) is used to reorder files. The number of values supplied
1109
+ to other Info options must match the number of file names, except
1110
+ for options that accept a single shared value, such as -AF, -DF, and
1111
+ -QT (-QuasarFileType).
1045
1112
 
1046
1113
 
1047
1114
  3.4.8 Get Quasar File Information
1048
- -GQ or -GetQuasarFile (Alias: -GetQuasar), retrieves Quasar backup file records
1049
- from GDEXDB for the specified dataset, optionally filtered by file name.
1115
+ -GQ or -GetQuasarFile (Alias: -GetQuasar), retrieves Quasar backup
1116
+ file records from GDEXDB for the specified dataset, optionally
1117
+ filtered by file name.
1050
1118
 
1051
1119
  dsarch [-(DS|Dataset)] dNNNNNN -(GQ|GetQuasarFile) [Mode Options]
1052
1120
  [-(FN|FieldNames) FieldNameString]
@@ -1059,11 +1127,11 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1059
1127
  [-(OF|OutputFile) OutputFileName]
1060
1128
  [-(DB|Debug) DebugModeInfo]
1061
1129
 
1062
- Mode option that can be specified for this action:
1130
+ Available mode option:
1063
1131
  -(FO|FormatOutput) - formats each column to a uniform fixed width
1064
1132
 
1065
- Use -FN (-FieldNames) to specify which Quasar file fields to retrieve. Defaults
1066
- to 'FNMTHS'. Use -FN ALL for all available fields.
1133
+ Use -FN (-FieldNames) to specify which Quasar file fields to
1134
+ retrieve. Defaults to 'FNMTHS'. Use -FN ALL for all available fields.
1067
1135
 
1068
1136
  Valid Quasar file field names and their corresponding Info options:
1069
1137
 
@@ -1082,18 +1150,18 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1082
1150
  K -(FT|FileTime) time data last modified at
1083
1151
  D -(DE|Description) Quasar file descriptions
1084
1152
 
1085
- A dataset number is required unless Quasar file names are provided. If file
1086
- names match multiple datasets and no dataset number is given, an error prompts
1087
- the specialist to specify one and rerun. Incomplete file paths are expanded
1088
- relative to the dataset Home Directory.
1153
+ A dataset number is required unless Quasar file names are provided.
1154
+ If file names match multiple datasets and no dataset number is given,
1155
+ an error prompts the specialist to specify one and rerun. Incomplete
1156
+ file paths are expanded relative to the dataset Home Directory.
1089
1157
 
1090
- Results can be filtered by archive type (-QT) and description (-DE). Both
1091
- -QF and -DE accept the '%' wildcard.
1158
+ Results can be filtered by archive type (-QT) and description (-DE).
1159
+ Both -QF and -DE accept the '%' wildcard.
1092
1160
 
1093
1161
  3.4.9 Archive Saved Files
1094
1162
  -AS or -ArchiveSavedFile (Alias: -ArchiveSaved|-ArchSaved|-ArchSavedFile),
1095
- copies local files to the GDEX Server as Saved files and registers them in
1096
- GDEXDB. One or more files may be archived per execution.
1163
+ copies local files to the GDEX Server as Saved files and registers
1164
+ them in GDEXDB. One or more files may be archived per execution.
1097
1165
 
1098
1166
  dsarch [-(DS|dataset)] dNNNNNN -(AS|ArchiveSavedFile) [Mode Options]
1099
1167
  [-(LF|LocalFile) LocalFileNames] # mandatory unless -LD or -LL present
@@ -1122,63 +1190,74 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1122
1190
  [-(DD|DeleteDir) DeleteLocalDirLevel]
1123
1191
  [-(DB|Debug) DebugModeInfo]
1124
1192
 
1125
- Mode options that can be specified for this action:
1126
- -(BG|BackGround) - runs in background; suppresses screen output and errors
1127
- -(CL|CleanLocal) - removes local files after all are successfully archived
1128
- -(EM|EMailNotice) - sends an email summary (including any errors) when the
1129
- action completes or aborts
1130
- -(GZ|GMTZone) - uses GMT rather than local time for archiving timestamps
1131
- -(KP|KeepLocalPath) - uses local file paths as relative paths on the GDEX Server
1193
+ Available mode options:
1194
+ -(BG|BackGround) - runs in background; suppresses screen output and
1195
+ errors
1196
+ -(CL|CleanLocal) - removes local files after all are successfully
1197
+ archived
1198
+ -(EM|EMailNotice) - sends an email summary (including any errors)
1199
+ when the action completes or aborts
1200
+ -(GZ|GMTZone) - uses GMT rather than local time for archiving
1201
+ timestamps
1202
+ -(KP|KeepLocalPath) - uses local file paths as relative paths on the
1203
+ GDEX Server
1132
1204
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1133
1205
  regardless of dataset ownership
1134
1206
  -(NE|NoEmail) - suppresses email notification on failure
1135
1207
  -(NT|NoTrim) - skips trimming of spaces and comments from input
1136
1208
  values, speeding up input file processing
1137
1209
  -(OE|OverrideExist) - overwrites existing Saved files
1138
- -(RO|ResetOrder) - resets display order indices to match the order files
1139
- are given per -SF. Alternatively, use -ON (-OrderNames)
1140
- to reorder all files in the dataset and affected groups
1141
- -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX Server and
1142
- saves them to GDEXDB
1143
- -(UZ|UnzipData) - decompresses files using 'gunzip', 'uncompress', 'unzip',
1144
- or 'bunzip' according to the extension: '.gz', '.Z',
1145
- '.zip', or '.bz2', respectively
1146
- -(XC|CrossCopy) - copies files from existing Saved/Object storage to fill
1147
- missing Object/Saved copies, using GDEXDB records for
1148
- guidance
1149
- -(XM|CrossMove) - moves files from existing Saved/Object storage to fill
1150
- missing Object/Saved copies (originals are removed)
1151
- -(ZD|ZipData) - compresses files using 'gzip', 'compress', 'zip', or
1152
- 'bzip' according to the archive format ('GZ', 'Z', 'ZIP',
1153
- or 'BZ2') given via -AF (-ArchiveFormat)
1154
-
1155
- Local file names are provided via -LF (-LocalFile). On the command line,
1156
- '*' and '?' wildcards are supported. Files not in the current directory must
1157
- include relative or absolute paths. If a directory is given via -LD
1158
- (-LocalDirectory), files are gathered recursively from that tree.
1210
+ -(RO|ResetOrder) - resets display order indices to match the order
1211
+ files are given per -SF. Alternatively, use -ON
1212
+ (-OrderNames) to reorder all files in the dataset
1213
+ and affected groups
1214
+ -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX
1215
+ Server and saves them to GDEXDB
1216
+ -(UZ|UnzipData) - decompresses files using 'gunzip', 'uncompress',
1217
+ 'unzip', or 'bunzip' according to the extension:
1218
+ '.gz', '.Z', '.zip', or '.bz2', respectively
1219
+ -(XC|CrossCopy) - copies files from existing Saved/Object storage
1220
+ to fill missing Object/Saved copies, using GDEXDB
1221
+ records for guidance
1222
+ -(XM|CrossMove) - moves files from existing Saved/Object storage
1223
+ to fill missing Object/Saved copies (originals
1224
+ are removed)
1225
+ -(ZD|ZipData) - compresses files using 'gzip', 'compress', 'zip',
1226
+ or 'bzip' according to the archive format ('GZ',
1227
+ 'Z', 'ZIP', or 'BZ2') given via -AF
1228
+ (-ArchiveFormat)
1229
+
1230
+ Local file names are provided via -LF (-LocalFile). On the command
1231
+ line, '*' and '?' wildcards are supported. Files not in the current
1232
+ directory must include relative or absolute paths. If a directory is
1233
+ given via -LD (-LocalDirectory), files are gathered recursively from
1234
+ that tree.
1159
1235
 
1160
1236
  Local file names are used as Saved file names by default unless -SF
1161
- (-SavedFile) is given explicitly. Files are archived under the dataset home
1162
- directory; use -SP (-SavedPath) or the path stored in GDEXDB to override.
1163
- When -KP (-KeepLocalPath) is specified, local file paths are used as-is on
1164
- the GDEX Server and -SP is not permitted.
1237
+ (-SavedFile) is given explicitly. Files are archived under the
1238
+ dataset home directory; use -SP (-SavedPath) or the path stored in
1239
+ GDEXDB to override. When -KP (-KeepLocalPath) is specified, local
1240
+ file paths are used as-is on the GDEX Server and -SP is not
1241
+ permitted.
1165
1242
 
1166
- Assign files to a group via -GI (-GroupIndex) or -GN (-GroupName). If no
1167
- group is specified, pattern matching against group patterns saved via -SG
1168
- is attempted when -PO (-PatternOffset) is present or the file is not yet in
1169
- GDEXDB. Unmatched files default to group index 0 (no group).
1243
+ Assign files to a group via -GI (-GroupIndex) or -GN (-GroupName). If
1244
+ no group is specified, pattern matching against group patterns saved
1245
+ via -SG is attempted when -PO (-PatternOffset) is present or the
1246
+ file is not yet in GDEXDB. Unmatched files default to group index 0
1247
+ (no group).
1170
1248
 
1171
- The number of values supplied to Info options must match the number of local
1172
- file names, except for options that accept a single shared value: -GI, -DF,
1173
- -AF, -ST (-SavedFileType), and -SP.
1249
+ The number of values supplied to Info options must match the number
1250
+ of local file names, except for options that accept a single shared
1251
+ value: -GI, -DF, -AF, -ST (-SavedFileType), and -SP.
1174
1252
 
1175
- The storage location is set via -LC (-Location). Defaults to 'G' (Glade
1176
- Disk only).
1253
+ The storage location is set via -LC (-Location). Defaults to 'G'
1254
+ (Glade Disk only).
1177
1255
 
1178
1256
  3.4.10 Archive Web Files
1179
- -AW or -ArchiveWebFile (Alias: -ArchiveWeb|-ArchWeb|-ArchWebFile), copies
1180
- local files to the GDEX Server as publicly accessible Web files and registers
1181
- them in GDEXDB. One or more files may be archived per execution.
1257
+ -AW or -ArchiveWebFile (Alias: -ArchiveWeb|-ArchWeb|-ArchWebFile),
1258
+ copies local files to the GDEX Server as publicly accessible Web
1259
+ files and registers them in GDEXDB. One or more files may be
1260
+ archived per execution.
1182
1261
 
1183
1262
  dsarch [-(DS|dataset)] dNNNNNN -(AW|ArchiveWebFile) [Mode Options]
1184
1263
  [-(LF|LocalFile) LocalFileNames] # mandatory unless -LD or -LL present
@@ -1207,68 +1286,78 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1207
1286
  [-(DD|DeleteDir) DeleteLocalDirLevel]
1208
1287
  [-(DB|Debug) DebugModeInfo]
1209
1288
 
1210
- Mode options that can be specified for this action:
1211
- -(BG|BackGround) - runs in background; suppresses screen output and errors
1212
- -(CL|CleanLocal) - removes local files after all are successfully archived
1213
- -(EM|EMailNotice) - sends an email summary (including any errors) when the
1214
- action completes or aborts
1215
- -(GX|GatherXML) - calls 'gatherxml' to evaluate file content metadata
1216
- directly from the local file
1217
- -(GZ|GMTZone) - uses GMT rather than local time for archiving timestamps
1218
- -(KP|KeepLocalPath) - uses local file paths as relative paths on the GDEX Server
1289
+ Available mode options:
1290
+ -(BG|BackGround) - runs in background; suppresses screen output and
1291
+ errors
1292
+ -(CL|CleanLocal) - removes local files after all are successfully
1293
+ archived
1294
+ -(EM|EMailNotice) - sends an email summary (including any errors)
1295
+ when the action completes or aborts
1296
+ -(GX|GatherXML) - calls 'gatherxml' to evaluate file content
1297
+ metadata directly from the local file
1298
+ -(GZ|GMTZone) - uses GMT rather than local time for archiving
1299
+ timestamps
1300
+ -(KP|KeepLocalPath) - uses local file paths as relative paths on the
1301
+ GDEX Server
1219
1302
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1220
1303
  regardless of dataset ownership
1221
1304
  -(NE|NoEmail) - suppresses email notification on failure
1222
1305
  -(NT|NoTrim) - skips trimming of spaces and comments from input
1223
1306
  values, speeding up input file processing
1224
1307
  -(OE|OverrideExist) - overwrites existing Web files
1225
- -(RO|ResetOrder) - resets display order indices to match the order files
1226
- are given per -WF. Alternatively, use -ON (-OrderNames)
1227
- to reorder all files in the dataset and affected groups
1228
- -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX Server and
1229
- saves them to GDEXDB
1230
- -(UZ|UnzipData) - decompresses files using 'gunzip', 'uncompress', 'unzip',
1231
- or 'bunzip' according to the extension: '.gz', '.Z',
1232
- '.zip', or '.bz2', respectively
1233
- -(XC|CrossCopy) - copies files from existing Web/Object storage to fill
1234
- missing Object/Web copies, using GDEXDB records for
1235
- guidance
1236
- -(XM|CrossMove) - moves files from existing Web/Object storage to fill
1237
- missing Object/Web copies (originals are removed)
1238
- -(ZD|ZipData) - compresses files using 'gzip', 'compress', 'zip', or
1239
- 'bzip' according to the archive format ('GZ', 'Z', 'ZIP',
1240
- or 'BZ2') given via -AF (-ArchiveFormat)
1241
-
1242
- Local file names are provided via -LF (-LocalFile). On the command line,
1243
- '*' and '?' wildcards are supported. Files not in the current directory must
1244
- include relative or absolute paths. If a directory is given via -LD
1245
- (-LocalDirectory), files are gathered recursively from that tree.
1246
-
1247
- Local file names are used as Web file names by default unless -WF (-WebFile)
1248
- is given explicitly. Files are archived under the dataset home directory;
1249
- use -WP (-WebPath) or the path stored in GDEXDB to override. When -KP
1250
- (-KeepLocalPath) is specified, local file paths are used as-is and -WP is
1251
- not permitted.
1252
-
1253
- Assign files to a group via -GI (-GroupIndex) or -GN (-GroupName). If no
1254
- group is specified, pattern matching against group patterns saved via -SG
1255
- is attempted when -PO (-PatternOffset) is present or the file is not yet in
1256
- GDEXDB. Unmatched files default to group index 0.
1257
-
1258
- Web files may be archived as P (public) or I (internal) for data types D or
1259
- N. Files assigned to an internal group are automatically set to I.
1260
-
1261
- The number of values supplied to Info options must match the number of local
1262
- file names, except for options that accept a single shared value: -GI, -DF,
1263
- -AF, -WT (-WebFileType), and -WP.
1264
-
1265
- The storage location is set via -LC (-Location). Defaults to 'G' (Glade
1266
- Disk only).
1308
+ -(RO|ResetOrder) - resets display order indices to match the order
1309
+ files are given per -WF. Alternatively, use -ON
1310
+ (-OrderNames) to reorder all files in the dataset
1311
+ and affected groups
1312
+ -(SC|SetChecksum) - computes MD5 checksums for files on the GDEX
1313
+ Server and saves them to GDEXDB
1314
+ -(UZ|UnzipData) - decompresses files using 'gunzip', 'uncompress',
1315
+ 'unzip', or 'bunzip' according to the extension:
1316
+ '.gz', '.Z', '.zip', or '.bz2', respectively
1317
+ -(XC|CrossCopy) - copies files from existing Web/Object storage to
1318
+ fill missing Object/Web copies, using GDEXDB
1319
+ records for guidance
1320
+ -(XM|CrossMove) - moves files from existing Web/Object storage to
1321
+ fill missing Object/Web copies (originals are
1322
+ removed)
1323
+ -(ZD|ZipData) - compresses files using 'gzip', 'compress', 'zip',
1324
+ or 'bzip' according to the archive format ('GZ',
1325
+ 'Z', 'ZIP', or 'BZ2') given via -AF
1326
+ (-ArchiveFormat)
1327
+
1328
+ Local file names are provided via -LF (-LocalFile). On the command
1329
+ line, '*' and '?' wildcards are supported. Files not in the current
1330
+ directory must include relative or absolute paths. If a directory is
1331
+ given via -LD (-LocalDirectory), files are gathered recursively from
1332
+ that tree.
1333
+
1334
+ Local file names are used as Web file names by default unless -WF
1335
+ (-WebFile) is given explicitly. Files are archived under the dataset
1336
+ home directory; use -WP (-WebPath) or the path stored in GDEXDB to
1337
+ override. When -KP (-KeepLocalPath) is specified, local file paths
1338
+ are used as-is and -WP is not permitted.
1339
+
1340
+ Assign files to a group via -GI (-GroupIndex) or -GN (-GroupName). If
1341
+ no group is specified, pattern matching against group patterns saved
1342
+ via -SG is attempted when -PO (-PatternOffset) is present or the
1343
+ file is not yet in GDEXDB. Unmatched files default to group index 0.
1344
+
1345
+ Web files may be archived as P (public) or I (internal) for data
1346
+ types D or N. Files assigned to an internal group are automatically
1347
+ set to I.
1348
+
1349
+ The number of values supplied to Info options must match the number
1350
+ of local file names, except for options that accept a single shared
1351
+ value: -GI, -DF, -AF, -WT (-WebFileType), and -WP.
1352
+
1353
+ The storage location is set via -LC (-Location). Defaults to 'G'
1354
+ (Glade Disk only).
1267
1355
 
1268
1356
  3.4.11 Archive Help Files
1269
1357
  -AH or -ArchiveHelpFile (Alias: -ArchiveHelp|-ArchHelp|-ArchHelpFile),
1270
- copies local files to the GDEX Server as Help files (Documents and Software)
1271
- and registers them in GDEXDB. One or more files may be archived per execution.
1358
+ copies local files to the GDEX Server as Help files (Documents and
1359
+ Software) and registers them in GDEXDB. One or more files may be
1360
+ archived per execution.
1272
1361
 
1273
1362
  dsarch [-(DS|dataset)] dNNNNNN -(AH|ArchiveHelpFile) [Mode Options]
1274
1363
  -(LF|LocalFile) LocalFileNames
@@ -1290,48 +1379,54 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1290
1379
  [-(DD|DeleteDir) DeleteLocalDirLevel]
1291
1380
  [-(DB|Debug) DebugModeInfo]
1292
1381
 
1293
- Mode options that can be specified for this action:
1294
- -(BG|BackGround) - runs in background; suppresses screen output and errors
1295
- -(CL|CleanLocal) - removes local files after all are successfully archived
1296
- -(EM|EMailNotice) - sends an email summary (including any errors) when the
1297
- action completes or aborts
1298
- -(GZ|GMTZone) - uses GMT rather than local time for archiving timestamps
1299
- -(KP|KeepLocalPath) - uses local file paths as relative paths on the GDEX Server
1382
+ Available mode options:
1383
+ -(BG|BackGround) - runs in background; suppresses screen output and
1384
+ errors
1385
+ -(CL|CleanLocal) - removes local files after all are successfully
1386
+ archived
1387
+ -(EM|EMailNotice) - sends an email summary (including any errors)
1388
+ when the action completes or aborts
1389
+ -(GZ|GMTZone) - uses GMT rather than local time for archiving
1390
+ timestamps
1391
+ -(KP|KeepLocalPath) - uses local file paths as relative paths on the
1392
+ GDEX Server
1300
1393
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1301
1394
  regardless of dataset ownership
1302
1395
  -(NE|NoEmail) - suppresses email notification on failure
1303
1396
  -(NT|NoTrim) - skips trimming of spaces and comments from input
1304
1397
  values, speeding up input file processing
1305
1398
  -(OE|OverrideExist) - overwrites existing Help files
1306
- -(RO|ResetOrder) - resets display order indices to match the order files
1307
- are given per -HF. Alternatively, use -ON (-OrderNames)
1308
- to reorder all files in the dataset and affected groups
1309
- -(SC|SetChecksum) - computes MD5 checksums for Help files and saves them
1310
- to GDEXDB
1399
+ -(RO|ResetOrder) - resets display order indices to match the order
1400
+ files are given per -HF. Alternatively, use -ON
1401
+ (-OrderNames) to reorder all files in the dataset
1402
+ and affected groups
1403
+ -(SC|SetChecksum) - computes MD5 checksums for Help files and saves
1404
+ them to GDEXDB
1311
1405
 
1312
- Local file names are provided via -LF (-LocalFile). On the command line,
1313
- '*' and '?' wildcards are supported. Files not in the current directory must
1314
- include relative or absolute paths. If a directory is given via -LD
1315
- (-LocalDirectory), files are gathered recursively.
1406
+ Local file names are provided via -LF (-LocalFile). On the command
1407
+ line, '*' and '?' wildcards are supported. Files not in the current
1408
+ directory must include relative or absolute paths. If a directory is
1409
+ given via -LD (-LocalDirectory), files are gathered recursively.
1316
1410
 
1317
- Local file names are used as Help file names by default unless -HF (-HelpFile)
1318
- is given explicitly. When -KP (-KeepLocalPath) is specified, local file paths
1319
- are used as-is on the GDEX Server.
1411
+ Local file names are used as Help file names by default unless -HF
1412
+ (-HelpFile) is given explicitly. When -KP (-KeepLocalPath) is
1413
+ specified, local file paths are used as-is on the GDEX Server.
1320
1414
 
1321
- The number of values supplied to Info options must match the number of local
1322
- file names, except for options that accept a single shared value: -DF, -AF,
1323
- and -HT (-HelpFileType).
1415
+ The number of values supplied to Info options must match the number
1416
+ of local file names, except for options that accept a single shared
1417
+ value: -DF, -AF, and -HT (-HelpFileType).
1324
1418
 
1325
- The storage location is set via -LC (-Location). Defaults to 'B' (both Web
1326
- Disk and Object Store).
1419
+ The storage location is set via -LC (-Location). Defaults to 'B'
1420
+ (both Web Disk and bOreas).
1327
1421
 
1328
1422
  3.4.12 Backup Quasar Files
1329
1423
  -AQ or -ArchiveQuasarFile (Alias: -ArchiveQuasar|-ArchiveBackupFile|-ArchiveBackup),
1330
- packages archived Saved and/or Web files into a single tar file and uploads it
1331
- to the Globus Quasar Server for long-term backup, recording the result in
1332
- GDEXDB. In practice, the companion utility 'dsquasar' handles identifying
1333
- files to back up, building optimally sized input lists (1-3 GB each), and
1334
- calling this action. See 'dsquasar' help for details.
1424
+ packages archived Saved and/or Web files into a single tar file and
1425
+ uploads it to the Globus Quasar Server for long-term backup,
1426
+ recording the result in GDEXDB. In practice, the companion utility
1427
+ 'dsquasar' handles identifying files to back up, building optimally
1428
+ sized input lists (1-3 GB each), and calling this action. See
1429
+ 'dsquasar' help for details.
1335
1430
 
1336
1431
  dsarch [-(DS|dataset)] dNNNNNN -(AQ|ArchiveQuasarFile) [Mode Options]
1337
1432
  [-(SF|SavedFile) SavedFileNames]
@@ -1343,30 +1438,33 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1343
1438
  [-(BP|BatchProcess) [BatchControlInfo]]
1344
1439
  [-(DB|Debug) DebugModeInfo]
1345
1440
 
1346
- Mode options that can be specified for this action:
1347
- -(BG|BackGround) - runs in background; suppresses screen output and errors
1348
- -(EM|EMailNotice) - sends an email summary (including any errors) when the
1349
- action completes or aborts
1441
+ Available mode options:
1442
+ -(BG|BackGround) - runs in background; suppresses screen output and
1443
+ errors
1444
+ -(EM|EMailNotice) - sends an email summary (including any errors)
1445
+ when the action completes or aborts
1350
1446
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1351
1447
  regardless of dataset ownership
1352
1448
  -(NE|NoEmail) - suppresses email notification on failure
1353
1449
  -(NT|NoTrim) - skips trimming of spaces and comments from input
1354
1450
  values, speeding up input file processing
1355
1451
  -(OE|OverrideExist) - overwrites existing Quasar files
1356
- -(TO|TarOnly) - creates the tar file only, without uploading it to the
1357
- Globus Quasar Server
1358
- -(XC|CrossCopy) - copies files from existing Quasar Backup and Disaster
1359
- Recovery files to fill missing Backup/Drdata copies,
1360
- using GDEXDB records for guidance
1452
+ -(TO|TarOnly) - creates the tar file only, without uploading it
1453
+ to the Globus Quasar Server
1454
+ -(XC|CrossCopy) - copies files from existing Quasar Backup and
1455
+ Disaster Recovery files to fill missing
1456
+ Backup/Drdata copies, using GDEXDB records for
1457
+ guidance
1361
1458
 
1362
- At least one Saved and/or Web file name must be provided via -SF and/or -WF.
1459
+ At least one Saved and/or Web file name must be provided via -SF
1460
+ and/or -WF.
1363
1461
 
1364
1462
 
1365
1463
  3.4.13 Restore Quasar Files
1366
1464
  -RQ or -RestoreQuasarFile (Alias: -RestoreQuasar|-RestoreBackupFile|-RestoreBackup),
1367
- finds the Quasar tar files that contain the specified Saved and/or Web files,
1368
- downloads them from the Globus Quasar Server, and restores any files that
1369
- are missing from the GDEX Server.
1465
+ finds the Quasar tar files containing the specified Saved and/or Web
1466
+ files, downloads them from the Globus Quasar Server, and restores
1467
+ any files missing from the GDEX Server.
1370
1468
 
1371
1469
  dsarch [-(DS|dataset)] dNNNNNN -(RQ|RestoreQuasarFile) [Mode Options]
1372
1470
  [-(QF|QuasarFile) QuasarFileNames]
@@ -1379,30 +1477,33 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1379
1477
  [-(BP|BatchProcess) [BatchControlInfo]]
1380
1478
  [-(DB|Debug) DebugModeInfo]
1381
1479
 
1382
- Mode options that can be specified for this action:
1383
- -(BG|BackGround) - runs in background; suppresses screen output and errors
1384
- -(EM|EMailNotice) - sends an email summary (including any errors) when the
1385
- action completes or aborts
1480
+ Available mode options:
1481
+ -(BG|BackGround) - runs in background; suppresses screen output and
1482
+ errors
1483
+ -(EM|EMailNotice) - sends an email summary (including any errors)
1484
+ when the action completes or aborts
1386
1485
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1387
1486
  regardless of dataset ownership
1388
1487
  -(NE|NoEmail) - suppresses email notification on failure
1389
1488
  -(NT|NoTrim) - skips trimming of spaces and comments from input
1390
1489
  values, speeding up input file processing
1391
1490
 
1392
- At least one Quasar, Saved, and/or Web file name must be provided via -QF,
1393
- -SF, and/or -WF. If only Quasar file names are given, the tar files are
1394
- retrieved from the server but no Saved or Web files are restored.
1491
+ At least one Quasar, Saved, and/or Web file name must be provided via
1492
+ -QF, -SF, and/or -WF. If only Quasar file names are given, the tar
1493
+ files are retrieved from the server but no Saved or Web files are
1494
+ restored.
1395
1495
 
1396
1496
 
1397
1497
  3.4.14 Move Saved/Web/Help/Quasar Files
1398
- -MV or -MoveFile, relocates archived files — across datasets, between groups,
1399
- or to a new name. One or more files may be moved per execution.
1498
+ -MV or -MoveFile, relocates archived files — across datasets,
1499
+ between groups, or to a new name. One or more files may be moved per
1500
+ execution.
1400
1501
 
1401
- When a file's name or path changes, 'dsarch' keeps the original name in GDEXDB
1402
- as a linked alias pointing to the new name.
1502
+ When a file's name or path changes, 'dsarch' retains the original
1503
+ name in GDEXDB as a linked alias pointing to the new name.
1403
1504
 
1404
- Files can also be converted between types (Web to Saved or Saved to Web)
1405
- using -TS (-ToSaved) or -TW (-ToWeb).
1505
+ Files can also be converted between types (Web to Saved or Saved to
1506
+ Web) using -TS (-ToSaved) or -TW (-ToWeb).
1406
1507
 
1407
1508
  dsarch [-(DS|Dataset)] dNNNNNN -(MV|MoveFile) [Mode Options]
1408
1509
  [-(OD|OriginDataset) OriginalDataset]
@@ -1471,32 +1572,33 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1471
1572
  [-(LN|LoginName) LoginAccountName]
1472
1573
  [-(DB|Debug) DebugModeInfo]
1473
1574
 
1474
- Mode options that can be specified for this action:
1475
- -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1476
- regardless of dataset ownership
1575
+ Available mode options:
1576
+ -(MD|MyDataset) - allows any specialist to set GDEXDB
1577
+ information, regardless of dataset ownership
1477
1578
  -(NT|NoTrim) - skips trimming of spaces and comments from input
1478
1579
  values, speeding up input file processing
1479
1580
  -(NE|NoEmail) - suppresses email notification on failure
1480
1581
  -(TS|ToSaved) - moves Web files to Saved files
1481
1582
  -(TW|ToWeb) - moves Saved files to Web files
1482
- -(KM|KeepMetadata) - used with -TW to retain the metadata record after the
1483
- Web file is moved to a Saved file
1583
+ -(KM|KeepMetadata) - used with -TW to retain the metadata record
1584
+ after the Web file is moved to a Saved file
1484
1585
 
1485
1586
  Provide the file names to move via -SF, -WF, -HF, or -QF. Files are
1486
- physically moved only when the new path differs from the original. Dataset
1487
- links are updated to the new dataset number, and group indices are updated
1488
- if -GI (-GroupIndex) is specified.
1587
+ physically moved only when the new path differs from the original.
1588
+ Dataset links are updated to the new dataset number, and group
1589
+ indices are updated if -GI (-GroupIndex) is specified.
1489
1590
 
1490
- If content metadata exists for the original Web file, it is automatically
1491
- transferred to the new file name via 'rcm'.
1591
+ If content metadata exists for the original Web file, it is
1592
+ automatically transferred to the new file name via 'rcm'.
1492
1593
 
1493
- If a DOI/Version-controlled Web file is renamed or converted to a Saved
1494
- file, its type is automatically set to 'V' (Version-controlled).
1594
+ If a DOI/Version-controlled Web file is renamed or converted to a
1595
+ Saved file, its type is automatically set to 'V' (Version-controlled).
1495
1596
 
1496
1597
 
1497
1598
  3.4.15 Delete Saved/Web/Help/Quasar Files
1498
- -DL or -Delete (Alias: -RM|-Remove|-DeleteFile|-RemoveFile), permanently
1499
- removes files from GDEX Servers and deletes their records from GDEXDB.
1599
+ -DL or -Delete (Alias: -RM|-Remove|-DeleteFile|-RemoveFile),
1600
+ permanently removes files from GDEX Servers and deletes their
1601
+ records from GDEXDB.
1500
1602
 
1501
1603
  dsarch [-(DS|Dataset)] dNNNNNN -(DL|Delete) [Mode Options]
1502
1604
  [-(SF|SavedFile) SavedFileNames]
@@ -1534,92 +1636,98 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1534
1636
  [-(LN|LoginName) LoginAccountName]
1535
1637
  [-(DB|Debug) DebugModeInfo]
1536
1638
 
1537
- Mode options that can be specified for this action:
1538
- -(DX|DeleteXML) - calls 'dcm' to delete content metadata for the Web files
1539
- being deleted
1540
- -(EM|EMailNotice) - sends an email summary (including any errors) when the
1541
- action completes or aborts
1639
+ Available mode options:
1640
+ -(DX|DeleteXML) - calls 'dcm' to delete content metadata for the
1641
+ Web files being deleted
1642
+ -(EM|EMailNotice) - sends an email summary (including any errors)
1643
+ when the action completes or aborts
1542
1644
  -(MD|MyDataset) - allows any specialist to set GDEXDB information,
1543
1645
  regardless of dataset ownership
1544
1646
  -(NE|NoEmail) - suppresses email notification on failure
1545
- -(NT|NoTrim) - skips trimming of spaces and comments from input values,
1546
- speeding up input file processing
1547
- -(RD|RemoveDir) - removes empty Saved or Web directories after deletion
1647
+ -(NT|NoTrim) - skips trimming of spaces and comments from input
1648
+ values, speeding up input file processing
1649
+ -(RD|RemoveDir) - removes empty Saved or Web directories after
1650
+ deletion
1548
1651
 
1549
1652
  Provide the file names to delete via -SF, -WF, -HF, or -QF. Use -DD
1550
- (-DeleteDir) to specify how many levels of empty parent directories to
1551
- remove after deletion.
1653
+ (-DeleteDir) to specify how many levels of empty parent directories
1654
+ to remove after deletion.
1552
1655
 
1553
1656
 
1554
1657
  3.5 All Info Actions
1555
1658
 
1556
- These two actions work across all record types at once, making it easy to
1557
- snapshot or bulk-update a dataset:
1558
- Get All Information - export all dataset, group, and file records to a file
1559
- Set All Information - import and apply changes to all record types at once
1659
+ These two actions work across all record types at once, making it
1660
+ easy to snapshot or bulk-update a dataset:
1661
+ Get All Information - export all dataset, group, and file records to
1662
+ a file
1663
+ Set All Information - import and apply changes to all record types
1664
+ at once
1560
1665
 
1561
1666
  3.5.1 Get All Information
1562
- -GA or -GetAll, exports all dataset, group, and Saved/Web/Help/Quasar file
1563
- records for a dataset in one step. Equivalent to running -GD, -GG, -GS, -GW,
1564
- -GH, and -GQ together.
1667
+ -GA or -GetAll, exports all dataset, group, and Saved/Web/Help/Quasar
1668
+ file records for a dataset in one step. Equivalent to running -GD,
1669
+ -GG, -GS, -GW, -GH, and -GQ together.
1565
1670
 
1566
1671
  dsarch [-(DS|dataset)] dNNNNNN -(GA|GetAll)
1567
1672
  [-(OF|OutputFile) OutputFileName]
1568
1673
  [-(DB|Debug) DebugModeInfo]
1569
1674
 
1570
- No Mode options apply to this action; all available fields are retrieved
1571
- for every record type.
1675
+ No Mode options apply to this action; all available fields are
1676
+ retrieved for every record type.
1572
1677
 
1573
- Output is organized under [DATASET], [DSGROUP], [SAVEDFILE], [WEBFILE],
1574
- [HELPFILE], and [QUASARFILE] sections.
1678
+ Output is organized under [DATASET], [DSGROUP], [SAVEDFILE],
1679
+ [WEBFILE], [HELPFILE], and [QUASARFILE] sections.
1575
1680
 
1576
- Use -OF (-OutputFile) to write results to a file; without it, results print
1577
- to screen. The output file can be edited and fed back to -SA (-SetAll) to
1578
- apply changes in bulk.
1681
+ Use -OF (-OutputFile) to write results to a file; without it,
1682
+ results print to screen. The output file can be edited and fed back
1683
+ to -SA (-SetAll) to apply changes in bulk.
1579
1684
 
1580
1685
  3.5.2 Set All Information
1581
1686
  -SA or -SetAll, creates and updates all dataset, group, and
1582
- Saved/Web/Help/Quasar file records for a dataset in one step. Equivalent to
1583
- running -SD, -SG, -SS, -SW, -SH, and -SQ together.
1687
+ Saved/Web/Help/Quasar file records for a dataset in one step.
1688
+ Equivalent to running -SD, -SG, -SS, -SW, -SH, and -SQ together.
1584
1689
 
1585
1690
  dsarch [-(DS|Dataset)] dNNNNNN -(SA|SetAll) [Mode Options]
1586
1691
  -(IF|InputFile) Input Files
1587
1692
  [-(LN|LoginName) LoginAccountName]
1588
1693
  [-(DB|Debug) DebugModeInfo]
1589
1694
 
1590
- All Mode options applicable to the individual Set actions may be used with
1591
- -SA. At least one input file is required, since section headers can only be
1592
- specified in an input file. A typical workflow: run -GA (-GetAll) to export
1593
- all records, edit the output file as needed, then feed it back with -SA.
1695
+ All Mode options applicable to the individual Set actions may be
1696
+ used with -SA. At least one input file is required, since section
1697
+ headers can only be specified in an input file. A typical workflow:
1698
+ run -GA (-GetAll) to export all records, edit the output file as
1699
+ needed, then feed it back with -SA.
1594
1700
 
1595
1701
 
1596
1702
  3.6 Webpage Actions
1597
1703
 
1598
- After updating GDEXDB records, use these actions to refresh the corresponding
1599
- web pages:
1600
- Regenerate Dataset Webpages - rebuild the main webpage and all file lists
1601
- for the dataset
1602
- Increment Cache Number - bump the cache control number to signal that
1603
- cached file lists should be reloaded
1704
+ After updating GDEXDB records, use these actions to refresh the
1705
+ corresponding web pages:
1706
+ Regenerate Dataset Webpages - rebuild the main webpage and all file
1707
+ lists for the dataset
1708
+ Increment Cache Number - bump the cache control number to
1709
+ signal that cached file lists should
1710
+ be reloaded
1604
1711
 
1605
1712
  3.6.1 Regenerate Dataset Webpages
1606
- -UW or -UpdateWeb, rebuilds the main and filelist webpages for the specified
1607
- dataset so they reflect the current state of GDEXDB.
1713
+ -UW or -UpdateWeb, rebuilds the main and filelist webpages for the
1714
+ specified dataset to reflect the current state of GDEXDB.
1608
1715
 
1609
1716
  dsarch [-(DS|Dataset)] dNNNNNN -(UW|UpdateWeb)
1610
1717
  [-(DB|Debug) DebugModeInfo]
1611
1718
 
1612
1719
  Provide the dataset number to regenerate its web pages.
1613
1720
 
1614
- 'dsarch' automatically bumps a dataset's cache control number whenever it
1615
- writes to GDEXDB, prompting the webpage utility to reload stale cache.
1616
- Changes made through other utilities may not trigger this; use -UC
1617
- (-UpdateCache) to increment the number manually when needed.
1721
+ 'dsarch' automatically bumps a dataset's cache control number
1722
+ whenever it writes to GDEXDB, prompting the webpage utility to
1723
+ reload stale cache. Changes made through other utilities may not
1724
+ trigger this; use -UC (-UpdateCache) to increment the number
1725
+ manually when needed.
1618
1726
 
1619
1727
  3.6.2 Increment Cache Number
1620
- -UC or -UpdateCache (Alias: -UpdateCacheNumber), increments the cache control
1621
- number by 1 for the specified dataset, signalling that cached web content
1622
- should be refreshed.
1728
+ -UC or -UpdateCache (Alias: -UpdateCacheNumber), increments the
1729
+ cache control number by 1 for the specified dataset, signalling that
1730
+ cached web content should be refreshed.
1623
1731
 
1624
1732
  dsarch [-(DS|Dataset)] dNNNNNN -(UC|UpdateCache)
1625
1733
  [-(DB|Debug) DebugModeInfo]
@@ -1627,142 +1735,162 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
1627
1735
 
1628
1736
  4 MODE OPTIONS
1629
1737
 
1630
- Mode options adjust how an Action option behaves. They are all optional and
1631
- take no values — simply include the flag to activate the behavior.
1738
+ Mode options adjust how an Action option behaves. They are all
1739
+ optional and take no values — simply include the flag to activate the
1740
+ behavior.
1632
1741
 
1633
- -BG or -BackGround (Alias: -b), runs the action as a background process,
1634
- suppressing all screen output and error messages.
1742
+ -BG or -BackGround (Alias: -b), runs the action as a background
1743
+ process, suppressing all screen output and error messages.
1635
1744
 
1636
- -CL or -CleanLocal (Alias: -CleanLocfile|-CleanLocalFile), deletes local
1637
- source files once all have been successfully archived by -AS or -AW. Pair
1638
- with -DD (-DeleteDir) to also clean up any empty local directories.
1745
+ -CL or -CleanLocal (Alias: -CleanLocfile|-CleanLocalFile), deletes
1746
+ local source files once all have been successfully archived by -AS
1747
+ or -AW. Pair with -DD (-DeleteDir) to also clean up any empty local
1748
+ directories.
1639
1749
 
1640
- -DX or -DeleteXML, calls 'dcm' to delete content metadata for the specified
1641
- Web files. With -SW (-SetWebFile), it explicitly removes metadata; with -DL
1642
- (-Delete) when Web files are specified, this happens automatically.
1750
+ -DX or -DeleteXML, calls 'dcm' to delete content metadata for the
1751
+ specified Web files. With -SW (-SetWebFile), it explicitly removes
1752
+ metadata; with -DL (-Delete) when Web files are specified, this
1753
+ happens automatically.
1643
1754
 
1644
- -EM or -EMailNotice, sends the executing specialist an email when an action
1645
- finishes or fails. Applies to -AS, -AW, -AH, -AQ, -SS, -SW, -SH, -SQ, -RQ,
1646
- -MV, and -DL. The email includes a brief summary and any errors encountered.
1647
- Ignored when -d (-BP) is present.
1755
+ -EM or -EMailNotice, sends the executing specialist an email when
1756
+ an action finishes or fails. Applies to -AS, -AW, -AH, -AQ, -SS,
1757
+ -SW, -SH, -SQ, -RQ, -MV, and -DL. The email includes a brief
1758
+ summary and any errors encountered. Ignored when -d (-BP) is
1759
+ present.
1648
1760
 
1649
- Tip: when archiving many files, consolidate them into a single input file
1650
- and include -EM once — only one email is sent regardless of file count.
1761
+ Tip: when archiving many files, consolidate them into a single
1762
+ input file and include -EM once — only one email is sent regardless
1763
+ of file count.
1651
1764
 
1652
- -FO or -FormatOutput, aligns GET action output into fixed-width columns,
1653
- making results easier to read at a glance.
1765
+ -FO or -FormatOutput, aligns GET action output into fixed-width
1766
+ columns, making results easier to read at a glance.
1654
1767
 
1655
- -GF or -GrowingFile, lifts the DOI/Version control lock on Web files so
1656
- that -AW (-ArchiveWebFile) can overwrite them. Use this when a file is
1657
- actively being appended to and must be updated in place. When 'dsupdt'
1658
- drives -AW, growing files are detected and handled automatically.
1768
+ -GF or -GrowingFile, lifts the DOI/Version control lock on Web
1769
+ files so that -AW (-ArchiveWebFile) can overwrite them. Use this
1770
+ when a file is actively being appended to and must be updated in
1771
+ place. When 'dsupdt' drives -AW, growing files are detected and
1772
+ handled automatically.
1659
1773
 
1660
- -GX or -GatherXML (Alias: -Grid2XML), calls 'gatherxml' to extract and
1661
- record content metadata for archived Web files. For -MV (-MoveFile), metadata
1662
- is transferred to the new file name automatically via 'rcm' — -GX is not
1663
- needed for moves.
1774
+ -GX or -GatherXML (Alias: -Grid2XML), calls 'gatherxml' to extract
1775
+ and record content metadata for archived Web files. For -MV
1776
+ (-MoveFile), metadata is transferred to the new file name
1777
+ automatically via 'rcm' — -GX is not needed for moves.
1664
1778
 
1665
- -GZ or -GMTZone (Alias: -GMT|-GreenwichZone|-UTC), records archiving
1666
- timestamps in GMT instead of local time.
1779
+ -GZ or -GMTZone (Alias: -GMT|-GreenwichZone|-UTC), records
1780
+ archiving timestamps in GMT instead of local time.
1667
1781
 
1668
- -KM or -KeepMetadata (Alias: -KeepMeta), preserves the content metadata
1669
- record when a Web file is converted to a Saved file via -MV with -TS.
1782
+ -KM or -KeepMetadata (Alias: -KeepMeta), preserves the content
1783
+ metadata record when a Web file is converted to a Saved file via
1784
+ -MV with -TS.
1670
1785
 
1671
- -KP or -KeepPath (Alias: -KeepLocalPath), preserves local file paths as-is
1672
- on the GDEX Server during -AS, -AW, and -AH. When -KP is active, -SP and -WP
1673
- are ignored. -KP is also ignored when destination file names are provided
1674
- explicitly via -SF, -WF, or -HF.
1786
+ -KP or -KeepPath (Alias: -KeepLocalPath), preserves local file
1787
+ paths as-is on the GDEX Server during -AS, -AW, and -AH. When -KP
1788
+ is active, -SP and -WP are ignored. -KP is also ignored when
1789
+ destination file names are provided explicitly via -SF, -WF, or
1790
+ -HF.
1675
1791
 
1676
- -MD or -MyDataset, bypasses the dataset ownership check, allowing any
1677
- specialist to modify records in GDEXDB for any dataset.
1792
+ -MD or -MyDataset, bypasses the dataset ownership check, allowing
1793
+ any specialist to modify records in GDEXDB for any dataset.
1678
1794
 
1679
- -NE or -NoEmail, suppresses the automatic failure email notification.
1795
+ -NE or -NoEmail, suppresses the automatic failure email
1796
+ notification.
1680
1797
 
1681
- -NT or -NoTrim, skips stripping leading/trailing spaces and inline comments
1682
- from input values. Use this to speed up processing of large input files.
1798
+ -NT or -NoTrim, skips stripping leading/trailing spaces and inline
1799
+ comments from input values. Use this to speed up processing of
1800
+ large input files.
1683
1801
 
1684
- -NV or -NewVersion, required to create a new DOI/Version control record
1685
- when using -SV (-SetVersion).
1802
+ -NV or -NewVersion, required to create a new DOI/Version control
1803
+ record when using -SV (-SetVersion).
1686
1804
 
1687
- -OE or -OverrideExist, allows an existing file on the GDEX Server to be
1688
- overwritten at the target path. Without this flag, archiving fails if the
1689
- destination already exists.
1805
+ -OE or -OverrideExist, allows an existing file on the GDEX Server
1806
+ to be overwritten at the target path. Without this flag, archiving
1807
+ fails if the destination already exists.
1690
1808
 
1691
- -PE or -ShowPeriod, adds data period information (begin/end dates and times)
1692
- for the dataset and any specified groups to the output of -GD (-GetDataset).
1809
+ -PE or -ShowPeriod, adds data period information (begin/end dates
1810
+ and times) for the dataset and any specified groups to the output
1811
+ of -GD (-GetDataset).
1693
1812
 
1694
- -RA or -RetryArchive, deprecated; has no effect and may be removed in a
1695
- future version.
1813
+ -RA or -RetryArchive, deprecated; has no effect and may be removed
1814
+ in a future version.
1696
1815
 
1697
- -RD or -RemoveDir (Alias: -RemoveDirectory|-RemoveEmptyDir), removes any
1698
- directories that become empty after file changes from -DL, -SS, or -SW.
1816
+ -RD or -RemoveDir (Alias: -RemoveDirectory|-RemoveEmptyDir),
1817
+ removes any directories that become empty after file changes from
1818
+ -DL, -SS, or -SW.
1699
1819
 
1700
- To clean up empty directories without modifying files, run -SS or -SW with
1701
- -RD and no file names; 'dsarch' will prune empty Web or Saved directories
1702
- for the specified dataset and groups.
1820
+ To clean up empty directories without modifying files, run -SS or
1821
+ -SW with -RD and no file names; 'dsarch' will prune empty Web or
1822
+ Saved directories for the specified dataset and groups.
1703
1823
 
1704
- -RG or -RecursiveGroup (Alias: -RepeatGroup), descends into subgroups
1705
- recursively when used with -GG, -GS, or -GW, gathering all nested records.
1706
- A group index must be provided via -GI for this to take effect.
1824
+ -RG or -RecursiveGroup (Alias: -RepeatGroup), descends into
1825
+ subgroups recursively when used with -GG, -GS, or -GW, gathering
1826
+ all nested records. A group index must be provided via -GI for
1827
+ this to take effect.
1707
1828
 
1708
- -RN or -RelativeName, returns file names as relative paths (relative to the
1709
- dataset or group's Saved or Web path) in the output of -GS and -GW.
1829
+ -RN or -RelativeName, returns file names as relative paths
1830
+ (relative to the dataset or group's Saved or Web path) in the
1831
+ output of -GS and -GW.
1710
1832
 
1711
- -RO or -ResetOrder (Alias: -Reorder), sets display order indices to match
1712
- the order files are listed when passed to -SS, -SW, -SH, or -SQ. To set
1713
- explicit indices instead, use -DO (-DisplayOrder).
1833
+ -RO or -ResetOrder (Alias: -Reorder), sets display order indices
1834
+ to match the order files are listed when passed to -SS, -SW, -SH,
1835
+ or -SQ. To set explicit indices instead, use -DO (-DisplayOrder).
1714
1836
 
1715
- For sorting files by field values across an entire dataset or individual
1716
- groups, use -ON (-OrderNames).
1837
+ For sorting files by field values across an entire dataset or
1838
+ individual groups, use -ON (-OrderNames).
1717
1839
 
1718
- -RS or -GXRSOptions, passes the R and S flags to 'gatherxml' to speed up
1719
- metadata evaluation. Use alongside -GX (-GatherXML).
1840
+ -RS or -GXRSOptions, passes the R and S flags to 'gatherxml' to
1841
+ speed up metadata evaluation. Use alongside -GX (-GatherXML).
1720
1842
 
1721
- -RT or -ResetTIndex (Alias: -ResetTopGroup), recalculates and resets the
1722
- top-level group index stored in Saved or Web file records for the dataset
1723
- and any specified groups.
1843
+ -RT or -ResetTIndex (Alias: -ResetTopGroup), recalculates and
1844
+ resets the top-level group index stored in Saved or Web file
1845
+ records for the dataset and any specified groups.
1724
1846
 
1725
- -SC or -SetChecksum, calculates MD5 checksums for data files on the GDEX
1726
- Server and stores them in GDEXDB for integrity verification.
1847
+ -SC or -SetChecksum, calculates MD5 checksums for data files on
1848
+ the GDEX Server and stores them in GDEXDB for integrity
1849
+ verification.
1727
1850
 
1728
- -TO or -TarOnly, builds the Quasar tar file locally without uploading it
1729
- to the Globus Quasar Server. Useful for testing. Used with -AQ.
1851
+ -TO or -TarOnly, builds the Quasar tar file locally without
1852
+ uploading it to the Globus Quasar Server. Useful for testing. Used
1853
+ with -AQ.
1730
1854
 
1731
- -TS or -ToSaved (Alias: -ToSavedFile|-MoveToSaved), used with -MV (-MoveFile)
1732
- to move Web files to Saved files.
1855
+ -TS or -ToSaved (Alias: -ToSavedFile|-MoveToSaved), used with -MV
1856
+ (-MoveFile) to move Web files to Saved files.
1733
1857
 
1734
- -TT or -TotalSummary, appends file count and size totals to the output
1735
- of -GS (-GetSavedFile) and -GW (-GetWebFile).
1858
+ -TT or -TotalSummary, appends file count and size totals to the
1859
+ output of -GS (-GetSavedFile) and -GW (-GetWebFile).
1736
1860
 
1737
- -TW or -ToWeb (Alias: -ToWebFile|-MoveToWeb), used with -MV (-MoveFile)
1738
- to move Saved files to Web files.
1861
+ -TW or -ToWeb (Alias: -ToWebFile|-MoveToWeb), used with -MV
1862
+ (-MoveFile) to move Saved files to Web files.
1739
1863
 
1740
- -UZ or -UnzipData (Alias: -Unzip|-UncompressData), decompresses files during
1741
- archiving. The tool is selected by extension: 'gunzip' for '.gz', 'uncompress'
1742
- for '.Z', 'unzip' for '.zip', and 'bunzip' for '.bz2'.
1864
+ -UZ or -UnzipData (Alias: -Unzip|-UncompressData), decompresses
1865
+ files during archiving. The tool is selected by extension:
1866
+ 'gunzip' for '.gz', 'uncompress' for '.Z', 'unzip' for '.zip', and
1867
+ 'bunzip' for '.bz2'.
1743
1868
 
1744
- -WC or -WithChecksum, adds MD5 checksum verification on top of size checks
1745
- when validating data files on the GDEX Server.
1869
+ -WC or -WithChecksum, adds MD5 checksum verification on top of
1870
+ size checks when validating data files on the GDEX Server.
1746
1871
 
1747
- -WM or -WithMetadata, triggers a fresh 'gatherxml' run at the dataset or
1748
- group level when used with -SD (-SetDataset) or -SG (-SetGroup).
1872
+ -WM or -WithMetadata, triggers a fresh 'gatherxml' run at the
1873
+ dataset or group level when used with -SD (-SetDataset) or -SG
1874
+ (-SetGroup).
1749
1875
 
1750
- -WN or -WithFileNumber, recomputes and updates Saved/Web file counts for the
1751
- dataset and any specified groups. With -GD (-GetDataset), the counts are
1752
- calculated on the fly and included in the output.
1876
+ -WN or -WithFileNumber, recomputes and updates Saved/Web file
1877
+ counts for the dataset and any specified groups. With -GD
1878
+ (-GetDataset), the counts are calculated on the fly and included
1879
+ in the output.
1753
1880
 
1754
- -XC or -CrossCopy, used with -AW or -AS to fill gaps in storage: copies
1755
- files from Glade disk to Object Store (or vice versa) wherever copies are
1756
- missing.
1881
+ -XC or -CrossCopy, used with -AW or -AS to fill gaps in storage:
1882
+ copies files from Glade disk to bOreas (or vice versa) wherever
1883
+ copies are missing.
1757
1884
 
1758
- -XM or -CrossMove, like -XC but moves instead of copying — the original
1759
- file is deleted once the destination copy is confirmed.
1885
+ -XM or -CrossMove, like -XC but moves instead of copying — the
1886
+ original file is deleted once the destination copy is confirmed.
1760
1887
 
1761
- -ZD or -ZipData (Alias: -Zip|-CompressData), compresses files during -AS or
1762
- -AW. The compression tool is selected by the format given via -AF: 'gzip' for
1763
- 'GZ', 'compress' for 'Z', 'zip' for 'ZIP', 'bzip' for 'BZ2'. Files already
1764
- in the target format are skipped. Files compressed in a different format are
1765
- decompressed first (using the tool matched by extension: '.gz', '.Z', '.zip',
1888
+ -ZD or -ZipData (Alias: -Zip|-CompressData), compresses files
1889
+ during -AS or -AW. The compression tool is selected by the format
1890
+ given via -AF: 'gzip' for 'GZ', 'compress' for 'Z', 'zip' for
1891
+ 'ZIP', 'bzip' for 'BZ2'. Files already in the target format are
1892
+ skipped. Files compressed in a different format are decompressed
1893
+ first (using the tool matched by extension: '.gz', '.Z', '.zip',
1766
1894
  or '.bz2') before being recompressed into the target format.
1767
1895
 
1768
1896
 
@@ -1775,104 +1903,116 @@ They come in two forms:
1775
1903
 
1776
1904
  5.1 Single-Value Info Options
1777
1905
 
1778
- A single-value Info option accepts exactly one value. Providing no value or
1779
- more than one causes an error.
1906
+ A single-value Info option accepts exactly one value. Providing no
1907
+ value or more than one causes an error.
1780
1908
 
1781
1909
  -AL or -AsyncLimit (Alias: -AsynchronousLimit), caps the number of
1782
- simultaneous background processes spawned for 'cp' and 'gatherxml' calls.
1783
- Has no effect when running as a PBS batch job.
1910
+ simultaneous background processes spawned for 'cp' and 'gatherxml'
1911
+ calls. Has no effect when running as a PBS batch job.
1784
1912
 
1785
- -AO or -ActOption (Alias: -ActionOption), the token that marks Action and
1786
- Mode options in input files. Defaults to '<!>'. Change this if your input
1787
- data contains the default token.
1913
+ -AO or -ActOption (Alias: -ActionOption), the token that marks
1914
+ Action and Mode options in input files. Defaults to '<!>'. Change
1915
+ this if your input data contains the default token.
1788
1916
 
1789
- -BL or -ButtonLimit, the minimum file count at which download script buttons
1790
- appear on file list web pages. Defaults to 2.
1917
+ -BL or -ButtonLimit, the minimum file count at which download
1918
+ script buttons appear on file list web pages. Defaults to 2.
1791
1919
 
1792
- -DD or -DeleteDir (Alias: -DeleteDirLevel|-DeleteEmptyDir), how many levels
1793
- of empty parent directories to prune after files are deleted or moved.
1794
- Applies to -DL, -MV, and -CL (when used with -AS or -AW).
1920
+ -DD or -DeleteDir (Alias: -DeleteDirLevel|-DeleteEmptyDir), how
1921
+ many levels of empty parent directories to prune after files are
1922
+ deleted or moved. Applies to -DL, -MV, and -CL (when used with -AS
1923
+ or -AW).
1795
1924
 
1796
- -DS or -Dataset, the target dataset ID (format: [a-z]NNNNNN). Required
1797
- by almost all actions.
1925
+ -DS or -Dataset, the target dataset ID (format: [a-z]NNNNNN).
1926
+ Required by almost all actions.
1798
1927
 
1799
- -DV or -Divider (Alias: -Delimiter|-Separator), the column separator used
1800
- for multi-value Info options in input files. Defaults to '<:>'.
1928
+ -DV or -Divider (Alias: -Delimiter|-Separator), the column
1929
+ separator used for multi-value Info options in input files.
1930
+ Defaults to '<:>'.
1801
1931
 
1802
- -ES or -EqualSign, the token used to assign a value to an option in input
1803
- files (e.g., 'Dataset<=>d123456'). Defaults to '<=>'.
1932
+ -ES or -EqualSign, the token used to assign a value to an option
1933
+ in input files (e.g., 'Dataset<=>d123456'). Defaults to '<=>'.
1804
1934
 
1805
- -FL or -FileLimit (Alias: -FilecountLimit), the file count threshold for
1806
- static file list pages. Groups whose combined count falls below this limit
1807
- are shown together on one page; a group whose count exceeds it is split
1808
- across multiple sub-pages. Defaults to 2000.
1935
+ -FL or -FileLimit (Alias: -FilecountLimit), the file count
1936
+ threshold for static file list pages. Groups whose combined count
1937
+ falls below this limit are shown together on one page; a group
1938
+ whose count exceeds it is split across multiple sub-pages. Defaults
1939
+ to 2000.
1809
1940
 
1810
- -FN or -FieldNames, a compact string of single-letter codes that selects
1811
- which fields to include in GET action output. Default codes are listed in
1812
- each action's section; use ALL to retrieve every available field.
1941
+ -FN or -FieldNames, a compact string of single-letter codes that
1942
+ selects which fields to include in GET action output. Default
1943
+ codes are listed in each action's section; use ALL to retrieve
1944
+ every available field.
1813
1945
 
1814
- -LD or -LocalDirectory, a local directory to source files from. All files
1815
- within it and any sub-directories are collected recursively.
1946
+ -LD or -LocalDirectory, a local directory to source files from.
1947
+ All files within it and any sub-directories are collected
1948
+ recursively.
1816
1949
 
1817
- -LL or -LocalFileList, a plain-text file listing local file names to
1818
- process, one name per line.
1950
+ -LL or -LocalFileList, a plain-text file listing local file names
1951
+ to process, one name per line.
1819
1952
 
1820
- -LN or -LoginName, the login name to attribute the action to. Defaults to
1821
- the current user. Use this when running on behalf of another specialist or
1822
- from an automated process (daemon or cron job). Use with care — it affects
1823
- which records are updated under that specialist's name.
1953
+ -LN or -LoginName, the login name to attribute the action to.
1954
+ Defaults to the current user. Use this when running on behalf of
1955
+ another specialist or from an automated process (daemon or cron
1956
+ job). Use with care — it affects which records are updated under
1957
+ that specialist's name.
1824
1958
 
1825
- -OF or -OutputFile, redirects output to a file instead of the screen.
1826
- The file format is compatible with 'dsarch' input files.
1959
+ -OF or -OutputFile, redirects output to a file instead of the
1960
+ screen. The file format is compatible with 'dsarch' input files.
1827
1961
 
1828
- -ON or -OrderNames, a string of single-letter field codes controlling the
1829
- sort order of GET action results (-GG, -GS, -GW, -GH, -GQ). Uppercase means
1830
- ascending; lowercase means descending. When file records are modified via
1831
- -AS, -AW, -SS, -SW, -DL, or -MV, files in affected groups are reordered too.
1962
+ -ON or -OrderNames, a string of single-letter field codes
1963
+ controlling the sort order of GET action results (-GG, -GS, -GW,
1964
+ -GH, -GQ). Uppercase means ascending; lowercase means descending.
1965
+ When file records are modified via -AS, -AW, -SS, -SW, -DL, or
1966
+ -MV, files in affected groups are reordered too.
1832
1967
 
1833
- For example, to reorder an existing file list without other changes,
1834
- use -SW with -ON:
1968
+ For example, to reorder an existing file list without other
1969
+ changes, use -SW with -ON:
1835
1970
 
1836
1971
  dsarch dNNNNNN -SW -ON OrderNameString [-GI GroupIndices]
1837
1972
 
1838
- Without group indices, reordering applies to all files in the dataset.
1973
+ Without group indices, reordering applies to all files in the
1974
+ dataset.
1839
1975
 
1840
- -PO or -PatternOffset, controls how 'dsarch' matches file names against
1841
- group patterns to auto-assign group indices. A value >= 0 uses binary
1842
- search (faster, for large sorted lists); -1 uses linear search. Required
1843
- when matching files already registered in GDEXDB; defaults to -1 for new
1844
- files.
1976
+ -PO or -PatternOffset, controls how 'dsarch' matches file names
1977
+ against group patterns to auto-assign group indices. A value >= 0
1978
+ uses binary search (faster, for large sorted lists); -1 uses
1979
+ linear search. Required when matching files already registered in
1980
+ GDEXDB; defaults to -1 for new files.
1845
1981
 
1846
- -QS or -QsubOptions (Alias: -PBSOptions), passes options to qsub when
1847
- running 'dsarch' as a PBS batch job. Quote the value on the command line,
1848
- e.g., -QS '-l walltime=12:00:00'.
1982
+ -QS or -QsubOptions (Alias: -PBSOptions), passes options to qsub
1983
+ when running 'dsarch' as a PBS batch job. Quote the value on the
1984
+ command line, e.g., -QS '-l walltime=12:00:00'.
1849
1985
 
1850
- -UD or -UseDSARCH (Alias: -UseGDEXDB), the gating flag that controls
1851
- 'dsarch' access to a dataset. Set via -SD (-SetDataset). Values:
1986
+ -UD or -UseDSARCH (Alias: -UseGDEXDB), the gating flag that
1987
+ controls 'dsarch' access to a dataset. Set via -SD (-SetDataset).
1988
+ Values:
1852
1989
  'N' - disabled (default; blocks all 'dsarch' writes)
1853
1990
  'Y' - enabled for modification
1854
1991
  'I' - enabled for internal users only
1855
1992
  'P' - enabled and file lists are published publicly
1856
1993
  'W' - file list publication only
1857
1994
 
1858
- Any value except 'N' must be set before 'dsarch' can write to GDEXDB.
1995
+ Any value except 'N' must be set before 'dsarch' can write to
1996
+ GDEXDB.
1859
1997
 
1860
1998
  -VS or -ValidSize, the minimum acceptable file size (in bytes) for
1861
- archiving. Files smaller than this threshold are rejected. Defaults to 100.
1999
+ archiving. Files smaller than this threshold are rejected.
2000
+ Defaults to 100.
1862
2001
 
1863
- -WI or -WaitInterval, how long 'dsarch' waits before rechecking whether a
1864
- background process slot has freed up (see -AL). Units: S (seconds),
1865
- M (minutes), H (hours), D (days) — e.g., '-WI 5M'. A bare number is
1866
- treated as seconds.
2002
+ -WI or -WaitInterval, how long 'dsarch' waits before rechecking
2003
+ whether a background process slot has freed up (see -AL). Units:
2004
+ S (seconds), M (minutes), H (hours), D (days) — e.g., '-WI 5M'. A
2005
+ bare number is treated as seconds.
1867
2006
 
1868
2007
 
1869
2008
  5.2 Multi-Value Info Options
1870
2009
 
1871
- A multi-value Info option accepts a list of one or more values. Supplying
1872
- zero values causes an error.
2010
+ A multi-value Info option accepts a list of one or more values.
2011
+ Supplying zero values causes an error.
1873
2012
 
1874
- -AF or -ArchiveFormat (Alias: -FF|-FileFormat|-ExternalFormat), describes
1875
- how a data file has been packaged or compressed. Recognized values:
2013
+ -AF or -ArchiveFormat (Alias: -FF|-FileFormat|-ExternalFormat),
2014
+ describes how a data file has been packaged or compressed.
2015
+ Recognized values:
1876
2016
  'BI' - binary (COS) blocked
1877
2017
  'C1' or 'CH' - ASCII/character blocked
1878
2018
  'TAR' - tarred
@@ -1880,120 +2020,134 @@ They come in two forms:
1880
2020
  'GZ' - gzipped
1881
2021
  'BZ2' - bzip2-compressed
1882
2022
 
1883
- Combine values in processing order, e.g., 'C1.TAR.GZ' = COS ASCII blocked,
1884
- then tarred, then gzipped. Maximum total length is 20 characters.
2023
+ Combine values in processing order, e.g., 'C1.TAR.GZ' = COS ASCII
2024
+ blocked, then tarred, then gzipped. Maximum total length is 20
2025
+ characters.
1885
2026
 
1886
- -BD or -BeginDate, the earliest date covered by the data, for a group,
1887
- the whole dataset, or a version control record.
2027
+ -BD or -BeginDate, the earliest date covered by the data, for a
2028
+ group, the whole dataset, or a version control record.
1888
2029
 
1889
- -BF or -BackupFlag, controls whether and how a dataset or group is backed
1890
- up to Quasar. Values:
2030
+ -BF or -BackupFlag, controls whether and how a dataset or group
2031
+ is backed up to Quasar. Values:
1891
2032
  'N' - no auto-backup (dataset default)
1892
- 'P' - inherit the setting from the parent (group default; index 0 inherits
1893
- from the dataset)
2033
+ 'P' - inherit the setting from the parent (group default; index
2034
+ 0 inherits from the dataset)
1894
2035
  'B' - back up files only
1895
2036
  'D' - back up files and create a disaster recovery copy
1896
2037
 
1897
- -BP or -BatchProcess (Alias: -d, -DelayedMode), defers execution: the
1898
- command is written to GDEXDB and run later by the 'dscheck' daemon. One
1899
- or more host names may follow -BP to target or exclude specific hosts
1900
- (e.g., '-d PBS' to use PBS batch hosts). An optional retry limit (1-99)
1901
- can also be specified, e.g., '-d 5'; defaults to 2. Archive actions
1902
- (-AS, -AW, -AH, -AQ) retry automatically after storage system outage.
2038
+ -BP or -BatchProcess (Alias: -d, -DelayedMode), defers execution:
2039
+ the command is written to GDEXDB and run later by the 'dscheck'
2040
+ daemon. One or more host names may follow -BP to target or
2041
+ exclude specific hosts (e.g., '-d PBS' to use PBS batch hosts).
2042
+ An optional retry limit (1-99) can also be specified, e.g.,
2043
+ '-d 5'; defaults to 2. Archive actions (-AS, -AW, -AH, -AQ) retry
2044
+ automatically after storage system outage.
1903
2045
 
1904
2046
  -BS or -BackupStatus, the current Quasar backup state for a file:
1905
2047
  'A' - archived to Quasar (complete)
1906
2048
  'T' - tar file created, awaiting upload
1907
2049
  'N' - record created, awaiting tar
1908
2050
 
1909
- -BT or -BeginTime, the time component of the data start, for a group,
1910
- the whole dataset, or a version control record.
2051
+ -BT or -BeginTime, the time component of the data start, for a
2052
+ group, the whole dataset, or a version control record.
1911
2053
 
1912
- -DA or -AccessFlag (Alias: -DataAccessFlag|-FileListFlag), controls which
1913
- file list views are displayed at the dataset and/or top group level:
2054
+ -DA or -AccessFlag (Alias: -DataAccessFlag|-FileListFlag),
2055
+ controls which file list views are displayed at the dataset
2056
+ and/or top group level:
1914
2057
  'B' - both complete and faceted
1915
2058
  'C' - complete list only (default)
1916
2059
  'F' - faceted list only
1917
2060
  'N' - none (no file list shown)
1918
2061
 
1919
- -DB or -Debug, enables debug logging. Up to 3 values may be given: debug
1920
- level (required), log file path, and log file name. The level can be a
1921
- single integer (e.g., 1000) or a range (e.g., 200-1000). Defaults: log
1922
- path '$DECSHOME/dssdb/log', file name 'mydss.dbg'.
2062
+ -DB or -Debug, enables debug logging. Up to 3 values may be
2063
+ given: debug level (required), log file path, and log file name.
2064
+ The level can be a single integer (e.g., 1000) or a range
2065
+ (e.g., 200-1000). Defaults: log path '$DSSHOME/dssdb/log', file
2066
+ name 'mydss.dbg'.
1923
2067
 
1924
- -DE or -Description (Alias: -Desc|-Note|-FileDesc|-FileDescription), a
1925
- free-text description for a data file or version record. Multi-line values
1926
- are supported in input files (-IF). Quote values containing spaces on the
1927
- command line. With version control actions (-SV), this becomes the version
1928
- note.
2068
+ -DE or -Description (Alias: -Desc|-Note|-FileDesc|-FileDescription),
2069
+ a free-text description for a data file or version record.
2070
+ Multi-line values are supported in input files (-IF). Quote values
2071
+ containing spaces on the command line. With version control
2072
+ actions (-SV), this becomes the version note.
1929
2073
 
1930
- -DF or -DataFormat (Alias: -TF|-ContentFormat|-InternalFormat), the
1931
- scientific format of the data content (e.g., NetCDF, IMMA, BINARY). A
1932
- dataset-level default can be set via -SD and is applied automatically when
1933
- no format is specified at archive time.
2074
+ -DF or -DataFormat (Alias: -TF|-ContentFormat|-InternalFormat),
2075
+ the scientific format of the data content (e.g., NetCDF, IMMA,
2076
+ BINARY). A dataset-level default can be set via -SD and is applied
2077
+ automatically when no format is specified at archive time.
1934
2078
 
1935
- -DN or -DOINumber (Alias: -DOI|-DOIName), the Digital Object Identifier
1936
- assigned to a dataset version, providing a stable, citable reference.
2079
+ -DN or -DOINumber (Alias: -DOI|-DOIName), the Digital Object
2080
+ Identifier assigned to a dataset version, providing a stable,
2081
+ citable reference.
1937
2082
 
1938
- -DO or -DisplayOrder, explicit display position indices for files within a
1939
- group or across the dataset. Overridden by -RO (-ResetOrder) when both are
1940
- present.
2083
+ -DO or -DisplayOrder, explicit display position indices for files
2084
+ within a group or across the dataset. Overridden by -RO
2085
+ (-ResetOrder) when both are present.
1941
2086
 
1942
- -ED or -EndDate, the latest date covered by the data, for a group,
1943
- the whole dataset, or a version control record.
2087
+ -ED or -EndDate, the latest date covered by the data, for a
2088
+ group, the whole dataset, or a version control record.
1944
2089
 
1945
- -ET or -EndTime, the time component of the data end, for a group,
1946
- the whole dataset, or a version control record.
2090
+ -ET or -EndTime, the time component of the data end, for a
2091
+ group, the whole dataset, or a version control record.
1947
2092
 
1948
- -EV or -ExternalVersion, the human-readable version label shown publicly
1949
- for a dataset (e.g., '2.0'). Empty by default.
2093
+ -EV or -ExternalVersion, the human-readable version label shown
2094
+ publicly for a dataset (e.g., '2.0'). Empty by default.
1950
2095
 
1951
- -FD or -FileDate, the calendar date a data file was last modified.
2096
+ -FD or -FileDate, the calendar date a data file was last
2097
+ modified.
1952
2098
 
1953
- -FF or -FileFlag, specifies whether an entry represents a regular file
1954
- ('F') or a directory path ('P').
2099
+ -FF or -FileFlag, specifies whether an entry represents a regular
2100
+ file ('F') or a directory path ('P').
1955
2101
 
1956
- -FS or -FileStatus, the access level of a file, 'P' (public, visible to
1957
- all users) or 'I' (internal, visible to specialists only).
2102
+ -FS or -FileStatus, the access level of a file: 'P' (public,
2103
+ visible to all users) or 'I' (internal, visible to specialists
2104
+ only).
1958
2105
 
1959
2106
  -FT or -FileTime, the time of day a data file was last modified.
1960
2107
 
1961
- -GI or -GroupIndex, assigns files to a specific group within a dataset.
1962
- Groups must be created first via -SG (-SetGroup). Use 1, 2, 3, ... for
1963
- specific groups; 0 means no group assignment (default).
2108
+ -GI or -GroupIndex, assigns files to a specific group within a
2109
+ dataset. Groups must be created first via -SG (-SetGroup). Use
2110
+ 1, 2, 3, ... for specific groups; 0 means no group assignment
2111
+ (default).
1964
2112
 
1965
2113
  When omitted for -AS or -AW, 'dsarch' attempts to assign groups
1966
- automatically by matching file names against patterns stored in GDEXDB.
2114
+ automatically by matching file names against patterns stored in
2115
+ GDEXDB.
1967
2116
 
1968
- -GL or -GroupLevel, the number of group nesting levels displayed on the
1969
- web interface. Defaults to 2. A value of -2 shows one level initially,
1970
- expanding to two when subgroups are present.
2117
+ -GL or -GroupLevel, the number of group nesting levels displayed
2118
+ on the web interface. Defaults to 2. A value of -2 shows one level
2119
+ initially, expanding to two when subgroups are present.
1971
2120
 
1972
- -GN or -GroupName (Alias: -GroupID), a short human-readable identifier for
1973
- a group (up to 20 characters). Set via -SG (-SetGroup). Names can be used
1974
- wherever group indices are accepted, and appear on file list webpages.
2121
+ -GN or -GroupName (Alias: -GroupID), a short human-readable
2122
+ identifier for a group (up to 20 characters). Set via -SG
2123
+ (-SetGroup). Names can be used wherever group indices are
2124
+ accepted, and appear on file list webpages.
1975
2125
 
1976
- -GP or -GroupPattern, wildcard patterns that 'dsarch' uses to automatically
1977
- assign files to the right group during archiving. Stored per group via -SG.
2126
+ -GP or -GroupPattern, wildcard patterns that 'dsarch' uses to
2127
+ automatically assign files to the right group during archiving.
2128
+ Stored per group via -SG.
1978
2129
 
1979
- -GT or -GroupType (Alias: -GroupDataType), the access level for a group,
1980
- 'P' (public) or 'I' (internal). Changing from P to I recursively marks
1981
- all nested subgroups and their Web files as internal.
2130
+ -GT or -GroupType (Alias: -GroupDataType), the access level for a
2131
+ group: 'P' (public) or 'I' (internal). Changing from P to I
2132
+ recursively marks all nested subgroups and their Web files as
2133
+ internal.
1982
2134
 
1983
- -HF or -HelpFile, the destination names for Help files on the GDEX Server.
1984
- Defaults to the local file names from -LF unless overridden explicitly.
2135
+ -HF or -HelpFile, the destination names for Help files on the
2136
+ GDEX Server. Defaults to the local file names from -LF unless
2137
+ overridden explicitly.
1985
2138
 
1986
- -HT or -HelpFileType (Alias: -HelpType), the category of a Help file,
1987
- 'D' (Document) or 'S' (Software). One value applies to all files in the
1988
- batch.
2139
+ -HT or -HelpFileType (Alias: -HelpType), the category of a Help
2140
+ file: 'D' (Document) or 'S' (Software). One value applies to all
2141
+ files in the batch.
1989
2142
 
1990
- -ID or -InitialDate, the original publication or release date of a Help,
1991
- Document, or Software file.
2143
+ -ID or -InitialDate, the original publication or release date of
2144
+ a Help, Document, or Software file.
1992
2145
 
1993
- -IF or -InputFile, one or more input file names provided on the command
1994
- line. Each file name must start with the dataset number (format 'dNNNNNN.*')
1995
- and match the -DS value. This naming rule is a safeguard against accidentally
1996
- running an action on the wrong dataset.
2146
+ -IF or -InputFile, one or more input file names provided on the
2147
+ command line. Each file name must start with the dataset number
2148
+ (format 'dNNNNNN.*') and match the -DS value. This naming rule
2149
+ is a safeguard against accidentally running an action on the
2150
+ wrong dataset.
1997
2151
 
1998
2152
  Input file format rules:
1999
2153
  - Lines beginning with '#' are comments and are ignored.
@@ -2001,20 +2155,20 @@ They come in two forms:
2001
2155
  - Action/Mode options: OptionName<!> (marker changeable via -AO)
2002
2156
  - Single-value assignments: OptionName<=>Value, one per line
2003
2157
  (delimiter changeable via -ES; default '<=>')
2004
- - Multi-value (tabular) assignments: a title row followed by data rows,
2005
- with columns separated by '<:>' (changeable via -DV).
2006
- - Tabular data ends at EOF or when a new title line or single-value
2007
- assignment is encountered.
2008
- - If the last column contains multi-line text, append the separator
2009
- to every row (including the title line).
2158
+ - Multi-value (tabular) assignments: a title row followed by data
2159
+ rows, with columns separated by '<:>' (changeable via -DV).
2160
+ - Tabular data ends at EOF or when a new title line or
2161
+ single-value assignment is encountered.
2162
+ - If the last column contains multi-line text, append the
2163
+ separator to every row (including the title line).
2010
2164
 
2011
- -IV or -InternalVersion, a minor revision counter within the same DOI.
2012
- Increments when data are updated without changing the DOI itself. Starts
2013
- at 1 when a new DOI record is created.
2165
+ -IV or -InternalVersion, a minor revision counter within the
2166
+ same DOI. Increments when data are updated without changing the
2167
+ DOI itself. Starts at 1 when a new DOI record is created.
2014
2168
 
2015
- -KV or -KeyValue, custom key/value metadata pairs for a dataset. Use -SD
2016
- to set them and -GD to view them. Keys: up to 40 characters; values: up to
2017
- 128 characters.
2169
+ -KV or -KeyValue, custom key/value metadata pairs for a dataset.
2170
+ Use -SD to set them and -GD to view them. Keys: up to 40
2171
+ characters; values: up to 128 characters.
2018
2172
 
2019
2173
  Set a pair:
2020
2174
  dsarch d540000 SD -KV 'test=>test it'
@@ -2027,81 +2181,89 @@ They come in two forms:
2027
2181
 
2028
2182
  -LC or -Location (Alias: -LocationFlag), where the file resides:
2029
2183
  'C' - CGD data path
2030
- 'G' - Glade Disk (NCAR HPC filesystem)
2031
- 'O' - Object Store
2032
- 'B' - both Glade and Object Store
2184
+ 'G' - Glade Disk (NCAR HPC file system)
2185
+ 'O' - bOreas
2186
+ 'B' - both Glade and bOreas
2033
2187
  'R' - remote URL (Help files only)
2034
2188
 
2035
- At the dataset level (as the online access location), only 'G' or 'O'
2036
- are valid.
2189
+ At the dataset level (as the online access location), only 'G'
2190
+ or 'O' are valid.
2037
2191
 
2038
- -LF or -LocalFile (Alias: -LocFile|-SourceFile), the local source files to
2039
- archive via -AS, -AW, or -AH. UNIX wildcards ('*', '?') are accepted on
2040
- the command line. Use absolute or relative paths for files outside the
2041
- current directory.
2192
+ -LF or -LocalFile (Alias: -LocFile|-SourceFile), the local source
2193
+ files to archive via -AS, -AW, or -AH. UNIX wildcards ('*', '?')
2194
+ are accepted on the command line. Use absolute or relative paths
2195
+ for files outside the current directory.
2042
2196
 
2043
- -MC or -MD5Checksum, the MD5 checksum of a data file on the GDEX Server,
2044
- used for integrity verification.
2197
+ -MC or -MD5Checksum, the MD5 checksum of a data file on the GDEX
2198
+ Server, used for integrity verification.
2045
2199
 
2046
- -ML or -MetaLink (Alias: -MetadataLink), a URL pointing to the content
2047
- metadata page for a dataset, group, or file. Normally set automatically by
2048
- 'gatherxml' when -GX is used. A custom value may be provided and will
2049
- take precedence over the auto-generated link.
2200
+ -ML or -MetaLink (Alias: -MetadataLink), a URL pointing to the
2201
+ content metadata page for a dataset, group, or file. Normally set
2202
+ automatically by 'gatherxml' when -GX is used. A custom value may
2203
+ be provided and will take precedence over the auto-generated link.
2050
2204
 
2051
- -ND or -NoteDocument (Alias: -DocumentNote|-DescDocument), a brief
2052
- description of the documentation available for a dataset.
2205
+ -ND or -NoteDocument (Alias: -DocumentNote|-DescDocument), a
2206
+ brief description of the documentation available for a dataset.
2053
2207
 
2054
- -NI or -NoteInternal (Alias: -InternalNote|-DescInternal|-DI), an internal
2055
- note about a group's or dataset's data, visible to specialists only.
2208
+ -NI or -NoteInternal (Alias: -InternalNote|-DescInternal|-DI),
2209
+ an internal note about a group's or dataset's data, visible to
2210
+ specialists only.
2056
2211
 
2057
- -NS or -NoteSoftware (Alias: -SoftwareNote|-DescSoftware), a description of
2058
- any software tools or scripts associated with a dataset.
2212
+ -NS or -NoteSoftware (Alias: -SoftwareNote|-DescSoftware), a
2213
+ description of any software tools or scripts associated with a
2214
+ dataset.
2059
2215
 
2060
- -NW or -NoteWeb (Alias: -WebNote|-DescWeb|-DW), a public-facing description
2061
- of the web-accessible data for a group or the dataset as a whole.
2216
+ -NW or -NoteWeb (Alias: -WebNote|-DescWeb|-DW), a public-facing
2217
+ description of the web-accessible data for a group or the dataset
2218
+ as a whole.
2062
2219
 
2063
- -OB or -OrderBy (Alias: -OrderByPattern), a date/time pattern that guides
2064
- temporal sorting when combined with -ON. For example, 'YYYYmon' sorts by
2065
- 4-digit year followed by 3-letter month abbreviation.
2220
+ -OB or -OrderBy (Alias: -OrderByPattern), a date/time pattern
2221
+ that guides temporal sorting when combined with -ON. For example,
2222
+ 'YYYYmon' sorts by 4-digit year followed by 3-letter month
2223
+ abbreviation.
2066
2224
 
2067
- -OD or -OriginDataset, the dataset the files are being moved from when
2068
- using -MV (-MoveFile).
2225
+ -OD or -OriginDataset, the dataset the files are being moved
2226
+ from when using -MV (-MoveFile).
2069
2227
 
2070
- -OG or -OriginGroup, the existing group indices to be renumbered by
2071
- -CG (-ChangeGroup).
2228
+ -OG or -OriginGroup, the existing group indices to be renumbered
2229
+ by -CG (-ChangeGroup).
2072
2230
 
2073
- -OT or -OriginType, the source file type when converting between types
2074
- (e.g., Web to Saved) during a -MV (-MoveFile) operation.
2231
+ -OT or -OriginType, the source file type when converting between
2232
+ types (e.g., Web to Saved) during a -MV (-MoveFile) operation.
2075
2233
 
2076
- -PI or -ParentIndex (Alias: -ParentGroupIndex), the index of the parent
2077
- group for a subgroup. Groups can be nested to any depth.
2234
+ -PI or -ParentIndex (Alias: -ParentGroupIndex), the index of the
2235
+ parent group for a subgroup. Groups can be nested to any depth.
2078
2236
 
2079
- -QF or -QuasarFile, the name of the Quasar backup (tar) file, required
2080
- for -AQ (-ArchiveQuasarFile).
2237
+ -QF or -QuasarFile, the name of the Quasar backup (tar) file,
2238
+ required for -AQ (-ArchiveQuasarFile).
2081
2239
 
2082
- -QT or -QuasarFileType (Alias: -QuasarType|-BackupType), the backup scope:
2083
- 'B' (backup only) or 'D' (backup plus disaster recovery copy).
2240
+ -QT or -QuasarFileType (Alias: -QuasarType|-BackupType), the
2241
+ backup scope: 'B' (backup only) or 'D' (backup plus disaster
2242
+ recovery copy).
2084
2243
 
2085
- -RF or -OriginFile, the source file names for -MV (-MoveFile) when they
2086
- differ from the destination names given via -SF, -WF, or -HF.
2244
+ -RF or -OriginFile, the source file names for -MV (-MoveFile)
2245
+ when they differ from the destination names given via -SF, -WF,
2246
+ or -HF.
2087
2247
 
2088
- -SF or -SavedFile, the destination names for Saved files on the GDEX Server.
2089
- For -AS (-ArchiveSavedFile), defaults to the local file names from -LF
2090
- unless specified explicitly.
2248
+ -SF or -SavedFile, the destination names for Saved files on the
2249
+ GDEX Server. For -AS (-ArchiveSavedFile), defaults to the local
2250
+ file names from -LF unless specified explicitly.
2091
2251
 
2092
- -SP or -SavedPath, the directory path for Saved files, relative to the
2093
- Saved data home directory. For -AS, the dataset or group's stored path is
2094
- used by default. For -SG and -SD, this value is written to GDEXDB.
2252
+ -SP or -SavedPath, the directory path for Saved files, relative
2253
+ to the Saved data home directory. For -AS, the dataset or
2254
+ group's stored path is used by default. For -SG and -SD, this
2255
+ value is written to GDEXDB.
2095
2256
 
2096
- Keeping Saved paths accurate is important: NCAR users browse data through
2097
- 'rdals' using these paths. Each top-level group should map to one directory,
2098
- with one subdirectory per subgroup level, mirroring the physical layout.
2257
+ Keeping Saved paths accurate is important: NCAR users browse
2258
+ data through 'gdexls' using these paths. Each top-level group
2259
+ should map to one directory, with one subdirectory per subgroup
2260
+ level, mirroring the physical layout.
2099
2261
 
2100
- -SR or -Source, the person, team, or organization that contributed or
2101
- produced a Help file.
2262
+ -SR or -Source, the person, team, or organization that
2263
+ contributed or produced a Help file.
2102
2264
 
2103
- -ST or -SavedFileType (Alias: -SavedType|-SavedArchiveType), the role of a
2104
- Saved file:
2265
+ -ST or -SavedFileType (Alias: -SavedType|-SavedArchiveType), the
2266
+ role of a Saved file:
2105
2267
  'P' - Primary (main dataset file)
2106
2268
  'R' - Original (source/raw copy)
2107
2269
  'W' - Work (working/intermediate file)
@@ -2110,44 +2272,51 @@ They come in two forms:
2110
2272
 
2111
2273
  One value applies to all files in the batch.
2112
2274
 
2113
- -SZ or -Size, the file size in bytes. Measured automatically from local
2114
- files during archiving; provide explicitly to override.
2275
+ -SZ or -Size, the file size in bytes. Measured automatically from
2276
+ local files during archiving; provide explicitly to override.
2115
2277
 
2116
- -TG or -TopGroupIndex (Alias: -TopGroup), the index of the outermost
2117
- (top-level) group that a Saved or Web file belongs to within a group
2118
- hierarchy.
2278
+ -TG or -TopGroupIndex (Alias: -TopGroup), the index of the
2279
+ outermost (top-level) group that a Saved or Web file belongs to
2280
+ within a group hierarchy.
2119
2281
 
2120
- -TI or -Title, the display title for a dataset or group. Dataset titles
2121
- cannot be changed through 'dsarch' — use the Metadata Editor instead.
2282
+ -TI or -Title, the display title for a dataset or group. Dataset
2283
+ titles cannot be changed through 'dsarch' — use the Metadata
2284
+ Editor instead.
2122
2285
 
2123
- -TL or -ThreddLink, a URL to the THREDDS Catalog page for a specific file.
2124
- Set to 'Y' to indicate that THREDDS Catalog information has been gathered.
2286
+ -TL or -ThreddLink, a URL to the THREDDS Catalog page for a
2287
+ specific file. Set to 'Y' to indicate that THREDDS Catalog
2288
+ information has been gathered.
2125
2289
 
2126
- -VI or -VersionIndex, the numeric identifier of a specific DOI/Version
2127
- control record for a dataset.
2290
+ -VI or -VersionIndex, the numeric identifier of a specific
2291
+ DOI/Version control record for a dataset.
2128
2292
 
2129
- -VT or -VersionStatus, the lifecycle state of a version control record:
2130
- 'A' (Active), 'P' (Pending — no DOI yet), or 'H' (History — terminated).
2293
+ -VT or -VersionStatus, the life cycle state of a version control
2294
+ record: 'A' (Active), 'P' (Pending — no DOI yet), or 'H' (History
2295
+ — terminated).
2131
2296
 
2132
- -WF or -WebFile, the destination names for Web files on the GDEX Server.
2133
- For -AW (-ArchiveWebFile), defaults to the local file names from -LF
2134
- unless specified explicitly.
2297
+ -WF or -WebFile, the destination names for Web files on the GDEX
2298
+ Server. For -AW (-ArchiveWebFile), defaults to the local file
2299
+ names from -LF unless specified explicitly.
2135
2300
 
2136
- -WH or -WebHome (Alias: -WebDataHome), an alternative Web data home
2137
- directory for a dataset. Stored in GDEXDB via -SD (-SetDataset).
2301
+ -WH or -WebHome (Alias: -WebDataHome), an alternative Web data
2302
+ home directory for a dataset. Stored in GDEXDB via -SD
2303
+ (-SetDataset).
2138
2304
 
2139
- -WP or -WebPath, the directory path for Web files, relative to the Web
2140
- data home directory. For -AW, the dataset or group's stored path is used
2141
- by default. For -SG and -SD, this value is written to GDEXDB.
2305
+ -WP or -WebPath, the directory path for Web files, relative to
2306
+ the Web data home directory. For -AW, the dataset or group's
2307
+ stored path is used by default. For -SG and -SD, this value is
2308
+ written to GDEXDB.
2142
2309
 
2143
- Keeping Web paths accurate is important: NCAR users browse data through
2144
- 'rdals' using these paths. Each top-level group should map to one directory,
2145
- with one subdirectory per subgroup level, mirroring the physical layout.
2310
+ Keeping Web paths accurate is important: NCAR users browse data
2311
+ through 'gdexls' using these paths. Each top-level group should
2312
+ map to one directory, with one subdirectory per subgroup level,
2313
+ mirroring the physical layout.
2146
2314
 
2147
- -WT or -WebFileType (Alias: -WebType|-WebArchiveType), the accessibility of
2148
- a Web file, 'D' (public data) or 'N' (NCAR internal data only). One value
2149
- applies to all files in the batch.
2315
+ -WT or -WebFileType (Alias: -WebType|-WebArchiveType), the
2316
+ accessibility of a Web file: 'D' (public data) or 'N' (NCAR
2317
+ internal data only). One value applies to all files in the batch.
2150
2318
 
2151
- -WU or -WebURL (Alias: -URL|-WebAddress), the full URL of a Help file
2152
- hosted remotely (e.g., on GitHub). Use with -SH (-SetHelpFile) to register
2153
- the file in GDEXDB without needing a local copy on the GDEX Server.
2319
+ -WU or -WebURL (Alias: -URL|-WebAddress), the full URL of a Help
2320
+ file hosted remotely (e.g., on GitHub). Use with -SH (-SetHelpFile)
2321
+ to register the file in GDEXDB without a local copy on the GDEX
2322
+ Server.