.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
.SH "SYNOPSIS"
List snapshot contents\.
.P
\fBbupstash list\-contents [OPTIONS] QUERY\|\.\|\.\|\.\fR
.SH "DESCRIPTION"
\fBbupstash list\-contents\fR lists the contents of the item matching the given query\.
.P
Items created by using \fBbupstash put\fR on a directory will have an associated index, other items are not listable\.
.SH "OUTPUT FORMATS"
.SS "Human"
When \fB\-\-format\fR is set to \fBhuman\fR, \fBbupstash list\-contents\fR outputs aligned rows consisting of:
.IP "" 4
.nf
PERMS SIZE YYYY/MM/DD HH:MM:SS PATH\|\.\|\.\|\.
.fi
.IP "" 0
.P
The included date is the time of the last change to a given file as reported by the operating system at the time of the snapshot\.
.P
Prefer using one of the versioned machine readable formats when writing scripts\.
.SS "JSONl1"
When \fB\-\-format\fR is set to \fBjsonl1\fR, \fBbupstash list\-contents\fR outputs one json object per line\.
.P
Each line has the following json schema:
.IP "" 4
.nf
{
  "path": string | [ bytes\|\.\|\.\|\. ],
  "mode": number,
  "size": number,
  "uid": number,
  "gid": number,
  "mtime": number,
  "mtime_nsec": number,
  "ctime": number,
  "ctime_nsec": number,
  "norm_dev": number,
  "ino": number,
  "nlink": number,
  "link_target": string | null,
  "dev_major": number | null,
  "dev_minor": number | null,
  "xattrs": {string : string | [bytes\|\.\|\.\|\.] \|\.\|\.\|\.} | null,
  "sparse": boolean,
  "data_hash": "$KIND[:$HEXBYTE]" | null
}
.fi
.IP "" 0
.SH "QUERY LANGUAGE"
For full documentation on the query language, see bupstash\-query\-language(7)\.
.SH "QUERY CACHING"
The list\-contents command uses the same query caching mechanisms as bupstash\-list(1), check that page for more information on the query cache\.
.SH "OPTIONS"
.TP
\-r, \-\-repository REPO
The repository to connect to, , may be of the form \fBssh://$SERVER/$PATH\fR for remote repositories if ssh access is configured\. If not specified, is set to \fBBUPSTASH_REPOSITORY\fR\.
.TP
\-k, \-\-key KEY
Key used to decrypt data and metadata\. If not set, defaults to \fBBUPSTASH_KEY\fR\.
.TP
\-\-format FORMAT
Set output format to one of the following 'human', 'jsonl'\.
.TP
\-\-query\-cache PATH
Path to the query\-cache file, defaults to one of the following, in order, provided the appropriate environment variables are set, \fB$BUPSTASH_QUERY_CACHE\fR, \fB$XDG_CACHE_HOME/\.cache/bupstash/bupstash\.qcache\fR or \fB$HOME/\.cache/bupstash/bupstash\.qcache\fR\.
.TP
\-\-pick PATH
List a sub\-directory of the query\.
.TP
\-\-utc\-timestamps
Display and search against timestamps in utc time instead of local time\.
.TP
\-q, \-\-quiet
Be quiet, implies \-\-no\-progress\.
.SH "ENVIRONMENT"
.TP
BUPSTASH_REPOSITORY
The repository to connect to\. May be of the form \fBssh://$SERVER/$PATH\fR for remote repositories if ssh access is configured\.
.TP
BUPSTASH_REPOSITORY_COMMAND
A command to run to connect to an instance of bupstash\-serve(1)\. This allows more complex connections to the repository for less common use cases\.
.TP
BUPSTASH_KEY
Path to a primary key that will be used for decrypting data and metadata\.
.TP
BUPSTASH_KEY_COMMAND
A command to run that must print the key data, can be used instead of BUPSTASH_KEY to fetch the key from arbitrary locations such as the network or other secret storage\.
.TP
BUPSTASH_QUERY_CACHE
Path to the query cache file to use\.
.SH "EXAMPLES"
.SS "Get an item with a specific id from the repository"
.nf
$ bupstash list\-contents id="14eb*"
drwxr\-xr\-x 0     2020/10/30 13:32:04 \.
\-rw\-r\-\-r\-\- 1967  2020/10/30 13:32:04 data\.txt
.fi
.SH "SEE ALSO"
bupstash(1), bupstash\-put(1), bupstash\-diff(1), bupstash\-keyfiles(7), bupstash\-query\-language(7)