Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Autogenerated man pages for bup-0.21-rc1

  • Loading branch information...
commit 94a131c838fd818eabc214a5bbad986765d1eedc 1 parent 239f3d8
@apenwarr apenwarr authored
View
2  bup-damage.1
@@ -1,4 +1,4 @@
-.TH bup-damage 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-damage 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-damage - randomly destroy blocks of a file
View
15 bup-drecurse.1
@@ -1,10 +1,11 @@
-.TH bup-drecurse 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-drecurse 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-drecurse - recursively list files in your filesystem
.SH SYNOPSIS
.PP
-bup drecurse [-x] [-q] [--profile] <path>
+bup drecurse [-x] [-q] [--exclude \f[I]path\f[]] [--exclude-from
+\f[I]filename\f[]] [--profile] <path>
.SH DESCRIPTION
.PP
\f[B]bup\ drecurse\f[] traverses files in the filesystem in a way
@@ -33,6 +34,16 @@ testing performance of the traversal algorithms\.
.RS
.RE
.TP
+.B --exclude=\f[I]path\f[]
+a path to exclude from the backup (can be used more than once)
+.RS
+.RE
+.TP
+.B --exclude-from=\f[I]filename\f[]
+a file that contains exclude paths (can be used more than once)
+.RS
+.RE
+.TP
.B --profile
print profiling information upon completion\. Useful when testing
performance of the traversal algorithms\.
View
2  bup-fsck.1
@@ -1,4 +1,4 @@
-.TH bup-fsck 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-fsck 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-fsck - verify or repair a bup repository
View
2  bup-ftp.1
@@ -1,4 +1,4 @@
-.TH bup-ftp 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-ftp 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-ftp - ftp-like client for navigating bup repositories
View
2  bup-fuse.1
@@ -1,4 +1,4 @@
-.TH bup-fuse 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-fuse 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-fuse - mount a bup repository as a filesystem
View
2  bup-help.1
@@ -1,4 +1,4 @@
-.TH bup-help 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-help 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-help - open the documentation for a given bup command
View
35 bup-import-rsnapshot.1
@@ -0,0 +1,35 @@
+.TH bup-import-rsnapshot 1 "2011-01-02" "Bup 0\.20-39-g2c955a0"
+.SH NAME
+.PP
+bup-import-rsnapshot - import a rsnapshot archive
+.SH SYNOPSIS
+bup import-rsnapshot [-n]
+<path to snapshot_root>
+[
+<backuptarget>
+.PP
+]
+.SH SYNOPSIS
+.PP
+\f[B]bup\ import-rsnapshot\f[] imports a 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\.
+.SH OPTIONS
+.TP
+.B -n,--dry-rung
+don\[aq]t do anything just print out what would be done
+.RS
+.RE
+.SH EXAMPLE
+.PP
+\f[CR]
+ $\ bup\ import-rsnapshot\ /\.snapshots
+\f[]
+.SH BUP
+.PP
+Part of the \f[B]bup\f[](1) suite\.
+.SH AUTHOR
+Zoran Zaric <zz@zoranzaric.de>
View
15 bup-index.1
@@ -1,11 +1,12 @@
-.TH bup-index 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-index 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.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[]] [-v] <filenames\.\.\.>
+[-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,
@@ -103,6 +104,16 @@ use a different index filename instead of
.RS
.RE
.TP
+.B --exclude=\f[I]path\f[]
+a path to exclude from the backup (can be used more than once)
+.RS
+.RE
+.TP
+.B --exclude-from=\f[I]filename\f[]
+a file that contains exclude paths (can be used more than once)
+.RS
+.RE
+.TP
.B -v, --verbose
increase log output during update (can be used more than once)\.
With one \f[B]-v\f[], print each directory as it is updated; with
View
2  bup-init.1
@@ -1,4 +1,4 @@
-.TH bup-init 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-init 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-init - initialize a bup repository
View
2  bup-join.1
@@ -1,4 +1,4 @@
-.TH bup-join 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-join 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-join - concatenate files from a bup repository
View
2  bup-ls.1
@@ -1,4 +1,4 @@
-.TH bup-ls 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-ls 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-ls - list the contents of a bup repository
View
2  bup-margin.1
@@ -1,4 +1,4 @@
-.TH bup-margin 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-margin 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-margin - figure out your deduplication safety margin
View
2  bup-memtest.1
@@ -1,4 +1,4 @@
-.TH bup-memtest 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-memtest 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-memtest - test bup memory usage statistics
View
137 bup-meta.1.1
@@ -1,137 +0,0 @@
-.TH bup-meta 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
-.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>
View
2  bup-midx.1
@@ -1,4 +1,4 @@
-.TH bup-midx 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-midx 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-midx - create a multi-index (\.midx) file from several \.idx
View
2  bup-newliner.1
@@ -1,4 +1,4 @@
-.TH bup-newliner 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-newliner 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-newliner - make sure progress messages don\[aq]t overlap with
View
2  bup-on.1
@@ -1,4 +1,4 @@
-.TH bup-on 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-on 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-on - run a bup server locally and client remotely
View
2  bup-random.1
@@ -1,4 +1,4 @@
-.TH bup-random 1 "2010-11-08" "Bup 0\.19-21-g864a45a"
+.TH bup-random 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-random - generate a stream of random output
View
2  bup-restore.1
@@ -1,4 +1,4 @@
-.TH bup-restore 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-restore 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-restore - extract files from a backup set
View
34 bup-save.1
@@ -1,11 +1,12 @@
-.TH bup-save 1 "2010-11-08" "Bup 0\.19-21-g864a45a"
+.TH bup-save 1 "2011-01-02" "Bup 0\.20-39-g2c955a0"
.SH NAME
.PP
bup-save - create a new bup backup set
.SH SYNOPSIS
.PP
bup save [-r \f[I]host\f[]:\f[I]path\f[]] <-t|-c|-n \f[I]name\f[]>
-[-v] [-q] [--smaller=\f[I]maxsize\f[]] <paths\.\.\.>
+[-f \f[I]indexfile\f[]] [-v] [-q] [--smaller=\f[I]maxsize\f[]]
+<paths\.\.\.>
.SH DESCRIPTION
.PP
\f[B]bup\ save\f[] saves the contents of the given files or paths
@@ -47,6 +48,12 @@ time\.)
.RS
.RE
.TP
+.B -f, --indexfile=\f[I]indexfile\f[]
+use a different index filename instead of
+\f[B]~/\.bup/bupindex\f[]\.
+.RS
+.RE
+.TP
.B -v, --verbose
increase verbosity (can be used more than once)\. With one -v,
prints every directory name as it gets backed up\. With two -v,
@@ -77,6 +84,29 @@ your network bandwidth\. Use a suffix like k, M, or G to specify
multiples of 1024, 1024\f[I]1024, 1024\f[]1024*1024 respectively\.
.RS
.RE
+.TP
+.B --strip
+strips the path that is given from all files and directories\.
+.RS
+.RE
+.PP
+\f[CR]
+ A\ directory\ */root/chroot/etc*\ saved\ with
+ \"bup\ save\ -n\ chroot\ --strip\ /root/chroot\"\ would\ be\ saved
+ as\ */etc*\.
+\f[]
+.TP
+.B --strip-prefix=\f[I]path-prefix\f[]
+strips the given path-prefix \f[I]path-prefix\f[] from all files
+and directories\.
+.RS
+.RE
+.PP
+\f[CR]
+ A\ directory\ */root/chroots/webserver*\ saved\ with
+ \"bup\ save\ -n\ webserver\ --strip-path=/root/chroots\"\ would
+ be\ saved\ as\ */webserver/etc*
+\f[]
.SH EXAMPLE
.PP
\f[CR]
View
2  bup-server.1
@@ -1,4 +1,4 @@
-.TH bup-server 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-server 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-server - the server side of the bup client-server relationship
View
4 bup-split.1
@@ -1,4 +1,4 @@
-.TH bup-split 1 "2010-11-08" "Bup 0\.19-21-g864a45a"
+.TH bup-split 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-split - save individual files to bup backup sets
@@ -15,7 +15,7 @@ bup split [-r \f[I]host\f[]:\f[I]path\f[]] <-b|-t|-c|-n
content into chunks of around 8k using a rolling checksum
algorithm, and saves the chunks into a bup repository\. Chunks
which have previously been stored are not stored again (ie\. they
-are \"deduplicated\")\.
+are \[aq]deduplicated\[aq])\.
.PP
Because of the way the rolling checksum works, chunks tend to be
very stable across changes to a given file, including adding,
View
43 bup-tag.1
@@ -1,21 +1,42 @@
-.TH bup-tag 1 "2010-11-08" "Bup 0\.19-23-g7e16daf"
+.TH bup-tag 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-tag - tag a commit in the bup repository
.SH SYNOPSIS
-bup tag bup tag
-<tag name> <committish>
-bup tag -d
-<tag name>
-
+.PP
+bup tag
+.PP
+bup tag <tag name> <committish>
+.PP
+bup tag -d <tag name>
.SH DESCRIPTION
.PP
\f[B]bup\ tag\f[] lists, creates or deletes a tag in the bup
repository\.
.PP
A tag is an easy way to retreive a specific commit\. It can be used
-to mark a specific backup for easier retrieval later, or to make
-one specific commit avoid automatic cleanup\.
+to mark a specific backup for easier retrieval later\.
+.PP
+When called without any arguments, the command lists all tags that
+can be found in the repository\. When called with a tag name and a
+commit ID or ref name, it creates a new tag with the given name, if
+it doesn\[aq]t already exist, that points to the commit given in
+the second argument\. When called with \[aq]-d\[aq] and a tag name,
+it removes the given tag, if it exists\.
+.PP
+bup exposes the contents of backups with current tags, via any
+command that lists or shows backups\. They can be found under the
+/\.tag directory\. For example, the \[aq]ftp\[aq] command will show
+the tag named \[aq]tag1\[aq] under /\.tag/tag1\.
+.PP
+Tags are also exposed under the branches from which they can be
+reached\. For example, if you create a tag named
+\[aq]important\[aq] under branch \[aq]computerX\[aq], you will also
+be able to retrieve the contents of the backup that was tagged
+under /computerX/important\. This is done as a convenience, and
+should the branch \[aq]computerX\[aq] be deleted, the contents of
+the tagged backup will be available through /\.tag/important as
+long as the tag is not deleted\.
.SH OPTIONS
.TP
.B -d, --delete
@@ -30,11 +51,15 @@ delete a tag
$\ bup\ tag
new-puppet-version
+ $\ bup\ ftp\ \"ls\ /\.tag/new-puppet-version\"
+ files\.\.
+
$\ bup\ tag\ -d\ new-puppet-version
\f[]
.SH SEE ALSO
.PP
-\f[B]bup-save\f[](1), \f[B]bup-split\f[](1)
+\f[B]bup-save\f[](1), \f[B]bup-split\f[](1), \f[B]bup-ftp\f[](1),
+\f[B]bup-fuse\f[](1), \f[B]bup-web\f[](1)
.SH BUP
.PP
Part of the \f[B]bup\f[](1) suite\.
View
2  bup-tick.1
@@ -1,4 +1,4 @@
-.TH bup-tick 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-tick 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-tick - wait for up to one second
View
2  bup-web.1
@@ -1,4 +1,4 @@
-.TH bup-ftp 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup-ftp 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup-web - Start web server to browse bup repositiory
View
2  bup.1
@@ -1,4 +1,4 @@
-.TH bup 1 "2010-11-03" "Bup 0\.19-34-g3694c19"
+.TH bup 1 "2011-01-02" "Bup 0\.20-32-g6eedafc"
.SH NAME
.PP
bup - Backup program using rolling checksums and git file formats
Please sign in to comment.
Something went wrong with that request. Please try again.