Wrap readline oursleves to avoid py3's interference

[bup.git] / Documentation / bup-split.md

diff --git a/Documentation/bup-split.md b/Documentation/bup-split.md
index f62d72ad0387f432aac5c153fc987a449ff5ba1e..73b418d8df95b525e7d47dc9228f7925c026fec3 100644 (file)
--- a/Documentation/bup-split.md
+++ b/Documentation/bup-split.md
@@ -12,13 +12,15 @@ bup split \[-t\] \[-c\] \[-n *name*\] COMMON\_OPTIONS
 
 bup split -b COMMON\_OPTIONS
 
-bup split \<--noop \[--copy\]|--copy\> COMMON\_OPTIONS
+bup split --copy COMMON\_OPTIONS
+
+bup split --noop \[-t|-b\] COMMON\_OPTIONS
 
 COMMON\_OPTIONS
   ~ \[-r *host*:*path*\] \[-v\] \[-q\] \[-d *seconds-since-epoch*\] \[\--bench\]
     \[\--max-pack-size=*bytes*\] \[-#\] \[\--bwlimit=*bytes*\]
     \[\--max-pack-objects=*n*\] \[\--fanout=*count*\]
-    \[\--keep-boundaries\] \[--git-ids | filenames...\]
+    \[\--keep-boundaries\] \[\--git-ids | filenames...\]
 
 # DESCRIPTION
 
@@ -60,7 +62,9 @@ being the most likely choice.
     will be considered a descendant of the old *name*.
     (Thus, you can continually create new datasets with
     the same name, and later view the history of that
-    dataset to see how it has changed over time.)
+    dataset to see how it has changed over time.)  The original data
+    will also be available as a top-level file named "data" in the VFS,
+    accessible via `bup fuse`, `bup ftp`, etc.
 
 -t, \--tree
 :   output the git tree id of the resulting dataset.
@@ -74,9 +78,11 @@ being the most likely choice.
 
 \--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.  Incompatible with -n, -t,
-    -c, and -b.
+    rolling checksum algorithm, but don't store anything in the repo.
+    Can be combined with -b or -t to compute (but not store) the git
+    blobs or tree ids for the dataset. This is mostly useful for
+    benchmarking and validating the bupsplit algorithm. Incompatible
+    with -n and -c.
 
 \--copy
 :   like `--noop`, but also write the data to stdout.  This can be
@@ -146,7 +152,7 @@ being the most likely choice.
     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.
+    1024\*1024, 1024\*1024\*1024 respectively.
 
 -*#*, \--compress=*#*
 :   set the compression level to # (a value from 0-9, where
@@ -154,8 +160,8 @@ being the most likely choice.
     is 1 (fast, loose compression)
 
 
-# EXAMPLE
-    
+# EXAMPLES
+
     $ tar -cf - /etc | bup split -r myserver: -n mybackup-tar
     tar: Removing leading /' from member names
     Indexing objects: 100% (196/196), done.