2015-03-24 19:23:59 +00:00
|
|
|
# NAME
|
|
|
|
|
|
2019-01-16 18:16:10 +00:00
|
|
|
git-annex info - information about an item or the repository
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
2019-03-28 17:21:37 +00:00
|
|
|
git annex info `[directory|file|treeish|remote|description|uuid ...]`
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
|
|
|
|
Displays statistics and other information for the specified item,
|
2016-09-15 16:51:00 +00:00
|
|
|
which can be a directory, or a file, or a treeish, or a remote,
|
2019-03-28 17:21:37 +00:00
|
|
|
or the description or uuid of a repository.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
When no item is specified, displays statistics and information
|
2019-03-28 17:25:14 +00:00
|
|
|
for the local repository and all known annexed files.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
# OPTIONS
|
|
|
|
|
|
|
|
|
|
* `--fast`
|
|
|
|
|
|
|
|
|
|
Only show the data that can be gathered quickly.
|
|
|
|
|
|
|
|
|
|
* `--json`
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Enable JSON output. This is intended to be parsed by programs that use
|
|
|
|
|
git-annex. Each line of output is a JSON object.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
2018-02-19 18:28:17 +00:00
|
|
|
* `--json-error-messages`
|
|
|
|
|
|
2018-02-19 19:33:59 +00:00
|
|
|
Messages that would normally be output to standard error are included in
|
|
|
|
|
the json instead.
|
2018-02-19 18:28:17 +00:00
|
|
|
|
2015-04-12 18:08:40 +00:00
|
|
|
* `--bytes`
|
|
|
|
|
|
|
|
|
|
Show file sizes in bytes, disabling the default nicer units.
|
|
|
|
|
|
2016-01-15 19:56:47 +00:00
|
|
|
* `--batch`
|
|
|
|
|
|
|
|
|
|
Enable batch mode, in which a line containing an item is read from stdin,
|
|
|
|
|
the information about it is output to stdout, and repeat.
|
|
|
|
|
|
added -z
Added -z option to git-annex commands that use --batch, useful for
supporting filenames containing newlines.
It only controls input to --batch, the output will still be line delimited
unless --json or etc is used to get some other output. While git often
makes -z affect both input and output, I don't like trying them together,
and making it affect output would have been a significant complication,
and also git-annex output is generally not intended to be machine parsed,
unless using --json or a format option.
Commands that take pairs like "file key" still separate them with a space
in --batch mode. All such commands take care to support filenames with
spaces when parsing that, so there was no need to change it, and it would
have needed significant changes to the batch machinery to separate tose
with a null.
To make fromkey and registerurl support -z, I had to give them a --batch
option. The implicit batch mode they enter when not provided with input
parameters does not support -z as that would have complicated option
parsing. Seemed better to move these toward using the same --batch as
everything else, though the implicit batch mode can still be used.
This commit was sponsored by Ole-Morten Duesund on Patreon.
2018-09-20 20:09:21 +00:00
|
|
|
* `-z`
|
|
|
|
|
|
|
|
|
|
Makes the `--batch` input be delimited by nulls instead of the usual
|
|
|
|
|
newlines.
|
|
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
* file matching options
|
|
|
|
|
|
|
|
|
|
When a directory is specified, the [[git-annex-matching-options]](1)
|
|
|
|
|
can be used to select the files in the directory that are included
|
|
|
|
|
in the statistics.
|
|
|
|
|
|
2021-05-10 19:00:13 +00:00
|
|
|
* Also the [[git-annex-common-options]](1) can be used.
|
|
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
# EXAMPLES
|
|
|
|
|
|
|
|
|
|
Suppose you want to run "git annex get .", but
|
|
|
|
|
would first like to see how much disk space that will use.
|
|
|
|
|
Then run:
|
|
|
|
|
|
|
|
|
|
git annex info --fast . --not --in here
|
|
|
|
|
|
|
|
|
|
# SEE ALSO
|
|
|
|
|
|
|
|
|
|
[[git-annex]](1)
|
|
|
|
|
|
|
|
|
|
# AUTHOR
|
|
|
|
|
|
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
|
|
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|