Re: Update to table(5) man page

2018-09-05 Thread Matt Schwartz
I will make those changes you want as soon as I can get to my computer.

On Wed, Sep 5, 2018, 6:23 AM Matt Schwartz 
wrote:

> Thanks guys. I really like working on documentation. Please let me know if
> I can help on anything in the future.
>
> On Wed, Sep 5, 2018, 3:22 AM Jason McIntyre  wrote:
>
>> On Tue, Sep 04, 2018 at 08:54:37AM -0400, Matt Schwartz wrote:
>> > Below is a diff to clear up the description of the Userinfo table in
>> > table(5). I also added an example of how it can be used with an Alias
>> > table.
>> >
>> > Thanks,
>> > Matt
>> >
>>
>> fixed now. thanks,
>> jmc
>>
>> > Index: table.5
>> > ===
>> > RCS file: /cvs/src/usr.sbin/smtpd/table.5,v
>> > retrieving revision 1.9
>> > diff -u -p -u -r1.9 table.5
>> > --- table.524 May 2018 20:40:21 -1.9
>> > +++ table.54 Sep 2018 12:52:47 -
>> > @@ -174,16 +174,12 @@ ipv6:::1
>> >  192.168.1.0/24
>> >  .Ed
>> >  .Ss Userinfo tables
>> > -User info tables are used to described virtual system users.
>> > -They are used in rule context to specify an alternate user base,
>> mapping
>> > -virtual users to local system UID, GID and home directory.
>> > +User info tables are used in rule context to specify an alternate user
>> base,
>> > +mapping virtual users to local system users by UID, GID and home
>> directory.
>> >  .Pp
>> >  .D1 Ic action Ar name method Cm userbase Pf < Ar table Ns >
>> >  .Pp
>> > -The userinfo table is a mapping from virtual user names to a set of
>> system user
>> > -ID, group ID and path to home directory.
>> > -.Pp
>> > -A userinfo table looks as follows:
>> > +An userinfo table looks as follows:
>> >  .Bd -literal -offset indent
>> >  joe1000:100:/home/virtual/joe
>> >  jack1000:100:/home/virtual/jack
>> > @@ -193,7 +189,15 @@ In this example, both joe and jack are v
>> >  system user with UID 1000 and GID 100, but different home directories.
>> >  These directories may contain a
>> >  .Xr forward 5
>> > -file.
>> > +file. This can be used in conjunction with an
>> > +.Cm Alias table
>> > +that maps an email address or the domain part to the desired virtual
>> > +username. For example:
>> > +.Bd -literal -offset indent
>> > +j...@example.orgjoe
>> > +j...@example.comjack
>> > +.Ed
>> > +.Pp
>> >  .Ss Source tables
>> >  Source tables are lists of IPv4 and IPv6 addresses.
>> >  They can only be used in the following context:
>> >
>>
>>


Re: Update to table(5) man page

2018-09-05 Thread Matt Schwartz
Thanks guys. I really like working on documentation. Please let me know if
I can help on anything in the future.

On Wed, Sep 5, 2018, 3:22 AM Jason McIntyre  wrote:

