diff options
| author |  Joey Hess <joeyh@joeyh.name> | 2015-05-06 13:44:53 -0400 |
|---|---|---|
| committer | Joey Hess <joeyh@joeyh.name> | 2015-05-06 13:44:53 -0400 |
| commit | 2bbb276e38fb8503daccf7a419336d67c0a23c9c (patch) | |
| tree | d796474a8b82bc5e79ae99a40ee93fd81cdf83a7 /doc | |
| parent | 582fa3e2f10f1e1064314a8a1d9bb5aa5cf84f92 (diff) | |
contentlocation, examinekey, lookupkey: Added --batch mode option.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/git-annex-contentlocation.mdwn | 11 | ||||
| -rw-r--r-- | doc/git-annex-examinekey.mdwn | 5 | ||||
| -rw-r--r-- | doc/git-annex-lookupkey.mdwn | 10 |
3 files changed, 26 insertions, 0 deletions
diff --git a/doc/git-annex-contentlocation.mdwn b/doc/git-annex-contentlocation.mdwn index 128622bc8..a090e3754 100644 --- a/doc/git-annex-contentlocation.mdwn +++ b/doc/git-annex-contentlocation.mdwn @@ -16,6 +16,17 @@ Note that in direct mode, the file will typically be in the git work tree, and while its content should correspond to the key, the file could become modified at any time after git-annex checks it. +# OPTIONS + +* `--batch` + + Enable batch mode, in which a line containing the key is read from + stdin, the filename to its content is output to stdout (with a trailing + newline), and repeat. + + Note that if a key's content is not present, an empty line is output to + stdout instead. + # SEE ALSO [[git-annex]](1) diff --git a/doc/git-annex-examinekey.mdwn b/doc/git-annex-examinekey.mdwn index 3a8159f66..49bc95711 100644 --- a/doc/git-annex-examinekey.mdwn +++ b/doc/git-annex-examinekey.mdwn @@ -33,6 +33,11 @@ that can be determined purely by looking at the key. Enable JSON output. This is intended to be parsed by programs that use git-annex. Each line of output is a JSON object. +* `--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) diff --git a/doc/git-annex-lookupkey.mdwn b/doc/git-annex-lookupkey.mdwn index 568bbdc05..154b4a753 100644 --- a/doc/git-annex-lookupkey.mdwn +++ b/doc/git-annex-lookupkey.mdwn @@ -13,6 +13,16 @@ index. The key is output to stdout. If there is no key (because the file is not present in the index, or is not a git-annex managed file), nothing is output, and it exits nonzero. +# OPTIONS + +* `--batch` + + Enable batch mode, in which a line containing the filename is read from + stdin, the key is output to stdout (with a trailing newline), and repeat. + + Note that is there is no key corresponding to the file, an empty line is + output to stdout instead. + # SEE ALSO [[git-annex]](1) |