aboutsummaryrefslogtreecommitdiff
path: root/doc/index.html.part.in
blob: 3fb41e7d58601351328f7e49193077d04ead7caa (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->

<h1>Paludis</h1>

<ul>
    <li>We use <a href="http://trac.pioto.org/paludis/">Trac</a> for bug reports, feature requests etc.</li>
    <li>You are encouraged to use the <a href="http://lists.pioto.org/mailman/listinfo/paludis-user">paludis-user</a>
        mailing list, or the <code>#paludis</code> IRC channel on <code>irc.freenode.net</code>.</li>
    <li>The current version is ###PALUDIS_VERSION###. See <a href="news.html">the release notes</a> and <a
        href="changelog.html">changelog</a>.</li>
    <li>You should generally install Paludis using your distribution's package manager, rather than by hand. However, if
        you can't do that, you can <a href="http://paludis.exherbo.org/download/">download Paludis</a> or
        <a href="http://git.exherbo.org/paludis/paludis.git/">browse the source</a>.</li>
</ul>

<h2>Overview</h2>

<p>Paludis is a multi-format package manager. It can currently be used on <a href="http://www.gentoo.org/">Gentoo</a>
and derivatives, using the ebuild and VDB repository formats, and on <a href="http://www.exherbo.org/">Exherbo</a> using
the exheres repository format.</p>

<ul>
    <li><a href="overview/features.html">Features</a>: an overview of Paludis, and how it differs from its predecessor,
    Portage.</li>
    <li><a href="overview/gettingstarted.html">Getting started</a>: where to begin.</li>
    <li><a href="overview/pbins.html">Pbins</a>: how to work with binary packages.</li>
    <li><a href="overview/contact.html">Contact</a>: how to get in touch.</li>
</ul>

<h2>FAQ</h2>

<ul>
    <li><a href="faq/general.html">General questions</a> about Paludis.</li>
    <li><a href="faq/howdoi.html">How do I</a> do and use various things.</li>
    <li><a href="faq/operation.html">Operation</a> of Paludis.</li>
    <li><a href="faq/stricter.html">Stricter than Portage</a>: why certain things happen to work with Portage, but not
    Paludis.</li>
    <li><a href="faq/misfunctionality.html">Undesirable misfunctionality</a>: why Paludis doesn't do certain
    things.</li>
    <li><a href="faq/different.html">Things Paludis does differently</a>: why Paludis does some things differently.</li>
    <li><a href="faq/repositories.html">Repository questions</a>.</li>
    <li><a href="faq/upgrades.html">Upgrades, old bugs and migration</a>.</li>
</ul>

<h2>Configuration</h2>

<p>In general:</p>

<ul>
    <li><a href="configuration/hooks.html">Hooks</a>: how to execute additional code at well defined points.</li>
    <li><a href="configuration/syncers.html">Syncers</a>: options for built-in syncers, and how to implement custom sync protocols
    or override built-in syncers.</li>
    <li><a href="configuration/fetchers.html">Fetchers</a>: options for built-in fetchers, and how to implement custom URI fetching
    protocols or replace built-in fetchers.</li>
    <li><a href="configuration/envvars.html">Environment variables</a> that Paludis itself recognises.</li>
</ul>

<p>For the 'Paludis' environment:</p>

<ul>
    <li><a href="configuration/configfiles.html">Configuration file formats</a> in general, including <code>conf.d/</code> directories
    and <code>.bash</code> dynamic configuration files.</li>
    <li><a href="configuration/specs.html">Dependency specifications</a> in general.</li>
    <li><a href="configuration/specpath.html">specpath.conf</a>, and where Paludis looks for configuration files.</li>
    <li><a href="configuration/general.html">general.conf</a>: for general options.</li>
    <li><a href="configuration/keywords.html">keywords.conf or platforms.conf</a>: for keywords or platforms.</li>
    <li><a href="configuration/use.html">use.conf or options.conf</a>: for USE flags or options.</li>
    <li><a href="configuration/licenses.html">licenses.conf or licences.conf</a>: for licence filtering.</li>
    <li><a href="configuration/mirrors.html">mirrors.conf</a>: for mirrors.</li>
    <li><a href="configuration/output.html">output.conf</a>: for output configuration and logging.</li>
    <li><a href="configuration/packagemask.html">package_mask.conf and package_unmask.conf</a>: for masks.</li>
    <li><a href="configuration/bashrc.html">bashrc</a>: for package build environment options.</li>
    <li><a href="configuration/suggestions.html">suggestions.conf</a>: for suggestions.</li>
    <li><a href="configuration/sets.html">sets/*.conf</a>: for user defined package sets.</li>
    <li><a href="configuration/repositories/index.html">repositories/*.conf and repository_defaults.conf</a></li>
</ul>

<h2>Client Documentation</h2>

<p>For users:</p>

<ul>
    <li><a href="clients/cave.html">cave</a>, the new, improved and modular console package
    management client.</li>
</ul>

<h2>API Documentation</h2>

<ul>
    <li>There are <a href="api/index.html#examples">examples of how to use the API and bindings</a>.</li>
    <li>The core library code is written in <a href="api/cplusplus/index.html">C++</a>.</li>
    <li>
        <p>Bindings are available for:</p>
        <ul>
            <li><a href="api/ruby/index.html">Ruby</a></li>
            <li><a href="api/python/index.html">Python</a></li>
        </ul>
    </li>
</ul>