1# NAME
2
3git-annex mirror - mirror content of files to/from another repository
4
5# SYNOPSIS
6
7git annex mirror `[path ...] [--to=remote|--from=remote]`
8
9# DESCRIPTION
10
11This causes a destination repository to mirror a source repository.
12
13Each specified file in the source repository is mirrored to the destination
14repository. If a file's content is present in the source repository, it is
15copied to the destination repository. If a file's content is not present in
16the source repository, it will be dropped from the destination repository
17when the numcopies setting allows.
18
19Note that mirror does not sync the git repository, but only the file
20contents. Use [[git-annex-sync]](1) for that.
21
22# OPTIONS
23
24* `--to=remote`
25
26  Use the local repository as the source repository, and mirror its contents
27  to the remote.
28
29* `--from=remote`
30
31  Use the remote as the source repository, and mirror its contents to the local
32  repository.
33
34* `--jobs=N` `-JN`
35
36  Enables parallel transfers with up to the specified number of jobs
37  running at once. For example: `-J10`
38
39  Setting this to "cpus" will run one job per CPU core.
40
41* `--all` `-A`
42
43  Mirror all objects stored in the git annex, not only objects used by
44  currently existing files.
45
46  However, this bypasses checking the .gitattributes annex.numcopies
47  setting when dropping files.
48
49  This is the default behavior when running git-annex in a bare repository.
50
51* `--branch=ref`
52
53  Operate on files in the specified branch or treeish.
54
55  Like --all, this bypasses checking the .gitattributes annex.numcopies
56  setting when dropping files.
57
58* `--unused`
59
60  Operate on files found by last run of git-annex unused.
61
62* `--failed`
63
64  Operate on files that have recently failed to be transferred.
65
66* matching options
67
68  The [[git-annex-matching-options]](1)
69  can be used to control what to mirror.
70
71* `--json`
72
73  Enable JSON output. This is intended to be parsed by programs that use
74  git-annex. Each line of output is a JSON object.
75
76* `--json-progress`
77
78  Include progress objects in JSON output.
79
80* `--json-error-messages`
81
82  Messages that would normally be output to standard error are included in
83  the json instead.
84
85* Also the [[git-annex-common-options]](1) can be used.
86
87# SEE ALSO
88
89[[git-annex]](1)
90
91[[git-annex-sync]](1)
92
93# AUTHOR
94
95Joey Hess <id@joeyh.name>
96
97Warning: Automatically converted into a man page by mdwn2man. Edit with care.
98