1git-annex-examinekey(1) General Commands Manual git-annex-examinekey(1)
2
3
4
6 git-annex-examinekey - prints information from a key
7
9 git annex examinekey [key ...]
10
12 This plumbing-level command is given a key, and prints information that
13 can be determined purely by looking at the key.
14
16 --format=value
17
18 Use custom output formatting.
19
20 The value is a format string, in which '${var}' is expanded to
21 the value of a variable. To right-justify a variable with white‐
22 space, use '${var;width}' ; to left-justify a variable, use
23 '${var;-width}'; to escape unusual characters in a variable, use
24 '${escaped_var}'
25
26 To generate a path from the top of the repository to the git-
27 annex object for a key, use ${objectpath}. To generate the value
28 of a git-annex pointer file for a key, use ${objectpointer}.
29
30 These variables are also available for use in formats: ${key},
31 ${backend}, ${bytesize}, ${humansize}, ${keyname}, ${hashdir‐
32 lower}, ${hashdirmixed}, ${mtime} (for the mtime field of a WORM
33 key), ${file} (when a filename is provided to examinekey).
34
35 Also, '\n' is a newline, '\000' is a NULL, etc.
36
37 --json Enable JSON output. This is intended to be parsed by programs
38 that use git-annex. Each line of output is a JSON object.
39
40 --json-error-messages
41 Messages that would normally be output to standard error are
42 included in the json instead.
43
44 --migrate-to-backend=backend
45 Attempt to migrate the input key to the new backend specified.
46 If successful, outputs information about the migrated key. Oth‐
47 erwise, outputs information about the input key.
48
49 This only does fast migrations; it will not re-hash the content
50 of a key or similar expensive operation.
51
52 One way to use it is to add an extension to a key.
53
54 git-annex examinekey SHA256--xxx --migrate-to-backend=SHA256E
55 --filename=foo.tar.gz
56
57 Or to remove the extension from a key:
58
59 git-annex examinekey SHA256E-xxx.tar.gz --migrate-to-back‐
60 end=SHA256
61
62 --filename=name
63 The name of a file associated with the key, eg a work tree file.
64 It does not need to exist. This is needed when using
65 --migrate-to-backend to add an extension to the key.
66
67 --batch
68 Enable batch mode, in which a line containing a key is read from
69 stdin, the information about it is output to stdout, and repeat.
70
71 In order to also provide the name of a file associated with the
72 key, the line can be in the format "$key $file"
73
75 git-annex(1)
76
78 Joey Hess <id@joeyh.name>
79
80 git-annex-examinekey(1)