[gentoo-doc-cvs] cvs commit: qmail-howto.xml

[Sven Vermeulen]

swift       08/05/23 19:39:35

  Modified:             qmail-howto.xml
  Log:
  Coding style

Revision  Changes    Path
1.40                 xml/htdocs/doc/en/qmail-howto.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/qmail-howto.xml?rev=1.40&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/qmail-howto.xml?rev=1.40&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/qmail-howto.xml?r1=1.39&r2=1.40

Index: qmail-howto.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/qmail-howto.xml,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -r1.39 -r1.40
--- qmail-howto.xml	11 Oct 2007 20:17:47 -0000	1.39
+++ qmail-howto.xml	23 May 2008 19:39:35 -0000	1.40
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/qmail-howto.xml,v 1.39 2007/10/11 20:17:47 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/qmail-howto.xml,v 1.40 2008/05/23 19:39:35 swift Exp $ -->
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
 <guide link="/doc/en/qmail-howto.xml">
@@ -33,23 +33,23 @@
 </p>
 
 <p>
-Specifically, the packages this guide will help you with are netqmail, 
-courier-imap, vpopmail, and horde/imp. These core packages will also bring in 
-daemontools, ucspi-tcp, mysql, apache, and mod_php.  netqmail provides the core 
-mta functions, courier-imap provides remote retrieval services, vpopmail 
+Specifically, the packages this guide will help you with are netqmail,
+courier-imap, vpopmail, and horde/imp. These core packages will also bring in
+daemontools, ucspi-tcp, mysql, apache, and mod_php.  netqmail provides the core
+mta functions, courier-imap provides remote retrieval services, vpopmail
 provides virtual domain management, and horde/imp provides webmail access.
 </p>
 
 <p>
-Before emerging anything, you will need the following USE variables enabled.  
+Before emerging anything, you will need the following USE variables enabled.
 If you've already emerged any of these packages, you may have to re-emerge them.
-<c>USE="maildir ssl imap mysql"</c>.  Additionally, if you want to use 
-horde/imp for your webmail then you will need <c>USE="nls"</c> before emerging 
+<c>USE="maildir ssl imap mysql"</c>.  Additionally, if you want to use
+horde/imp for your webmail then you will need <c>USE="nls"</c> before emerging
 mod_php.
 </p>
 
 <note>
-This guide is written in steps.  If at anytime you feel your setup is 
+This guide is written in steps.  If at anytime you feel your setup is
 'complete', you do not need to continue.
 </note>
 
@@ -77,14 +77,14 @@
 </pre>
 
 <impo>
-This guide is designed around netqmail-1.05-r4 or later.  Will it work with 
-earlier versions?  Maybe.  Should you upgrade? Yes, if you want to be sure this 
+This guide is designed around netqmail-1.05-r4 or later.  Will it work with
+earlier versions?  Maybe.  Should you upgrade? Yes, if you want to be sure this
 guide will work.
 </impo>
 
 <warn>
-If you get a message like <c>the virtual/mta package conflicts with another 
-package</c> then you need to make sure to unmerge the other MTA on your system. 
+If you get a message like <c>the virtual/mta package conflicts with another
+package</c> then you need to make sure to unmerge the other MTA on your system.
 To figure out what package that is, just run <c>emerge netqmail -p</c>.
 </warn>
 
@@ -149,12 +149,12 @@
 # <i>qmail-inject vapier &lt;&lt; EOF
 test vapier e-mail!
 EOF</i>
-# <i>mutt</i> 
+# <i>mutt</i>
 <comment>(You should now have 3 e-mails in your inbox)</comment>
 </pre>
 
 <p>
-And that's all!  Now you have a mail system that will handle mail for your 
+And that's all!  Now you have a mail system that will handle mail for your
 local machine and the system daemons/users who utilize it.
 </p>
 
@@ -213,27 +213,27 @@
 </pre>
 
 <impo>
-This guide is designed around vpopmail-5.4.6 or later.  Will it work with 
-earlier versions?  Maybe.  Should you upgrade?  Yes, if you want to be sure 
+This guide is designed around vpopmail-5.4.6 or later.  Will it work with
+earlier versions?  Maybe.  Should you upgrade?  Yes, if you want to be sure
 this guide will work.
 </impo>
 
 <p>
