Use "EXAMPLES" consistently in the manpages.

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

diff --git a/Documentation/bup-ls.md b/Documentation/bup-ls.md
index a8381655b7a551bacc0be9327585b15a3bc62166..259afec4296288565bda404048f82ca7afefd9a8 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] <paths...>
+bup ls [OPTION...] \<paths...\>
 
 # DESCRIPTION
 
@@ -16,24 +16,58 @@ bup ls [-s] <paths...>
 using the same directory hierarchy as they would have with
 `bup-fuse`(1).
 
-The top level directory is the branch (corresponding to
+The top level directory contains the branch (corresponding to
 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`
+and `.tag` are hidden directories.
+
 Once you have identified the file you want using `bup ls`,
 you can view its contents using `bup join` or `git show`.
 
 # OPTIONS
 
--s, --hash
+-s, \--hash
 :   show hash for each file/directory.
 
+-a, \--all
+:   show hidden files.
+
+-A, \--almost-all
+:   show hidden files, except "." and "..".
+
+-l
+:   provide a detailed, long listing for each item.
 
-# EXAMPLE
+-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)