git-annex/doc/git-annex-required.mdwn
Joey Hess 7f5c6a28a6
fsck: Warn when required content is not present in the repository that requires it.
This commit was sponsored by Jack Hill on Patreon.
2018-02-08 14:08:41 -04:00

46 lines
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]] is just a preference,
[[git-annex-required]] 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.
# 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.