]> git.ipfire.org Git - people/ms/dma.git/blob - dma.8
drop the virtusertable support
[people/ms/dma.git] / 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 August 27, 2009
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 DiOt
43 .Op Fl A Ns Ar mode
44 .Op Fl b Ns Ar mode
45 .Op Fl f Ar sender
46 .Op Fl L Ar tag
47 .Op Fl o Ns Ar option
48 .Op Fl r Ar sender
49 .Op Fl q Ns Op Ar arg
50 .Op Ar recipient ...
51 .Sh DESCRIPTION
52 .Nm
53 is a small Mail Transport Agent (MTA), designed for home and office use.
54 It accepts mails from locally installed Mail User Agents (MUA) and
55 delivers the mails either locally or to a remote destination.
56 Remote delivery includes several features like TLS/SSL support and SMTP
57 authentication.
58 .Pp
59 .Nm
60 is not intended as a replacement for real, big MTAs like
61 .Xr sendmail 8
62 or
63 .Xr postfix 1 .
64 Consequently,
65 .Nm
66 does not listen on port 25 for incoming connections.
67 .Pp
68 The options are as follows:
69 .Bl -tag -width indent
70 .It Fl A Ns Ar mode
71 .Fl \&Ac
72 acts as a compatibility option for sendmail.
73 .It Fl b Ns Ar mode
74 .Bl -tag -width indent
75 .It Fl bp
76 List all mails currently stored in the mail queue.
77 .It Fl bq
78 Queue the mail, but don't attempt to deliver it.
79 See also the
80 .Sq DEFER
81 config file setting below.
82 .El
83 .Pp
84 All other
85 .Ar mode Ns
86 s are are ignored.
87 .It Fl D
88 Don't run in the background.
89 Useful for debugging.
90 .It Fl f Ar sender
91 Set sender address to
92 .Ar sender .
93 .It Fl i
94 Ignore dots alone on lines by themselves in incoming messages.
95 This should be set if you are reading data from a file.
96 .It Fl L Ar tag
97 Set the identifier used in syslog messages to the supplied
98 .Ar tag .
99 This is a compatibility option for sendmail.
100 .It Fl O
101 This is a compatibility option for sendmail.
102 .It Fl o Ns Ar option
103 Specifying
104 .Fl oi
105 is synonymous to
106 .Fl i .
107 All other options are ignored.
108 .It Fl q Ns Op Ar arg
109 Process saved messages in the queue.
110 The argument is optional and ignored.
111 .It Fl r Ar sender
112 Same as
113 .Fl f .
114 .It Fl t
115 Obtain recipient addresses from the message header.
116 .Nm
117 will parse the
118 .Li To: ,
119 .Li Cc: ,
120 and
121 .Li Bcc:
122 headers.
123 The
124 .Li Bcc:
125 header will be removed independent of whether
126 .Fl t
127 is specified or not.
128 .El
129 .Sh CONFIGURATION
130 .Nm
131 can be configured with three config files:
132 .Pp
133 .Bl -bullet -compact
134 .It
135 auth.conf
136 .It
137 dma.conf
138 .El
139 .Pp
140 These three files are stored per default in
141 .Pa /etc/dma .
142 .Sh FILE FORMAT
143 Every file contains parameters of the form
144 .Sq name value .
145 Lines containing boolean values are set to
146 .Sq NO
147 if the line is commented and to
148 .Sq YES
149 if the line is uncommented.
150 Empty lines or lines beginning with a
151 .Sq #
152 are ignored.
153 Parameter names and their values are case sensitive.
154 .Sh PARAMETERS
155 .Ss auth.conf
156 SMTP authentication can be configured in
157 .Pa auth.conf .
158 Each line has the format
159 .Dq Li user|smarthost:password .
160 .Ss dma.conf
161 Most of the behaviour of
162 .Nm
163 can be configured in
164 .Pa dma.conf .
165 .Bl -tag -width 4n
166 .It Ic SMARTHOST Xo
167 (string, default=empty)
168 .Xc
169 If you want to send outgoing mails via a smarthost, set this variable to
170 your smarthosts address.
171 .It Ic PORT Xo
172 (numeric, default=25)
173 .Xc
174 Use this port to deliver remote emails.
175 Only useful together with the
176 .Sq SMARTHOST
177 option, because
178 .Nm
179 will deliver all mails to this port, regardless of whether a smarthost is set
180 or not.
181 .It Ic ALIASES Xo
182 (string, default=/etc/mail/aliases)
183 .Xc
184 Path to the local aliases file.
185 Just stick with the default.
186 .It Ic SPOOLDIR Xo
187 (string, default=/var/spool/dma)
188 .Xc
189 Path to
190 .Nm Ap s
191 spool directory.
192 Just stick with the default.
193 .It Ic AUTHPATH Xo
194 (string, default=/etc/dma/auth.conf)
195 .Xc
196 Path to the
197 .Sq auth.conf
198 file.
199 .It Ic SECURETRANS Xo
200 (boolean, default=commented)
201 .Xc
202 Comment if you want TLS/SSL secured transfer.
203 .It Ic STARTTLS Xo
204 (boolean, default=commented)
205 .Xc
206 Comment if you want to use STARTTLS.
207 Only useful together with
208 .Sq SECURETRANS .
209 .It Ic CERTFILE Xo
210 (string, default=empty)
211 .Xc
212 Path to your SSL certificate file.
213 .It Ic SECURE Xo
214 (boolean, default=commented)
215 .Xc
216 Change this entry to
217 .Sq INSECURE
218 to use plain text SMTP login over an insecure connection.
219 You have to rename this variable manually to prevent that you send your
220 password accidentally over an insecure connection.
221 .It Ic DEFER Xo
222 (boolean, default=commented)
223 .Xc
224 Comment if you want that
225 .Nm
226 defers your mail.
227 You have to flush your mail queue manually with the
228 .Fl q
229 option.
230 This option is handy if you are behind a dialup line.
231 .It Ic FULLBOUNCE Xo
232 (boolean, default=commented)
233 .Xc
234 Uncomment if you want the bounce message to include the complete original
235 message, not just the headers.
236 .It Ic MAILNAME Xo
237 (string, default=empty)
238 .Xc
239 The name to be used when introducing this host, if different from
240 the result of
241 .Xr hostname 1 .
242 If specified, this option overrides
243 .Sq MAILNAMEFILE .
244 .It Ic MAILNAMEFILE Xo
245 (string, default=empty)
246 .Xc
247 The name of the file to read the
248 .Sq MAILNAME
249 from.
250 .El
251 .Sh SEE ALSO
252 .Xr mailaddr 7 ,
253 .Xr mailwrapper 8 ,
254 .Xr sendmail 8
255 .Rs
256 .%A "J. B. Postel"
257 .%T "Simple Mail Transfer Protocol"
258 .%O RFC 821
259 .Re
260 .Rs
261 .%A "J. Myers"
262 .%T "SMTP Service Extension for Authentication"
263 .%O RFC 2554
264 .Re
265 .Rs
266 .%A "P. Hoffman"
267 .%T "SMTP Service Extension for Secure SMTP over TLS"
268 .%O RFC 2487
269 .Re
270 .Sh HISTORY
271 The
272 .Nm
273 utility first appeared in
274 .Dx 1.11 .
275 .Sh AUTHORS
276 .Nm
277 was written by
278 .An Matthias Schmidt Aq matthias@dragonflybsd.org
279 and
280 .An Simon Schubert Aq corecode@dragonflybsd.org .