On Wed, Aug 01, 2018 at 12:57:18PM +0200, Florian Obser wrote:
> On Tue, Jul 31, 2018 at 06:39:18PM -0500, Andrew Daugherity wrote:
> [...] 
> > Related: in the same section of code (at the end of my diff actually,
> > as context), I noticed that when -u is used, the chroot path is set to
> > the target user's home directory instead of /var/www.  I found this
> > surprising, so I added a manpage diff to my patchset:
> > ====
> > --- slowcgi.8 2017-10-17 17:47:58.000000000 -0500
> > +++ slowcgi.8 2018-07-26 13:34:06.459779115 -0500
> > @@ -78,7 +78,9 @@
> >  .It Fl u Ar user
> >  Drop privileges to
> >  .Ar user
> > -instead of default user www.
> > +instead of the default www, and chroot to that user's home directory,
> > +unless you specify otherwise with
> > +.Ar -p .
> >  .El
> >  .Sh SEE ALSO
> >  .Xr httpd 8
> > ====
> > Perhaps that's a bit too wordy and only the first line is needed, I dunno.
> 
> How about this? jmc?
> 
> diff --git slowcgi.8 slowcgi.8
> index 52bded7eee6..117228403b4 100644
> --- slowcgi.8
> +++ slowcgi.8
> @@ -79,6 +79,12 @@ Create and bind to alternative local socket at
>  Drop privileges to
>  .Ar user
>  instead of default user www.
> +.Nm
> +will
> +.Xr chroot 8
> +to
> +the home directory of
> +.Ar user .

reads ok. you could shorten it to:

        ... user www
        and
        .Xr chroot 8
        ...

>  .El
>  .Sh SEE ALSO
>  .Xr httpd 8
> 
> Jmc: Btw, why are we using the section 8 man page in Xr, technically
> slowcgi uses chroot(2).
> 

we tend to try and use userland refs in userland docs. however if it
makes more sense to reference chroot(2), by all means do so (whichever
will be the most use to the target reader).

jmc

Reply via email to