aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-mirror.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-23 15:36:10 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-23 15:36:10 -0400
commit90c35465528195367cc4ed1e15478285d7b063f3 (patch)
treefc658fb5d483ad673d82bfa5c3d00bc4a7c2d5ef /doc/git-annex-mirror.mdwn
parent052e77469015e82ca33733388ff5740fa06312e2 (diff)
splitting up the man page
Common command man pages all split out and often expanded. A few sections split out into their own pages. Still need to do all the other commands..
Diffstat (limited to 'doc/git-annex-mirror.mdwn')
-rw-r--r--doc/git-annex-mirror.mdwn55
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/git-annex-mirror.mdwn b/doc/git-annex-mirror.mdwn
new file mode 100644
index 000000000..ddb46e6b7
--- /dev/null
+++ b/doc/git-annex-mirror.mdwn
@@ -0,0 +1,55 @@
+# NAME
+
+git-annex mirror - mirror content of files to/from another repository
+
+# SYNOPSIS
+
+git annex mirror `[path ...] [--to=remote|--from=remote]`
+
+# DESCRIPTION
+
+This causes a destination repository to mirror a source repository.
+
+Each specified file in the source repository is mirrored to the destination
+repository. If a file's content is present in the source repository, it is
+copied to the destination repository. If a file's content is not present in
+the source repository, it will be dropped from the destination repository
+when the numcopies setting allows.
+
+Note that mirror does not sync the git repository, but only the file
+contents.
+
+# OPTIONS
+
+* `--to=remote`
+
+ Use the local repository as the source repository, and mirror its contents
+ to the remote.
+
+* `--from=remote`
+
+ Use the remote as the source repository, and mirror its contents to the local
+ repository.
+
+* `--all`
+
+ Mirror all objects stored in the git annex, not only objects used by
+ currently existing files.
+
+ However, this bypasses checking the .gitattributes annex.numcopies
+ setting when dropping files.
+
+* file matching options
+
+ The [[git-annex-matching-options]](1)
+ can be used to specify files to mirror.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.