git-annex/doc/git-annex-dropkey.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

49 lines
1 KiB
Markdown

# NAME
git-annex dropkey - drops annexed content for specified keys
# SYNOPSIS
git annex dropkey `[key ...]`
# DESCRIPTION
This plumbing-level command drops the annexed data for the specified
keys from this repository.
This can be used to drop content for arbitrary keys, which do not need
to have a file in the git repository pointing at them.
Warning: This command does not check that enough other copies of the content
exist; using it can easily result in data loss.
# OPTIONS
* `--batch`
Enables batch mode, in which lines containing keys to drop are read from
stdin.
* `--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-error-messages`
Messages that would normally be output to standard error are included in
the json instead.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)
[[git-annex-setkey]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.