Re: smtpd.conf(5)/table(5) manuals: change `\-' to `-'
On Sat, Mar 23, 2019 at 11:50:53PM -0600, Randy Hartman wrote: > Change smtpd.conf(5) and table(5) man pages to represent hyphen > as plain `-'. According to mandoc_char(7), "[...] in manual pages > just write plain `-' to represent hyphen, minus, and hyphen-minus." > > Found while comparing ssl(8), starttls(8), and smtpd.conf(5). > hi. the current situation is that both formats are regarded as correct, and the work neccessary to flip all pages one way or the other just isn;t worth it. to that end, ingo has just bumped mandoc_char(7) a little to hopefully make this clearer. thanks for the mail anyway, jmc > Index: smtpd.conf.5 > === > RCS file: /cvs/src/usr.sbin/smtpd/smtpd.conf.5,v > retrieving revision 1.210 > diff -u -p -u -p -r1.210 smtpd.conf.5 > --- smtpd.conf.5 22 Dec 2018 08:54:02 - 1.210 > +++ smtpd.conf.5 24 Mar 2019 05:08:30 - > @@ -110,12 +110,12 @@ The delivery > .Ar method > parameter may be one of the following: > .Bl -tag -width Ds > -.It Cm expand\-only > +.It Cm expand-only > Only accept the message if a delivery method was specified > in an aliases or > .Pa .forward > file. > -.It Cm forward\-only > +.It Cm forward-only > Only accept the message if the recipient results in a remote address > after the processing of aliases or forward file. > .It Cm lmtp Ar destination Op Ar rcpt-to > @@ -223,7 +223,7 @@ with higher priority than mail exchanger > Advertise > .Ar heloname > as the hostname to other mail exchangers during the HELO phase. > -.It Cm helo\-src Pf < Ar table Ns > > +.It Cm helo-src Pf < Ar table Ns > > Use the mapping > .Ar table > to look up a hostname matching the source address, > @@ -283,7 +283,7 @@ This option is usable only with > option. > The credential table format is described in > .Xr table 5 . > -.It Cm mail\-from Ar mailaddr > +.It Cm mail-from Ar mailaddr > Use > .Ar mailaddr > as the MAIL FROM address within the SMTP transaction. > @@ -294,7 +294,7 @@ for the source IP address. > If the list contains more than one address, all of them are used > in such a way that traffic is routed as efficiently as possible. > .El > -.It Ic bounce Cm warn\-interval Ar delay Op , Ar delay ... > +.It Ic bounce Cm warn-interval Ar delay Op , Ar delay ... > Send warning messages to the envelope sender when temporary delivery > failures cause a message to remain on the queue for longer than > .Ar delay . > @@ -308,7 +308,7 @@ At most four > .Ar delay > parameters can be specified. > The default is > -.Qq Ic bounce Cm warn\-interval No 4h , > +.Qq Ic bounce Cm warn-interval No 4h , > sending a single warning after four hours. > .It Ic ca Ar caname Cm cert Ar cafile > Associate the Certificate Authority (CA) certificate file > @@ -355,7 +355,7 @@ or a credentials table > .Ar authtable , > the format of which is described in > .Xr table 5 . > -.It Cm auth\-optional Op Pf < Ar authtable Ns > > +.It Cm auth-optional Op Pf < Ar authtable Ns > > Support SMTPAUTH optionally: > clients need not authenticate, but may do so. > This allows a > @@ -386,13 +386,13 @@ The > table contains a mapping of IP addresses to hostnames. > If the address on which the connection arrives appears in the mapping, > the associated hostname is used. > -.It Cm mask\-src > +.It Cm mask-src > Omit the > .Sy from > part when prepending > .Dq Received > headers. > -.It Cm no\-dsn > +.It Cm no-dsn > Disable the DSN (Delivery Status Notification) extension. > .It Cm pki Ar pkiname > For secure connections, > @@ -406,7 +406,7 @@ to prove a mail server's identity. > Listen on the given > .Ar port > instead of the default port 25. > -.It Cm received\-auth > +.It Cm received-auth > In > .Dq Received > headers, report whether the session was authenticated > @@ -432,7 +432,7 @@ Clients connecting to the listener are t > Support STARTTLS, by default on port 25. > Mutually exclusive with > .Cm smtps . > -.It Cm tls\-require Op Cm verify > +.It Cm tls-require Op Cm verify > Like > .Cm tls , > but force clients to establish a secure connection > @@ -442,12 +442,12 @@ With the > option, clients must also provide a valid certificate > to establish an SMTP session. > .El > -.It Ic listen on Cm socket Op Cm mask\-src > +.It Ic listen on Cm socket Op Cm mask-src > Listen for incoming SMTP connections on the Unix domain socket > .Pa /var/run/smtpd.sock . > This is done by default, even if the directive is absent. > If the > -.Cm mask\-src > +.Cm mask-src > option is specified, printing of the HELO name, hostname, and IP > address of the originating host is suppressed in Received: header lines. > .\" XXX The option > @@ -564,28 +564,28 @@ Specify that session's HELO / EHLO shoul > .Ar helo-name . > .It Xo > .Op Ic \&! > -.Cm mail\-from > +.Cm mail-from > .Ar sender | Pf < Ar sender Ns > > .Xc > Specify that transactions's MAIL FROM should match the string or list
smtpd.conf(5)/table(5) manuals: change `\-' to `-'
Change smtpd.conf(5) and table(5) man pages to represent hyphen as plain `-'. According to mandoc_char(7), "[...] in manual pages just write plain `-' to represent hyphen, minus, and hyphen-minus." Found while comparing ssl(8), starttls(8), and smtpd.conf(5). Index: smtpd.conf.5 === RCS file: /cvs/src/usr.sbin/smtpd/smtpd.conf.5,v retrieving revision 1.210 diff -u -p -u -p -r1.210 smtpd.conf.5 --- smtpd.conf.522 Dec 2018 08:54:02 - 1.210 +++ smtpd.conf.524 Mar 2019 05:08:30 - @@ -110,12 +110,12 @@ The delivery .Ar method parameter may be one of the following: .Bl -tag -width Ds -.It Cm expand\-only +.It Cm expand-only Only accept the message if a delivery method was specified in an aliases or .Pa .forward file. -.It Cm forward\-only +.It Cm forward-only Only accept the message if the recipient results in a remote address after the processing of aliases or forward file. .It Cm lmtp Ar destination Op Ar rcpt-to @@ -223,7 +223,7 @@ with higher priority than mail exchanger Advertise .Ar heloname as the hostname to other mail exchangers during the HELO phase. -.It Cm helo\-src Pf < Ar table Ns > +.It Cm helo-src Pf < Ar table Ns > Use the mapping .Ar table to look up a hostname matching the source address, @@ -283,7 +283,7 @@ This option is usable only with option. The credential table format is described in .Xr table 5 . -.It Cm mail\-from Ar mailaddr +.It Cm mail-from Ar mailaddr Use .Ar mailaddr as the MAIL FROM address within the SMTP transaction. @@ -294,7 +294,7 @@ for the source IP address. If the list contains more than one address, all of them are used in such a way that traffic is routed as efficiently as possible. .El -.It Ic bounce Cm warn\-interval Ar delay Op , Ar delay ... +.It Ic bounce Cm warn-interval Ar delay Op , Ar delay ... Send warning messages to the envelope sender when temporary delivery failures cause a message to remain on the queue for longer than .Ar delay . @@ -308,7 +308,7 @@ At most four .Ar delay parameters can be specified. The default is -.Qq Ic bounce Cm warn\-interval No 4h , +.Qq Ic bounce Cm warn-interval No 4h , sending a single warning after four hours. .It Ic ca Ar caname Cm cert Ar cafile Associate the Certificate Authority (CA) certificate file @@ -355,7 +355,7 @@ or a credentials table .Ar authtable , the format of which is described in .Xr table 5 . -.It Cm auth\-optional Op Pf < Ar authtable Ns > +.It Cm auth-optional Op Pf < Ar authtable Ns > Support SMTPAUTH optionally: clients need not authenticate, but may do so. This allows a @@ -386,13 +386,13 @@ The table contains a mapping of IP addresses to hostnames. If the address on which the connection arrives appears in the mapping, the associated hostname is used. -.It Cm mask\-src +.It Cm mask-src Omit the .Sy from part when prepending .Dq Received headers. -.It Cm no\-dsn +.It Cm no-dsn Disable the DSN (Delivery Status Notification) extension. .It Cm pki Ar pkiname For secure connections, @@ -406,7 +406,7 @@ to prove a mail server's identity. Listen on the given .Ar port instead of the default port 25. -.It Cm received\-auth +.It Cm received-auth In .Dq Received headers, report whether the session was authenticated @@ -432,7 +432,7 @@ Clients connecting to the listener are t Support STARTTLS, by default on port 25. Mutually exclusive with .Cm smtps . -.It Cm tls\-require Op Cm verify +.It Cm tls-require Op Cm verify Like .Cm tls , but force clients to establish a secure connection @@ -442,12 +442,12 @@ With the option, clients must also provide a valid certificate to establish an SMTP session. .El -.It Ic listen on Cm socket Op Cm mask\-src +.It Ic listen on Cm socket Op Cm mask-src Listen for incoming SMTP connections on the Unix domain socket .Pa /var/run/smtpd.sock . This is done by default, even if the directive is absent. If the -.Cm mask\-src +.Cm mask-src option is specified, printing of the HELO name, hostname, and IP address of the originating host is suppressed in Received: header lines. .\" XXX The option @@ -564,28 +564,28 @@ Specify that session's HELO / EHLO shoul .Ar helo-name . .It Xo .Op Ic \&! -.Cm mail\-from +.Cm mail-from .Ar sender | Pf < Ar sender Ns > .Xc Specify that transactions's MAIL FROM should match the string or list table .Ar sender . .It Xo .Op Ic \&! -.Cm mail\-from regex +.Cm mail-from regex .Ar sender | Pf < Ar sender Ns > .Xc Specify that transactions's MAIL FROM should match the regex or regex table .Ar sender . .It Xo .Op Ic \&! -.Cm rcpt\-to +.Cm rcpt-to .Ar recipient | Pf < Ar recipient Ns > .Xc Specify that transaction's RCPT TO should match the string or list table .Ar recipient . .It Xo .Op Ic \&! -.Cm rcpt\-to regex +.Cm rcpt-to regex .Ar recipient | Pf < Ar recipient Ns > .Xc Specify that transaction's RCPT TO should match the regex or regex table @@ -626,7 +626,7 @@ When a local
