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