git-annex/doc/git-annex-dropkey.mdwn
Joey Hess 6583448bab
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 14:32:15 -04:00

46 lines
994 B
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`
Include any error messages in the json, rather than output to stderr.
# 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.