aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-info.mdwn
blob: 311edc4d94990da35a267eb95c2211ce3f0bac50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# NAME

git-annex info - shows information about the specified item or the repository as a whole

# SYNOPSIS

git annex info `[directory|file|treeish|remote|uuid ...]`

# DESCRIPTION

Displays statistics and other information for the specified item,
which can be a directory, or a file, or a treeish, or a remote,
or the uuid of a repository.
  
When no item is specified, displays statistics and information
for the repository as a whole.

# OPTIONS

* `--fast`

  Only show the data that can be gathered quickly.

* `--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.

* `--bytes`

  Show file sizes in bytes, disabling the default nicer units.

* `--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.

* 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.

# 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.