]> arthur.barton.de Git - bup.git/blobdiff - Documentation/bup-ls.md
Enable test-index-check-device test-xdev for python 3
[bup.git] / Documentation / bup-ls.md
index cc9b77409543fd93268d3efb39afbef65868f57d..2e820d69c4cf09ca55d897b24f167a3c5cf39f58 100644 (file)
@@ -8,7 +8,7 @@ bup-ls - list the contents of a bup repository
 
 # SYNOPSIS
 
-bup ls [OPTION...] \<paths...\>
+bup ls [-r *host*:[*path*]] [OPTION...] \<paths...\>
 
 # DESCRIPTION
 
@@ -39,6 +39,14 @@ you can view its contents using `bup join` or `git show`.
 
 # OPTIONS
 
+-r, \--remote=*host*:[*path*]
+:   list information for the repository at *path* on the indicated
+    *host*.  If *path* is omitted, uses the default path on the remote
+    server (you still need to include the ':').  The connection to the
+    remote server will be made by SSH.  If you'd like to specify the
+    port, user, or private key, we recommend you use the
+    `~/.ssh/config` file (`ssh_config(5)`).
+
 -s, \--hash
 :   show hash for each file/directory.
 
@@ -48,6 +56,10 @@ you can view its contents using `bup join` or `git show`.
 -A, \--almost-all
 :   show hidden files, except "." and "..".
 
+-d, \--directory
+:   show information about directories themselves, rather than their
+    contents, and don't follow symlinks.
+
 -l
 :   provide a detailed, long listing for each item.
 
@@ -63,15 +75,15 @@ you can view its contents using `bup join` or `git show`.
 \--numeric-ids
 :   display numeric IDs (user, group, etc.) rather than names.
 
-# EXAMPLE
-
+# 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)
+`bup-join`(1), `bup-fuse`(1), `bup-ftp`(1), `bup-save`(1),
+`git-show`(1), `ssh_config`(5)
 
 # BUP