/[gentoo]/xml/htdocs/proj/en/glep/glep-0032.html
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0032.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 Revision 1.2
… …
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.3: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 32 -- Maildir Location</title> 12 <title>GLEP 32 -- Maildir Location</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <style type="text/css">
14
15/*
16:Author: David Goodger
17:Contact: goodger@users.sourceforge.net
18:date: $Date: 2006/10/10 20:25:14 $
19:version: $Revision: 1.2 $
20:copyright: This stylesheet has been placed in the public domain.
21
22Default cascading style sheet for the PEP HTML output of Docutils.
23*/
24
25.first {
26 margin-top: 0 }
27
28.last {
29 margin-bottom: 0 }
30
31.navigation {
32 width: 100% ;
33 background: #cc99ff ;
34 margin-top: 0px ;
35 margin-bottom: 0px }
36
37.navigation .navicon {
38 width: 150px ;
39 height: 35px }
40
41.navigation .textlinks {
42 padding-left: 1em ;
43 text-align: left }
44
45.navigation td, .navigation th {
46 padding-left: 0em ;
47 padding-right: 0em ;
48 vertical-align: middle }
49
50.rfc2822 {
51 margin-top: 0.5em ;
52 margin-left: 0.5em ;
53 margin-right: 0.5em ;
54 margin-bottom: 0em }
55
56.rfc2822 td {
57 text-align: left }
58
59.rfc2822 th.field-name {
60 text-align: right ;
61 font-family: sans-serif ;
62 padding-right: 0.5em ;
63 font-weight: bold ;
64 margin-bottom: 0em }
65
66a.toc-backref {
67 text-decoration: none ;
68 color: black }
69
70body {
71 margin: 0px ;
72 margin-bottom: 1em ;
73 padding: 0px }
74
75dd {
76 margin-bottom: 0.5em }
77
78div.section {
79 margin-left: 1em ;
80 margin-right: 1em ;
81 margin-bottom: 1.5em }
82
83div.section div.section {
84 margin-left: 0em ;
85 margin-right: 0em ;
86 margin-top: 1.5em }
87
88div.abstract {
89 margin: 2em 5em }
90
91div.abstract p.topic-title {
92 font-weight: bold ;
93 text-align: center }
94
95div.attention, div.caution, div.danger, div.error, div.hint,
96div.important, div.note, div.tip, div.warning {
97 margin: 2em ;
98 border: medium outset ;
99 padding: 1em }
100
101div.attention p.admonition-title, div.caution p.admonition-title,
102div.danger p.admonition-title, div.error p.admonition-title,
103div.warning p.admonition-title {
104 color: red ;
105 font-weight: bold ;
106 font-family: sans-serif }
107
108div.hint p.admonition-title, div.important p.admonition-title,
109div.note p.admonition-title, div.tip p.admonition-title {
110 font-weight: bold ;
111 font-family: sans-serif }
112
113div.figure {
114 margin-left: 2em }
115
116div.footer, div.header {
117 font-size: smaller }
118
119div.footer {
120 margin-left: 1em ;
121 margin-right: 1em }
122
123div.system-messages {
124 margin: 5em }
125
126div.system-messages h1 {
127 color: red }
128
129div.system-message {
130 border: medium outset ;
131 padding: 1em }
132
133div.system-message p.system-message-title {
134 color: red ;
135 font-weight: bold }
136
137div.topic {
138 margin: 2em }
139
140h1 {
141 font-family: sans-serif ;
142 font-size: large }
143
144h2 {
145 font-family: sans-serif ;
146 font-size: medium }
147
148h3 {
149 font-family: sans-serif ;
150 font-size: small }
151
152h4 {
153 font-family: sans-serif ;
154 font-style: italic ;
155 font-size: small }
156
157h5 {
158 font-family: sans-serif;
159 font-size: x-small }
160
161h6 {
162 font-family: sans-serif;
163 font-style: italic ;
164 font-size: x-small }
165
166.section hr {
167 width: 75% }
168
169ol.simple, ul.simple {
170 margin-bottom: 1em }
171
172ol.arabic {
173 list-style: decimal }
174
175ol.loweralpha {
176 list-style: lower-alpha }
177
178ol.upperalpha {
179 list-style: upper-alpha }
180
181ol.lowerroman {
182 list-style: lower-roman }
183
184ol.upperroman {
185 list-style: upper-roman }
186
187p.caption {
188 font-style: italic }
189
190p.credits {
191 font-style: italic ;
192 font-size: smaller }
193
194p.label {
195 white-space: nowrap }
196
197p.topic-title {
198 font-family: sans-serif ;
199 font-weight: bold }
200
201pre.line-block {
202 font-family: serif ;
203 font-size: 100% }
204
205pre.literal-block, pre.doctest-block {
206 margin-left: 2em ;
207 margin-right: 2em ;
208 background-color: #eeeeee }
209
210span.classifier {
211 font-family: sans-serif ;
212 font-style: oblique }
213
214span.classifier-delimiter {
215 font-family: sans-serif ;
216 font-weight: bold }
217
218span.interpreted {
219 font-family: sans-serif }
220
221span.option-argument {
222 font-style: italic }
223
224span.pre {
225 white-space: pre }
226
227span.problematic {
228 color: red }
229
230table {
231 margin-top: 0.5em ;
232 margin-bottom: 0.5em }
233
234td, th {
235 padding-left: 0.5em ;
236 padding-right: 0.5em ;
237 vertical-align: top }
238
239td.num {
240 text-align: right }
241
242th.field-name {
243 font-weight: bold ;
244 text-align: left ;
245 white-space: nowrap }
246
247h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248 font-size: 100% }
249
250tt {
251 background-color: #eeeeee }
252
253ul.auto-toc {
254 list-style-type: none }
255
256</style>
14</head> 257</head>
15<body bgcolor="white"> 258<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 259<table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0"> 260 width="100%" border="0">
18<tr><td class="navicon" width="150" height="35"> 261<tr><td class="navicon" width="150" height="35">
19<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 262<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 263<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 264 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 265<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 266[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] 267[<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>]
25[<b><a href="./glep-0032.txt">GLEP Source</a></b>] 268[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0032.txt">GLEP Source</a></b>]
26</td></tr></table> 269</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 270<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 271<col class="field-name" />
30<col class="field-body" /> 272<col class="field-body" />
31<tbody valign="top"> 273<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">32</td> 274<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">32</td>
33</tr> 275</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Maildir Location</td> 276<tr class="field"><th class="field-name">Title:</th><td class="field-body">Maildir Location</td>
35</tr> 277</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 278<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td>
37</tr> 279</tr>
38<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0032.txt?cvsroot=gentoo">2004/11/03 23:38:05</a></td> 280<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0032.txt?cvsroot=gentoo">2004/11/03 23:38:05</a></td>
39</tr> 281</tr>
40<tr class="field"><th class="field-name">Author:</th><td class="field-body">Georgi Georgiev &lt;chutz&#32;&#97;t&#32;gg3.net&gt;</td> 282<tr class="field"><th class="field-name">Author:</th><td class="field-body">Georgi Georgiev &lt;chutz&#32;&#97;t&#32;gg3.net&gt;</td>
41</tr> 283</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 284<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
43</tr> 285</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 286<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45</tr> 287</tr>
46<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td> 288<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
47</tr> 289</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">03-Nov-2004</td> 290<tr class="field"><th class="field-name">Created:</th><td class="field-body">03-Nov-2004</td>
49</tr> 291</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">03-Nov-2004</td> 292<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">03-Nov-2004</td>
51</tr> 293</tr>
52</tbody> 294</tbody>
53</table> 295</table>
54<hr /> 296<hr />
55<div class="contents topic" id="contents"> 297<div class="contents topic">
56<p class="topic-title first"><a name="contents">Contents</a></p> 298<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
57<ul class="simple"> 299<ul class="simple">
58<li><a class="reference" href="#abstract" id="id4" name="id4">Abstract</a></li> 300<li><a class="reference" href="#abstract" id="id4" name="id4">Abstract</a></li>
59<li><a class="reference" href="#motivation" id="id5" name="id5">Motivation</a></li> 301<li><a class="reference" href="#motivation" id="id5" name="id5">Motivation</a></li>
60<li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li> 302<li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li>
61<li><a class="reference" href="#implementation" id="id7" name="id7">Implementation</a><ul> 303<li><a class="reference" href="#implementation" id="id7" name="id7">Implementation</a><ul>
… …
67<li><a class="reference" href="#backwards-compatibility" id="id11" name="id11">Backwards Compatibility</a></li> 309<li><a class="reference" href="#backwards-compatibility" id="id11" name="id11">Backwards Compatibility</a></li>
68<li><a class="reference" href="#references" id="id12" name="id12">References</a></li> 310<li><a class="reference" href="#references" id="id12" name="id12">References</a></li>
69<li><a class="reference" href="#copyright" id="id13" name="id13">Copyright</a></li> 311<li><a class="reference" href="#copyright" id="id13" name="id13">Copyright</a></li>
70</ul> 312</ul>
71</div> 313</div>
72<div class="section" id="abstract"> 314<div class="section">
73<h1><a class="toc-backref" href="#id4" name="abstract">Abstract</a></h1> 315<h1><a class="toc-backref" href="#id4" id="abstract" name="abstract">Abstract</a></h1>
74<p>Ebuilds that install mail delivery agents often need to know the default 316<p>Ebuilds that install mail delivery agents often need to know the default
75location of users' mailbox. When the mailbox is of a maildir type, there is no 317location of users' mailbox. When the mailbox is of a maildir type, there is no
76set standard what the name of the directory should be. The most popular 318set standard what the name of the directory should be. The most popular
77extensions are &quot;Maildir&quot;, &quot;.Maildir&quot; and Gentoo has adopted its own &quot;.maildir&quot; 319extensions are &quot;Maildir&quot;, &quot;.Maildir&quot; and Gentoo has adopted its own &quot;.maildir&quot;
78name.</p> 320name.</p>
79<p>This GLEP proposes a user-definable maildir location.</p> 321<p>This GLEP proposes a user-definable maildir location.</p>
80</div> 322</div>
81<div class="section" id="motivation"> 323<div class="section">
82<h1><a class="toc-backref" href="#id5" name="motivation">Motivation</a></h1> 324<h1><a class="toc-backref" href="#id5" id="motivation" name="motivation">Motivation</a></h1>
83<p>To provide the means to change the default location of a maildir, that is 325<p>To provide the means to change the default location of a maildir, that is
84currently hardcoded in ebuilds.</p> 326currently hardcoded in ebuilds.</p>
85<p>The &quot;.maildir&quot; name is not adequate for most situations.</p> 327<p>The &quot;.maildir&quot; name is not adequate for most situations.</p>
86<ul class="simple"> 328<ul class="simple">
87<li>&quot;Maildir&quot; is the defacto standard name for maildir mailboxes.</li> 329<li>&quot;Maildir&quot; is the defacto standard name for maildir mailboxes.</li>
… …
91dedicated for e-mail delivery is not a plus.</li> 333dedicated for e-mail delivery is not a plus.</li>
92<li>All postfix and qmail related documentation gives &quot;Maildir&quot; as an example 334<li>All postfix and qmail related documentation gives &quot;Maildir&quot; as an example
93name.</li> 335name.</li>
94</ul> 336</ul>
95</div> 337</div>
96<div class="section" id="rationale"> 338<div class="section">
97<h1><a class="toc-backref" href="#id6" name="rationale">Rationale</a></h1> 339<h1><a class="toc-backref" href="#id6" id="rationale" name="rationale">Rationale</a></h1>
98<p>The following comments were made in a discussion <a class="footnote-reference" href="#bugreport" id="id1" name="id1">[1]</a> on the Gentoo 340<p>The following comments were made in a discussion <a class="footnote-reference" href="#bugreport" id="id1" name="id1">[1]</a> on the Gentoo
99bugzilla</p> 341bugzilla</p>
100<ul class="simple"> 342<ul class="simple">
101<li>The default location should be specified in <tt class="literal"><span class="pre">rc.conf</span></tt></li> 343<li>The default location should be specified in <tt class="docutils literal"><span class="pre">rc.conf</span></tt></li>
102<li>Preventing users from shooting themselves in the foot is not an issue</li> 344<li>Preventing users from shooting themselves in the foot is not an issue</li>
103</ul> 345</ul>
104</div> 346</div>
105<div class="section" id="implementation"> 347<div class="section">
106<h1><a class="toc-backref" href="#id7" name="implementation">Implementation</a></h1> 348<h1><a class="toc-backref" href="#id7" id="implementation" name="implementation">Implementation</a></h1>
107<p>A <tt class="literal"><span class="pre">maildir.eclass</span></tt> has been submitted to Bug 52076 <a class="footnote-reference" href="#bugreport" id="id2" name="id2">[1]</a>.</p> 349<p>A <tt class="docutils literal"><span class="pre">maildir.eclass</span></tt> has been submitted to Bug 52076 <a class="footnote-reference" href="#bugreport" id="id2" name="id2">[1]</a>.</p>
108<p>Patches that implement features similar to this GLEP have already been 350<p>Patches that implement features similar to this GLEP have already been
109submitted to Bug 52076 <a class="footnote-reference" href="#bugreport" id="id3" name="id3">[1]</a>.</p> 351submitted to Bug 52076 <a class="footnote-reference" href="#bugreport" id="id3" name="id3">[1]</a>.</p>
110<div class="section" id="maildir-variable"> 352<div class="section">
111<h2><a class="toc-backref" href="#id8" name="maildir-variable">MAILDIR variable</a></h2> 353<h2><a class="toc-backref" href="#id8" id="maildir-variable" name="maildir-variable">MAILDIR variable</a></h2>
112<p>The default location for maildir delivery is specified by the <tt class="literal"><span class="pre">$MAILDIR</span></tt> 354<p>The default location for maildir delivery is specified by the <tt class="docutils literal"><span class="pre">$MAILDIR</span></tt>
113variable. This variable is specified in <tt class="literal"><span class="pre">rc.conf</span></tt>.</p> 355variable. This variable is specified in <tt class="docutils literal"><span class="pre">rc.conf</span></tt>.</p>
114</div> 356</div>
115<div class="section" id="maildir-eclass"> 357<div class="section">
116<h2><a class="toc-backref" href="#id9" name="maildir-eclass">maildir.eclass</a></h2> 358<h2><a class="toc-backref" href="#id9" id="maildir-eclass" name="maildir-eclass">maildir.eclass</a></h2>
117<p>This eclass exports a <tt class="literal"><span class="pre">$MAILDIR</span></tt> variable to the ebuilds that inherit it. If 359<p>This eclass exports a <tt class="docutils literal"><span class="pre">$MAILDIR</span></tt> variable to the ebuilds that inherit it. If
118<tt class="literal"><span class="pre">$MAILDIR</span></tt> has not been specified in <tt class="literal"><span class="pre">rc.conf</span></tt> the eclass exports 360<tt class="docutils literal"><span class="pre">$MAILDIR</span></tt> has not been specified in <tt class="docutils literal"><span class="pre">rc.conf</span></tt> the eclass exports
119<tt class="literal"><span class="pre">MAILDIR=.maildir</span></tt> for backwards compatibility reasons.</p> 361<tt class="docutils literal"><span class="pre">MAILDIR=.maildir</span></tt> for backwards compatibility reasons.</p>
120</div> 362</div>
121<div class="section" id="patching-ebuilds"> 363<div class="section">
122<h2><a class="toc-backref" href="#id10" name="patching-ebuilds">Patching ebuilds</a></h2> 364<h2><a class="toc-backref" href="#id10" id="patching-ebuilds" name="patching-ebuilds">Patching ebuilds</a></h2>
123<p>Since most ebuilds that currently need to know what the maildir delivery 365<p>Since most ebuilds that currently need to know what the maildir delivery
124location is already take the default <tt class="literal"><span class="pre">.maildir</span></tt> location into account when 366location is already take the default <tt class="docutils literal"><span class="pre">.maildir</span></tt> location into account when
125installing, modifying ebuilds to implement this GLEP is as simple as 367installing, modifying ebuilds to implement this GLEP is as simple as
126inheriting the <tt class="literal"><span class="pre">maildir.eclass</span></tt> and substituting <tt class="literal"><span class="pre">.maildir</span></tt> in the ebuild 368inheriting the <tt class="docutils literal"><span class="pre">maildir.eclass</span></tt> and substituting <tt class="docutils literal"><span class="pre">.maildir</span></tt> in the ebuild
127with the <tt class="literal"><span class="pre">$MAILDIR</span></tt> variable. Care should be taken, to also modify any 369with the <tt class="docutils literal"><span class="pre">$MAILDIR</span></tt> variable. Care should be taken, to also modify any
128patches or scripts that are used by the ebuild, that already have <tt class="literal"><span class="pre">.maildir</span></tt> 370patches or scripts that are used by the ebuild, that already have <tt class="docutils literal"><span class="pre">.maildir</span></tt>
129hardcoded (vpopmail, exim).</p> 371hardcoded (vpopmail, exim).</p>
130</div> 372</div>
131</div> 373</div>
132<div class="section" id="backwards-compatibility"> 374<div class="section">
133<h1><a class="toc-backref" href="#id11" name="backwards-compatibility">Backwards Compatibility</a></h1> 375<h1><a class="toc-backref" href="#id11" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
134<p>The default location is &quot;.maildir&quot;, unless it is overridden. This way, there 376<p>The default location is &quot;.maildir&quot;, unless it is overridden. This way, there
135would be no backwards compatibility issues.</p> 377would be no backwards compatibility issues.</p>
136</div> 378</div>
137<div class="section" id="references"> 379<div class="section">
138<h1><a class="toc-backref" href="#id12" name="references">References</a></h1> 380<h1><a class="toc-backref" href="#id12" id="references" name="references">References</a></h1>
139<table class="footnote" frame="void" id="bugreport" rules="none"> 381<table class="docutils footnote" frame="void" id="bugreport" rules="none">
140<colgroup><col class="label" /><col /></colgroup> 382<colgroup><col class="label" /><col /></colgroup>
141<tbody valign="top"> 383<tbody valign="top">
142<tr><td class="label"><a name="bugreport">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>)</em> Bug 52076 (<a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=52076">http://bugs.gentoo.org/show_bug.cgi?id=52076</a>)</td></tr> 384<tr><td class="label"><a name="bugreport">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>)</em> Bug 52076 (<a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=52076">http://bugs.gentoo.org/show_bug.cgi?id=52076</a>)</td></tr>
143</tbody> 385</tbody>
144</table> 386</table>
145</div> 387</div>
146<div class="section" id="copyright"> 388<div class="section">
147<h1><a class="toc-backref" href="#id13" name="copyright">Copyright</a></h1> 389<h1><a class="toc-backref" href="#id13" id="copyright" name="copyright">Copyright</a></h1>
148<p>This document has been placed in the public domain.</p> 390<p>This document has been placed in the public domain.</p>
149</div> 391</div>
150</div>
151 392
393</div>
394<div class="footer">
152<hr class="footer" /> 395<hr class="footer" />
153<div class="footer">
154<a class="reference" href="glep-0032.txt">View document source</a>. 396<a class="reference" href="glep-0032.txt">View document source</a>.
155Generated on: 2004-11-03 23:31 UTC. 397Generated on: 2006-10-10 20:23 UTC.
156Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. 398Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
399
157</div> 400</div>
158</body> 401</body>
159</html> 402</html>
160 403
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
  ViewVC Help
Powered by ViewVC 1.1.20