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.
134 lines
3.6 KiB
Markdown
134 lines
3.6 KiB
Markdown
# NAME
|
|
|
|
git-annex get - make content of annexed files available
|
|
|
|
# SYNOPSIS
|
|
|
|
git annex get `[path ...]`
|
|
|
|
# DESCRIPTION
|
|
|
|
Makes the content of annexed files available in this repository. This
|
|
will involve copying them from a remote repository, or downloading them,
|
|
or transferring them from some kind of key-value store.
|
|
|
|
# OPTIONS
|
|
|
|
* `--auto`
|
|
|
|
Rather than getting all files, get only files that don't yet have
|
|
the desired number of copies, or that are preferred content of the
|
|
repository. See [[git-annex-preferred-content]](1)
|
|
|
|
* `--from=remote`
|
|
|
|
Normally git-annex will choose which remotes to get the content
|
|
from, preferring remotes with lower costs. Use this option to specify
|
|
which remote to use.
|
|
|
|
Any files that are not available on the remote will be silently skipped.
|
|
|
|
* `--jobs=N` `-JN`
|
|
|
|
Enables parallel download with up to the specified number of jobs
|
|
running at once. For example: `-J10`
|
|
|
|
When files can be downloaded from multiple remotes, enabling parallel
|
|
downloads will split the load between the remotes. For example, if
|
|
the files are available on remotes A and B, then one file will be
|
|
downloaded from A, and another file will be downloaded from B in
|
|
parallel. (Remotes with lower costs are still preferred over higher cost
|
|
remotes.)
|
|
|
|
* file matching options
|
|
|
|
The [[git-annex-matching-options]](1)
|
|
can be used to specify files to get.
|
|
|
|
* `--incomplete`
|
|
|
|
Resume any incomplete downloads of files that were started and
|
|
interrupted at some point previously. Useful to pick up where you left
|
|
off ... when you don't quite remember where that was.
|
|
|
|
These incomplete files are the same ones that are
|
|
listed as unused temp files by [[git-annex-unused]](1).
|
|
|
|
Note that the git-annex key will be displayed when downloading,
|
|
as git-annex does not know the associated file, and the associated file
|
|
may not even be in the current git working directory.
|
|
|
|
* `--all` `-A`
|
|
|
|
Rather than specifying a filename or path to get, this option can be
|
|
used to get 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.
|
|
|
|
Not to be confused with `--incomplete` which resumes only downloads
|
|
that managed to transfer part of the content of a file.
|
|
|
|
* `--key=keyname`
|
|
|
|
Use this option to get a specified key.
|
|
|
|
* `--batch`
|
|
|
|
Enables batch mode, in which lines containing names of files to get
|
|
are read from stdin.
|
|
|
|
As each specified file is processed, the usual progress output is
|
|
displayed. If the specified file's content is already present,
|
|
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 getting 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-drop]](1)
|
|
|
|
[[git-annex-copy]](1)
|
|
|
|
[[git-annex-move]](1)
|
|
|
|
# AUTHOR
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|