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

44 lines
890 B
Markdown

# NAME
git-annex rekey - change keys used for files
# SYNOPSIS
git annex rekey `[file key ...]`
# DESCRIPTION
This plumbing-level command is similar to migrate, but you specify
both the file, and the new key to use for it.
Multiple pairs of file and key can be given in a single command line.
# OPTIONS
* `--force`
Allow rekeying of even files whose content is not currently available.
Use with caution.
* `--batch`
Enables batch mode, in which lines are read from stdin.
Each line should contain the file, and the new key to use for that file,
separated by a single space.
* `-z`
Makes the `--batch` input be delimited by nulls instead of the usual
newlines.
* 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.