summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-09-18 18:24:10 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-09-18 18:24:10 -0400
commitd78b9f7d546bd4f13349e01777d5dd45fc01b0af (patch)
tree1a4e5b8e131a7132b4dcec77193854d57fdfbb1b
parentb9aa944b09e60badb99c65a87f5689e0ab9010e3 (diff)
update man page for file matching options
(--in is not yet implemented)
-rw-r--r--doc/git-annex.mdwn55
1 files changed, 48 insertions, 7 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index d587f763c..03277c6a0 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -379,13 +379,6 @@ subdirectories).
It should be specified using the name of a configured remote.
-* --exclude=glob
-
- Skips files matching the glob pattern. The glob is matched relative to
- the current directory.
-
- This option can be specified multiple times.
-
* --numcopies=n
Overrides the `annex.numcopies` setting, forcing git-annex to ensure the
@@ -415,6 +408,54 @@ subdirectories).
Used to override git configuration settings. May be specified multiple times.
+# FILE MATCHING OPTIONS
+
+These options can all be specified multiple times, and can be combined to
+limit which files git-annex acts on.
+
+Arbitrarily complicated expressions can be built using these options.
+For example:
+
+ --exclude '*.mp3' --and --not -( --in usbdrive --or --in archive -)
+
+The above example prevents git-annex from working on mp3 files whose
+file contents are present at either of two repositories.
+
+* --exclude=glob
+
+ Skips files matching the glob pattern. The glob is matched relative to
+ the current directory. For example: --exclude='*.mp3' --exclude='subdir/*'
+
+* --in=repository
+
+ Matches only files that git-annex believes have their contents present
+ in a repository.
+
+ The repository should be specified using the name of a configured remote,
+ or the UUID or description of a repository.
+
+* --not
+
+ Inverts the next file matching option. For example, to only act on
+ mp3s, use: --not --exclude='*.mp3'
+
+* --and
+
+ Requires that both the previous and the next file matching option matches.
+ The default.
+
+* --or
+
+ Requires that either the previous, or the next file matching option matches.
+
+* -(
+
+ Opens a group of file matching options.
+
+* -)
+
+ Closes a group of file matching options.
+
# CONFIGURATION
Like other git commands, git-annex is configured via `.git/config`.