ftp/ls: Adjust documentation

Now that 'bup ftp ls' and 'bup ls' have the same features, adjust both
commands' man pages.

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

diff --git a/Documentation/bup-ftp.md b/Documentation/bup-ftp.md
index 817332010c406a85bb427526938dca067d0f6d32..a6117cc31c79c5352c445fac4b12c428583b3621 100644 (file)
--- a/Documentation/bup-ftp.md
+++ b/Documentation/bup-ftp.md
@@ -27,10 +27,13 @@ lot of typing.
 
 The following commands are available inside `bup ftp`:
 
-ls [-a]
-:   print the contents of the current working directory. 
+ls [-s] [-a] [*path*]
+:   print the contents of a directory. If no path argument
+    is given, the current directory's contents are listed.
     If -a is given, also include hidden files (files which
-    start with a `.` character).
+    start with a `.` character). If -s is given, each file
+    is displayed with its hash from the bup archive to its
+    left.
 
 cd *dirname*
 :   change to a different working directory

diff --git a/Documentation/bup-ls.md b/Documentation/bup-ls.md
index cef01be05210827d18c33ddfaf4bcd8bfb877e72..ed07ca64a1b61853e57d351950b06da4d4732312 100644 (file)
--- a/Documentation/bup-ls.md
+++ b/Documentation/bup-ls.md
@@ -21,6 +21,13 @@ 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`