aboutsummaryrefslogtreecommitdiff
path: root/doc/configuration/repositories/unwritten.html.part
blob: e7edcf357090f40f303f0bcdefb51cb3968d8979 (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
<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->

<h1>unwritten Repository Format</h1>

<p>The <code>unwritten</code> repository format is used by Exherbo to keep track of packages that have not yet been
written. It is not used by Gentoo and derived distributions.</p>

<p>As well as the <a href="index.html">general keys supported for all repositories</a>, the following keys have meaning
for <code>unwritten</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>unwritten</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>

<h2>Reference Configurations</h2>

<h3>Exherbo</h3>

<p>The following lists all officially unwritten repositories:</p>

<pre>
format = unwritten
location = /var/db/paludis/repositories/unwritten
sync = git://git.exherbo.org/unwritten.git
importance = -100
</pre>