1 08/21/2018 complete_dump
  2 
  3 Syntax as a command:  complete_dump {ctl_file {operator {ntapes}}}
  4    {-control_args}
  5 
  6 
  7 Function:  begins a complete hierarchy dump.  It dumps all storage
  8 system segments and directories, regardless of their modification
  9 dates.  The complete_dump command calls the backup_dump command to do
 10 the actual dumping.
 11 
 12 The complete_dump command requires a dump control file, containing the
 13 full pathnames of the objects to be dumped.  It calls backup_dump once
 14 for each line in the control file.  See "Notes on Format of a Dump
 15 Control File" below.  A map of all objects dumped is created in the
 16 working directory, with the name <unique-name>.dump.map.
 17 
 18 
 19 The complete_dump command is one of the commands used to control
 20 hierarchy dumping of storage system segments and directories to
 21 magnetic tape.  The other commands are:
 22 
 23    backup_dump
 24    catchup_dump
 25    end_dump
 26    start_dump
 27    wakeup_dump
 28 
 29 
 30 You should note that argument processing for all of the hierarchy
 31 backup commands is performed by a common argument processing procedure.
 32 The values of all arguments are remembered in static storage and remain
 33 in effect for the life of the process, unless changed by arguments
 34 given in subsequent invocations of backup commands.  It should also be
 35 noted that the dumping commands and the reloading/retrieving commands
 36 are all part of the same hierarchy backup system, and argument values
 37 set by the dumping commands remain in effect for the
 38 reloading/retrieving commands and vice versa, unless overridden.
 39 However, dumping and reloading cannot be done in the same process; use
 40 the new_proc command between dumping and reloading.  See "Notes on
 41 Default Arguments" below.
 42 
 43 
 44 You may define certain frequently used arguments to the complete_dump
 45 command in two different ways.  The first way is to precede the
 46 argument with an identifying control argument.  The second way is to
 47 place the argument in a certain position on the command line.  In the
 48 first case, the combination of control argument and argument may appear
 49 anywhere on the command line after any positional information.  In the
 50 second case, the argument must appear at the beginning of the command
 51 line, before any control argument-argument combinations or any control
 52 arguments which stand alone.
 53 
 54 
 55 For the complete_dump command, the frequently used arguments are the
 56 control file, the operator's name, and the number of tape copies.  When
 57 defined to the command positionally, i.e., without identifying control
 58 arguments, these arguments must appear in the following positions:
 59 
 60       complete_dump {ctl_file {operator {ntapes}}} {-control_args}
 61 
 62 The control file and the operator's name must be specified, in one way
 63 or the other.
 64 
 65 
 66 Arguments:
 67 ctl_file
 68    is the pathname of the dump control file (see the -control control
 69    argument).
 70 operator
 71    is the operator's name or initials (see the -operator control
 72    argument).
 73 ntapes
 74    is the number of copies to be made of each hierarchy dump tape (see
 75    the -tapes control argument).
 76 
 77 
 78 Control arguments:
 79 -all
 80    causes all directory entries (in the specified subtree) to be
 81    dumped, regardless of their dates modified or dates dumped.  This
 82    argument overrides a previously given -dtd control argument or DATE
 83    argument.  This is the default.
 84 -brief_map, -bfmap
 85    creates a map file that lists the processed entries.
 86 -control path
 87    indicates that path is the pathname of a dump control file.  The
 88    suffix "dump" is assumed.  For example, "-control sys_dirs"
 89    specifies a control file named sys_dirs.dump, in the working
 90    directory.  See "Notes on Format of a Dump Control File" below.
 91 
 92 
 93 -debug
 94    disables those phcs_ and hphcs_ calls that deactivate dumped
 95    segments and set quotas.
 96 -destination STR, -ds STR
 97    specifies a destination for printing maps and error files.  The
 98    default is "incremental" for maps and "error file" for error files.
 99 -dtd
