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

SEE ALSO

100       git-annex(1)
101
102       git-annex-find(1)
103
104       git-annex-list(1)
105

AUTHOR

107       Joey Hess <id@joeyh.name>
108
109                                                          git-annex-whereis(1)