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

NAME

6       git-annex-whereis - lists repositories that have file content
7

SYNOPSIS

9       git annex whereis [path ...]
10

DESCRIPTION

12       Displays information about where the contents of files are located.
13
14       For example:
15
16        # git annex whereis
17        whereis my_cool_big_file (1 copy)
18            0c443de8-e644-11df-acbf-f7cd7ca6210d  -- laptop
19        whereis other_file (3 copies)
20            0c443de8-e644-11df-acbf-f7cd7ca6210d  -- laptop
21            62b39bbe-4149-11e0-af01-bb89245a1e61  -- usb drive [here]
22            7570b02e-15e9-11e0-adf0-9f3f94cb2eaa  -- backup drive
23
24       Note that this command does not contact remotes to verify if they still
25       have the content of files. It only reports on the last information that
26       was received from remotes.
27

OPTIONS

29       matching options
30
31              The git-annex-matching-options(1) can be used to control what to
32              act on.
33
34       --key=keyname
35              Show where a particular git-annex key is located.
36
37       --all -A
38              Show whereis information for all known keys.
39
40              (Except for keys that have been  marked  as  dead,  see  git-an‐
41              nex-dead(1).)
42
43       --branch=ref
44              Show  whereis  information  for files in the specified branch or
45              treeish.
46
47       --unused
48              Show whereis information for files found by last run of  git-an‐
49              nex unused.
50
51       --batch
52              Enables  batch  mode,  in  which  a  file is read in a line from
53              stdin, its information displayed, and repeat.
54
55              Note that if the file is not an annexed file, or does not  match
56              specified  matching  options,  an  empty line will be output in‐
57              stead.
58
59       --batch-keys
60              This is like --batch but the lines read from stdin are parsed as
61              keys.
62
63       -z     Makes  batch  input  be  delimited by nulls instead of the usual
64              newlines.
65
66       --json Enable JSON output. This is intended to be  parsed  by  programs
67              that use git-annex. Each line of output is a JSON object.
68
69       --json-error-messages
70              Messages that would normally be output to standard error are in‐
71              cluded in the JSON instead.
72
73       --format=value
74              Use custom output formatting.
75
76              The value is a format string, in which '${var}' is  expanded  to
77              the value of a variable. To right-justify a variable with white‐
78              space, use '${var;width}' ;  to  left-justify  a  variable,  use
79              '${var;-width}'; to escape unusual characters (including control
80              characters) in a variable, use '${escaped_var}'
81
82              These variables are available for use  in  formats:  file,  key,
83              uuid,  url, backend, bytesize, humansize, keyname, hashdirlower,
84              hashdirmixed, mtime (for the mtime field of a WORM key).
85
86              Also, '\n' is a newline, '\000' is a NULL, etc.
87
88              When the format contains the uuid variable, it will be  expanded
89              in  turn for each repository that contains the file content. For
90              example, with --format="${file}  ${uuid}\n",  output  will  look
91              like:
92
93               foo 00000000-0000-0000-0000-000000000001
94               foo a7f7ddd0-9a08-11ea-ab66-8358e4209d30
95               bar a7f7ddd0-9a08-11ea-ab66-8358e4209d30
96
97              The  same  applies  when the url variable is used and a file has
98              multiple recorded urls.
99
100       Also the git-annex-common-options(1) can be used.
101

SEE ALSO

103       git-annex(1)
104
105       git-annex-find(1)
106
107       git-annex-list(1)
108

AUTHOR

110       Joey Hess <id@joeyh.name>
111
112                                                          git-annex-whereis(1)