-vpopmail takes a little bit more effort to setup than the previous packages.  
-Since vpopmail runs off of mysql, we'll have to make sure that it's up and 
-running first.  Then we can setup the vpopmail database and move on.  
-Before you do this step, you should make sure you've already emerged 
-and setup mysql properly.  Note that the password I will use for the 
+vpopmail takes a little bit more effort to setup than the previous packages.
+Since vpopmail runs off of mysql, we'll have to make sure that it's up and
+running first.  Then we can setup the vpopmail database and move on.
+Before you do this step, you should make sure you've already emerged
+and setup mysql properly.  Note that the password I will use for the
 vpopmail database is 'vpoppw', you however should pick a different one.
 </p>
 
 <pre caption="Setting up vpopmail in mysql">
 # <i>rc-update add mysql default</i>
-<comment>If you just emerged mysql for the first time, make sure you run 
-the <i>ebuild &lt;mysql.ebuild&gt; config</i> command and follow the 
+<comment>If you just emerged mysql for the first time, make sure you run
+the <i>ebuild &lt;mysql.ebuild&gt; config</i> command and follow the
 directions before starting the mysql server.</comment>
 # <i>/etc/init.d/mysql start</i>
-# <i>nano /etc/vpopmail.conf</i> 
+# <i>nano /etc/vpopmail.conf</i>
 <comment>(Change the password from 'secret' to 'vpoppw')</comment>
 # <i>mysql -p &lt;&lt; EOF
 create database vpopmail;
@@ -249,14 +249,14 @@
 </pre>
 
 <warn>
-If you experience permission problems with mysql/vpopmail, you may want to 
+If you experience permission problems with mysql/vpopmail, you may want to
 try restarting mysql.  Just run <c>/etc/init.d/mysql restart</c>.
 </warn>
 
 <p>
-At this point in time, vpopmail is ready to roll.  In this guide, we will be 
-providing virtual hosting for the domain 'wh0rd.org'.  This means we need to 
-tell vpopmail about this domain we want it to host for us.  We'll also quickly 
+At this point in time, vpopmail is ready to roll.  In this guide, we will be
+providing virtual hosting for the domain 'wh0rd.org'.  This means we need to
+tell vpopmail about this domain we want it to host for us.  We'll also quickly
 add an user account for 'vapier' while we're here.
 </p>
 
@@ -277,9 +277,9 @@
 </pre>
 
 <p>
-Every domain that vpopmail creates comes with a 'postmaster' account.  Here we 
-told vpopmail that the password for the postmaster account is 'postpass'.  
-Before vpopmail can be truly useful, we'll need to be able to receive mail 
+Every domain that vpopmail creates comes with a 'postmaster' account.  Here we
+told vpopmail that the password for the postmaster account is 'postpass'.
+Before vpopmail can be truly useful, we'll need to be able to receive mail
 via courier and send mail via netqmail and SMTP.
 </p>
 
@@ -297,20 +297,20 @@
 </pre>
 
 <impo>
-You must emerge courier-imap after vpopmail.  That way the authvchkpw module 
+You must emerge courier-imap after vpopmail.  That way the authvchkpw module
 will be built.
 </impo>
 
 <impo>
-This guide is designed around net-mail/courier-imap-3.0.7 or later.  Will 
-it work with earlier versions?  Maybe.  Should you upgrade?  Yes, if you want 
+This guide is designed around net-mail/courier-imap-3.0.7 or later.  Will
+it work with earlier versions?  Maybe.  Should you upgrade?  Yes, if you want
 to be sure this guide will work.
 </impo>
 
 <p>
-Now for the common post-install configuration steps.  These steps are only 
-needed if you wish to run SSL encrypted communications (which you should !). 
-Otherwise you can skip to the last two steps in the two following code 
+Now for the common post-install configuration steps.  These steps are only
+needed if you wish to run SSL encrypted communications (which you should !).
+Otherwise you can skip to the last two steps in the two following code
 listings, removing the '-ssl' from the init script name each time.
 </p>
 
@@ -318,7 +318,7 @@
 # <i>nano /etc/courier/authlib/authdaemonrc</i>
 <comment>(Set the authmodulelist variable to only contain "authvchkpw")</comment>
 # <i>cd /etc/courier-imap</i>
-# <i>nano pop3d.cnf</i> 
+# <i>nano pop3d.cnf</i>
 <comment>(Edit the [ req_dn ] section)</comment>
 # <i>mkpop3dcert</i>
 # <i>rc-update add courier-pop3d-ssl default</i>
@@ -327,7 +327,7 @@
 
 <pre caption="Out-of-the-box setup for IMAP/SSL">
 # <i>cd /etc/courier-imap</i>
