Welcome! Log In Create A New Profile

Advanced

Re: nginx.conf(5) man page

Maxim Konovalov
September 24, 2013 10:36AM
Hi Florian.

On 9/24/13 6:24 PM, Florian Obser wrote:
> Hi,
> OpenBSD is working on replacing the (heavily patched) apache 1.3 in
> base with nginx. During that work the question was raised if we can
> have a nginx.conf(5) man page.

Nice to hear.

> As a proof of concept I put a perl script together which scrapes the
> pages on http://nginx.org/en/docs/ (below "Modules reference") and
> generates a mdoc(7) file.
> * what's the license of the documentation?

It's under the same license as the whole nginx distribution:

http://nginx.org/LICENSE

> * is the documentation on http://nginx.org/en/docs/ generated from some
> sort of source file? Parsing the html works reasonably well but is not
> optimal.

It is generated from xml files. The whole nginx.org repository is
public (see "Source Code" section):

http://nginx.org/en/download.html

Also, you can explore it online:

http://trac.nginx.org/nginx/browser/nginx_org

Please note that http://nginx.org/en/docs/ has documentation
for nginx f/oss and nginx-plus, our commercial product under
commercial license.

The features available in nginx-plus only have an appropriate note
in the documentation.

> * would there be interest to include a man page into the distribution
> once it's ready?

I think it's a good idea while we manage to keep a single source for
both nginx.org docs and man page.

--
Maxim Konovalov
http://nginx.com

_______________________________________________
nginx mailing list
nginx@nginx.org
http://mailman.nginx.org/mailman/listinfo/nginx
Subject Author Posted

nginx.conf(5) man page

Florian Obser September 24, 2013 10:26AM

Re: nginx.conf(5) man page

Maxim Konovalov September 24, 2013 10:36AM

Re: nginx.conf(5) man page

Maxim Dounin September 24, 2013 10:46AM

Re: nginx.conf(5) man page

Maxim Konovalov September 24, 2013 10:46AM

Re: nginx.conf(5) man page

Maxim Dounin September 24, 2013 10:56AM



Sorry, only registered users may post in this forum.

Click here to login

Online Users

Guests: 259
Record Number of Users: 8 on April 13, 2023
Record Number of Guests: 421 on December 02, 2018
Powered by nginx      Powered by FreeBSD      PHP Powered      Powered by MariaDB      ipv6 ready