From: Gabriel Filion <lelutin@gmail.com>
Date: Sun, 9 Jan 2011 02:59:48 +0000 (-0500)
Subject: Update ls man page for new -a option
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=92ddf15b28918b0934242b9687729b3b7cd30234;p=packages%2Fb%2Fbup.git

Update ls man page for new -a option

Commit 74d28e77366dba1eefbfa2beeda34bcaa835dc58, while modifying the
default behaviour for 'bup ls', introduced a new option to obtain the
old default behaviour.

Reflect this change in the bup-ls man page.

Signed-off-by: Gabriel Filion <lelutin@gmail.com>
---

diff --git a/Documentation/bup-ls.md b/Documentation/bup-ls.md
index a838165..cef01be 100644
--- 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,11 +16,16 @@ 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.
 
+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`.
 
@@ -29,11 +34,15 @@ you can view its contents using `bup join` or `git show`.
 -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)