2015-03-24 19:23:59 +00:00
|
|
|
# NAME
|
|
|
|
|
|
|
|
|
|
git-annex whereis - lists repositories that have file content
|
|
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
|
|
|
|
git annex whereis `[path ...]`
|
|
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
|
|
|
|
Displays information about where the contents of files are located.
|
|
|
|
|
|
|
|
|
|
For example:
|
|
|
|
|
|
|
|
|
|
# git annex whereis
|
|
|
|
|
whereis my_cool_big_file (1 copy)
|
|
|
|
|
0c443de8-e644-11df-acbf-f7cd7ca6210d -- laptop
|
|
|
|
|
whereis other_file (3 copies)
|
|
|
|
|
0c443de8-e644-11df-acbf-f7cd7ca6210d -- laptop
|
|
|
|
|
62b39bbe-4149-11e0-af01-bb89245a1e61 -- usb drive [here]
|
|
|
|
|
7570b02e-15e9-11e0-adf0-9f3f94cb2eaa -- backup drive
|
|
|
|
|
|
2018-09-24 15:34:39 +00:00
|
|
|
Note that this command does not contact remotes to verify if they still
|
|
|
|
|
have the content of files. It only reports on the last information that was
|
|
|
|
|
received from remotes.
|
|
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
# OPTIONS
|
|
|
|
|
|
2021-08-25 18:20:33 +00:00
|
|
|
* matching options
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
The [[git-annex-matching-options]](1)
|
2021-08-25 18:20:33 +00:00
|
|
|
can be used to control what to act on.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
2015-04-21 20:31:00 +00:00
|
|
|
* `--key=keyname`
|
|
|
|
|
|
|
|
|
|
Show where a particular git-annex key is located.
|
|
|
|
|
|
2018-04-04 03:12:04 +00:00
|
|
|
* `--all` `-A`
|
2015-04-21 20:31:00 +00:00
|
|
|
|
|
|
|
|
Show whereis information for all known keys.
|
2022-09-13 19:29:06 +00:00
|
|
|
|
|
|
|
|
(Except for keys that have been marked as dead,
|
|
|
|
|
see [[git-annex-dead]](1).)
|
2015-04-21 20:31:00 +00:00
|
|
|
|
--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`
|
|
|
|
|
|
|
|
|
|
Show whereis information for files in the specified branch or treeish.
|
|
|
|
|
|
2015-04-21 20:31:00 +00:00
|
|
|
* `--unused`
|
|
|
|
|
|
|
|
|
|
Show whereis information for files found by last run of git-annex unused.
|
|
|
|
|
|
2016-01-20 16:46:00 +00:00
|
|
|
* `--batch`
|
|
|
|
|
|
|
|
|
|
Enables batch mode, in which a file is read in a line from stdin,
|
|
|
|
|
its information displayed, and repeat.
|
|
|
|
|
|
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
|
|
|
Note that if the file is not an annexed file, or does not match
|
2021-08-25 18:20:33 +00:00
|
|
|
specified matching options, an empty line will be
|
2016-01-20 16:46:00 +00:00
|
|
|
output instead.
|
2015-04-21 20:31:00 +00:00
|
|
|
|
2021-08-25 18:20:33 +00:00
|
|
|
* `--batch-keys`
|
|
|
|
|
|
|
|
|
|
This is like `--batch` but the lines read from stdin are parsed as keys.
|
|
|
|
|
|
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`
|
|
|
|
|
|
2021-08-25 18:20:33 +00:00
|
|
|
Makes batch input be delimited by nulls instead of the usual
|
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
|
|
|
newlines.
|
|
|
|
|
|
2018-02-19 18:28:17 +00:00
|
|
|
* `--json`
|
|
|
|
|
|
|
|
|
|
Enable JSON output. This is intended to be parsed by programs that use
|
2023-04-25 21:37:34 +00:00
|
|
|
git-annex. Each line of output is a JSON object.
|
2018-02-19 18:28:17 +00:00
|
|
|
|
|
|
|
|
* `--json-error-messages`
|
|
|
|
|
|
2023-04-25 21:37:34 +00:00
|
|
|
Messages that would normally be output to standard error are included in
|
|
|
|
|
the JSON instead.
|
2018-02-19 18:28:17 +00:00
|
|
|
|
2020-05-19 20:01:02 +00:00
|
|
|
* `--format=value`
|
|
|
|
|
|
|
|
|
|
Use custom output formatting.
|
|
|
|
|
|
|
|
|
|
The value is a format string, in which '${var}' is expanded to the
|
|
|
|
|
value of a variable. To right-justify a variable with whitespace,
|
|
|
|
|
use '${var;width}' ; to left-justify a variable, use '${var;-width}';
|
2023-04-11 18:06:46 +00:00
|
|
|
to escape unusual characters (including control characters)
|
|
|
|
|
in a variable, use '${escaped_var}'
|
2020-05-19 20:01:02 +00:00
|
|
|
|
|
|
|
|
These variables are available for use in formats: file, key, uuid,
|
|
|
|
|
url, backend, bytesize, humansize, keyname, hashdirlower, hashdirmixed,
|
|
|
|
|
mtime (for the mtime field of a WORM key).
|
|
|
|
|
|
|
|
|
|
Also, '\\n' is a newline, '\\000' is a NULL, etc.
|
|
|
|
|
|
|
|
|
|
When the format contains the uuid variable, it will be expanded in turn
|
|
|
|
|
for each repository that contains the file content. For example,
|
|
|
|
|
with --format="${file} ${uuid}\\n", output will look like:
|
|
|
|
|
|
|
|
|
|
foo 00000000-0000-0000-0000-000000000001
|
|
|
|
|
foo a7f7ddd0-9a08-11ea-ab66-8358e4209d30
|
|
|
|
|
bar a7f7ddd0-9a08-11ea-ab66-8358e4209d30
|
|
|
|
|
|
|
|
|
|
The same applies when the url variable is used and a file has multiple
|
|
|
|
|
recorded urls.
|
|
|
|
|
|
2021-05-10 19:00:13 +00:00
|
|
|
* Also the [[git-annex-common-options]](1) can be used.
|
|
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
# SEE ALSO
|
|
|
|
|
|
|
|
|
|
[[git-annex]](1)
|
|
|
|
|
|
2015-05-29 16:12:55 +00:00
|
|
|
[[git-annex-find]](1)
|
|
|
|
|
|
|
|
|
|
[[git-annex-list]](1)
|
|
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
# AUTHOR
|
|
|
|
|
|
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
|
|
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|