> On Tue, Sep 04, 2018 at 08:54:37AM -0400, Matt Schwartz wrote:
> > Below is a diff to clear up the description of the Userinfo table in
> > table(5). I also added an example of how it can be used with an Alias
> > table.
> >
> > Thanks,
> > Matt
> >
>
> fixed now. thanks,
> jmc
>
> > Index: table.5
> > ===
> > RCS file: /cvs/src/usr.sbin/smtpd/table.5,v
> > retrieving revision 1.9
> > diff -u -p -u -r1.9 table.5
> > --- table.524 May 2018 20:40:21 -1.9
> > +++ table.54 Sep 2018 12:52:47 -
> > @@ -174,16 +174,12 @@ ipv6:::1
> >  192.168.1.0/24
> >  .Ed
> >  .Ss Userinfo tables
> > -User info tables are used to described virtual system users.
> > -They are used in rule context to specify an alternate user base, mapping
> > -virtual users to local system UID, GID and home directory.
> > +User info tables are used in rule context to specify an alternate user
> base,
> > +mapping virtual users to local system users by UID, GID and home
> directory.
> >  .Pp
> >  .D1 Ic action Ar name method Cm userbase Pf < Ar table Ns >
> >  .Pp
> > -The userinfo table is a mapping from virtual user names to a set of
> system user
> > -ID, group ID and path to home directory.
> > -.Pp
> > -A userinfo table looks as follows:
> > +An userinfo table looks as follows:
> >  .Bd -literal -offset indent
> >  joe1000:100:/home/virtual/joe
> >  jack1000:100:/home/virtual/jack
> > @@ -193,7 +189,15 @@ In this example, both joe and jack are v
> >  system user with UID 1000 and GID 100, but different home directories.
> >  These directories may contain a
> >  .Xr forward 5
> > -file.
> > +file. This can be used in conjunction with an
> > +.Cm Alias table
> > +that maps an email address or the domain part to the desired virtual
> > +username. For example:
> > +.Bd -literal -offset indent
> > +j...@example.orgjoe
> > +j...@example.comjack
> > +.Ed
> > +.Pp
> >  .Ss Source tables
> >  Source tables are lists of IPv4 and IPv6 addresses.
> >  They can only be used in the following context:
> >
>
>


Re: Update to table(5) man page

2018-09-05 Thread Jason McIntyre
On Tue, Sep 04, 2018 at 08:54:37AM -0400, Matt Schwartz wrote:
> Below is a diff to clear up the description of the Userinfo table in
> table(5). I also added an example of how it can be used with an Alias
> table.
> 
> Thanks,
> Matt
> 

fixed now. thanks,
jmc

> Index: table.5
> ===
> RCS file: /cvs/src/usr.sbin/smtpd/table.5,v
> retrieving revision 1.9
> diff -u -p -u -r1.9 table.5
> --- table.524 May 2018 20:40:21 -1.9
> +++ table.54 Sep 2018 12:52:47 -
> @@ -174,16 +174,12 @@ ipv6:::1
>  192.168.1.0/24
>  .Ed
>  .Ss Userinfo tables
> -User info tables are used to described virtual system users.
> -They are used in rule context to specify an alternate user base, mapping
> -virtual users to local system UID, GID and home directory.
> +User info tables are used in rule context to specify an alternate user base,
> +mapping virtual users to local system users by UID, GID and home directory.
>  .Pp
>  .D1 Ic action Ar name method Cm userbase Pf < Ar table Ns >
>  .Pp
> -The userinfo table is a mapping from virtual user names to a set of system 
> user
> -ID, group ID and path to home directory.
> -.Pp
> -A userinfo table looks as follows:
> +An userinfo table looks as follows:
>  .Bd -literal -offset indent
>  joe1000:100:/home/virtual/joe
>  jack1000:100:/home/virtual/jack
> @@ -193,7 +189,15 @@ In this example, both joe and jack are v
>  system user with UID 1000 and GID 100, but different home directories.
>  These directories may contain a
>  .Xr forward 5
> -file.
> +file. This can be used in conjunction with an
> +.Cm Alias table
> +that maps an email address or the domain part to the desired virtual
> +username. For example:
> +.Bd -literal -offset indent
> +j...@example.orgjoe
> +j...@example.comjack
> +.Ed
> +.Pp
>  .Ss Source tables
>  Source tables are lists of IPv4 and IPv6 addresses.
>  They can only be used in the following context:
> 



Re: Update to table(5) man page

2018-09-05 Thread Gilles Chehade
On Wed, Sep 05, 2018 at 07:08:39AM +0100, Jason McIntyre wrote:
> On Tue, Sep 04, 2018 at 08:54:37AM -0400, Matt Schwartz wrote:
> > Below is a diff to clear up the description of the Userinfo table in
> > table(5). I also added an example of how it can be used with an Alias
> > table.
> > 
> > Thanks,
> > Matt
> > 
> 
> [...]
>
> 
> i think your diff reads better than what's there now. gilles, eric?
> 

agreed



-- 
Gilles Chehade

https://www.poolp.org  @poolpOrg



Re: Update to table(5) man page

