Permalink
Browse files

Autogenerated man pages for bup-0.24b

  • Loading branch information...
1 parent cc1ec17 commit 1783a571c62816277ce0eaff97246ae895c9713e @apenwarr committed Apr 6, 2011
Showing with 263 additions and 38 deletions.
  1. +59 −0 bup-bloom.1
  2. +13 −2 bup-daemon.1
  3. +1 −1 bup-damage.1
  4. +1 −1 bup-drecurse.1
  5. +1 −1 bup-fsck.1
  6. +1 −1 bup-ftp.1
  7. +1 −1 bup-fuse.1
  8. +1 −1 bup-help.1
  9. +7 −5 bup-import-rsnapshot.1
  10. +16 −7 bup-index.1
  11. +1 −1 bup-init.1
  12. +1 −1 bup-join.1
  13. +1 −1 bup-ls.1
  14. +1 −1 bup-margin.1
  15. +1 −1 bup-memtest.1
  16. +137 −0 bup-meta.1
  17. +8 −1 bup-midx.1
  18. +1 −1 bup-mux.1
  19. +1 −1 bup-newliner.1
  20. +1 −1 bup-on.1
  21. +1 −1 bup-random.1
  22. +1 −1 bup-restore.1
  23. +1 −1 bup-save.1
  24. +1 −1 bup-server.1
  25. +1 −1 bup-split.1
  26. +1 −1 bup-tag.1
  27. +1 −1 bup-tick.1
  28. +1 −1 bup-web.1
  29. +1 −1 bup.1
