If a neighbor solictation or neighbor advertisement isn't from the
[dragonfly.git] / 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.10 2008/09/06 14:17:56 swildner Exp $
33 .\"
34 .Dd September 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 DiOq
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.
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 1 .
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
91 This is a compatibility option for sendmail.
92 .It Fl o Ar option
93 Specifying
94 .Fl o Ns Ar i
95 is synonymous to
96 .Fl i .
97 All other options are ignored.
98 .It Fl q
99 Process saved messages in the queue.
100 .It Fl r Ar sender
101 Same as
102 .Fl f .
103 .El
104 .Sh CONFIGURATION
105 .Nm
106 can be configured with three config files:
107 .Pp
108 .Bl -bullet -compact
109 .It
110 auth.conf
111 .It
112 dma.conf
113 .It
114 virtusertable
115 .El
116 .Pp
117 These three files are stored per default in
118 .Pa /etc/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 .Bl -tag -width 4n
143 .It Ic SMARTHOST Xo
144 (string, default=empty)
145 .Xc
146 If you want to send outgoing mails via a smarthost, set this variable to
147 your smarthosts address.
148 .It Ic PORT Xo
149 (numeric, default=25)
150 .Xc
151 Use this port to deliver remote emails.
152 Only useful together with the
153 .Sq SMARTHOST
154 option, because
155 .Nm
156 will deliver all mails to this port, regardless of whether a smarthost is set
157 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 .It Ic AUTHPATH Xo
177 (string, default=/etc/dma/auth.conf)
178 .Xc
179 Path to the
180 .Sq auth.conf
181 file.
182 .It Ic VIRTUAL Xo
183 (boolean, default=commented)
184 .Xc
185 Comment if you want virtual user support.
186 .It Ic SECURETRANS Xo
187 (boolean, default=commented)
188 .Xc
189 Comment if you want TLS/SSL secured transfer.
190 .It Ic STARTTLS Xo
191 (boolean, default=commented)
192 .Xc
193 Comment if you want to use STARTTLS.
194 Only useful together with
195 .Sq SECURETRANS .
196 .It Ic CERTFILE Xo
197 (string, default=empty)
198 .Xc
199 Path to your SSL certificate file.
200 .It Ic SECURE Xo
201 (boolean, default=commented)
202 .Xc
203 Change this entry to
204 .Sq INSECURE
205 to use plain text SMTP login over an insecure connection.
206 You have to rename this variable manually to prevent that you send your
207 password accidentally over an insecure connection.
208 .It Ic DEFER Xo
209 (boolean, default=commented)
210 .Xc
211 Comment if you want that
212 .Nm
213 defers your mail.
214 You have to flush your mail queue manually with the
215 .Fl q
216 option.
217 This option is handy if you are behind a dialup line.
218 .El
219 .Ss virtusertable
220 The
221 .Pa virtusertable
222 file specifies a virtual user table.
223 Each line has the format
224 .Dq Li localuser:mail-address .
225 Some smarthosts do not accept mails from unresolvable email address
226 (e.g.\& user@localhost) so you have to rewrite your outgoing email
227 address to a valid address.
228 .Sh SEE ALSO
229 .Xr mailaddr 7 ,
230 .Xr mailwrapper 8 ,
231 .Xr sendmail 8
232 .Rs
233 .%A "J. B. Postel"
234 .%T "Simple Mail Transfer Protocol"
235 .%O RFC 821
236 .Re
237 .Rs
238 .%A "J. Myers"
239 .%T "SMTP Service Extension for Authentication"
240 .%O RFC 2554
241 .Re
242 .Rs
243 .%A "P. Hoffman"
244 .%T "SMTP Service Extension for Secure SMTP over TLS"
245 .%O RFC 2487
246 .Re
247 .Sh HISTORY
248 The
249 .Nm
250 utility first appeared in
251 .Dx 1.11 .
252 .Sh AUTHORS
253 .Nm
254 was written by
255 .An Matthias Schmidt Aq matthias@dragonflybsd.org
256 and
257 .An Simon Schubert Aq corecode@dragonflybsd.org .