aboutsummaryrefslogtreecommitdiff
path: root/doc/index.html.part.in
blob: d9566e01251ca3101578e2405f67aa5df9c7990a (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<!-- 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.pioto.org/download/">download Paludis</a> or
        <a href="http://git.pioto.org/gitweb/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/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/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>

<p>And the old clients, which are being phased out:</p>

<ul>
    <li><a href="clients/paludis.html">paludis</a>, the original console package management client.</li>
    <li><a href="clients/importare.html">importare</a>, the unpackaged package installer.</li>
    <li><a href="clients/inquisitio.html">inquisitio</a>, the search client.</li>
    <li><a href="clients/reconcilio.html">reconcilio</a>, a tool for rebuilding packages with broken linkage.</li>
</ul>

<p>For ebuild developers and distribution maintainers:</p>

<ul>
    <li><a href="clients/accerso.html">accerso</a>, the mirror client.</li>
    <li><a href="clients/adjutrix.html">adjutrix</a>, a collection of utilities for ebuild developers and arch teams.</li>
    <li><a href="clients/instruo.html">instruo</a>, the metadata generation client.</li>
    <li><a href="clients/appareo.html">appareo</a>, a Manifest generation tool.</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>

<h2>Donating</h2>

<p>You can donate to the Paludis hosting fund with this button:</p>

<form action="https://www.paypal.com/cgi-bin/webscr" method="post">
    <div>
        <input type="hidden" name="cmd" value="_s-xclick" />
        <input type="image" src="https://www.paypal.com/en_US/i/btn/btn_donate_LG.gif" style="border: 0px solid none;" name="submit"
        alt="PayPal - The safer, easier way to pay online!" />
        <img alt="" style="border: 0px solid none;" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1" />
        <input type="hidden" name="encrypted" value="-----BEGIN PKCS7-----MIIHRwYJKoZIhvcNAQcEoIIHODCCBzQCAQExggEwMIIBLAIBADCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwDQYJKoZIhvcNAQEBBQAEgYC4giyOi5GYLxn6SMt3+32+xbJ5ynlyT5CV0DeaBcK02L6kM18Q5xOC2Pdp6eVcHcvV54TOqjf7LJFJKcsBp+fi/EV2kCAWUf5WON3tx0axBfSlNS3foy3hhep8iU4gxSD0JnfGd5vssRzi4fMFsbO58QBjAbZkrRAEDd6XVhGPxzELMAkGBSsOAwIaBQAwgcQGCSqGSIb3DQEHATAUBggqhkiG9w0DBwQIi0v/DKaNhtKAgaDJoz9NS5scsvLr3M3ittsY3eo/dqU4XitlRgPSiLGOzLUOKnALaI9SOHKV92HfIJz+sX5TH2km4Yu2dJ+zYkYlzWoeDQ5I4hQw9xIe3QYpFoZgA2Tts3y46Jf0QNesgbNZMGqEAbbmUPTz+266S/MAxTxhJmHBWG/PpdNFdGBqcN52Qt3goVEGpa3FaS9LFab6tQaL3RekLuVS5yAMfkKdoIIDhzCCA4MwggLsoAMCAQICAQAwDQYJKoZIhvcNAQEFBQAwgY4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEUMBIGA1UEChMLUGF5UGFsIEluYy4xEzARBgNVBAsUCmxpdmVfY2VydHMxETAPBgNVBAMUCGxpdmVfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tMB4XDTA0MDIxMzEwMTMxNVoXDTM1MDIxMzEwMTMxNVowgY4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEUMBIGA1UEChMLUGF5UGFsIEluYy4xEzARBgNVBAsUCmxpdmVfY2VydHMxETAPBgNVBAMUCGxpdmVfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDBR07d/ETMS1ycjtkpkvjXZe9k+6CieLuLsPumsJ7QC1odNz3sJiCbs2wC0nLE0uLGaEtXynIgRqIddYCHx88pb5HTXv4SZeuv0Rqq4+axW9PLAAATU8w04qqjaSXgbGLP3NmohqM6bV9kZZwZLR/klDaQGo1u9uDb9lr4Yn+rBQIDAQABo4HuMIHrMB0GA1UdDgQWBBSWn3y7xm8XvVk/UtcKG+wQ1mSUazCBuwYDVR0jBIGzMIGwgBSWn3y7xm8XvVk/UtcKG+wQ1mSUa6GBlKSBkTCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb22CAQAwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOBgQCBXzpWmoBa5e9fo6ujionW1hUhPkOBakTr3YCDjbYfvJEiv/2P+IobhOGJr85+XHhN0v4gUkEDI8r2/rNk1m0GA8HKddvTjyGw/XqXa+LSTlDYkqI8OwR8GEYj4efEtcRpRYBxV8KxAW93YDWzFGvruKnnLbDAF6VR5w/cCMn5hzGCAZowggGWAgEBMIGUMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbQIBADAJBgUrDgMCGgUAoF0wGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMDgwNTI1MTcyMjUxWjAjBgkqhkiG9w0BCQQxFgQUvyK45WabRuUW3h1D4GPOonGPdtwwDQYJKoZIhvcNAQEBBQAEgYB/QL6ZDhqQ4k0vkjANGxREtwu6GCxZ8slRrKhgFIUU/6dP8h3/IdWnqiVFoWiqSU7Tm1ZnBsdLFYToHWRn4Eysp0JbGNs3P3E/nv9NLuz4YK3dDELct/ENOSTrYqPuTN096tgqAhhcoegv541W3s10d8fE9K36tgU2B+GjHgMbxQ==-----END PKCS7-----
        " />
    </div>
</form>