1d1054faa6
Added -z option to git-annex commands that use --batch, useful for supporting filenames containing newlines. It only controls input to --batch, the output will still be line delimited unless --json or etc is used to get some other output. While git often makes -z affect both input and output, I don't like trying them together, and making it affect output would have been a significant complication, and also git-annex output is generally not intended to be machine parsed, unless using --json or a format option. Commands that take pairs like "file key" still separate them with a space in --batch mode. All such commands take care to support filenames with spaces when parsing that, so there was no need to change it, and it would have needed significant changes to the batch machinery to separate tose with a null. To make fromkey and registerurl support -z, I had to give them a --batch option. The implicit batch mode they enter when not provided with input parameters does not support -z as that would have complicated option parsing. Seemed better to move these toward using the same --batch as everything else, though the implicit batch mode can still be used. This commit was sponsored by Ole-Morten Duesund on Patreon.
124 lines
2.8 KiB
Markdown
124 lines
2.8 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.
|
|
|
|
* `--to=here`
|
|
|
|
Copy the content of files from all reachable remotes to the local
|
|
repository.
|
|
|
|
* `--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.
|
|
|
|
* `--all` `-A`
|
|
|
|
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.
|
|
|
|
* `--batch`
|
|
|
|
Enables batch mode, in which lines containing names of files to copy
|
|
are read from stdin.
|
|
|
|
As each specified file is processed, the usual progress output is
|
|
displayed. If a file's content does not need to be copied, or it does not
|
|
match specified matching options, or it is not an annexed file,
|
|
a blank line is output in response instead.
|
|
|
|
Since the usual output while copying a file is verbose and not
|
|
machine-parseable, you may want to use --json in combination with
|
|
--batch.
|
|
|
|
* `-z`
|
|
|
|
Makes the `--batch` input be delimited by nulls instead of the usual
|
|
newlines.
|
|
|
|
* `--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.
|
|
|
|
* `--json-error-messages`
|
|
|
|
Messages that would normally be output to standard error are included in
|
|
the json instead.
|
|
|
|
# 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.
|