af6b73a7e6
This option is not specific to sync, so it seemed it should be in either pull or push as well as sync. Since it does modify the remote, it seems better to have it in push; the modification of the local repo pulls in the direction of pull, but not hard enough. Maybe it would be better to have it in both? Sponsored-by: Luke Shumaker on Patreon
81 lines
2 KiB
Markdown
81 lines
2 KiB
Markdown
# NAME
|
|
|
|
git-annex sync - synchronize local repository with remotes
|
|
|
|
# SYNOPSIS
|
|
|
|
git annex sync `[remote ...]`
|
|
|
|
# DESCRIPTION
|
|
|
|
This command synchronizes the local repository with its remotes.
|
|
|
|
This command first commits any local changes to files that have
|
|
previously been added to the repository. Then it does the equivilant of
|
|
[[git-annex-pull]](1) followed by [[git-annex-push]](1).
|
|
|
|
However, unlike those commands, this command does not transfer annexed
|
|
content by default. This may change in a future version of git-annex.
|
|
|
|
# OPTIONS
|
|
|
|
* `--content`, `--no-content`, `-g`
|
|
|
|
The --content option causes the content of annexed files
|
|
to also be pulled and pushed.
|
|
|
|
The --no-content and -g options cause the content of annexed files to
|
|
not be pulled and pushed.
|
|
|
|
The `annex.synccontent` configuration can be set to true to make
|
|
`--content` be enabled by default.
|
|
|
|
* `--content-of=path` `-C path`
|
|
|
|
This option causes the content of annexed files in the given
|
|
path to also be pulled and pushed.
|
|
|
|
This option can be repeated multiple times with different paths.
|
|
|
|
* `--commit`, `--no-commit`
|
|
|
|
A commit is done by default (unless `annex.autocommit` is set to false).
|
|
|
|
Use --no-commit to avoid committing local changes.
|
|
|
|
* `--message=msg`
|
|
|
|
Use this option to specify a commit message.
|
|
|
|
* `--pull`, `--no-pull`
|
|
|
|
Use this option to disable pulling.
|
|
|
|
When `remote.<name>.annex-sync` is set to false, pulling is disabled
|
|
for that remote, and using `--pull` will not enable it.
|
|
|
|
* `--push`, `--no-push`
|
|
|
|
Use this option to disable pushing.
|
|
|
|
When `remote.<name>.annex-sync` is set to false, pushing is disabled for
|
|
that remote, and using `--push` will not enable it.
|
|
|
|
* Also all options supported by [[git-annex-pull]](1) and
|
|
[[git-annex-push]](1) can be used.
|
|
|
|
* Also the [[git-annex-common-options]](1) can be used.
|
|
|
|
# SEE ALSO
|
|
|
|
[[git-annex]](1)
|
|
|
|
[[git-annex-pull]](1)
|
|
|
|
[[git-annex-push]](1)
|
|
|
|
# AUTHOR
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|