]> arthur.barton.de Git - bup.git/blobdiff - Documentation/bup-ls.md
Documentation/bup-save.md: change --strip-prefix to --strip-path.
[bup.git] / Documentation / bup-ls.md
index cef01be05210827d18c33ddfaf4bcd8bfb877e72..ed07ca64a1b61853e57d351950b06da4d4732312 100644 (file)
@@ -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`