diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/git-annex-find.mdwn | 29 | ||||
-rw-r--r-- | doc/git-annex-whereis.mdwn | 17 | ||||
-rw-r--r-- | doc/todo/--batch_for_find.mdwn | 2 | ||||
-rw-r--r-- | doc/todo/--batch_for_whereis.mdwn | 2 |
4 files changed, 35 insertions, 15 deletions
diff --git a/doc/git-annex-find.mdwn b/doc/git-annex-find.mdwn index 4c1501e96..9c578c245 100644 --- a/doc/git-annex-find.mdwn +++ b/doc/git-annex-find.mdwn @@ -13,6 +13,19 @@ finds files in the current directory and its subdirectories. # OPTIONS +* matching options + + The [[git-annex-matching-options]](1) + can be used to specify files to list. + + By default, the find command only lists annexed files whose content is + currently present. Specifying any of the matching options will override + this default behavior. + + To list all annexed files, present or not, specify `--include "*"`. + + To list annexed files whose content is not present, specify `--not --in=here` + * `--print0` Output filenames terminated with nulls, for use with `xargs -0` @@ -41,18 +54,14 @@ finds files in the current directory and its subdirectories. This is intended to be parsed by programs that use git-annex. Each line of output is a JSON object. -* matching options - - The [[git-annex-matching-options]](1) - can be used to specify files to list. +* `--batch` - By default, the find command only lists annexed files whose content is - currently present. Specifying any of the matching options will override - this default behavior. + Enables batch mode, in which a file is read in a line from stdin, + its information displayed, and repeat. - To list all annexed files, present or not, specify `--include "*"`. - - To list annexed files whose content is not present, specify `--not --in=here` + Note that if the file is not an annexed file, or is not present, + or otherwise doesn't meet the matching options, an empty line + will be output instead. # SEE ALSO diff --git a/doc/git-annex-whereis.mdwn b/doc/git-annex-whereis.mdwn index ed77ad7fa..4611468ba 100644 --- a/doc/git-annex-whereis.mdwn +++ b/doc/git-annex-whereis.mdwn @@ -22,11 +22,6 @@ For example: # OPTIONS -* `--json` - - Enable JSON output. This is intended to be parsed by programs that use - git-annex. Each line of output is a JSON object. - * file matching options The [[git-annex-matching-options]](1) @@ -44,6 +39,18 @@ For example: Show whereis information for files found by last run of git-annex unused. +* `--json` + + Enable JSON output. This is intended to be parsed by programs that use + git-annex. Each line of output is a JSON object. + +* `--batch` + + Enables batch mode, in which a file is read in a line from stdin, + its information displayed, and repeat. + + Note that if the file is not an annexed file, an empty line will be + output instead. # SEE ALSO diff --git a/doc/todo/--batch_for_find.mdwn b/doc/todo/--batch_for_find.mdwn index 89f6e3de5..825ca560f 100644 --- a/doc/todo/--batch_for_find.mdwn +++ b/doc/todo/--batch_for_find.mdwn @@ -1,3 +1,5 @@ I am using `annex find filename` after running 'annex add` to figure out if file was added to annex or to git. [[!meta author=yoh]] + +> [[done]] --[[Joey]] diff --git a/doc/todo/--batch_for_whereis.mdwn b/doc/todo/--batch_for_whereis.mdwn index 8a2cd22bd..11cd3e8f8 100644 --- a/doc/todo/--batch_for_whereis.mdwn +++ b/doc/todo/--batch_for_whereis.mdwn @@ -1 +1,3 @@ subject. IMHO yet another useful command to be batched + +> [[done]] --[[Joey]] |