summaryrefslogtreecommitdiff
path: root/doc/git-annex-find.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-24 15:23:59 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-24 15:23:59 -0400
commit5c8727dea29d5266de481475495eb979038bfa5a (patch)
tree2362c6ba5cd464d1e44f6a08ef4d7d034b594c75 /doc/git-annex-find.mdwn
parentd17d5a77893ac01fc7c29f92447a3e85e3501d9f (diff)
separated man pages for all the maintenance commands
Diffstat (limited to 'doc/git-annex-find.mdwn')
-rw-r--r--doc/git-annex-find.mdwn55
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/git-annex-find.mdwn b/doc/git-annex-find.mdwn
new file mode 100644
index 000000000..3bac3f892
--- /dev/null
+++ b/doc/git-annex-find.mdwn
@@ -0,0 +1,55 @@
+# NAME
+
+git-annex find - lists available files
+
+# SYNOPSIS
+
+git annex find `[path ...]`
+
+# DESCRIPTION
+
+Outputs a list of annexed files in the specified path. With no path,
+finds files in the current directory and its subdirectories.
+
+# OPTIONS
+
+* `--print0`
+
+ Output filenames terminated with nulls, for use with `xargs -0`
+
+* `--format=fmt`
+
+ Use custom output formatting.
+
+ The default output format is the same as `--format='${file}\\n'`
+
+ 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).
+
+* `--json`
+
+ Output the list of files in JSON format.
+
+* 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`
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.