git-annex/doc/git-annex-copy.mdwn
Joey Hess 98b2917b59
document move/copy --fast and --force
There was documentation in 66285ca3d1,
but it was lost in the man page split.

I don't know if this --force is very useful. Considered removing it
instead..
2017-05-31 20:01:21 -04:00

101 lines
2.2 KiB
Markdown

# NAME
git-annex copy - copy content of files to/from another repository
# SYNOPSIS
git annex copy `[path ...] [--from=remote|--to=remote]`
# DESCRIPTION
Copies the content of files from or to another remote.
# OPTIONS
* `--from=remote`
Copy the content of files from the specified
remote to the local repository.
Any files that are not available on the remote will be silently skipped.
* `--to=remote`
Copy the content of files from the local repository
to the specified remote.
* `--jobs=N` `-JN`
Enables parallel transfers with up to the specified number of jobs
running at once. For example: `-J10`
* `--auto`
Rather than copying all files, only copy files that don't yet have
the desired number of copies, or that are preferred content of the
destination repository. See [[git-annex-preferred-content]](1)
* `--fast`
When copying content to a remote, avoid a round trip to check if the remote
already has content. This can be faster, but might skip copying content
to the remote in some cases.
* `--force`
When copying content from a remote, ignore location tracking information
and always check if the remote has content. Can be useful if the location
tracking information is out of date.
* `--all`
Rather than specifying a filename or path to copy, this option can be
used to copy all available versions of all files.
This is the default behavior when running git-annex in a bare repository.
* `--branch=ref`
Operate on files in the specified branch or treeish.
* `--unused`
Operate on files found by last run of git-annex unused.
* `--failed`
Operate on files that have recently failed to be transferred.
* `--key=keyname`
Use this option to move a specified key.
* file matching options
The [[git-annex-matching-options]](1)
can be used to specify files to copy.
* `--json`
Enable JSON output. This is intended to be parsed by programs that use
git-annex. Each line of output is a JSON object.
* `--json-progress`
Include progress objects in JSON output.
# SEE ALSO
[[git-annex]](1)
[[git-annex-get]](1)
[[git-annex-move]](1)
[[git-annex-drop]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.