1git-annex-findkeys(1)       General Commands Manual      git-annex-findkeys(1)
2
3
4

NAME

6       git-annex-findkeys - lists available keys
7

SYNOPSIS

9       git annex findkeys
10

DESCRIPTION

12       Outputs a list of keys known to git-annex.
13

OPTIONS

15       matching options
16
17              The  git-annex-matching-options(1)  can be used to specify which
18              keys to list.
19
20              By default, the findkeys command only lists keys  whose  content
21              is  currently  present.  Specifying  any of the matching options
22              will override this default behavior and match on all  keys  that
23              git-annex knows about.
24
25              To list all keys, present or not, specify --anything.
26
27              To  list  keys  whose  content  is  not  present,  specify --not
28              --in=here
29
30       --print0
31              Output keys terminated with nulls, for use with xargs -0
32
33       --format=value
34              Use custom output formatting.
35
36              The value is a format string, in which '${var}' is  expanded  to
37              the value of a variable. To right-justify a variable with white‐
38              space, use '${var;width}' ;  to  left-justify  a  variable,  use
39              '${var;-width}'; to escape unusual characters (including control
40              characters) in a variable, use '${escaped_var}'
41
42              These variables are available for use in formats: key,  backend,
43              bytesize,  humansize, keyname, hashdirlower, hashdirmixed, mtime
44              (for the mtime field of a WORM key).
45
46              Also, '\n' is a newline, '\000' is a NULL, etc.
47
48              The default output format is the  same  as  --format='${escaped‐
49              key}\n' except when outputting to a terminal, control characters
50              will be escaped.
51
52       --json Output the list of keys in JSON format.
53
54              This is intended to be parsed by programs  that  use  git-annex.
55              Each line of output is a JSON object.
56
57       --json-error-messages
58              Messages that would normally be output to standard error are in‐
59              cluded in the JSON instead.
60
61       Also the git-annex-common-options(1) can be used.
62

SEE ALSO

64       git-annex(1)
65
66       git-annex-find(1)
67

AUTHOR

69       Joey Hess <id@joeyh.name>
70
71                                                         git-annex-findkeys(1)