aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-sync.mdwn
blob: 1659dfb8b80b1d2ca7a162f2a468f2739ee15748 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# NAME

git-annex sync - synchronize local repository with remotes

# SYNOPSIS

git annex sync `[remote ...]`

# DESCRIPTION

Use this command when you want to synchronize the local repository with
one or more of its remotes. You can specify the remotes (or remote
groups) to sync with by name; the default if none are specified is to
sync with all remotes.

The sync process involves first committing any local changes to files
that have previously been added to the repository,
then fetching and merging the `synced/master` and the `git-annex` branch
from the remote repositories, and finally pushing the changes back to
those branches on the remote repositories. You can use standard git
commands to do each of those steps by hand, or if you don't want to
worry about the details, you can use sync.

Merge conflicts are automatically handled by sync. When two conflicting
versions of a file have been committed, both will be added to the tree,
under different filenames. For example, file "foo" would be replaced
with "foo.somekey" and "foo.otherkey".

Note that syncing with a remote will not update the remote's working
tree with changes made to the local repository. However, those changes
are pushed to the remote, so they can be merged into its working tree
by running "git annex sync" on the remote.


# OPTIONS

* `--fast`

  Only sync with the remotes with the lowest annex-cost value configured.

* `--content`

  Normally, syncing does not transfer the contents of annexed files.
  This option causes the file contents to also be uploaded and downloaded
  as necessary.  

  By default, this tries to get each annexed file that the local repository 
  does not yet have, and then copies each file to every remote that it is
  syncing with. This behavior can be overridden by configuring the preferred
  content of a repository. See [[git-annex-preferred-content]](1).

  To make two repositories have the same set of files, you should use
  [[git-annex-mirror]](1) instead of this flag.

* `--message=msg`

  Use this option to specify a commit message.

# SEE ALSO

[[git-annex]](1)

[[git-annex-preferred-content]](1)

[[git-annex-mirror]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.