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 -0000 1.210
> +++ smtpd.conf.5 24 Mar 2019 05:08:30 -0000
> @@ -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 delivery specifies a wrappe
> associated with the wrapper will be executed instead.
> The command may contain format specifiers
> .Pq see Sx FORMAT SPECIFIERS .
> -.It Ic mta Cm max\-deferred Ar number
> +.It Ic mta Cm max-deferred Ar number
> When delivery to a given host is suspended due to temporary failures,
> cache at most
> .Ar number
> @@ -692,7 +692,7 @@ is specified, it is read with
> If the string
> .Cm stdin
> or a single dash
> -.Pq Ql \-
> +.Pq Ql -
> is given instead of a
> .Ar key ,
> the key is read from the standard input.
> @@ -711,14 +711,14 @@ string for
> .Xr SSL_CTX_set_cipher_list 3 .
> The default is
> .Qq HIGH:!aNULL:!MD5 .
> -.It Ic smtp Cm max\-message\-size Ar size
> +.It Ic smtp Cm max-message-size Ar size
> Reject messages larger than
> .Ar size ,
> given as a positive number of bytes or as a string to be parsed with
> .Xr scan_scaled 3 .
> The default is
> .Qq 35M .
> -.It Ic smtp Cm sub\-addr\-delim Ar character
> +.It Ic smtp Cm sub-addr-delim Ar character
> When resolving the local part of a local email address, ignore the ASCII
> .Ar character
> and all characters following it.
> @@ -792,13 +792,13 @@ Expansion formats also support partial e
> bracket notations with substring offset.
> For example, with recipient domain
> .Dq example.org :
> -.Bl -column %{rcpt.domain[0:\-4]} -offset indent
> +.Bl -column %{rcpt.domain[0:-4]} -offset indent
> .It %{rcpt.domain[0]} Ta expands to Dq e
> .It %{rcpt.domain[1]} Ta expands to Dq x
> .It %{rcpt.domain[8:]} Ta expands to Dq org
> -.It %{rcpt.domain[\-3:]} Ta expands to Dq org
> +.It %{rcpt.domain[-3:]} Ta expands to Dq org
> .It %{rcpt.domain[0:6]} Ta expands to Dq example
> -.It %{rcpt.domain[0:\-4]} Ta expands to Dq example
> +.It %{rcpt.domain[0:-4]} Ta expands to Dq example
> .El
> .Pp
> In addition, modifiers may be applied to the token.
> @@ -887,9 +887,9 @@ The mail server listens on all interface
> Mail with a local destination is sent to an external MDA.
> First, the RSA certificate is created:
> .Bd -literal -offset indent
> -# openssl genrsa \-out /etc/ssl/private/mail.example.com.key 4096
> -# openssl req \-new \-x509 \-key /etc/ssl/private/mail.example.com.key \e
> - \-out /etc/ssl/mail.example.com.crt \-days 365
> +# openssl genrsa -out /etc/ssl/private/mail.example.com.key 4096
> +# openssl req -new -x509 -key /etc/ssl/private/mail.example.com.key \e
> + -out /etc/ssl/mail.example.com.crt -days 365
> # chmod 600 /etc/ssl/mail.example.com.crt
> # chmod 600 /etc/ssl/private/mail.example.com.key
> .Ed
> @@ -906,8 +906,8 @@ table aliases file:/etc/mail/aliases
> listen on lo0
> listen on egress tls pki mail.example.com auth
>
> -action mda_with_aliases mda "/path/to/mda \-f \-" alias <aliases>
> -action mda_without_aliases mda "/path/to/mda \-f \-"
> +action mda_with_aliases mda "/path/to/mda -f -" alias <aliases>
> +action mda_without_aliases mda "/path/to/mda -f -"
> action "relay" relay
>
> match for local action mda_with_aliases
> @@ -957,7 +957,7 @@ action "relay" relay
>
> match for local action "mbox"
> match for any action "relay"
> -match !from src <other-relays> mail\-from "@example.com" for any \e
> +match !from src <other-relays> mail-from "@example.com" for any \e
> reject
> match from any for domain example.com action "mbox"
> .Ed
> Index: table.5
> ===================================================================
> RCS file: /cvs/src/usr.sbin/smtpd/table.5,v
> retrieving revision 1.10
> diff -u -p -u -p -r1.10 table.5
> --- table.5 5 Sep 2018 07:19:35 -0000 1.10
> +++ table.5 24 Mar 2019 05:08:30 -0000
> @@ -219,8 +219,8 @@ ipv6:::4
> Mailaddr tables are lists of email addresses.
> They can be used in the following contexts:
> .Bd -unfilled -offset indent
> -.Ic match Cm mail\-from Pf < Ar table Ns > Cm action Ar name
> -.Ic match Cm rcpt\-to Pf < Ar table Ns > Cm action Ar name
> +.Ic match Cm mail-from Pf < Ar table Ns > Cm action Ar name
> +.Ic match Cm rcpt-to Pf < Ar table Ns > Cm action Ar name
> .Ed
> .Pp
> A mailaddr entry is used to match an email address against a username,
> @@ -239,7 +239,7 @@ Addrname tables are used to map IP addre
> They can be used in both listen context and relay context:
> .Bd -unfilled -offset indent
> .Ic listen on Ar interface Cm hostnames Pf < Ar table Ns >
> -.Ic action Ar name Cm relay helo\-src Pf < Ar table Ns >
> +.Ic action Ar name Cm relay helo-src Pf < Ar table Ns >
> .Ed
> .Pp
> In listen context, the table is used to look up the server name to advertise
>
