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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations) (download) (as text)
Wed Nov 3 23:38:53 2004 UTC (9 years, 5 months ago) by g2boojum
Branch: MAIN
File MIME type: text/html
new glep

1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <!--
5 This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
6 PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
8 -->
9 <head>
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/" />
12 <title>GLEP 32 -- Maildir Location</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14 </head>
15 <body bgcolor="white">
16 <table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0">
18 <tr><td class="navicon" width="150" height="35">
19 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td>
22 <td class="textlinks" align="left">
23 [<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>]
25 [<b><a href="./glep-0032.txt">GLEP Source</a></b>]
26 </td></tr></table>
27 <div class="document">
28 <table class="rfc2822 field-list" frame="void" rules="none">
29 <col class="field-name" />
30 <col class="field-body" />
31 <tbody valign="top">
32 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">32</td>
33 </tr>
34 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Maildir Location</td>
35 </tr>
36 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td>
37 </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>
39 </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>
41 </tr>
42 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
43 </tr>
44 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45 </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>
47 </tr>
48 <tr class="field"><th class="field-name">Created:</th><td class="field-body">03-Nov-2004</td>
49 </tr>
50 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">03-Nov-2004</td>
51 </tr>
52 </tbody>
53 </table>
54 <hr />
55 <div class="contents topic" id="contents">
56 <p class="topic-title first"><a name="contents">Contents</a></p>
57 <ul class="simple">
58 <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>
60 <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>
62 <li><a class="reference" href="#maildir-variable" id="id8" name="id8">MAILDIR variable</a></li>
63 <li><a class="reference" href="#maildir-eclass" id="id9" name="id9">maildir.eclass</a></li>
64 <li><a class="reference" href="#patching-ebuilds" id="id10" name="id10">Patching ebuilds</a></li>
65 </ul>
66 </li>
67 <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>
69 <li><a class="reference" href="#copyright" id="id13" name="id13">Copyright</a></li>
70 </ul>
71 </div>
72 <div class="section" id="abstract">
73 <h1><a class="toc-backref" href="#id4" name="abstract">Abstract</a></h1>
74 <p>Ebuilds that install mail delivery agents often need to know the default
75 location of users' mailbox. When the mailbox is of a maildir type, there is no
76 set standard what the name of the directory should be. The most popular
77 extensions are &quot;Maildir&quot;, &quot;.Maildir&quot; and Gentoo has adopted its own &quot;.maildir&quot;
78 name.</p>
79 <p>This GLEP proposes a user-definable maildir location.</p>
80 </div>
81 <div class="section" id="motivation">
82 <h1><a class="toc-backref" href="#id5" name="motivation">Motivation</a></h1>
83 <p>To provide the means to change the default location of a maildir, that is
84 currently hardcoded in ebuilds.</p>
85 <p>The &quot;.maildir&quot; name is not adequate for most situations.</p>
86 <ul class="simple">
87 <li>&quot;Maildir&quot; is the defacto standard name for maildir mailboxes.</li>
88 <li>People transferring e-mail configuration from other systems prefer to keep
89 the original naming conventions.</li>
90 <li>In a virtual hosting environment, having a hidden file in a directory
91 dedicated for e-mail delivery is not a plus.</li>
92 <li>All postfix and qmail related documentation gives &quot;Maildir&quot; as an example
93 name.</li>
94 </ul>
95 </div>
96 <div class="section" id="rationale">
97 <h1><a class="toc-backref" href="#id6" 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
99 bugzilla</p>
100 <ul class="simple">
101 <li>The default location should be specified in <tt class="literal"><span class="pre">rc.conf</span></tt></li>
102 <li>Preventing users from shooting themselves in the foot is not an issue</li>
103 </ul>
104 </div>
105 <div class="section" id="implementation">
106 <h1><a class="toc-backref" href="#id7" 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>
108 <p>Patches that implement features similar to this GLEP have already been
109 submitted to Bug 52076 <a class="footnote-reference" href="#bugreport" id="id3" name="id3">[1]</a>.</p>
110 <div class="section" id="maildir-variable">
111 <h2><a class="toc-backref" href="#id8" 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>
113 variable. This variable is specified in <tt class="literal"><span class="pre">rc.conf</span></tt>.</p>
114 </div>
115 <div class="section" id="maildir-eclass">
116 <h2><a class="toc-backref" href="#id9" 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
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
119 <tt class="literal"><span class="pre">MAILDIR=.maildir</span></tt> for backwards compatibility reasons.</p>
120 </div>
121 <div class="section" id="patching-ebuilds">
122 <h2><a class="toc-backref" href="#id10" name="patching-ebuilds">Patching ebuilds</a></h2>
123 <p>Since most ebuilds that currently need to know what the maildir delivery
124 location is already take the default <tt class="literal"><span class="pre">.maildir</span></tt> location into account when
125 installing, modifying ebuilds to implement this GLEP is as simple as
126 inheriting 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
127 with the <tt class="literal"><span class="pre">$MAILDIR</span></tt> variable. Care should be taken, to also modify any
128 patches or scripts that are used by the ebuild, that already have <tt class="literal"><span class="pre">.maildir</span></tt>
129 hardcoded (vpopmail, exim).</p>
130 </div>
131 </div>
132 <div class="section" id="backwards-compatibility">
133 <h1><a class="toc-backref" href="#id11" name="backwards-compatibility">Backwards Compatibility</a></h1>
134 <p>The default location is &quot;.maildir&quot;, unless it is overridden. This way, there
135 would be no backwards compatibility issues.</p>
136 </div>
137 <div class="section" id="references">
138 <h1><a class="toc-backref" href="#id12" name="references">References</a></h1>
139 <table class="footnote" frame="void" id="bugreport" rules="none">
140 <colgroup><col class="label" /><col /></colgroup>
141 <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>
143 </tbody>
144 </table>
145 </div>
146 <div class="section" id="copyright">
147 <h1><a class="toc-backref" href="#id13" name="copyright">Copyright</a></h1>
148 <p>This document has been placed in the public domain.</p>
149 </div>
150 </div>
152 <hr class="footer" />
153 <div class="footer">
154 <a class="reference" href="glep-0032.txt">View document source</a>.
155 Generated on: 2004-11-03 23:31 UTC.
156 Generated 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.
157 </div>
158 </body>
159 </html>

  ViewVC Help
Powered by ViewVC 1.1.20