[PATCH] Update nginx(8) manual page

Sergey A. Osokin osa at freebsd.org.ru
Fri Dec 6 00:17:21 UTC 2019


Hi Ruslan,

thank you very much for the review.
Could you please go ahead and commit the changes.

--
Sergey Osokin

On Thu, Dec 05, 2019 at 02:04:08PM +0300, Ruslan Ermilov wrote:
> On Sun, Dec 01, 2019 at 04:41:23AM +0300, Sergey A. Osokin wrote:
> > # HG changeset patch
> > # User Sergey A. Osokin <osa at FreeBSD.org.ru>
> > # Date 1575163872 -10800
> > #      Sun Dec 01 04:31:12 2019 +0300
> > # Node ID 477a78d1b14e415a80b6bfb3d829eb408f33f390
> > # Parent  d13eddd9e2529b4bc30dc00aad959bd10ced4c33
> > Update nginx(8) manual page.
> > Sort the command line options.
> > 
> > diff -r d13eddd9e252 -r 477a78d1b14e docs/man/nginx.8
> > --- a/docs/man/nginx.8	Tue Nov 19 17:18:58 2019 +0300
> > +++ b/docs/man/nginx.8	Sun Dec 01 04:31:12 2019 +0300
> > @@ -1,5 +1,5 @@
> >  .\"
> > -.\" Copyright (C) 2010 Sergey A. Osokin
> > +.\" Copyright (C) 2010, 2019 Sergey A. Osokin
> >  .\" Copyright (C) Nginx, Inc.
> >  .\" All rights reserved.
> >  .\"
> 
> The document date should be updated.
> 
> > @@ -42,9 +42,9 @@
> >  .Nm
> >  (pronounced
> >  .Dq engine x )
> > -is an HTTP and reverse proxy server, as well as a mail proxy server.
> > -It is known for its high performance, stability, rich feature set, simple
> > -configuration, and low resource consumption.
> > +is an HTTP and reverse proxy server, a mail proxy server, and a generic
> > +TCP/UDP proxy server.  It is known for its high performance, stability,
> > +rich feature set, simple configuration, and low resource consumption.
> 
> Each new sentence should start on its own line.
> 
> >  .Pp
> >  The options are as follows:
> >  .Bl -tag -width ".Fl d Ar directives"
> > @@ -91,16 +91,16 @@
> >  Same as
> >  .Fl t ,
> >  but additionally dump configuration files to standard output.
> > +.It Fl v
> > +Print the
> > +.Nm
> > +version.
> >  .It Fl V
> >  Print the
> >  .Nm
> >  version, compiler version, and
> >  .Pa configure
> >  script parameters.
> > -.It Fl v
> > -Print the
> > -.Nm
> > -version.
> >  .El
> >  .Sh SIGNALS
> >  The master process of
> 
> In ASCII, capital letters come first, and mdoc(7) follows the same
> sorting order.  The correct fix would be to interchange -T with -t.
> 
> # HG changeset patch
> # User Sergey A. Osokin <osa at FreeBSD.org.ru>
> # Date 1575543437 -10800
> #      Thu Dec 05 13:57:17 2019 +0300
> # Node ID 5186ed8aa6330230205b69ba05ff449457b67410
> # Parent  03bd76ca0fd8ce0628503a0a4cd453fbb206bafe
> Update manpage, sort command line options.
> 
> diff --git a/docs/man/nginx.8 b/docs/man/nginx.8
> --- a/docs/man/nginx.8
> +++ b/docs/man/nginx.8
> @@ -1,5 +1,5 @@
>  .\"
> -.\" Copyright (C) 2010 Sergey A. Osokin
> +.\" Copyright (C) 2010, 2019 Sergey A. Osokin
>  .\" Copyright (C) Nginx, Inc.
>  .\" All rights reserved.
>  .\"
> @@ -25,7 +25,7 @@
>  .\" SUCH DAMAGE.
>  .\"
>  .\"
> -.Dd June 16, 2015
> +.Dd December 5, 2019
>  .Dt NGINX 8
>  .Os
>  .Sh NAME
> @@ -42,7 +42,8 @@
>  .Nm
>  (pronounced
>  .Dq engine x )
> -is an HTTP and reverse proxy server, as well as a mail proxy server.
> +is an HTTP and reverse proxy server, a mail proxy server, and a generic
> +TCP/UDP proxy server.
>  It is known for its high performance, stability, rich feature set, simple
>  configuration, and low resource consumption.
>  .Pp
> @@ -82,15 +83,15 @@ The following table shows the correspond
>  .It Cm reload
>  .Dv SIGHUP
>  .El
> +.It Fl T
> +Same as
> +.Fl t ,
> +but additionally dump configuration files to standard output.
>  .It Fl t
>  Do not run, just test the configuration file.
>  .Nm
>  checks the configuration file syntax and then tries to open files
>  referenced in the configuration file.
> -.It Fl T
> -Same as
> -.Fl t ,
> -but additionally dump configuration files to standard output.
>  .It Fl V
>  Print the
>  .Nm
> _______________________________________________
> nginx-devel mailing list
> nginx-devel at nginx.org
> http://mailman.nginx.org/mailman/listinfo/nginx-devel


More information about the nginx-devel mailing list