Re: OpenSMTPD docs: smtpd.conf.5
On Fri, Feb 12, 2021 at 03:29:02PM +, Larry Hynes wrote: > > Index: smtpd.conf.5 > === > RCS file: /cvs/src/usr.sbin/smtpd/smtpd.conf.5,v > retrieving revision 1.256 > diff -u -p -r1.256 smtpd.conf.5 > --- smtpd.conf.5 27 Jan 2021 14:59:10 - 1.256 > +++ smtpd.conf.5 12 Feb 2021 15:28:04 - > @@ -184,7 +184,7 @@ Specify how long a message may remain in > .It Cm user Ar username > Specify the > .Ar username > -for performing the delivery, to be looked up with > +to perform the delivery, looked up with > .Xr getpwnam 3 . > .Pp > This is used for virtual hosting where a single username > @@ -202,7 +202,7 @@ function. > .Pp > The > .Cm userbase > -does not apply for the > +does not apply to the taken > .Cm user > option. > .It Cm virtual Pf < Ar table Ns > > @@ -322,13 +322,13 @@ If the list contains more than one addre > in such a way that traffic is routed as efficiently as possible. > .El > .It Ic admd Ar authservid > -The Administrative Management Domain this mailserver belongs to. > +The Administrative Management Domain this mail server belongs to. i committed this since every other instance in this page is two words, not one > The authservid will be forwarded to filters using it to identify or mark > authentication-results headers. > If omitted it defaults to the server name. > .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 > +failures cause a message to remain in the queue for longer than i think it's probably ok to say "on the queue" but i agree "in the queue" is probably more usual, so i took this > .Ar delay . > Each > .Ar delay > @@ -359,11 +359,11 @@ directive. > .It Ic filter Ar chain-name Ic chain Brq Ar filter-name Op , Ar ... > Register a chain of filters > .Ar chain-name , > -consisting of the filters listed from > +consisting of the filters listed in taken > .Ar filter-name . > -Filters part of a filter chain are executed in order of declaration for > -each phase that they are registered for. > -A filter chain may be used in place of a filter for any directive but > +Filters in a filter chain are executed in order of declaration > +for each phase that they are registered for. > +A filter chain may be used in place of a filter for any directive except > filter chains themselves. taken > .It Ic filter Ar filter-name Ic phase Ar phase-name Ic match Ar conditions > decision > Register a filter > @@ -372,8 +372,9 @@ A > .Ar decision > about what to do with the mail is taken at phase > .Ar phase-name > -when matching > -.Ar conditions . > +when > +.Ar conditions > +are matched. > Phases, matching conditions, and decisions are described in > .Sx MAIL FILTERING , > below. > @@ -387,15 +388,15 @@ backed by the > process. > .It Ic filter Ar filter-name Ic proc-exec Ar command > Register and execute > -.Qq proc > +.Ar command > +as > +.Qq proc-exec > filter > -.Ar filter-name > -from > -.Ar command . > +.Ar filter-name . i don;t understand enough about what is happening here. can you resubmit an updated diff once i have committed your changes to this file, preferrably with an example, and i will try and get some feedback for it. > If > .Ar command > starts with a slash it is executed with an absolute path, > -else it will be run from > +otherwise it will be run from taken > .Dq /usr/local/libexec/smtpd/ . > .It Ic include Qq Ar pathname > Replace this directive with the content of the additional configuration > @@ -404,7 +405,7 @@ file at the absolute > .It Ic listen on Ar interface Oo Ar family Oc Op Ar options > Listen on the > .Ar interface > -for incoming connections, using the same syntax as for > +for incoming connections, using the same syntax as taken > .Xr ifconfig 8 . > The > .Ar interface > @@ -461,7 +462,7 @@ Override the server name for specific ad > The > .Ar names > table contains a mapping of IP addresses to hostnames. > -If the address on which the connection arrives appears in the mapping, > +If the address on which the connection is made appears in the mapping, > the associated hostname is used. > .It Cm mask-src > Omit the > @@ -485,7 +486,7 @@ Listen on the given > instead of the default port 25. > .It Cm proxy-v2 > Support the PROXYv2 protocol, > -rewriting appropriately source address received from proxy. > +appropriately rewriting the source address passed from the proxy. taken > .It Cm received-auth > In > .Dq Received > @@ -555,7 +556,8 @@ matching envelope, and atomically save t > spool for later processing by the respective dispatcher > .Ar name . > .Pp > -The following matching options are supported and can all be negated: > +The following session matching options are supported and can all > +be negated: > .Bl -tag -width Ds > .It Xo > .Op Ic \&! > @@
OpenSMTPD docs: smtpd.conf.5
Index: smtpd.conf.5 === RCS file: /cvs/src/usr.sbin/smtpd/smtpd.conf.5,v retrieving revision 1.256 diff -u -p -r1.256 smtpd.conf.5 --- smtpd.conf.527 Jan 2021 14:59:10 - 1.256 +++ smtpd.conf.512 Feb 2021 15:28:04 - @@ -184,7 +184,7 @@ Specify how long a message may remain in .It Cm user Ar username Specify the .Ar username -for performing the delivery, to be looked up with +to perform the delivery, looked up with .Xr getpwnam 3 . .Pp This is used for virtual hosting where a single username @@ -202,7 +202,7 @@ function. .Pp The .Cm userbase -does not apply for the +does not apply to the .Cm user option. .It Cm virtual Pf < Ar table Ns > @@ -322,13 +322,13 @@ If the list contains more than one addre in such a way that traffic is routed as efficiently as possible. .El .It Ic admd Ar authservid -The Administrative Management Domain this mailserver belongs to. +The Administrative Management Domain this mail server belongs to. The authservid will be forwarded to filters using it to identify or mark authentication-results headers. If omitted it defaults to the server name. .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 +failures cause a message to remain in the queue for longer than .Ar delay . Each .Ar delay @@ -359,11 +359,11 @@ directive. .It Ic filter Ar chain-name Ic chain Brq Ar filter-name Op , Ar ... Register a chain of filters .Ar chain-name , -consisting of the filters listed from +consisting of the filters listed in .Ar filter-name . -Filters part of a filter chain are executed in order of declaration for -each phase that they are registered for. -A filter chain may be used in place of a filter for any directive but +Filters in a filter chain are executed in order of declaration +for each phase that they are registered for. +A filter chain may be used in place of a filter for any directive except filter chains themselves. .It Ic filter Ar filter-name Ic phase Ar phase-name Ic match Ar conditions decision Register a filter @@ -372,8 +372,9 @@ A .Ar decision about what to do with the mail is taken at phase .Ar phase-name -when matching -.Ar conditions . +when +.Ar conditions +are matched. Phases, matching conditions, and decisions are described in .Sx MAIL FILTERING , below. @@ -387,15 +388,15 @@ backed by the process. .It Ic filter Ar filter-name Ic proc-exec Ar command Register and execute -.Qq proc +.Ar command +as +.Qq proc-exec filter -.Ar filter-name -from -.Ar command . +.Ar filter-name . If .Ar command starts with a slash it is executed with an absolute path, -else it will be run from +otherwise it will be run from .Dq /usr/local/libexec/smtpd/ . .It Ic include Qq Ar pathname Replace this directive with the content of the additional configuration @@ -404,7 +405,7 @@ file at the absolute .It Ic listen on Ar interface Oo Ar family Oc Op Ar options Listen on the .Ar interface -for incoming connections, using the same syntax as for +for incoming connections, using the same syntax as .Xr ifconfig 8 . The .Ar interface @@ -461,7 +462,7 @@ Override the server name for specific ad The .Ar names table contains a mapping of IP addresses to hostnames. -If the address on which the connection arrives appears in the mapping, +If the address on which the connection is made appears in the mapping, the associated hostname is used. .It Cm mask-src Omit the @@ -485,7 +486,7 @@ Listen on the given instead of the default port 25. .It Cm proxy-v2 Support the PROXYv2 protocol, -rewriting appropriately source address received from proxy. +appropriately rewriting the source address passed from the proxy. .It Cm received-auth In .Dq Received @@ -555,7 +556,8 @@ matching envelope, and atomically save t spool for later processing by the respective dispatcher .Ar name . .Pp -The following matching options are supported and can all be negated: +The following session matching options are supported and can all +be negated: .Bl -tag -width Ds .It Xo .Op Ic \&! @@ -691,7 +693,7 @@ Specify that session may only originate which can be a specific address or a subnet expressed in CIDR-notation. .El .Pp -In addition, the following transaction options: +In addition, the following transaction options may be matched: .Bl -tag -width Ds .It Xo .Op Ic \&! @@ -731,14 +733,14 @@ Specify that session's HELO / EHLO shoul .Cm mail-from .Ar sender | Pf < Ar sender Ns > .Xc -Specify that transactions's MAIL FROM should match the string or list table +Specify that transaction's MAIL FROM should match the string or list table .Ar sender . .It Xo .Op Ic \&! .Cm mail-from regex .Ar sender | Pf < Ar sender Ns > .Xc -Specify that transactions's MAIL FROM should match the regex or regex table +Specify that transaction's MAIL FROM
