aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-required.mdwn
blob: 81bfd956e5b46e29a932d91e7665e48ae5ca6cd6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# 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`.

# 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.