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

NAME

6       git-annex-examinekey - prints information from a key
7

SYNOPSIS

9       git annex examinekey [key ...]
10

DESCRIPTION

12       This plumbing-level command is given a key, and prints information that
13       can be determined purely by looking at the key.
14

OPTIONS

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 (including control
24              characters) in a variable, use '${escaped_var}'
25
26              To generate a path from the top of the repository to the git-an‐
27              nex  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              The  default  output  format is the same as --format='${escaped‐
38              key}\n' except when outputting to a terminal, control characters
39              will be escaped.
40
41       --json Enable  JSON  output.  This is intended to be parsed by programs
42              that use git-annex. Each line of output is a JSON object.
43
44       --json-error-messages
45              Messages that would normally be output to standard error are in‐
46              cluded in the JSON instead.
47
48       --migrate-to-backend=backend
49              Attempt  to  migrate the input key to the new backend specified.
50              If successful, outputs information about the migrated key.  Oth‐
51              erwise, outputs information about the input key.
52
53              This  only does fast migrations; it will not re-hash the content
54              of a key or similar expensive operation.
55
56              One way to use it is to add an extension to a key.
57
58               git-annex examinekey  SHA256--xxx  --migrate-to-backend=SHA256E
59              --filename=foo.tar.gz
60
61              Or to remove the extension from a key:
62
63               git-annex   examinekey   SHA256E-xxx.tar.gz  --migrate-to-back‐
64              end=SHA256
65
66       --filename=name
67              The name of a file associated with the key, eg a work tree file.
68              It  does  not  need  to  exist.  This is needed when using --mi‐
69              grate-to-backend to add an extension to the key.
70
71       --batch
72              Enable batch mode, in which a line containing a key is read from
73              stdin, the information about it is output to stdout, and repeat.
74
75              In  order to also provide the name of a file associated with the
76              key, the line can be in the format "$key $file"
77
78       Also the git-annex-common-options(1) can be used.
79

SEE ALSO

81       git-annex(1)
82

AUTHOR

84       Joey Hess <id@joeyh.name>
85
86                                                       git-annex-examinekey(1)