Changeset 2305 for box/trunk/documentation/bbackupquery.xml
- Timestamp:
- 01/10/2008 00:28:57 (4 years ago)
- File:
-
- 1 edited
-
box/trunk/documentation/bbackupquery.xml (modified) (8 diffs)
Legend:
- Unmodified
- Added
- Removed
-
box/trunk/documentation/bbackupquery.xml
r2127 r2305 1 1 <?xml version="1.0" encoding="UTF-8"?> 2 <refentry> 2 <refentry version="5.0" xmlns="http://docbook.org/ns/docbook" 3 xmlns:xlink="http://www.w3.org/1999/xlink" 4 xmlns:xi="http://www.w3.org/2001/XInclude" 5 xmlns:svg="http://www.w3.org/2000/svg" 6 xmlns:m="http://www.w3.org/1998/Math/MathML" 7 xmlns:html="http://www.w3.org/1999/xhtml" 8 xmlns:db="http://docbook.org/ns/docbook"> 3 9 <refmeta> 4 10 <refentrytitle>bbackupquery</refentrytitle> 5 11 6 12 <manvolnum>8</manvolnum> 13 14 <refmiscinfo class="manual">Box Backup 0.11</refmiscinfo> 7 15 </refmeta> 8 16 … … 10 18 <refname>bbackupquery</refname> 11 19 12 <refpurpose>Box Backup store query and retrieval</refpurpose>20 <refpurpose>Box Backup store query and file retrieval</refpurpose> 13 21 </refnamediv> 14 22 15 23 <refsynopsisdiv> 16 24 <cmdsynopsis> 17 <command>bbackupquery [-q] [-c configfile] [commands ...]</command> 25 <command>bbackupquery</command> 26 27 <arg>-q</arg> 28 29 <arg>-c configfile</arg> 30 31 <arg>command ...</arg> 18 32 </cmdsynopsis> 19 33 </refsynopsisdiv> … … 22 36 <title>Description</title> 23 37 24 <para>< literal>bbackupquery</literal> is the main way of interacting with38 <para><command>bbackupquery</command> is the main way of interacting with 25 39 the backup store from a Box Backup client machine. It supports both 26 40 interactive and batch modes of operation.</para> … … 30 44 files and directories when needed.</para> 31 45 32 <para>< literal>bbackupquery</literal> supports interactive and batch modes46 <para><command>bbackupquery</command> supports interactive and batch modes 33 47 of operation. Interactive mode allows for interaction with the server much 34 48 like an interactive FTP client.</para> 35 49 36 50 <para>Batch mode is invoked by putting commands into the invocation of 37 bbackupquery. Example:</para>38 39 <p rogramlisting>bbackupquery "list home-dirs" quit</programlisting>51 <command>bbackupquery</command>. Example:</para> 52 53 <para><programlisting>bbackupquery "list home-dirs" quit</programlisting></para> 40 54 41 55 <para>Note that commands that contain spaces are enclosed in double 42 quotes. If the < literal>quit</literal> command is omitted, after the43 preceding commands are completed, < literal>bbackupquery</literal> will56 quotes. If the <command>quit</command> command is omitted, after the 57 preceding commands are completed, <command>bbackupquery</command> will 44 58 enter interactive mode.</para> 45 46 <para><emphasis role="bold">Options</emphasis></para> 47 48 <para><emphasis>-q: Quiet. Suppresses status output while 49 running.</emphasis></para> 50 51 <para><emphasis>-c configfile: Use config file, instead of the default 52 bbackupd.conf file. Can be a relative or full path.</emphasis></para> 53 54 <refsection> 55 <title>Commands</title> 56 57 <para>The commands that can be used in <literal>bbackupquery</literal> 58 are listed below.</para> 59 60 <itemizedlist> 61 <listitem> 62 <para><literal>help</literal></para> 63 59 </refsection> 60 61 <refsection> 62 <title>Options</title> 63 64 <para><variablelist> 65 <varlistentry> 66 <term><option>-q</option></term> 67 68 <listitem> 69 <para>Quiet. Suppresses status output while running.</para> 70 </listitem> 71 </varlistentry> 72 73 <varlistentry> 74 <term><option>-c</option> <option>configfile</option></term> 75 76 <listitem> 77 <para>Use configfile instead of the default bbackupd.conf file. 78 Can be a relative or full path.</para> 79 </listitem> 80 </varlistentry> 81 </variablelist></para> 82 </refsection> 83 84 <refsection> 85 <title>Commands</title> 86 87 <para>The commands that can be used in bbackupquery are listed 88 below.</para> 89 90 <variablelist> 91 <varlistentry> 92 <term><command>help</command></term> 93 94 <listitem> 64 95 <para>Displays the basic help message, which gives information about 65 the commands available in bbackupquery. Use the form <literal>help 66 command</literal>, to get help on a specific command.</para> 67 </listitem> 68 69 <listitem> 70 <para><literal>quit</literal></para> 71 96 the commands available in <command>bbackupquery</command>. Use the 97 form <command>help command</command> to get help on a specific 98 command.</para> 99 </listitem> 100 </varlistentry> 101 102 <varlistentry> 103 <term><command>quit</command></term> 104 105 <listitem> 72 106 <para>End the session with the store server, and quit 73 <literal>bbackupquery</literal>.</para> 74 </listitem> 75 76 <listitem> 77 <para><literal>cd [options] <directory-name></literal></para> 78 79 <para>Change directory. Options:</para> 80 81 <itemizedlist> 82 <listitem> 83 <para><literal>-d</literal> -- consider deleted directories for 84 traversal</para> 85 </listitem> 86 87 <listitem> 88 <para><literal>-o</literal> -- consider old versions of 89 directories for traversal. This option should never be useful in 90 a correctly formed store.</para> 91 </listitem> 92 </itemizedlist> 93 </listitem> 94 95 <listitem> 96 <para><literal>lcd <local-directory-name></literal></para> 97 107 bbackupquery.</para> 108 </listitem> 109 </varlistentry> 110 111 <varlistentry> 112 <term><command>cd</command> <optional>options</optional> 113 <varname>directory-name</varname></term> 114 115 <listitem> 116 <para>Change directory. Options: <variablelist> 117 <varlistentry> 118 <term><option>-d</option></term> 119 120 <listitem> 121 <para>consider deleted directories for traversal</para> 122 </listitem> 123 </varlistentry> 124 125 <varlistentry> 126 <term><option>-o</option></term> 127 128 <listitem> 129 <para>consider old versions of directories for traversal. 130 This option should never be useful in a correctly formed 131 store.</para> 132 </listitem> 133 </varlistentry> 134 </variablelist></para> 135 </listitem> 136 </varlistentry> 137 138 <varlistentry> 139 <term><command>lcd</command> 140 <varname>local-directory-name</varname></term> 141 142 <listitem> 98 143 <para>Change directory on the client machine. To list the contents 99 of the local directory, type <literal>sh ls</literal> (on unix-like 100 machines). TODO: Does <literal>sh dir</literal> work on 101 Windows?</para> 102 </listitem> 103 104 <listitem> 105 <para><literal>list [options] [directory-name]</literal></para> 106 107 <para>The <literal>list</literal> (or its synonym 108 <literal>ls</literal>) command lists the content of the current, or 109 specified, directory. The options are as follows:</para> 110 111 <itemizedlist> 112 <listitem> 113 <para><literal>-r</literal> -- recursively list all files</para> 114 </listitem> 115 116 <listitem> 117 <para><literal>-d</literal> -- list deleted files and 118 directories</para> 119 </listitem> 120 121 <listitem> 122 <para><literal>-o</literal> -- list old versions of files and 123 directories</para> 124 </listitem> 125 126 <listitem> 127 <para><literal>-I</literal> -- don't display object IDs</para> 128 </listitem> 129 130 <listitem> 131 <para><literal>-F</literal> -- don't display flags</para> 132 </listitem> 133 134 <listitem> 135 <para><literal>-t</literal> -- show file modification time (and 136 attr mod time, if the object has attributes.</para> 137 </listitem> 138 139 <listitem> 140 <para><literal>-s</literal> -- show file size in blocks used on 141 server. Note that this is only a very approximate indication of 142 local file size.</para> 143 </listitem> 144 </itemizedlist> 145 </listitem> 146 147 <listitem> 148 <para><literal>ls [options] [directory-name]</literal></para> 149 150 <para>Synonym for <literal>list</literal>.</para> 151 </listitem> 152 153 <listitem> 154 <para><literal><literal>pwd</literal></literal></para> 155 144 of the local directory, type <command>sh ls</command> (on Unix-like 145 machines).</para> 146 </listitem> 147 </varlistentry> 148 149 <varlistentry> 150 <term><command>list</command> <optional>options</optional> 151 <optional>directory-name</optional></term> 152 153 <listitem> 154 <para>The list (or its synonym <command>ls</command>) command lists 155 the content of the current, or specified, directory. The options are 156 as follows:</para> 157 158 <para><variablelist> 159 <varlistentry> 160 <term><option>-r</option></term> 161 162 <listitem> 163 <para>recursively list all files</para> 164 </listitem> 165 </varlistentry> 166 167 <varlistentry> 168 <term><option>-d</option></term> 169 170 <listitem> 171 <para>list deleted files and directories</para> 172 </listitem> 173 </varlistentry> 174 175 <varlistentry> 176 <term><option>-o</option></term> 177 178 <listitem> 179 <para>list old versions of files and directories</para> 180 </listitem> 181 </varlistentry> 182 183 <varlistentry> 184 <term><option>-I</option></term> 185 186 <listitem> 187 <para>don't display object IDs</para> 188 </listitem> 189 </varlistentry> 190 191 <varlistentry> 192 <term><option>-F</option></term> 193 194 <listitem> 195 <para>don't display flags</para> 196 </listitem> 197 </varlistentry> 198 199 <varlistentry> 200 <term><option>-t</option></term> 201 202 <listitem> 203 <para>show file modification time (and attr mod time, if the 204 object has attributes).</para> 205 </listitem> 206 </varlistentry> 207 208 <varlistentry> 209 <term><option>-s</option></term> 210 211 <listitem> 212 <para>show file size in blocks used on server. Note that 213 this is only a very approximate indication of local file 214 size.</para> 215 </listitem> 216 </varlistentry> 217 </variablelist></para> 218 </listitem> 219 </varlistentry> 220 221 <varlistentry> 222 <term><command>ls</command> <optional>options</optional> 223 <optional>directory-name</optional></term> 224 225 <listitem> 226 <para>Synonym for <command>list</command>.</para> 227 </listitem> 228 </varlistentry> 229 230 <varlistentry> 231 <term><command>pwd</command></term> 232 233 <listitem> 156 234 <para>Print current directory, always relative to the backup store 157 235 root.</para> 158 236 </listitem> 159 160 <listitem> 161 <para><literal>sh <shell command></literal></para> 162 237 </varlistentry> 238 239 <varlistentry> 240 <term><command>sh</command> <varname>shell-command</varname></term> 241 242 <listitem> 163 243 <para>Everything after the sh is passed to a shell and run. All 164 244 output from the command is displayed in the client.</para> 165 245 166 246 <para>Example: to list the contents of the current directory on the 167 client machine type <literal>sh ls</literal>.</para> 168 </listitem> 169 170 <listitem> 171 <para><literal>compare -a</literal></para> 172 173 <para><literal>compare -l <location-name></literal></para> 174 175 <para><literal>compare <store-dir-name> 176 <local-dir-name></literal></para> 177 247 client machine type <command>sh ls</command>.</para> 248 </listitem> 249 </varlistentry> 250 251 <varlistentry> 252 <term><command>compare -a</command></term> 253 254 <listitem> 255 <para></para> 256 </listitem> 257 </varlistentry> 258 259 <varlistentry> 260 <term><command>compare -l</command> 261 <varname>location-name</varname></term> 262 263 <listitem> 264 <para></para> 265 </listitem> 266 </varlistentry> 267 268 <varlistentry> 269 <term><command>compare</command> <varname>store-dir-name</varname> 270 <varname>local-dir-name</varname></term> 271 272 <listitem> 178 273 <para>Compare the current data in the store with the data on the 179 274 disc. Please note that all the data will be downloaded from the … … 183 278 <para>Options:</para> 184 279 185 <itemizedlist> 186 <listitem> 187 <para><literal>-a</literal> -- compare all locations. </para> 188 </listitem> 189 190 <listitem> 191 <para><literal>-l</literal> -- compare one backup location as 192 specified in the configuration file. This compares one of the 193 top level store directories.</para> 194 </listitem> 195 196 <listitem> 197 <para><literal>-c</literal> -- set return code. The return code 198 is set to the following values, if <literal>quit</literal> is 199 the next command. So, if another command is run after the 200 <literal>compare</literal>, the return code will not refer to 201 the <literal>compare</literal>. This option is very useful for 202 automating compares. Return code values:</para> 203 204 <itemizedlist> 205 <listitem> 206 <para>1 -- no differences were found</para> 207 </listitem> 208 209 <listitem> 210 <para>2 -- differences were found</para> 211 </listitem> 212 213 <listitem> 214 <para>3 -- an error occured</para> 215 </listitem> 216 </itemizedlist> 217 </listitem> 218 </itemizedlist> 219 </listitem> 220 221 <listitem> 222 <para><literal>get <object-filename> 223 [<local-filename>]</literal></para> 224 225 <para><literal>get -i <object-id> 226 <local-filename></literal></para> 227 280 <para><variablelist> 281 <varlistentry> 282 <term><option>-a</option></term> 283 284 <listitem> 285 <para>compare all locations.</para> 286 </listitem> 287 </varlistentry> 288 289 <varlistentry> 290 <term><option>-l</option></term> 291 292 <listitem> 293 <para>compare one backup location as specified in the 294 configuration file. This compares one of the top level store 295 directories.</para> 296 </listitem> 297 </varlistentry> 298 299 <varlistentry> 300 <term><option>-c</option></term> 301 302 <listitem> 303 <para>set return code. The return code is set to the 304 following values, if quit is the next command. So, if 305 another command is run after the compare, the return code 306 will not refer to the compare. This option is very useful 307 for automating compares. Return code values:<itemizedlist> 308 <listitem> 309 <para><option>1</option> -- no differences were 310 found</para> 311 </listitem> 312 313 <listitem> 314 <para><option>2</option> -- differences were 315 found</para> 316 </listitem> 317 318 <listitem> 319 <para><option>3</option> -- an error occured</para> 320 </listitem> 321 </itemizedlist></para> 322 </listitem> 323 </varlistentry> 324 </variablelist></para> 325 </listitem> 326 </varlistentry> 327 328 <varlistentry> 329 <term><command>get</command> <varname>object-filename</varname> 330 <optional>local-filename</optional></term> 331 332 <listitem> 333 <para></para> 334 </listitem> 335 </varlistentry> 336 337 <varlistentry> 338 <term><command>get -i</command> <varname>object-id</varname> 339 <varname>local-filename</varname></term> 340 341 <listitem> 228 342 <para>Gets a file from the store. Object is specified as the 229 343 filename within the current directory. Local filename is optional. … … 231 345 file to retrieve.</para> 232 346 233 <para>To get an old or deleted file, use the < literal>-i</literal>347 <para>To get an old or deleted file, use the <option>-i</option> 234 348 option and select the object as a hex object ID (first column in 235 349 listing). The local filename must be specified.</para> 236 350 </listitem> 237 238 <listitem> 239 <para><literal>getobject <object-id> 240 <local-filename></literal></para> 241 351 </varlistentry> 352 353 <varlistentry> 354 <term><command>getobject</command> <varname>object-id</varname> 355 <varname>local-filename</varname></term> 356 357 <listitem> 242 358 <para>Gets the object specified by the object id (in hex) and stores 243 the raw contents in the local file specified. <emphasis 244 role="bold">Note</emphasis>: This is only useful for debugging as it 245 does not decode files from the stored format, which is encrypted and 246 compressed.</para> 247 </listitem> 248 249 <listitem> 250 <para><literal>restore [-d] <directory-name> 251 <local-directory-name></literal></para> 252 253 <para><literal>restore -r</literal></para> 254 359 the raw contents in the local file specified. Note: This is only 360 useful for debugging as it does not decode files from the stored 361 format, which is encrypted and compressed.</para> 362 </listitem> 363 </varlistentry> 364 365 <varlistentry> 366 <term><command>restore</command> <optional>-d</optional> 367 <varname>directory-name</varname> 368 <varname>local-directory-name</varname></term> 369 370 <listitem> 371 <para></para> 372 </listitem> 373 </varlistentry> 374 375 <varlistentry> 376 <term><command>restore -r</command></term> 377 378 <listitem> 255 379 <para>Restores a directory to the local disc. The local directory 256 380 specified must not exist (unless a previous restore is being 257 381 restarted). The root cannot be restored -- restore locations 258 individually. </para>382 individually.</para> 259 383 260 384 <para>Options:</para> 261 385 262 <itemizedlist> 263 <listitem> 264 <para><literal>-d</literal> -- restore a deleted 265 directory</para> 266 </listitem> 267 268 <listitem> 269 <para><literal>-r</literal> -- resume an interrupted 270 restore</para> 271 </listitem> 272 </itemizedlist> 273 274 <para> If a restore operation is interrupted for any reason, it can 275 be restarted using the <literal>-r</literal> switch. Restore 276 progress information is saved in a file at regular intervals during 277 the restore operation to allow restarts.</para> 278 </listitem> 279 280 <listitem> 281 <para>usage</para> 282 386 <para><variablelist> 387 <varlistentry> 388 <term><option>-d</option></term> 389 390 <listitem> 391 <para>restore a deleted directory</para> 392 </listitem> 393 </varlistentry> 394 395 <varlistentry> 396 <term><option>-r</option></term> 397 398 <listitem> 399 <para>resume an interrupted restore</para> 400 </listitem> 401 </varlistentry> 402 </variablelist>If a restore operation is interrupted for any 403 reason, it can be restarted using the <option>-r</option> switch. 404 Restore progress information is saved in a file at regular intervals 405 during the restore operation to allow restarts.</para> 406 </listitem> 407 </varlistentry> 408 409 <varlistentry> 410 <term><command>usage</command></term> 411 412 <listitem> 283 413 <para>Show space used on the server for this account. Display 284 fields:</para> 285 286 <itemizedlist> 287 <listitem> 288 <para><literal>Used</literal>: Total amount of space used on the 289 server</para> 290 </listitem> 291 292 <listitem> 293 <para><literal>Old files</literal>: Space used by old 294 files</para> 295 </listitem> 296 297 <listitem> 298 <para><literal>Deleted files</literal>: Space used by deleted 299 files</para> 300 </listitem> 301 302 <listitem> 303 <para><literal>Directories</literal>: Space used by the 304 directory structure</para> 305 </listitem> 306 </itemizedlist> 307 308 <para>When Used exceeds the soft limit, the server will start to 309 remove old and deleted files until the usage drops below the soft 310 limit. After a while, you should expect to see the usage stay at 311 just below the soft limit. You only need more space if the space 312 used by old and deleted files is near zero.</para> 313 </listitem> 314 </itemizedlist> 315 </refsection> 316 </refsection> 317 318 <refsection> 319 <title>Author</title> 320 321 <para>Ben Summers and contributors. For help, please go to the <ulink 322 url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 323 Backup <ulink 324 url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 325 list.</ulink></para> 326 </refsection> 327 328 <refsection> 329 <title>See Also</title> 330 331 <para>bbackupd.conf(5)</para> 332 </refsection> 333 334 <refsection> 335 <title>Files</title> 336 337 <para><literal>bbackupquery</literal> uses the Box Backup client 338 configuration file, usually located in 339 <filename>/etc/box/bbackupd.conf</filename>. On Windows this file is 340 usually located in the installation directory, and is named 341 <filename>bbackupd.conf</filename> as well.</para> 414 fields:<itemizedlist> 415 <listitem> 416 <para><property>Used</property>: Total amount of space used on 417 the server</para> 418 </listitem> 419 420 <listitem> 421 <para><property>Old files</property>: Space used by old 422 files</para> 423 </listitem> 424 425 <listitem> 426 <para><property>Deleted files</property>: Space used by 427 deleted files</para> 428 </listitem> 429 430 <listitem> 431 <para><property>Directories</property>: Space used by the 432 directory structure</para> 433 </listitem> 434 </itemizedlist></para> 435 436 <para>When <property>Used</property> exceeds the soft limit, the 437 server will start to remove old and deleted files until the usage 438 drops below the soft limit. After a while, you should expect to see 439 the usage stay at just below the soft limit. You only need more 440 space if the space used by old and deleted files is near 441 zero.</para> 442 </listitem> 443 </varlistentry> 444 </variablelist> 342 445 </refsection> 343 446 … … 345 448 <title>Bugs</title> 346 449 347 <para>If you find a bug in Box Backup ,and you want to let us know about348 it, join the < ulink349 url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing350 list</ ulink>, and senda description of the problem there.</para>450 <para>If you find a bug in Box Backup and you want to let us know about 451 it, join the <link 452 xlink:href="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 453 list</link> and send us a description of the problem there.</para> 351 454 352 455 <para>To report a bug, give us at least the following information:</para> … … 378 481 </itemizedlist> 379 482 </refsection> 483 484 <refsection> 485 <title>Authors</title> 486 487 <para><author> 488 <personname>Ben Summers</personname> 489 </author></para> 490 491 <para><author> 492 <personname>Per Thomsen</personname> 493 </author></para> 494 495 <para><author> 496 <personname>James O'Gorman</personname> 497 </author></para> 498 </refsection> 380 499 </refentry>
Note: See TracChangeset
for help on using the changeset viewer.