100    tests and dumps each segment only if the segment or its branch has
101    been modified since the last time it was dumped.
102 -error_of
103    writes error messages into a file rather than online.  The name of
104    the error file is printed when the first error is encountered.  This
105    is the default.
106 -error_on
107    writes error messages on the user's terminal.
108 
109 
110 -header STR, -he STR
111    specifies a heading for dprinting maps and error files.
112 -hold
113    leaves the current hierarchy dump tape or tapes mounted and inhibits
114    rewinding after the current hierarchy dump cycle is completed.
115 -map
116    writes a list of the segments and directories processed into a file.
117    This is the default.
118 -nodebug
119    enables hphcs_ calls to set quotas and the transparency switches.
120    This is the default.
121 -nodprint, -no_dprint, -ndp
122    causes the start_dump command not to dprint maps and error files.
123    The default is -dprint.  This control argument cannot be used with
124    the backup_dump command.
125 
126 
127 -nohold
128    rewinds and unloads the hierarchy dump tape or tapes at the end of
129    the current dump pass.  This is the default.
130 -nomap
131    inhibits listing of the names of processed segments and directories
132    and turns the tape switch on (see -tape below).
133 -nooutput
134    inhibits writing hierarchy dump information even if the tape switch
135    is on.  This is used for a test run or debugging.
136 -noprimary, -npri
137    uses each pathname as given.  The default is -primary.
138 -notape
139    inhibits writing of a hierarchy tape.  This argument also causes a
140    map to be created even if it was previously inhibited.  (See -map
141    above.)
142 
143 
144 -only
145    indicates that only the requested segment or directory and its
146    branch are to be dumped.  This is the opposite of -sweep.
147 -operator STR
148    indicates that STR is the user's name or initials (up to 16
149    characters in length).
150 -output
151    writes hierarchy dump information onto the tape if the tape switch
152    is on.  This is the default.
153 -primary, -pr
154    replaces all directory names in each pathname with the primary
155    names.  This is the default.
156 -pvname STR
157    indicates that segments and directories may only be dumped if they
158    reside on the physical volume specified by STR.
159 
160 
161 -queue N, -q N
162    specifies a queue number for any maps and error files that are
163    dprinted.  The default is queue 1.
164 -request_type STR, -rqt STR
165    specifies an output request type for printing maps and error files.
166    Available request types can be listed by using the
167    print_request_types command.  The default is "printer."
168 -restart path
169    indicates that path is the pathname of a segment or directory where
170    hierarchy dumping is to be restarted.  Use of this feature assumes
171    that there is a dump control file.  It is normally used to restart a
172    hierarchy dump that was interrupted by a system failure.
173 
174 
175 -sweep
176    indicates that the whole subtree beginning with the given directory
177    is to be dumped, subject to the criteria of the -dtd control
178    argument or the DATE argument if either has been invoked.  This is
179    the default.
180 -tape
181    allows writing of a tape.  This is the default.
182 -tapes N
183    indicates that N is the number of output tape copies to be made
184    where N can be either 1 or 2.  The default is 1.
185 -1tape
186    sets the number of tape copies to 1 as an alternative to the -tapes
187    argument.
188 
189 
190 -volume_pool path, -vp path
191    indicates that the specified volume pool should be used to provide
192    automated selection of tapes to use for dumping. See the
193    manage_volume_pool (mvp) command for help on managing volume
194    pools.
195 -no_volume_pool, -no_vp
196    disables use of a volume pool for automatic tape selection.
197 -2tapes
198    sets the number of tape copies to 2 as an alternative to the -tapes
199    argument.
200 -wakeup N
201    indicates that N is the wakeup interval between incremental
202    hierarchy dump passes, in minutes.  The default is 60 minutes.
203 
204 
205 DATE
206    an argument beginning with a character other than "-" or ">" is
207    assumed to be a date, in a format acceptable to the
208    convert_date_to_binary_ subroutine.  If the argument can be
209    converted to a date, then only segments and directories modified
210    after that date are dumped.
211 
212 
213 Notes on default arguments:  The values of arguments given to any of
214 the hierarchy backup commands are remembered in static storage and
215 remain in effect for the life of the process, unless explicitly changed
216 during the invocation of a subsequent backup command.
217 
218 
219 The following defaults are in effect for the dumper before any backup
220 commands are given; they are not, however, reset to these values at the
221 start of each backup command, except as noted.
222 
223    -all
224    -contin
225    -error_of
226    -map
227    -nodebug
228    -nohold
229    -output
230    -primary
231    -sweep
232    -tape
233 
234 
235 The following defaults are set automatically at the time the respective
236 commands are executed:
237 
238       catchup_dump
239            -tape (default date yesterday at midnight)
240 
241       complete_dump
242            -all
243            -tape
244 
245       start_dump
246            -dtd
247            -hold
248            -tape
249            -wakeup 60
250 
251 
252 Notes on format of a dump control file:  The control file specified by
253 "-control path" is an ASCII segment containing absolute pathnames of
254 entries (segments, MSFs, and directory subtrees) to be dumped, each on
255 a separate line.