doc/git-annex-preferred-content.mdwn


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
44
45
46
47
48
49
50
51
52
53
54
55
56

# NAME

git-annex-preferred-content - 

# DESCRIPTION

Each repository has a preferred content setting, which specifies content
that the repository wants to have present. These settings can be configured
using `git annex vicfg` or `git annex wanted`.
They are used by the `--auto` option, by `git annex sync --content`,
and by the git-annex assistant.

While preferred content expresses a preference, it can be overridden
by simply using `git annex drop`. On the other hand, required content
settings are enforced; `git annex drop` will refuse to drop a file if
doing so would violate its required content settings. A repository's
required content can be configured using `git annex vicfg` or
`git annex required`.

Preferred content expressions are similar, but not identical to
the [[git-annex-matching-options]](1), just without the dashes.
For example:

	exclude=archive/* and (include=*.mp3 or smallerthan=1mb)

The main differences are that `exclude=` and `include=` always
match relative to the top of the git repository, and that there is
no equivalent to `--in`.

For more details about preferred content expressions, see
See <https://git-annex.branchable.com/preferred_content/>

When a repository is in one of the standard predefined groups, like "backup"
and "client", setting its preferred content to "standard" will use a
built-in preferred content expression developed for that group. 
See <https://git-annex.branchable.com/preferred_content/standard_groups/>

If you have set a groupwanted expression for a group, it will be used
when a repository in the group has its preferred content set to
"groupwanted".

# SEE ALSO

[[git-annex]](1)

[[git-annex-vicfg]](1)

[[git-annex-wanted]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

<http://git-annex.branchable.com/>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.