Software evolves, but documentation evolves... slower.
Signed-off-by: Avery Pennarun <apenwarr@gmail.com>
The following commands are available inside `bup ftp`:
-ls
-: print the contents of the current working directory
+ls [-a]
+: print the contents of the current working directory.
+ If -a is given, also include hidden files (files which
+ start with a `.` character).
cd *dirname*
: change to a different working directory
$ bup ftp
bup> ls
- mybackup/
- yourbackup/
+ mybackup/ yourbackup/
+
bup> cd mybackup/
bup> ls
- .2fe288dedbfab372c84b0502ee2bc1504270f3b3/
- .ae760aa4cfc13b689b46e3d2ce5ae50e92299c72/
- 2010-02-05-185507@
- 2010-02-05-185508@
- latest@
+ 2010-02-05-185507@ 2010-02-05-185508@ latest@
+
bup> cd latest/
bup> ls
(...etc...)
+
bup> get myfile
Saving 'myfile'
bup> quit
$ bup help help
(Imagine that this man page was pasted below,
- recursively. Because that would cause an endless
+ recursively. Since that would cause an endless loop
we include this silly remark instead. Chicken.)
# BUP
-l, --long
: print more information about each file, in a similar
- format to the `-l` option to `ls`(1). (INCOMPLETE)
+ format to the `-l` option to `ls`(1).
-x, --xdev, --one-file-system
: don't cross filesystem boundaries when recursing
# SYNOPSIS
-bup margin
+bup margin [options...]
# DESCRIPTION
margin` occasionally to see if you're getting dangerously
close to 160 bits.
+# OPTIONS
+
+--predict
+: Guess the offset into each index file where a
+ particular object will appear, and report the maximum
+ deviation of the correct answer from the guess. This
+ is potentially useful for tuning an interpolation
+ search algorithm.
+
+--ignore-midx
+: don't use .midx files, use only .idx files. This is
+ only really useful when used with `--predict`.
+
+
# EXAMPLE
$ bup margin
Reading indexes: 100.00% (11188299/11188299), done.
45
+ $ bup margin --predict
+ PackIdxList: using 1 index.
+ Reading indexes: 100.00% (1612581/1612581), done.
+ 915 of 1612581 (0.057%)
+
# SEE ALSO
: ignore any `.midx` files created by `bup midx`. This
allows you to compare memory performance with and
without using midx.
+
+--existing
+: search for existing objects instead of searching for
+ random nonexistent ones. This can greatly affect
+ memory usage and performance. Note that most of the
+ time, `bup save` spends most of its time searching for
+ nonexistent objects, since existing ones are probably
+ in unmodified files that we won't be trying to back up
+ anyway. So the default behaviour reflects real bup
+ performance more accurately. But you might want this
+ option anyway just to make sure you haven't made
+ searching for existing objects much worse than before.
# EXAMPLE
already exist. This will result in the fastest backup
performance, but may take a long time to run.
+--max-files
+: maximum number of .idx files to open at a time. You
+ can use this if you have an especially small number of file
+ descriptors available, so that midx can complete
+ (though possibly non-optimally) even if it can't open
+ all your .idx files at once. The default value of this
+ option should be fine for most people.
+
# EXAMPLE
files, which can usually be backed up quickly, and skip
over large ones (like virtual machine images) which
take longer. Then you can back up the large files
- less frequently.
+ less frequently. Use a suffix like k, M, or G to
+ specify multiples of 1024, 1024*1024, 1024*1024*1024
+ respectively.
+
+--bwlimit=*bytes/sec*
+: don't transmit more than *bytes/sec* bytes per second
+ to the server. This is good for making your backups
+ not suck up all your network bandwidth. Use a suffix
+ like k, M, or G to specify multiples of 1024,
+ 1024*1024, 1024*1024*1024 respectively.
# EXAMPLE
$ bup index -ux /etc
Indexing: 1981, done.
- $ bup save -r myserver: -n my-pc-backup /etc
+ $ bup save -r myserver: -n my-pc-backup --bwlimit=50k /etc
Reading index: 1981, done.
Saving: 100.00% (998/998k, 1981/1981 files), done.
the same name, and later view the history of that
dataset to see how it has changed over time.)
+-q, --quiet
+: disable progress messages.
+
-v, --verbose
: increase verbosity (can be used more than once).
--q, --quiet
-: disable progress messages.
+--noop
+: read the data and split it into blocks based on the "bupsplit"
+ rolling checksum algorithm, but don't do anything with
+ the blocks. This is mostly useful for benchmarking.
+
+--copy
+: like --noop, but also write the data to stdout. This
+ can be useful for benchmarking the speed of read+bupsplit+write
+ for large amounts of data.
--bench
: print benchmark timings to stderr.
generate a new tree and link to that. Default is
4096 objects per tree.
+--bwlimit=*bytes/sec*
+: don't transmit more than *bytes/sec* bytes per second
+ to the server. This is good for making your backups
+ not suck up all your network bandwidth. Use a suffix
+ like k, M, or G to specify multiples of 1024,
+ 1024*1024, 1024*1024*1024 respectively.
+
+
# EXAMPLE
$ tar -cf - /etc | bup split -r myserver: -n mybackup-tar
# SYNOPSIS
-bup \<command\> [options...]
+bup [global options...] \<command\> [options...]
# DESCRIPTION
The individual bup subcommands appear in their own man
pages.
+# GLOBAL OPTIONS
+
+--version
+: print bup's version number. Equivalent to
+ `bup-version`(1)
+
+-d, --bup-dir=*BUP_DIR*
+: use the given BUP_DIR parameter as the bup repository
+ location, instead of reading it from the $BUP_DIR
+ environment variable or using the default `~/.bup`
+ location.
+
# COMMONLY USED SUBCOMMANDS
`bup-fsck`(1)
: Print detailed help for the given command
`bup-index`(1)
: Create or display the index of files to back up
-`bup-join`(1)
-: Retrieve a file backed up using `bup-split`(1)
-`bup-ls`(1)
-: Browse the files in your backup sets
`bup-midx`(1)
: Index objects to speed up future backups
`bup-save`(1)
: Save files into a backup set (note: run "bup index" first)
-`bup-split`(1)
-: Split a single file into its own backup set
+`bup-web`(1)
+: Launch a web server to examine backup sets
# RARELY USED SUBCOMMANDS
: Recursively list files in your filesystem
`bup-init`(1)
: Initialize a bup repository
+`bup-join`(1)
+: Retrieve a file backed up using `bup-split`(1)
+`bup-ls`(1)
+: Browse the files in your backup sets
`bup-margin`(1)
: Determine how close your bup repository is to armageddon
`bup-memtest`(1)
: Generate a stream of random output
`bup-server`(1)
: The server side of the bup client-server relationship
+`bup-split`(1)
+: Split a single file into its own backup set
`bup-tick`(1)
: Wait for up to one second.
+`bup-version`(1)
+: Report the version number of your copy of bup.
# SEE ALSO
t,tree output a tree id
c,commit output a commit id
n,name= name of backup set to update (if any)
-N,noop don't actually save the data anywhere
q,quiet don't print progress messages
v,verbose increase log output (can be used more than once)
+noop don't actually save the data anywhere
copy just copy input to output, hashsplitting along the way
bench print benchmark timings to stderr
max-pack-size= maximum bytes in a single pack
projects / bup.git / commitdiff