Update bup repository address in Documentation/bup.md.

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

diff --git a/Documentation/bup-ls.md b/Documentation/bup-ls.md
index a8381655b7a551bacc0be9327585b15a3bc62166..443f1788f35efbe7525f9180e81b5fbeafa34c49 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 [-s] [-a] \<paths...\>
 
 # DESCRIPTION
 
@@ -16,24 +16,40 @@ 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, it formats its output
+in columns so that it can list as much as possible in as few lines
+as possible. However, when `bup ls` 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 output 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.
 
 # EXAMPLE
 
     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)