diff options
author | Joey Hess <joeyh@joeyh.name> | 2015-03-23 15:36:10 -0400 |
---|---|---|
committer | Joey Hess <joeyh@joeyh.name> | 2015-03-23 15:36:10 -0400 |
commit | 90c35465528195367cc4ed1e15478285d7b063f3 (patch) | |
tree | fc658fb5d483ad673d82bfa5c3d00bc4a7c2d5ef /doc/git-annex-sync.mdwn | |
parent | 052e77469015e82ca33733388ff5740fa06312e2 (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-sync.mdwn')
-rw-r--r-- | doc/git-annex-sync.mdwn | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/doc/git-annex-sync.mdwn b/doc/git-annex-sync.mdwn new file mode 100644 index 000000000..fa539d8bc --- /dev/null +++ b/doc/git-annex-sync.mdwn @@ -0,0 +1,64 @@ +# 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) + +* `--message=msg` + + Use this option to specify a commit message. + +# SEE ALSO + +[[git-annex]](1) + +# AUTHOR + +Joey Hess <id@joeyh.name> + +Warning: Automatically converted into a man page by mdwn2man. Edit with care. |