index: fix -H option

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

diff --git a/Documentation/bup-ls.md b/Documentation/bup-ls.md
index cef01be05210827d18c33ddfaf4bcd8bfb877e72..2e820d69c4cf09ca55d897b24f167a3c5cf39f58 100644 (file)
--- a/Documentation/bup-ls.md
+++ b/Documentation/bup-ls.md
@@ -8,7 +8,7 @@ bup-ls - list the contents of a bup repository
 
 # SYNOPSIS
 
-bup ls [-s] [-a] <paths...>
+bup ls [-r *host*:[*path*]] [OPTION...] \<paths...\>
 
 # DESCRIPTION
 
@@ -21,6 +21,14 @@ the `-n` option in `bup save`), the next level is the date
 of the backup, and subsequent levels correspond to files in
 the backup.
 
+When `bup ls` is asked to output on a tty, and `-l` is not specified,
+it formats the output in columns so it can list as much as possible in
+as few lines as possible. However, when `-l` is specified or bup is
+asked to output to something other than a tty (say you pipe the output
+to another command, or you redirect it to a file), it will print one
+file name per line. This makes the listing easier to parse with
+external tools.
+
 Note that `bup ls` doesn't show hidden files by default and one needs to use
 the `-a` option to show them. Files are hidden when their name begins with a
 dot. For example, on the topmost level, the special directories named `.commit`
@@ -31,21 +39,51 @@ you can view its contents using `bup join` or `git show`.
 
 # OPTIONS
 
--s, --hash
+-r, \--remote=*host*:[*path*]
+:   list information for the repository at *path* on the indicated
+    *host*.  If *path* is omitted, uses the default path on the remote
+    server (you still need to include the ':').  The connection to the
+    remote server will be made by SSH.  If you'd like to specify the
+    port, user, or private key, we recommend you use the
+    `~/.ssh/config` file (`ssh_config(5)`).
+
+-s, \--hash
 :   show hash for each file/directory.
 
--a, --all
+-a, \--all
 :   show hidden files.
 
-# EXAMPLE
+-A, \--almost-all
+:   show hidden files, except "." and "..".
+
+-d, \--directory
+:   show information about directories themselves, rather than their
+    contents, and don't follow symlinks.
+
+-l
+:   provide a detailed, long listing for each item.
+
+-F, \--classify
+:   append type indicator: dir/, symlink@, fifo|, socket=, and executable*.
+
+\--file-type
+:   append type indicator: dir/, symlink@, fifo|, socket=.
+
+\--human-readable
+:   print human readable file sizes (i.e. 3.9K, 4.7M).
+
+\--numeric-ids
+:   display numeric IDs (user, group, etc.) rather than names.
 
+# EXAMPLES
     bup ls /myserver/latest/etc/profile
 
     bup ls -a /
 
 # SEE ALSO
 
-`bup-join`(1), `bup-fuse`(1), `bup-ftp`(1), `bup-save`(1), `git-show`(1)
+`bup-join`(1), `bup-fuse`(1), `bup-ftp`(1), `bup-save`(1),
+`git-show`(1), `ssh_config`(5)
 
 # BUP