summaryrefslogtreecommitdiff
path: root/doc/git-annex-find.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
commitf77d5bcc56a4692f321896dedab75c6ec32f967a (patch)
treeb57bf5d62fe1651502917f13d093ce9b4d79a6c3 /doc/git-annex-find.mdwn
parent00c09b2038611de97c26f4141a748f08cc8fe570 (diff)
finished splitting out man pages for all commands
Diffstat (limited to 'doc/git-annex-find.mdwn')
-rw-r--r--doc/git-annex-find.mdwn14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/git-annex-find.mdwn b/doc/git-annex-find.mdwn
index 3bac3f892..ce9c6326f 100644
--- a/doc/git-annex-find.mdwn
+++ b/doc/git-annex-find.mdwn
@@ -17,20 +17,30 @@ finds files in the current directory and its subdirectories.
Output filenames terminated with nulls, for use with `xargs -0`
-* `--format=fmt`
+* `--format=value`
Use custom output formatting.
- The default output format is the same as `--format='${file}\\n'`
+ The value is a format string, in which '${var}' is expanded to the
+ value of a variable. To right-justify a variable with whitespace,
+ use '${var;width}' ; to left-justify a variable, use '${var;-width}';
+ to escape unusual characters in a variable, use '${escaped_var}'
These variables are available for use in formats: file, key, backend,
bytesize, humansize, keyname, hashdirlower, hashdirmixed, mtime (for
the mtime field of a WORM key).
+ Also, '\\n' is a newline, '\\000' is a NULL, etc.
+
+ The default output format is the same as `--format='${file}\\n'`
+
* `--json`
Output the list of files in JSON format.
+ 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)