-# <i>nano imapd.cnf</i> 
+# <i>nano imapd.cnf</i>
 <comment>(Edit the [ req_dn ] section)</comment>
 # <i>mkimapdcert</i>
 # <i>rc-update add courier-imapd-ssl default</i>
@@ -335,8 +335,8 @@
 </pre>
 
 <p>
-Your mail client should now be able to login to the host running courier and 
-retrieve mail for the virtual host.  In my case, I am now able to login with 
+Your mail client should now be able to login to the host running courier and
+retrieve mail for the virtual host.  In my case, I am now able to login with
 the username 'vapier@×××××.org' and password 'vappw'.
 </p>
 
@@ -350,7 +350,7 @@
 <body>
 
 <p>
-Let's get SMTP up and running while making sure we don't create another spam 
+Let's get SMTP up and running while making sure we don't create another spam
 hole for people to abuse.
 </p>
 
@@ -358,7 +358,7 @@
 # <i>cd /var/qmail/control/</i>
 # <i>nano conf-smtpd</i>
 <comment>(Uncomment the SMTP-AUTH variables and set QMAIL_SMTP_CHECKPASSWORD to /var/vpopmail/bin/vchkpw)</comment>
-# <i>nano servercert.cnf</i> 
+# <i>nano servercert.cnf</i>
 <comment>(Edit the [ req_dn ] section)</comment>
 # <i>mkservercert</i>
 # <i>cd /service</i>
@@ -388,12 +388,12 @@
 <body>
 
 <p>
-Although there are plenty of webmail clients out there (and you're free to use 
-any of them), I prefer the <uri link="http://www.horde.org/imp/">IMP Webmail 
-Client</uri> that is part of the Horde framework.  The biggest reason is that 
+Although there are plenty of webmail clients out there (and you're free to use
+any of them), I prefer the <uri link="http://www.horde.org/imp/">IMP Webmail
+Client</uri> that is part of the Horde framework.  The biggest reason is that
 Horde can simply provide Webmail access, or you can easily add other components
-to handle Address Books, Calendars, Tasks, etc...  If this hasn't convinced 
-you yet, then perhaps you need to read up on <uri 
+to handle Address Books, Calendars, Tasks, etc...  If this hasn't convinced
+you yet, then perhaps you need to read up on <uri
 link="http://www.horde.org/">Horde</uri> for yourself.
 </p>
 
@@ -406,13 +406,13 @@
 </pre>
 
 <impo>
-This guide is based around horde-2.2.x and horde-imp-3.2.x.  The CVS versions 
-(and thus the next major release) will probably have very different 
+This guide is based around horde-2.2.x and horde-imp-3.2.x.  The CVS versions
+(and thus the next major release) will probably have very different
 configuration settings.  Also note that php-5.x will probably break horde-2.x.
 </impo>
 
 <p>
-Horde currently isn't the easiest to setup unless you know exactly what to do.  
+Horde currently isn't the easiest to setup unless you know exactly what to do.
 Fortunately for you, I know exactly what to do, thus you will too.
 </p>
 
@@ -444,8 +444,8 @@
 </pre>
 
 <note>
-You'll may want to change the 'webmaster' e-mail account to something else.  If 
-you wish to use that e-mail address, then remember you'll have to add that 
+You'll may want to change the 'webmaster' e-mail account to something else.  If
+you wish to use that e-mail address, then remember you'll have to add that
 user via vpopmail (or see below about qmailadmin).
 </note>
 
@@ -460,16 +460,16 @@
 
 <comment>(Edit the $servers['imap'] array:)</comment>
 $servers['imap'] = array(
-	'name' => 'wh0rd.org',
-	'server' => 'localhost',
-	'protocol' => 'imap/ssl/novalidate-cert',
-	'port' => 993,
-	'folders' => '',
-	'namespace' => 'INBOX.',
-	'maildomain' => 'wh0rd.org',
-	'smtphost' => 'localhost',
-	'realm' => '',
-	'preferred' => ''
+  'name' => 'wh0rd.org',
+  'server' => 'localhost',
+  'protocol' => 'imap/ssl/novalidate-cert',
+  'port' => 993,
+  'folders' => '',
+  'namespace' => 'INBOX.',
+  'maildomain' => 'wh0rd.org',
+  'smtphost' => 'localhost',
+  'realm' => '',
+  'preferred' => ''
 );
 </pre>
 
@@ -478,27 +478,27 @@
 </p>
 
 <pre caption="Running apache">
