libexec/dma/dma.8

   1 .\"
   2 .\" Copyright (c) 2008
   3 .\"     The DragonFly Project.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\" 3. Neither the name of The DragonFly Project nor the names of its
  16 .\"    contributors may be used to endorse or promote products derived
  17 .\"    from this software without specific, prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $DragonFly: src/libexec/dma/dma.8,v 1.2 2008/02/02 18:43:46 swildner Exp $
  33 .\"
  34 .Dd February 2, 2008
  35 .Dt DMA 8
  36 .Os
  37 .Sh NAME
  38 .Nm dma
  39 .Nd DragonFly Mail Agent
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl Diq
  43 .Op Fl A Ar mode
  44 .Op Fl b Ar mode
  45 .Op Fl f Ar sender
  46 .Op Fl L Ar tag
  47 .Op Fl o Ar option
  48 .Op Fl r Ar sender
  49 .Op Ar recipient ...
  50 .Sh DESCRIPTION
  51 .Nm
  52 is a small Mail Transport Agent (MTA), designed for home and office use.
  53 It accepts mails from locally installed Mail User Agents (MUA) and
  54 delivers the mails either locally or to a remote destination.
  55 Remote delivery includes several features like TLS/SSL support and SMTP
  56 authentication (AUTH LOGIN only).
  57 .Pp
  58 .Nm
  59 is not intended as a replacement for real, big MTAs like
  60 .Xr sendmail 8
  61 or
  62 .Xr postfix 8 .
  63 Consequently,
  64 .Nm
  65 does not listen on port 25 for incoming connections.
  66 .Pp
  67 The options are as follows:
  68 .Bl -tag -width indent
  69 .It Fl A Ar mode
  70 .Fl A Ns Ar c
  71 acts as a compatibility option for sendmail.
  72 .It Fl b Ar mode
  73 Specifying
  74 .Fl b Ns Ar p
  75 will list all mails currently stored in the mail queue.
  76 All other modes are are ignored.
  77 .It Fl D
  78 Don't run in the background.
  79 Useful for debugging.
  80 .It Fl f Ar sender
  81 Set sender address to
  82 .Ar sender .
  83 .It Fl i
  84 Ignore dots alone on lines by themselves in incoming messages.
  85 This should be set if you are reading data from a file.
  86 .It Fl L Ar tag
  87 Set the identifier used in syslog messages to the supplied
  88 .Ar tag .
  89 This is a compatibility option for sendmail.
  90 .It Fl o Ar option
  91 Specifying
  92 .Fl o Ns Ar i
  93 is synonymous to
  94 .Fl i .
  95 All other options are ignored.
  96 .It Fl q
  97 Process saved messages in the queue.
  98 .It Fl r Ar sender
  99 Same as
 100 .Fl f .
 101 .El
 102 .Sh CONFIGURATION
 103 .Nm
 104 can be configured with three config files:
 105 .Pp
 106 .Bl -bullet -compact
 107 .It
 108 auth.conf
 109 .It
 110 dma.conf
 111 .It
 112 virtusertable
 113 .El
 114 .Pp
 115 These three files are stored per default in
 116 .Pa /etc/dma .
 117 However every user can install it's own config files in
 118 .Pa $HOME/.dma .
 119 .Sh FILE FORMAT
 120 Every file contains parameters of the form
 121 .Sq name value .
 122 Lines containing boolean values are set to
 123 .Sq NO
 124 if the line is commented and to
 125 .Sq YES
 126 if the line is uncommented.
 127 Empty lines or lines beginning with a
 128 .Sq #
 129 are ignored.
 130 Parameter names and their values are case sensitive.
 131 .Sh PARAMETERS
 132 .Ss auth.conf
 133 SMTP authentication can be configured in
 134 .Pa auth.conf .
 135 Each line has the format
 136 .Dq Li user|smarthost:password .
 137 .Ss dma.conf
 138 Most of the behaviour of
 139 .Nm
 140 can be configured in
 141 .Pa dma.conf .
 142 .Pp
 143 .Bl -tag -width 4n
 144 .It Ic SMARTHOST Xo
 145 (string, default=empty)
 146 .Xc
 147 If you want to send outgoing mails via a smarthost, set this variable to
 148 your smarthosts address.
 149 .It Ic PORT Xo
 150 (numeric, default=25)
 151 .Xc
 152 Use this port to deliver remote emails.
 153 Only useful together with the
 154 .Sq SMARTHOST
 155 option, because
 156 .Nm
 157 will deliver all mails to this port, regardless if a smarthost is set or not.
 158 .It Ic ALIASES Xo
 159 (string, default=/etc/mail/aliases)
 160 .Xc
 161 Path to the local aliases file.
 162 Just stick with the default.
 163 .It Ic SPOOLDIR Xo
 164 (string, default=/var/spool/dma)
 165 .Xc
 166 Path to
 167 .Nm Ap s
 168 spool directory.
 169 Just stick with the default.
 170 .It Ic VIRTPATH Xo
 171 (string, default=/etc/dma/virtusertable)
 172 .Xc
 173 Path to the
 174 .Sq virtusertable
 175 file.
 176 If you have your config in
 177 .Pa $HOME/.dma
 178 be sure to change this path accordingly.
 179 .It Ic AUTHPATH Xo
 180 (string, default=/etc/dma/auth.conf)
 181 .Xc
 182 Path to the
 183 .Sq auth.conf
 184 file.
 185 If you have your config in
 186 .Pa $HOME/.dma
 187 be sure to change this path accordingly.
 188 .It Ic VIRTUAL Xo
 189 (boolean, default=commented)
 190 .Xc
 191 Comment if you want virtual user support.
 192 .It Ic SECURETRANS Xo
 193 (boolean, default=commented)
 194 .Xc
 195 Comment if you want TLS/SSL secured transfer.
 196 .It Ic STARTTLS Xo
 197 (boolean, default=commented)
 198 .Xc
 199 Comment if you want to use STARTTLS.
 200 Only useful together with
 201 .Sq SECURETRANS .
 202 .It Ic CERTFILE Xo
 203 (string, default=empty)
 204 .Xc
 205 Path to your SSL certificate file.
 206 .It Ic DEFER Xo
 207 (boolean, default=commented)
 208 .Xc
 209 Comment if you want that
 210 .Nm
 211 defers your mail.
 212 You have to flush your mail queue manually with the
 213 .Fl q
 214 option.
 215 This option is handy if you are behind a dialup line.
 216 .El
 217 .Ss virtusertable
 218 The
 219 .Pa virtusertable
 220 file specifies a virtual user table.
 221 Each line has the format
 222 .Dq Li localuser:mail-address .
 223 Some smarthosts do not accept mails from unresolvable email address
 224 (e.g. user@localhost) so you have to rewrite your outgoing email
 225 address to a valid address.
 226 .Sh SEE ALSO
 227 .Xr mailaddr 7 ,
 228 .Xr mailwrapper 8 ,
 229 .Xr sendmail 8
 230 .Rs
 231 .%A "J. B. Postel"
 232 .%T "Simple Mail Transfer Protocol"
 233 .%O RFC 821
 234 .Re
 235 .Rs
 236 .%A "J. Myers"
 237 .%T "SMTP Service Extension for Authentication"
 238 .%O RFC 2554
 239 .Re
 240 .Rs
 241 .%A "P. Hoffman"
 242 .%T "SMTP Service Extension for Secure SMTP over TLS"
 243 .%O RFC 2487
 244 .Re
 245 .Sh HISTORY
 246 The
 247 .Nm
 248 utility first appeared in
 249 .Dx 1.11 .
 250 .Sh AUTHORS
 251 .Nm
 252 was written by
 253 .An Matthias Schmidt Aq matthias@dragonflybsd.org
 254 and
 255 .An Simon Schubert Aq corecode@dragonflybsd.org .