aboutsummaryrefslogtreecommitdiff
path: root/doc/configuration/repositories/unavailable.html.part
blob: 187e7e396d041e035d75ef1809eecafd051e121f (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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->

<h1>unavailable Repository Format</h1>

<p>The <code>unavailable</code> repository format can be used to see basic information about packages that are available
in other repositories that have not been configured on this system. On Gentoo, this is used for seeing repositories
known to <code>layman</code> and <code>playman.rb</code>. On Exherbo, this is used for seeing all official and
selected unofficial repositories.</p>

<p>As well as the <a href="index.html">general keys supported for all repositories</a>, the following keys have meaning
for <code>unavailable</code> format repositories:</p>

<dl>
    <dt><code>location</code></dt>
    <dd>The location of the repository. Mandatory.</dd>

    <dt><code>name</code></dt>
    <dd>The name of the repository. Defaults to <code>unavailable</code>.</dd>

    <dt><code>sync</code></dt>
    <dd>How to sync the repository. See <a href="../syncers.html">Syncers</a> for supported formats. Optional if the
    repository does not need to be synced. Different sync URIs to use when a different suffix is requested may be
    specified, e.g. <code>sync = git+http://host/path local: git+file:///path</code>.</dd>

    <dt><code>sync_options</code></dt>
    <dd>Any options to be passed to the syncer. Optional. Options for suffixes are specified using the same format as
    for <code>sync</code>.</dd>
</dl>

<p>When used in conjunction with <a href="repository.html">repository format repositories</a>, the
<code>unavailable</code> repository format also allows automatic installation of configuration files for new repository
files.</p>

<h2>Reference Configurations</h2>

<h3>Gentoo</h3>

<p>The following makes <code>layman</code> repositories available:</p>

<pre>
format = unavailable
name = layman
location = /var/db/paludis/repositories/layman
sync = tar+http://git.exherbo.org/layman_repositories.tar.bz2
importance = -100
</pre>

<h3>Exherbo</h3>

<p>The following lists all official repositories:</p>

<pre>
format = unavailable
location = /var/db/paludis/repositories/unavailable
sync = tar+http://git.exherbo.org/exherbo_repositories.tar.bz2
importance = -100
</pre>

<p>The following lists selected unofficial repositories:</p>

<pre>
format = unavailable
name = unavailable-unofficial
location = /var/db/paludis/repositories/unavailable-unofficial
sync = tar+http://git.exherbo.org/exherbo_unofficial_repositories.tar.bz2
importance = -100
</pre>