mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
git-annex/doc/git-annex-get.mdwn

151 lines
4 KiB
Text
Raw Normal View History

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..
2015-03-23 19:36:10 +00:00
# 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.
improve documentation
2020-04-13 16:33:35 +00:00
With no parameters, gets all annexed files in the current directory whose
content was not already present. Paths of files or directories to get can
be specified.
man pages improvements Added some examples. Tightened up some language and removed some unncessary duplicate documentaton.
2020-05-12 13:07:45 +00:00
# EXAMPLES
# evince foo.pdf
error: Unable to open document foo.pdf: No such file or directory
# ls foo.pdf
foo.pdf@
# git annex get foo.pdf
get foo.pdf (from origin..) ok
# evince foo.pdf
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..
2015-03-23 19:36:10 +00:00
# OPTIONS
--auto is no longer a global option; only get, drop, and copy accept it. Not a behavior change unless you were passing it to a command that ignored it.
2015-03-25 21:06:14 +00:00
* `--auto`
--auto doc wording try to make more clear that --auto is not --all
2020-04-13 20:12:48 +00:00
Rather than getting all the specified files, get only those that don't yet
improve documentation
2020-04-13 16:33:35 +00:00
have the desired number of copies, or that are preferred content of the
--auto is no longer a global option; only get, drop, and copy accept it. Not a behavior change unless you were passing it to a command that ignored it.
2015-03-25 21:06:14 +00:00
repository. See [[git-annex-preferred-content]](1)
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..
2015-03-23 19:36:10 +00:00
* `--from=remote`
Normally git-annex will choose which remotes to get the content
document get -J's behavior of spreading load amoung same-cost remotes I implemented this last fall, but forgot to document it anywhere.
2017-03-08 18:26:29 +00:00
from, preferring remotes with lower costs. Use this option to specify
comment
2016-09-05 16:40:22 +00:00
which remote to use.
fix thru documentation
2015-05-01 18:13:30 +00:00
Any files that are not available on the remote will be silently skipped.
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..
2015-03-23 19:36:10 +00:00
get, move, copy, mirror: Concurrent downloads and uploads are now supported! This works, and seems fairly robust. Clean get of 20 files at -J3. At -J10, there are some messages about ssh multiplexing, probably due to a race spinning up the ssh connection cacher. But, it manages to get all the files ok regardless. The progress bars are a scrambled mess though, due to bugs in ascii-progress, which I've already filed. Particularly this one: https://github.com/yamadapc/haskell-ascii-progress/issues/8
2015-04-10 21:08:07 +00:00
* `--jobs=N` `-JN`
Enables parallel download with up to the specified number of jobs
running at once. For example: `-J10`
annex.jobs=cpus etc Added the ability to run one job per CPU (core), by setting annex.jobs=cpus, or using option --jobs=cpus or -Jcpus. Built with future expansion in mind, including not defaulting matching on Concurrency so more constructors can later be added, and using "cpu" instead of "0".
2019-05-10 17:24:31 +00:00
Setting this to "cpus" will run one job per CPU core.
document get -J's behavior of spreading load amoung same-cost remotes I implemented this last fall, but forgot to document it anywhere.
2017-03-08 18:26:29 +00:00
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.)
get, move, copy, mirror: Added --failed switch which retries failed copies/moves Note that get --from foo --failed will get things that a previous get --from bar tried and failed to get, etc. I considered making --failed only retry transfers from the same remote, but it was easier, and seems more useful, to not have the same remote requirement. Noisy due to some refactoring into Types/
2016-08-03 16:37:12 +00:00
* file matching options
The [[git-annex-matching-options]](1)
can be used to specify files to get.
get --incomplete: New option to resume any interrupted downloads.
2015-06-02 18:20:38 +00:00
* `--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.
document the -A shorthand for --all
2018-04-04 03:12:04 +00:00
* `--all` `-A`
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..
2015-03-23 19:36:10 +00:00
Rather than specifying a filename or path to get, this option can be
used to get all available versions of all files.
finished splitting out man pages for all commands
2015-03-25 16:09:49 +00:00
This is the default behavior when running git-annex in a bare repository.
--branch, stage 1 Added --branch option to copy, drop, fsck, get, metadata, mirror, move, and whereis commands. This option makes git-annex operate on files that are included in a specified branch (or other treeish). The names of the files from the branch that are being operated on are not displayed yet; only the keys. Displaying the filenames will need changes to every affected command. Also, note that --branch can be specified repeatedly. This is not really documented, but seemed worth supporting, especially since we may later want the ability to operate on all branches matching a refspec. However, when operating on two branches that contain the same key, that key will be operated on twice.
2016-07-20 16:05:22 +00:00
* `--branch=ref`
Operate on files in the specified branch or treeish.
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
* `--unused`
Operate on files found by last run of git-annex unused.
get, move, copy, mirror: Added --failed switch which retries failed copies/moves Note that get --from foo --failed will get things that a previous get --from bar tried and failed to get, etc. I considered making --failed only retry transfers from the same remote, but it was easier, and seems more useful, to not have the same remote requirement. Noisy due to some refactoring into Types/
2016-08-03 16:37:12 +00:00
* `--failed`
Operate on files that have recently failed to be transferred.
contrast with --incomplete
2016-08-03 17:55:09 +00:00
Not to be confused with `--incomplete` which resumes only downloads
that managed to transfer part of the content of a file.
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..
2015-03-23 19:36:10 +00:00
* `--key=keyname`
Use this option to get a specified key.
get: Add --batch and --json options.
2016-07-05 12:56:23 +00:00
* `--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
make --batch honor matching options When --batch is used with matching options like --in, --metadata, etc, only operate on the provided files when they match those options. Otherwise, a blank line is output in the batch protocol. Affected commands: find, add, whereis, drop, copy, move, get In the case of find, the documentation for --batch already said it honored the matching options. The docs for the rest didn't, but it makes sense to have them honor them. While this is a behavior change, why specify the matching options with --batch if you didn't want them to apply? Note that the batch output for all of the affected commands could already output a blank line in other cases, so batch users should already be prepared to deal with it. git-annex metadata didn't seem worth making support the matching options, since all it does is output metadata or set metadata, the use cases for using it in combination with the martching options seem small. Made it refuse to run when they're combined, leaving open the possibility for later support if a use case develops. This commit was sponsored by Brett Eisenberg on Patreon.
2018-08-08 16:03:30 +00:00
displayed. If the specified file's content is already present,
or it does not match specified matching options, or
get: Add --batch and --json options.
2016-07-05 12:56:23 +00:00
it is not an annexed file, a blank line is output in response instead.
addurl, get: Added --json-progress option, which adds progress objects to the json output. This doesn't work right when used with -J yet, and there is some really ugly hand-crafting of part of the json output.
2016-09-09 19:06:54 +00:00
Since the usual output while getting a file is verbose and not
get: Add --batch and --json options.
2016-07-05 12:56:23 +00:00
machine-parseable, you may want to use --json in combination with
--batch.
added -z 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.
2018-09-20 20:09:21 +00:00
* `-z`
Makes the `--batch` input be delimited by nulls instead of the usual
newlines.
get: Add --batch and --json options.
2016-07-05 12:56:23 +00:00
* `--json`
Enable JSON output. This is intended to be parsed by programs that use
git-annex. Each line of output is a JSON object.
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..
2015-03-23 19:36:10 +00:00
addurl, get: Added --json-progress option, which adds progress objects to the json output. This doesn't work right when used with -J yet, and there is some really ugly hand-crafting of part of the json output.
2016-09-09 19:06:54 +00:00
* `--json-progress`
Include progress objects in JSON output.
add --json-error-messages (not yet implemented) Added --json-error-messages option, which includes error messages in the json output, rather than outputting them to stderr. The actual rediretion of errors is not implemented yet, this is only the docs and option plumbing. This commit was supported by the NSF-funded DataLad project.
2018-02-19 18:28:17 +00:00
* `--json-error-messages`
better doc for --json-error-messages Word so warnings can be included, not only errors.
2018-02-19 19:33:59 +00:00
Messages that would normally be output to standard error are included in
the json instead.
add --json-error-messages (not yet implemented) Added --json-error-messages option, which includes error messages in the json output, rather than outputting them to stderr. The actual rediretion of errors is not implemented yet, this is only the docs and option plumbing. This commit was supported by the NSF-funded DataLad project.
2018-02-19 18:28:17 +00:00
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..
2015-03-23 19:36:10 +00:00
# SEE ALSO
[[git-annex]](1)
[[git-annex-drop]](1)
expand manpages cross-references significantly i found that most man pages only had references to the main git-annex manpage, which i stillfind pretty huge and hard to navigate through. i tried to sift through all the man pages and add cross-references between relevant pages. my general rule of thumb is that links should be both ways unless one of the pages is a more general page that would become ridiculously huge if all backlinks would be added (git-annex-preferred-content comes to mind). i have also make the links one per line as this is how it was done in the metadata pages so far. i did everything but the plumbing, utility and test commands, although some of those are linked from the other commands so cross-links were added there as well.
2015-05-29 16:12:55 +00:00
[[git-annex-copy]](1)
[[git-annex-move]](1)
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..
2015-03-23 19:36:10 +00:00
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
Reference in a new issue Copy permalink