aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-find.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2016-01-20 13:04:07 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2016-01-20 13:04:07 -0400
commit91c9f6f086cf6d503c3ecb10a211c0c946e554eb (patch)
treea4e5409d432176937b326f6bf9056c440c40dee1 /doc/git-annex-find.mdwn
parentc48b1434d1443ea1421fa474a6a5aecbf60ac83a (diff)
find --batch
Diffstat (limited to 'doc/git-annex-find.mdwn')
-rw-r--r--doc/git-annex-find.mdwn29
1 files changed, 19 insertions, 10 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