git-annex/doc/git-annex-required.mdwn

44 lines
965 B
Text
Raw Normal View History

2015-04-18 20:09:09 +00:00
# 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.
2015-04-18 20:09:09 +00:00
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
2018-02-08 17:32:54 +00:00
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`.
2015-08-18 18:53:25 +00:00
# NOTES
The `required` command was added in git-annex 5.20150420.
2015-04-18 20:09:09 +00:00
# SEE ALSO
[[git-annex]](1)
[[git-annex-wanted]](1)
[[git-annex-preferred-content]](1)
2015-04-18 20:09:09 +00:00
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.