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

55 lines
1.3 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 prevents commands like `git annex fsck --all`
from complaining about it; `--all` will not operate on the key anymore.
(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.
* 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.