Add "bup index --clear" to clear the index.

[bup.git] / Documentation / bup.md

diff --git a/Documentation/bup.md b/Documentation/bup.md
index 8def75c403712a63969397ee229bde3b3a0b75a4..746066f1752fb3e86034a61b8d4604606731266d 100644 (file)
--- a/Documentation/bup.md
+++ b/Documentation/bup.md
@@ -8,7 +8,7 @@ bup - Backup program using rolling checksums and git file formats
 
 # SYNOPSIS
 
-bup \<command\> [options...]
+bup [global options...] \<command\> [options...]
 
 # DESCRIPTION
 
@@ -24,6 +24,19 @@ using git tools.
 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)
@@ -36,16 +49,15 @@ pages.
 :   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-on`(1)
+:   Backup a remote machine to the local one
+`bup-restore`(1)
+:   Extract files from a backup set
 `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
 
@@ -55,21 +67,32 @@ pages.
 :   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)
 :   Test bup memory usage statistics
+`bup-midx`(1)
+:   Index objects to speed up future backups
 `bup-newliner`(1)
 :   Make sure progress messages don't overlap with output
 `bup-random`(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
 
 `git`(1) and the *README* file from the bup distribution.
 
-The home of bup is at <http://github.com/apenwarr/bup/>.
+The home of bup is at <http://github.com/bup/bup/>.