1git-annex-find(1) General Commands Manual git-annex-find(1)
2
3
4
6 git-annex-find - lists available files
7
9 git annex find [path ...]
10
12 Outputs a list of annexed files in the specified path. With no path,
13 finds files in the current directory and its subdirectories.
14
16 matching options
17
18 The git-annex-matching-options(1) can be used to specify files
19 to list.
20
21 By default, the find command only lists annexed files whose con‐
22 tent is currently present. Specifying any of the matching op‐
23 tions will override this default behavior.
24
25 To list all annexed files, present or not, specify --include
26 "*".
27
28 To list annexed files whose content is not present, specify
29 --not --in=here
30
31 --branch=ref
32 List files in the specified branch or treeish.
33
34 --print0
35 Output filenames terminated with nulls, for use with xargs -0
36
37 --format=value
38 Use custom output formatting.
39
40 The value is a format string, in which '${var}' is expanded to
41 the value of a variable. To right-justify a variable with white‐
42 space, use '${var;width}' ; to left-justify a variable, use
43 '${var;-width}'; to escape unusual characters in a variable, use
44 '${escaped_var}'
45
46 These variables are available for use in formats: file, key,
47 backend, bytesize, humansize, keyname, hashdirlower,
48 hashdirmixed, mtime (for the mtime field of a WORM key).
49
50 Also, '\n' is a newline, '\000' is a NULL, etc.
51
52 The default output format is the same as --format='${file}\n'
53
54 --json Output the list of files in JSON format.
55
56 This is intended to be parsed by programs that use git-annex.
57 Each line of output is a JSON object.
58
59 --json-error-messages
60 Messages that would normally be output to standard error are in‐
61 cluded in the json instead.
62
63 --batch
64 Enables batch mode, in which a file is read in a line from
65 stdin, its information displayed, and repeat.
66
67 Note that if the file is not an annexed file, or is not present,
68 or otherwise doesn't meet the matching options, an empty line
69 will be output instead.
70
71 -z Makes the --batch input be delimited by nulls instead of the
72 usual newlines.
73
74 Also the git-annex-common-options(1) can be used.
75
77 git-annex(1)
78
79 git-annex-whereis(1)
80
81 git-annex-list(1)
82
84 Joey Hess <id@joeyh.name>
85
86 git-annex-find(1)