note on efficiency

This commit is contained in:
Joey Hess 2018-04-03 22:58:34 -04:00
parent 5e34570299
commit 9f33225ad0
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38

View file

@ -25,16 +25,26 @@ some file formats can be usefully streamed in this way.
# OPTIONS
* file matching options
The [[git-annex-matching-options]](1)
can be used to specify files to access.
* `[path ..]`
The files or directories whose partially downloaded content you want to
access.
Note that, when no path is specified, it defaults to all files in the
current working directory, and subdirectories, which can take a while to
traverse. It's most efficient to specify a the file you are interested
in, or to use `--all`
* `--all`
Rather than specifying a filename or path, this option can be
used to access all files that are currently being downloaded.
* file matching options
The [[git-annex-matching-options]](1)
can be used to specify files to access.
# EXIT STATUS
If any of the requested files are not currently being downloaded,