-# <i>nano /etc/conf.d/apache2</i> 
+# <i>nano /etc/conf.d/apache2</i>
 <comment>(Uncomment APACHE2_OPTS="-D SSL -D PHP5")</comment>
 # <i>rc-update add apache2 default</i>
 # <i>/etc/init.d/apache2 start</i>
 </pre>
 
 <warn>
-You should really look into forcing https on users of horde.  This isn't a 
+You should really look into forcing https on users of horde.  This isn't a
 trivial issue, but you should look into it for the sake of security.
 </warn>
 
 <p>
-To test out the new IMP setup, launch a web browser and visit 
-<uri>http://localhost/horde/</uri> (or change localhost with the server you're 
+To test out the new IMP setup, launch a web browser and visit
+<uri>http://localhost/horde/</uri> (or change localhost with the server you're
 setting this up on).  You should see the Horde welcome page where you can login.
-Again, in my setup, I simply login with 'vapier@×××××.org' and 'vappw' as my 
+Again, in my setup, I simply login with 'vapier@×××××.org' and 'vappw' as my
 username and password.
 </p>
 
 <p>
-At this point, Horde and IMP are all setup.  You should, however, go back 
+At this point, Horde and IMP are all setup.  You should, however, go back
 through the config directories and tweak each to your heart's content.
 </p>
 
@@ -513,11 +513,11 @@
 <body>
 
 <p>
-The first package I would suggest you look into is <uri 
-link="http://www.inter7.com/qmailadmin.html">qmailadmin</uri>.  It's a web based 
-interface for managing virtual domains.  Simply <c>emerge 
-net-mail/qmailadmin</c> and then point your webbrowser to 
-<uri>http://localhost/cgi-bin/qmailadmin</uri> in order to use it.  Makes life 
+The first package I would suggest you look into is <uri
+link="http://www.inter7.com/qmailadmin.html">qmailadmin</uri>.  It's a web based
+interface for managing virtual domains.  Simply <c>emerge
+net-mail/qmailadmin</c> and then point your webbrowser to
+<uri>http://localhost/cgi-bin/qmailadmin</uri> in order to use it.  Makes life
 a lot easier.
 </p>
 
@@ -542,13 +542,13 @@
 <body>
 
 <p>
-I would highly recommend looking into the many other Horde applications.  The 
-<uri link="http://www.horde.org/turba/">Turba</uri>, <uri 
-link="http://www.horde.org/kronolith/">Kronolith</uri>, and <uri 
-link="http://www.horde.org/nag/">Nag</uri> applications complement IMP very 
-well for instance. Their configuration is similar to that of IMP, so you 
-should have no trouble setting them up.  Just remember to edit registry.php in 
-the horde config directory so the new applications show up at the bottom of 
+I would highly recommend looking into the many other Horde applications.  The
+<uri link="http://www.horde.org/turba/">Turba</uri>, <uri
+link="http://www.horde.org/kronolith/">Kronolith</uri>, and <uri
+link="http://www.horde.org/nag/">Nag</uri> applications complement IMP very
+well for instance. Their configuration is similar to that of IMP, so you
+should have no trouble setting them up.  Just remember to edit registry.php in
+the horde config directory so the new applications show up at the bottom of
 the horde website.
 </p>
 
@@ -578,18 +578,18 @@
 <body>
 
 <p>
-If you wish to do content filtering on your mail server (spam and virus), then 
-you'll need to use a different queuing program than the default one.  One good 
-program for doing so is <uri 
-link="http://qmail-scanner.sourceforge.net/">qmail-scanner</uri>.  
-Just <c>emerge qmail-scanner</c> and edit the 
+If you wish to do content filtering on your mail server (spam and virus), then
+you'll need to use a different queuing program than the default one.  One good
+program for doing so is <uri
+link="http://qmail-scanner.sourceforge.net/">qmail-scanner</uri>.
+Just <c>emerge qmail-scanner</c> and edit the
 <path>/etc/tcprules.d/tcp.qmail-smtp</path> file.
 </p>
 
 <impo>
-The build process of qmail-scanner is quite ugly.  In order to support 
-packages, they must already be on your system.  This means you will have 
-to emerge SpamAssassin and/or Clam AntiVirus before you emerge 
+The build process of qmail-scanner is quite ugly.  In order to support
+packages, they must already be on your system.  This means you will have
+to emerge SpamAssassin and/or Clam AntiVirus before you emerge
 qmail-scanner.  See the relevant following sections for more information.
 </impo>
 
@@ -601,8 +601,8 @@
 </pre>
 
 <p>
