X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=Documentation%2Fbup-ls.md;h=2e820d69c4cf09ca55d897b24f167a3c5cf39f58;hb=HEAD;hp=443f1788f35efbe7525f9180e81b5fbeafa34c49;hpb=97313e37523d18fed0be17225380b4a25d1798d0;p=bup.git diff --git a/Documentation/bup-ls.md b/Documentation/bup-ls.md index 443f178..2e820d6 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] [-a] \ +bup ls [-r *host*:[*path*]] [OPTION...] \ # DESCRIPTION @@ -21,12 +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. +When `bup ls` is asked to output on a tty, and `-l` is not specified, +it formats the output in columns so it can list as much as possible in +as few lines as possible. However, when `-l` is specified or bup 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 print 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 @@ -38,21 +39,51 @@ 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. -a, \--all : show hidden files. -# EXAMPLE +-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. + +-F, \--classify +: append type indicator: dir/, symlink@, fifo|, socket=, and executable*. + +\--file-type +: append type indicator: dir/, symlink@, fifo|, socket=. + +\--human-readable +: print human readable file sizes (i.e. 3.9K, 4.7M). + +\--numeric-ids +: display numeric IDs (user, group, etc.) rather than names. +# 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