git-annex/doc/git-annex-dead.mdwn
Joey Hess 365dbc89dc
expire, trust et al, dead, describe: Support --json and --json-error-messages
For expire, the normal output is unchanged, but the --json output includes the uuid
in machine parseable form. Which could be very useful for this somewhat obscure
command. That needed ActionItemUUID to be implemented, which seemed like a lot
of work, but then ---

I had been going to skip implementing them for trust, untrust, dead, semitrust,
and describe, but putting the uuid in the json is useful information, it tells
what uuid git-annex picked given the input. It was not hard to support
these once ActionItemUUID was implemented.

Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project
2023-05-05 15:33:30 -04:00

65 lines
1.5 KiB
Markdown

# NAME
git-annex dead - hide a lost repository or key
# SYNOPSIS
git annex dead `[repository ...] [--key somekey ...]`
# DESCRIPTION
This command exists to deal with situations where data has been lost,
and you know it has, and you want to stop being reminded of that fact.
When a repository is specified, indicates that the repository has
been irretrievably lost, so it will not be listed in eg, `git annex info`.
Repositories can be specified using their remote name, their
description, or their UUID. (To undo, use `git-annex semitrust`.)
When a key is specified, indicates that the content of that key has been
irretrievably lost. This makes the key be skipped when operating
on all keys with eg `--all`.
(To undo, add the key's content back to the repository,
by using eg, `git-annex reinject`.)
# OPTIONS
* `--key=somekey`
Use to specify a key that is dead.
* `--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-trust]](1)
[[git-annex-semitrust]](1)
[[git-annex-untrust]](1)
[[git-annex-renameremote]](1)
[[git-annex-expire]](1)
[[git-annex-fsck]](1)
[[git-annex-reinject]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.