Skip to content

Commit 9bd66bd

Browse files
concussiouscorecode
authored andcommitted
dma.8: Improve mdoc markup
Add mentioned paths to the whatis database by converting parentheticals to use the parenthesis macros. Convert all of them consistently while here. Silence linter warnings by escaping delimiters.
1 parent e801948 commit 9bd66bd

1 file changed

Lines changed: 37 additions & 32 deletions

File tree

dma.8

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,12 @@
4949
.Op Ar recipient ...
5050
.Sh DESCRIPTION
5151
.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.
52+
is a small Mail Transport Agent
53+
.Pq MTA ,
54+
designed for home and office use.
55+
It accepts mails from locally installed Mail User Agents
56+
.Pq MUA
57+
and delivers the mails either locally or to a remote destination.
5558
Remote delivery includes several features like TLS/SSL support and SMTP
5659
authentication.
5760
.Pp
@@ -87,7 +90,9 @@ s are ignored.
8790
Do not run in the background.
8891
Useful for debugging.
8992
.It Fl f Ar sender
90-
Set sender address (envelope-from) to
93+
Set sender address
94+
.Pq envelope-from
95+
to
9196
.Ar sender .
9297
This overrides the value of the
9398
.Ev EMAIL
@@ -119,13 +124,13 @@ Same as
119124
Obtain recipient addresses from the message header.
120125
.Nm
121126
will parse the
122-
.Li To: ,
123-
.Li Cc: ,
127+
.Li To:\& ,
128+
.Li Cc:\& ,
124129
and
125-
.Li Bcc:
130+
.Li Bcc:\&
126131
headers.
127132
The
128-
.Li Bcc:
133+
.Li Bcc:\&
129134
header will be removed independent of whether
130135
.Fl t
131136
is specified or not.
@@ -168,22 +173,22 @@ can be configured in
168173
.Pa dma.conf .
169174
.Bl -tag -width 4n
170175
.It Ic SMARTHOST Xo
171-
(string, default=empty)
176+
.Pq string, default=empty
172177
.Xc
173178
If you want to send outgoing mails via a smarthost, set this variable to
174179
your smarthosts address.
175180
.It Ic PORT Xo
176-
(numeric, default=25)
181+
.Pq numeric, default=25
177182
.Xc
178183
Use this port to deliver remote emails.
179184
Only useful together with the
180185
.Sq SMARTHOST
181186
option, because
182187
.Nm
183-
will deliver all mails to this port, regardless of whether a smarthost is set
184-
or not.
188+
will deliver all mails to this port,
189+
regardless of whether a smarthost is set or not.
185190
.It Ic ALIASES Xo
186-
(string, default=/etc/aliases)
191+
.Pq string, default= Ns Pa /etc/aliases
187192
.Xc
188193
Path to the local aliases file.
189194
Just stick with the default.
@@ -204,66 +209,66 @@ matching alias is found.
204209
Use the catch-all alias only if you do not want any local mail to be
205210
delivered.
206211
.It Ic SPOOLDIR Xo
207-
(string, default=/var/spool/dma)
212+
.Pq string, default= Ns Pa /var/spool/dma
208213
.Xc
209214
Path to
210215
.Nm Ap s
211216
spool directory.
212217
Just stick with the default.
213218
.It Ic AUTHPATH Xo
214-
(string, default=not set)
219+
.Pq string, default=not set
215220
.Xc
216221
Path to the
217222
.Sq auth.conf
218223
file.
219224
.It Ic SECURETRANSFER Xo
220-
(boolean, default=commented)
225+
.Pq boolean, default=commented
221226
.Xc
222227
Uncomment if you want TLS/SSL secured transfer.
223228
.It Ic STARTTLS Xo
224-
(boolean, default=commented)
229+
.Pq boolean, default=commented
225230
.Xc
226231
Uncomment if you want to use STARTTLS.
227232
Only useful together with
228233
.Sq SECURETRANSFER .
229234
.It Ic VERIFYCERT Xo
230-
(boolean, default=commented)
235+
.Pq boolean, default=commented
231236
.Xc
232237
Verify the server certificate against the CA.
233238
Only makes sense if you use a smarthost.
234239
.It Ic FINGERPRINT Xo
235-
(string, default=empty)
240+
.Pq string, default=empty
236241
.Xc
237242
Pin the server certificate by specifying its SHA256 fingerprint.
238243
Only makes sense if you use a smarthost.
239244
.It Ic OPPORTUNISTIC_TLS Xo
240-
(boolean, default=commented)
245+
.Pq boolean, default=commented
241246
.Xc
242247
Uncomment if you want to allow the STARTTLS negotiation to fail.
243248
Most useful when
244249
.Nm
245-
is used without a smarthost, delivering remote messages directly to
246-
the outside mail exchangers; in opportunistic TLS mode, the connection will
250+
is used without a smarthost, delivering remote messages directly to the
251+
outside mail exchangers; in opportunistic TLS mode, the connection will
247252
be encrypted if the remote server supports STARTTLS, but an unencrypted
248253
delivery will still be made if the negotiation fails.
249254
Only useful together with
250255
.Sq SECURETRANSFER
251256
and
252257
.Sq STARTTLS .
253258
.It Ic CERTFILE Xo
254-
(string, default=empty)
259+
.Pq string, default=empty
255260
.Xc
256261
Path to your SSL certificate file.
257262
.It Ic SECURE Xo
258-
(boolean, default=commented)
263+
.Pq boolean, default=commented
259264
.Xc
260265
Uncomment this entry and change it to
261266
.Sq INSECURE
262267
to use plain text SMTP login over an insecure connection.
263268
You have to rename this variable manually to prevent that you send your
264269
password accidentally over an insecure connection.
265270
.It Ic DEFER Xo
266-
(boolean, default=commented)
271+
.Pq boolean, default=commented
267272
.Xc
268273
Uncomment if you want that
269274
.Nm
@@ -273,12 +278,12 @@ You have to flush your mail queue manually with the
273278
option.
274279
This option is handy if you are behind a dialup line.
275280
.It Ic FULLBOUNCE Xo
276-
(boolean, default=commented)
281+
.Pq boolean, default=commented
277282
.Xc
278283
Uncomment if you want the bounce message to include the complete original
279284
message, not just the headers.
280285
.It Ic MAILNAME Xo
281-
(string, default=empty)
286+
.Pq string, default=empty
282287
.Xc
283288
The internet hostname
284289
.Nm
@@ -291,7 +296,7 @@ If
291296
is an absolute path to a file, the first line of this file will be used
292297
as the hostname.
293298
.It Ic MASQUERADE Xo
294-
(string, default=empty)
299+
.Pq string, default=empty
295300
.Xc
296301
Masquerade the envelope-from addresses with this address/hostname.
297302
Use this setting if mails are not accepted by destination mail servers
@@ -318,10 +323,9 @@ will send all mails as
318323
setting it to
319324
.Ql percolator
320325
will send all mails as
321-
.Ql Sm off Va username @percolator .
322-
.Sm on
326+
.Ql Va username Ns @percolator .
323327
.It Ic NULLCLIENT Xo
324-
(boolean, default=commented)
328+
.Pq boolean, default=commented
325329
.Xc
326330
Bypass aliases and local delivery, and instead forward all mails to
327331
the defined
@@ -338,7 +342,8 @@ can be influenced by some environment variables.
338342
.Bl -tag -width 4n
339343
.It Ev EMAIL Xo
340344
.Xc
341-
Used to set the sender address (envelope-from).
345+
Used to set the sender address
346+
.Pq envelope-from .
342347
Use a plain address, in the form of
343348
.Li user@example.com .
344349
This value will be overridden when the

0 commit comments

Comments
 (0)