2018-09-05 Thread Jason McIntyre
On Tue, Sep 04, 2018 at 08:54:37AM -0400, Matt Schwartz wrote:
> Below is a diff to clear up the description of the Userinfo table in
> table(5). I also added an example of how it can be used with an Alias
> table.
> 
> Thanks,
> Matt
> 

morning.

comments inline.

> Index: table.5
> ===
> RCS file: /cvs/src/usr.sbin/smtpd/table.5,v
> retrieving revision 1.9
> diff -u -p -u -r1.9 table.5
> --- table.524 May 2018 20:40:21 -1.9
> +++ table.54 Sep 2018 12:52:47 -
> @@ -174,16 +174,12 @@ ipv6:::1
>  192.168.1.0/24
>  .Ed
>  .Ss Userinfo tables
> -User info tables are used to described virtual system users.
> -They are used in rule context to specify an alternate user base, mapping
> -virtual users to local system UID, GID and home directory.
> +User info tables are used in rule context to specify an alternate user base,
> +mapping virtual users to local system users by UID, GID and home directory.
>  .Pp
>  .D1 Ic action Ar name method Cm userbase Pf < Ar table Ns >
>  .Pp
> -The userinfo table is a mapping from virtual user names to a set of system 
> user
> -ID, group ID and path to home directory.
> -.Pp
> -A userinfo table looks as follows:
> +An userinfo table looks as follows:

"A" not "An"

>  .Bd -literal -offset indent
>  joe1000:100:/home/virtual/joe
>  jack1000:100:/home/virtual/jack
> @@ -193,7 +189,15 @@ In this example, both joe and jack are v
>  system user with UID 1000 and GID 100, but different home directories.
>  These directories may contain a
>  .Xr forward 5
> -file.
> +file. This can be used in conjunction with an

start new sentences on new lines in man pages

> +.Cm Alias table

i would not mark up "Alias table". i think plain "alias table", without
uppercase, is enough

> +that maps an email address or the domain part to the desired virtual
> +username. For example:

again, new sentence, new line

> +.Bd -literal -offset indent
> +j...@example.orgjoe
> +j...@example.comjack
> +.Ed
> +.Pp
>  .Ss Source tables
>  Source tables are lists of IPv4 and IPv6 addresses.
>  They can only be used in the following context:
>

i think your diff reads better than what's there now. gilles, eric?

jmc



Update to table(5) man page

2018-09-04 Thread Matt Schwartz
Below is a diff to clear up the description of the Userinfo table in
table(5). I also added an example of how it can be used with an Alias
table.

Thanks,
Matt

Index: table.5
===
RCS file: /cvs/src/usr.sbin/smtpd/table.5,v
retrieving revision 1.9
diff -u -p -u -r1.9 table.5
--- table.524 May 2018 20:40:21 -1.9
+++ table.54 Sep 2018 12:52:47 -
@@ -174,16 +174,12 @@ ipv6:::1
 192.168.1.0/24
 .Ed
 .Ss Userinfo tables
-User info tables are used to described virtual system users.
-They are used in rule context to specify an alternate user base, mapping
-virtual users to local system UID, GID and home directory.
+User info tables are used in rule context to specify an alternate user base,
+mapping virtual users to local system users by UID, GID and home directory.
 .Pp
 .D1 Ic action Ar name method Cm userbase Pf < Ar table Ns >
 .Pp
-The userinfo table is a mapping from virtual user names to a set of system user
-ID, group ID and path to home directory.
-.Pp
-A userinfo table looks as follows:
+An userinfo table looks as follows:
 .Bd -literal -offset indent
 joe1000:100:/home/virtual/joe
 jack1000:100:/home/virtual/jack
@@ -193,7 +189,15 @@ In this example, both joe and jack are v
 system user with UID 1000 and GID 100, but different home directories.
 These directories may contain a
 .Xr forward 5
-file.
+file. This can be used in conjunction with an
+.Cm Alias table
+that maps an email address or the domain part to the desired virtual
+username. For example:
+.Bd -literal -offset indent
+j...@example.orgjoe
+j...@example.comjack
+.Ed
+.Pp
 .Ss Source tables
 Source tables are lists of IPv4 and IPv6 addresses.
 They can only be used in the following context: