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