View
@@ -0,0 +1,59 @@
+.TH bup-bloom 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
+.SH NAME
+.PP
+bup-bloom - generates, regenerates, updates bloom filters
+.SH SYNOPSIS
+.PP
+bup bloom [-d dir] [-o outfile] [-k hashes] [-c idxfile] [-f]
+[--ruin]
+.SH DESCRIPTION
+.PP
+\f[B]bup\ bloom\f[] builds a bloom filter file for a bup
+repository\. If one already exists, it checks the filter and
+updates or regenerates it as needed\.
+.SH OPTIONS
+.TP
+.B --ruin
+destroy bloom filters by setting the whole bitmask to zeros\. you
+really want to know what you are doing if run this and you want to
+delete the resulting bloom when you are done with it\.
+.RS
+.RE
+.TP
+.B -f, --force
+don\[aq]t update the existing bloom file; generate a new one from
+scratch\.
+.RS
+.RE
+.TP
+.B -d, --dir=\f[I]directory\f[]
+the directory, containing \.idx files, to process\. Defaults to
+$BUP_DIR/objects/pack
+.RS
+.RE
+.TP
+.B -o, --outfile=\f[I]outfile\f[]
+the file to write the bloom filter to\. defaults to $dir/bup\.bloom
+.RS
+.RE
+.TP
+.B -k, --hashes=\f[I]hashes\f[]
+number of hash functions to use only 4 and 5 are valid\. defaults
+to 5 for repositories < 2 TiB, or 4 otherwise\. See comments in
+git\.py for more on this value\.
+.RS
+.RE
+.TP
+.B -c, --check=\f[I]idxfile\f[]
+checks the bloom file (counterintuitively outfile) against the
+specified \.idx file, first checks that the bloom filter is
+claiming to contain the \.idx, then checks that it does actually
+contain all of the objects in the \.idx\. Does not write anything
+and ignores the \f[B]-k\f[] option\.
+.RS
+.RE
+.SH BUP
+.PP
+Part of the \f[B]bup\f[](1) suite\.
+.SH AUTHOR
+Brandon Low <lostlogic@lostlogicx.com>
View
@@ -1,15 +1,26 @@
-.TH bup-daemon 1 "2011-02-01" "Bup 0\.22"
+.TH bup-daemon 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-daemon - listens for connections and runs \f[B]bup\ server\f[]
.SH SYNOPSIS
.PP
-bup daemon
+bup daemon [-l address] [-p port]
.SH DESCRIPTION
.PP
\f[B]bup\ daemon\f[] is a simple bup server which listens on a
socket and forks connections to \f[B]bup\ mux\ server\f[]
children\.
+.SH OPTIONS
+.TP
+.B -l, --listen=\f[I]address\f[]
+the address or hostname to listen on
+.RS
+.RE
+.TP
+.B -p, --port=\f[I]port\f[]
+the port to listen on
+.RS
+.RE
.SH BUP
.PP
Part of the \f[B]bup\f[](1) suite\.
View
@@ -1,4 +1,4 @@
-.TH bup-damage 1 "2011-02-01" "Bup 0\.22"
+.TH bup-damage 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-damage - randomly destroy blocks of a file
View
@@ -1,4 +1,4 @@
-.TH bup-drecurse 1 "2011-02-01" "Bup 0\.22"
+.TH bup-drecurse 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-drecurse - recursively list files in your filesystem
View
@@ -1,4 +1,4 @@
-.TH bup-fsck 1 "2011-02-01" "Bup 0\.22"
+.TH bup-fsck 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-fsck - verify or repair a bup repository
View
@@ -1,4 +1,4 @@
-.TH bup-ftp 1 "2011-02-01" "Bup 0\.22"
+.TH bup-ftp 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-ftp - ftp-like client for navigating bup repositories
View
@@ -1,4 +1,4 @@
-.TH bup-fuse 1 "2011-02-01" "Bup 0\.22"
+.TH bup-fuse 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-fuse - mount a bup repository as a filesystem
View
@@ -1,4 +1,4 @@
-.TH bup-help 1 "2011-02-01" "Bup 0\.22"
+.TH bup-help 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-help - open the documentation for a given bup command
View
@@ -1,4 +1,4 @@
-.TH bup-import-rsnapshot 1 "2011-02-01" "Bup 0\.22"
+.TH bup-import-rsnapshot 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-import-rsnapshot - import a rsnapshot archive
@@ -11,22 +11,24 @@ bup import-rsnapshot [-n]
]
.SH SYNOPSIS
.PP
-\f[B]bup\ import-rsnapshot\f[] imports a rsnapshot archive\. The
+\f[B]bup\ import-rsnapshot\f[] imports an rsnapshot archive\. The
timestamps for the backups are preserved and the path to the
rsnapshot archive is stripped from the paths\.
.PP
\f[B]bup\ import-rsnapshot\f[] either imports the whole archive or
-only imports all backups for a given backuptarget\.
+imports all backups only for a given backuptarget\.
.SH OPTIONS
.TP
-.B -n,--dry-rung
+.B -n,--dry-run
don\[aq]t do anything just print out what would be done
.RS
.RE
-.SH EXAMPLE
+.SH EXAMPLES
.PP
\f[CR]
$\ bup\ import-rsnapshot\ /\.snapshots
+
+ $\ bup\ import-rsnapshot\ /\.snapshots\ host1
\f[]
.SH BUP
.PP
View
@@ -1,12 +1,13 @@
-.TH bup-index 1 "2011-02-01" "Bup 0\.22"
+.TH bup-index 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-index - print and/or update the bup filesystem index
.SH SYNOPSIS
.PP
-bup index <-p|-m|-u> [-s] [-H] [-l] [-x] [--fake-valid] [--check]
-[-f \f[I]indexfile\f[]] [--exclude \f[I]path\f[]] [--exclude-from
-\f[I]filename\f[]] [-v] <filenames\.\.\.>
+bup index <-p|-m|-s|-u> [-H] [-l] [-x] [--fake-valid]
+[--fake-invalid] [--check] [-f \f[I]indexfile\f[]] [--exclude
+\f[I]path\f[]] [--exclude-from \f[I]filename\f[]] [-v]
+<filenames\.\.\.>
.SH DESCRIPTION
.PP
\f[B]bup\ index\f[] prints and/or updates the bup filesystem index,
@@ -32,11 +33,12 @@ re-generating the list of files for each backup set\.
You may want to use the data tracked by bup index for other
purposes (such as speeding up other programs that need the same
information)\.
-.SH OPTIONS
+.SH MODES
.TP
.B -u, --update
-(recursively) update the index for the given filenames and their
-descendants\. One or more filenames must be given\.
+recursively update the index for the given filenames and their
+descendants\. One or more filenames must be given\. If no mode
+option is given, this is the default\.
.RS
.RE
.TP
@@ -60,6 +62,7 @@ marked in the index as added, modified, deleted, or unchanged since
the last backup\.
.RS
.RE
+.SH OPTIONS
.TP
.B -H, --hash
for each file printed, prepend the most recently recorded hash
@@ -92,6 +95,12 @@ up files that you know are boring\.
.RS
.RE
.TP
+.B --fake-invalid
+mark specified filenames as not up-to-date, forcing the next \"bup
+save\" run to re-check their contents\.
+.RS
+.RE
+.TP
.B --check
carefully check index file integrity before and after updating\.
Mostly useful for automated tests\.
View
@@ -1,4 +1,4 @@
-.TH bup-init 1 "2011-02-01" "Bup 0\.22"
+.TH bup-init 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-init - initialize a bup repository
View
@@ -1,4 +1,4 @@
-.TH bup-join 1 "2011-02-01" "Bup 0\.22"
+.TH bup-join 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-join - concatenate files from a bup repository
View
@@ -1,4 +1,4 @@
-.TH bup-ls 1 "2011-02-01" "Bup 0\.22"
+.TH bup-ls 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-ls - list the contents of a bup repository
View
@@ -1,4 +1,4 @@
-.TH bup-margin 1 "2011-02-01" "Bup 0\.22"
+.TH bup-margin 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-margin - figure out your deduplication safety margin
View
@@ -1,4 +1,4 @@
-.TH bup-memtest 1 "2011-02-01" "Bup 0\.22"
+.TH bup-memtest 1 "2011-03-01" "Bup 0\.24-83-gdfa9d85"
.SH NAME
.PP
bup-memtest - test bup memory usage statistics
View
@@ -0,0 +1,137 @@
+.TH bup-meta 1 "2011-03-20" "Bup 0\.24b-75-gb4ae447"
+.SH NAME
+.PP
+bup-meta - create or extract a metadata archive
+.SH SYNOPSIS
+.PP
+bup meta --create ~ [-R] [-v] [-q] [--no-symlinks] [--no-paths] [-f
+\f[I]file\f[]] <\f[I]paths\f[]\.\.\.>
+.PP
+bup meta --list ~ [-v] [-q] [-f \f[I]file\f[]]
+.PP
+bup meta --extract ~ [-v] [-q] [--numeric-ids] [--no-symlinks] [-f
+\f[I]file\f[]]
+.PP
+bup meta --start-extract ~ [-v] [-q] [--numeric-ids]
+[--no-symlinks] [-f \f[I]file\f[]]
+.PP
+bup meta --finish-extract ~ [-v] [-q] [--numeric-ids] [-f
+\f[I]file\f[]]
+.SH DESCRIPTION
+.PP
+\f[B]bup\ meta\f[] either creates or extracts a metadata archive\.
+A metadata archive contains the metadata information (timestamps,
+ownership, access permissions, etc\.) for a set of filesystem
+paths\.
+.SH OPTIONS
+.TP
+.B -c, --create
+Create a metadata archive for the specified \f[I]path\f[]s\. Write
+the archive to standard output unless \f[B]--file\f[] is
+specified\.
+.RS
+.RE
+.TP
+.B -t, --list
+Display information about the metadata in an archive\. Read the
+archive from standard output unless \f[B]--file\f[] is specified\.
+.RS
+.RE
+.TP
+.B -x, --extract
+Extract a metadata archive\. Conceptually, perform
+\f[B]--start-extract\f[] followed by \f[B]--finish-extract\f[]\.
+Read the archive from standard input unless \f[B]--file\f[] is
+specified\.
+.RS
+.RE
+.TP
+.B --start-extract
+Build a filesystem tree matching the paths stored in a metadata
+archive\. By itself, this command does not produce a full
+restoration of the metadata\. For a full restoration, this command
+must be followed by a call to \f[B]--finish-extract\f[]\. Once this
+command has finished, all of the normal files described by the
+metadata will exist and be empty\. Restoring the data in those
+files, and then calling \f[B]--finish-extract\f[] should restore
+the original tree\. The archive will be read from standard input
+unless \f[B]--file\f[] is specified\.
+.RS
+.RE
+.TP
+.B --finish-extract
+Finish applying the metadata stored in an archive to the
+filesystem\. Normally, this command should follow a call to
+\f[B]--start-extract\f[]\. The archive will be read from standard
+input unless \f[B]--file\f[] is specified\.
+.RS
+.RE
+.TP
+.B -f, --file=\f[I]filename\f[]
+Read the metadata archive from \f[I]filename\f[] or write it to
+\f[I]filename\f[] as appropriate\. If \f[I]filename\f[] is \"-\",
+then read from standard input or write to standard output\.
+.RS
+.RE
+.TP
+.B -R, --recurse
+Recursively descend into subdirectories during \f[B]--create\f[]\.
+.RS
+.RE
+.TP
+.B --numeric-ids
+Apply numeric user and group IDs (rather than text IDs) during
+\f[B]--extract\f[] or \f[B]--finish-extract\f[]\.
+.RS
+.RE
+.TP
+.B --symlinks
+Record symbolic link targets when creating an archive, or restore
+symbolic links when extracting an archive (during
+\f[B]--extract\f[] or \f[B]--start-extract\f[])\. This option is
+enabled by default\. Specify \f[B]--no-symlinks\f[] to disable it\.
+.RS
+.RE
+.TP
+.B --paths
+Record pathnames when creating an archive\. This option is enabled
+by default\. Specify \f[B]--no-paths\f[] to disable it\.
+.RS
+.RE
+.TP
+.B -v, --verbose
+Be more verbose (can be used more than once)\.
+.RS
+.RE
+.TP
+.B -q, --quiet
+Be quiet\.
+.RS
+.RE
+.SH EXAMPLES
+.PP
+\f[CR]
+ #\ Create\ a\ metadata\ archive\ for\ /etc\.
+ $\ bup\ meta\ -cRf\ etc\.meta\ /etc
+ bup:\ removing\ leading\ \"/\"\ from\ \"/etc\"
+
+ #\ Extract\ the\ etc\.meta\ archive\ (files\ will\ be\ empty)\.
+ $\ mkdir\ tmp\ &&\ cd\ tmp
+ $\ bup\ meta\ -xf\ \.\./etc\.meta
+ $\ ls
+ etc
+
+ #\ Restore\ /etc\ completely\.
+ $\ mkdir\ tmp\ &&\ cd\ tmp
+ $\ bup\ meta\ \\-\\-start-extract\ -f\ \.\./etc\.meta
+ \.\.\.fill\ in\ all\ regular\ file\ contents\ using\ some\ other\ tool\.\.\.
+ $\ bup\ meta\ \\-\\-finish-extract\ -f\ \.\./etc\.meta
+\f[]
+.SH BUGS
+.PP
+Hard links are not handled yet\.
+.SH BUP
+.PP
+Part of the \f[B]bup\f[](1) suite\.
+.SH AUTHOR
+Rob Browning <rlb@defaultvalue.org>
Oops, something went wrong.

0 comments on commit 1783a57

Please sign in to comment.