-See the following sections for setting up spam and virus filtering.  You may 
-want to set a few custom options by editing 
+See the following sections for setting up spam and virus filtering.  You may
+want to set a few custom options by editing
 <path>/var/qmail/bin/qmail-scanner-queue.pl</path>.
 </p>
 
@@ -613,12 +613,12 @@
 <body>
 
 <p>
-One of the best Open Source spam filters out there is <uri 
-link="http://www.spamassassin.org/">SpamAssassin</uri>.  Just <c>emerge 
-mail-filter/spamassassin</c> to install.  The package comes in two flavors, a 
-command line version and a client/server version.  For servers that will be 
-handling a small amount of mail, running with the command line version is OK, 
-but for anyone whose server will be handling appreciative loads should utilize 
+One of the best Open Source spam filters out there is <uri
+link="http://www.spamassassin.org/">SpamAssassin</uri>.  Just <c>emerge
+mail-filter/spamassassin</c> to install.  The package comes in two flavors, a
+command line version and a client/server version.  For servers that will be
+handling a small amount of mail, running with the command line version is OK,
+but for anyone whose server will be handling appreciative loads should utilize
 the client/server version.
 </p>
 
@@ -636,15 +636,15 @@
 </pre>
 
 <impo>
-If you did not have SpamAssassin on your system before you emerged 
-qmail-scanner, you will have to re-emerge qmail-scanner now.  Its build 
-process is pretty ugly and will only add in features for packages it detects 
+If you did not have SpamAssassin on your system before you emerged
+qmail-scanner, you will have to re-emerge qmail-scanner now.  Its build
+process is pretty ugly and will only add in features for packages it detects
 on the system at build time.
 </impo>
 
 <p>
-At this point, incoming mail should be sent through qmail-scanner which will 
-run it through SpamAssassin for you. 
+At this point, incoming mail should be sent through qmail-scanner which will
+run it through SpamAssassin for you.
 </p>
 
 </body>
@@ -654,13 +654,13 @@
 <body>
 
 <p>
-Like SpamAssassin, <uri link="http://www.clamav.net/">Clam AntiVirus</uri> 
-comes in two flavors.  I'll give you a quick run down on how to quickly setup 
-the client/server version.  First, just <c>emerge app-antivirus/clamav</c>. 
+Like SpamAssassin, <uri link="http://www.clamav.net/">Clam AntiVirus</uri>
+comes in two flavors.  I'll give you a quick run down on how to quickly setup
+the client/server version.  First, just <c>emerge app-antivirus/clamav</c>.
 </p>
 
 <pre caption="Out-of-the-box setup for Clam AntiVirus">
-# <i>nano /etc/conf.d/clamd</i> 
+# <i>nano /etc/conf.d/clamd</i>
 <comment>(Set START_CLAMD=yes)</comment>
 # <i>nano /etc/clamav.conf</i>
 <comment>(Setup stuff the way you want it)</comment>
@@ -674,14 +674,14 @@
 </pre>
 
 <impo>
-If you did not have Clam AntiVirus on your system before you emerged 
-qmail-scanner, you will have to re-emerge qmail-scanner now.  Its build 
-process is pretty ugly and will only add in features for packages it detects 
+If you did not have Clam AntiVirus on your system before you emerged
+qmail-scanner, you will have to re-emerge qmail-scanner now.  Its build
+process is pretty ugly and will only add in features for packages it detects
 on the system at build time.
 </impo>
 
 <p>
-At this point, incoming mail should be sent through qmail-scanner which will 
+At this point, incoming mail should be sent through qmail-scanner which will
 run it through Clam AntiVirus for you.
 </p>
 
@@ -695,11 +695,11 @@
 <body>
 
 <p>
-I have no final notes other than if you experience any troubles with the guide, 
-please contact <mail link="vapier@g.o">me</mail> or file a bug with 
-<uri link="http://bugs.gentoo.org/">Gentoo's Bugtracking Website</uri>.  If 
-you have some interesting bits you think would enhance this guide, by all means 
-send it my way for inclusion.  I love netqmail and would gladly add stuff that 
+I have no final notes other than if you experience any troubles with the guide,
+please contact <mail link="vapier@g.o">me</mail> or file a bug with
+<uri link="http://bugs.gentoo.org/">Gentoo's Bugtracking Website</uri>.  If
+you have some interesting bits you think would enhance this guide, by all means
+send it my way for inclusion.  I love netqmail and would gladly add stuff that
 could possibly enhance a user's experience with the mta.
 </p>
 



-- 
gentoo-doc-cvs@l.g.o mailing list