b184fc490a
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.
49 lines
1.1 KiB
Markdown
49 lines
1.1 KiB
Markdown
# NAME
|
|
|
|
git-annex required - get or set required content expression
|
|
|
|
# SYNOPSIS
|
|
|
|
git annex required `repository [expression]`
|
|
|
|
# DESCRIPTION
|
|
|
|
When run with an expression, configures the content that is required
|
|
to be held in the archive.
|
|
|
|
For example:
|
|
|
|
git annex required . "include=*.mp3 or include=*.ogg"
|
|
|
|
Without an expression, displays the current required content setting
|
|
of the repository.
|
|
|
|
While [[git-annex-wanted]](1) is just a preference, this designates content
|
|
that should really not be removed. For example a file that is `wanted` can
|
|
be removed with `git annex drop`, but if that file is `required`, it would
|
|
need to be removed with `git annex drop --force`.
|
|
|
|
Also, `git-annex fsck` will warn about required contents that are not
|
|
present.
|
|
|
|
# OPTIONS
|
|
|
|
* The [[git-annex-common-options]](1) can be used.
|
|
|
|
# NOTES
|
|
|
|
The `required` command was added in git-annex 5.20150420.
|
|
|
|
# SEE ALSO
|
|
|
|
[[git-annex]](1)
|
|
|
|
[[git-annex-wanted]](1)
|
|
|
|
[[git-annex-preferred-content]](1)
|
|
|
|
# AUTHOR
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|