git-annex/doc/git-annex-checkpresentkey.mdwn
Joey Hess b184fc490a
split out common options to its own page and mention it on each subcommand page
Sometimes users would get confused because an option they were looking
for was not mentioned on a subcommand's man page, and they had not
noticed that the main git-annex man page had a list of common options.
This change lets each subcommand mention the common options, similarly
to how the matching options are handled.

This commit was sponsored by Svenne Krap on Patreon.
2021-05-10 15:00:13 -04:00

40 lines
1 KiB
Markdown

# NAME
git-annex checkpresentkey - check if key is present in remote
# SYNOPSIS
git annex checkpresentkey `key` `[remote]`
# DESCRIPTION
This plumbing-level command verifies if the specified key's content
is present in the specified remote.
When no remote is specified, it verifies if the key's content is present
in any accessible remotes.
Exits 0 if the content is verified present in the remote, or 1 if it is
verified to not be present in the remote. If there is a problem,
the special exit code 100 is used, and an error message is output to stderr.
# OPTIONS
* `--batch`
Enables batch mode. In this mode, the `key` is not specified at the
command line, but the `remote` may still be. Lines containing keys are
read from stdin, and a line is output with "1" if the key is verified to
be present, and "0" otherwise.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.