8211f6bb87
I understand and sympathize with why this was added here, but the fact is that this kind of warning is clutter that is going to make it harder to understand this man page overall; this is not the place to document internal implementation details of the format of URL keys and more than it would be the place to document how WORM keys mangle and truncate filenames, or how the extension of a SHAnE key is chosen. I see that it did get documented better in backends.mdwn, which is a good place to document it. The chance that someone is going to have the same misunderstanding and happen to see this warning does not justify confusing everyone else with a warning that is really out of place in this documentation.
61 lines
1.5 KiB
Markdown
61 lines
1.5 KiB
Markdown
# NAME
|
|
|
|
git-annex examinekey - prints information from a key
|
|
|
|
# SYNOPSIS
|
|
|
|
git annex examinekey `[key ...]`
|
|
|
|
# DESCRIPTION
|
|
|
|
This plumbing-level command is given a key, and prints information
|
|
that can be determined purely by looking at the key.
|
|
|
|
# OPTIONS
|
|
|
|
* `--format=value`
|
|
|
|
Use custom output formatting.
|
|
|
|
The value is a format string, in which '${var}' is expanded to the
|
|
value of a variable. To right-justify a variable with whitespace,
|
|
use '${var;width}' ; to left-justify a variable, use '${var;-width}';
|
|
to escape unusual characters in a variable, use '${escaped_var}'
|
|
|
|
These variables are available for use in formats: key, backend,
|
|
bytesize, humansize, keyname, hashdirlower, hashdirmixed, mtime (for
|
|
the mtime field of a WORM key).
|
|
|
|
Also, '\\n' is a newline, '\\000' is a NULL, etc.
|
|
|
|
* `--json`
|
|
|
|
Enable JSON output. This is intended to be parsed by programs that use
|
|
git-annex. Each line of output is a JSON object.
|
|
|
|
* `--json-error-messages`
|
|
|
|
Messages that would normally be output to standard error are included in
|
|
the json instead.
|
|
|
|
* `--batch`
|
|
|
|
Enable batch mode, in which a line containing a key is read from stdin,
|
|
the information about it is output to stdout, and repeat.
|
|
|
|
# EXAMPLES
|
|
|
|
The location a key's value is stored (in indirect mode)
|
|
can be looked up by running:
|
|
|
|
git annex examinekey $KEY --format='.git/annex/objects/${hashdirmixed}${key}/${key}'
|
|
|
|
# SEE ALSO
|
|
|
|
[[git-annex]](1)
|
|
|
|
# AUTHOR
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|