From 437835944cbf84fe36bdc5c7901407745fcb8d2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ant=C3=B3nio=20P=2E=20P=2E=20Almeida?= Date: Tue, 9 Aug 2011 06:00:20 +0100 Subject: [PATCH] * Updated the manpage. --- man/index.txt | 4 + man/nginx_ensite.8 | 161 ++++++++++++++++++++++------------------ man/nginx_ensite.8.ronn | 40 +++++++--- 3 files changed, 124 insertions(+), 81 deletions(-) create mode 100644 man/index.txt diff --git a/man/index.txt b/man/index.txt new file mode 100644 index 0000000..22395c1 --- /dev/null +++ b/man/index.txt @@ -0,0 +1,4 @@ +## Manuals referenced on this project. +a2ensite(8) http://man.cx/a2ensite +a2dissite(8) http://man.cx/a2dissite +nginx(1) http://man.cx/nginx diff --git a/man/nginx_ensite.8 b/man/nginx_ensite.8 index 772ed9f..e73f091 100644 --- a/man/nginx_ensite.8 +++ b/man/nginx_ensite.8 @@ -1,71 +1,90 @@ -.\" Hey, EMACS: -*- nroff -*- -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH NGINX_ENSITE 8 "31 August 2010" -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for manpage-specific macros, see man(7) -.AM -.SH NAME -nginx_ensite, nginx_dissite \- enable or disable an nginx site / virtual host -.SH SYNOPSIS -.B nginx_ensite -.RI [ site ] -.PP -.B nginx_dissite -.RI [ site ] -.SH DESCRIPTION -This manual page documents briefly the -.B nginx_ensite -and -.B nginx_dissite -commands. -.PP -.B nginx_ensite -is a script that enables the specified site which is included in a -http block within the -.B nginx -configuration. It does this by creating symlinks within -.BR /etc/nginx/sites-enabled . -Likewise, -.B nginx_dissite -disables a site by removing those symlinks. It is not an error to -enable a site which is already enabled, or to disable one which is -already disabled. -.PP -The -.B default -site is handled specially: The resulting symlink will be called -.B 000-default -in order to be loaded first. -.SH EXAMPLES -.RS -.B "nginx_dissite default" -.RE -.PP -Disables the -.B default -site. -.SH FILES -.TP -.B /etc/nginx/sites-available -Directory with files giving information on available sites. -.TP -.B /etc/nginx/sites-enabled -Directory with links to the files in -.B sites-available -for enabled sites. -.SH AUTHOR -This manual page was written by Ant\['o]nio Almeida -(based on the a2ensite manual -page by Stefan Fritsch ) for the Debian GNU/Linux distribution. +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "NGINX_ENSITE" "8" "August 2011" "" "" +. +.SH "NAME" +\fBnginx_ensite\fR \- enable/disable an nginx site/virtual host +. +.SH "SYNOPSIS" +\fBnginx_ensite\fR [ \fIsite\fR ]\.\.\. +. +.br +\fBnginx_dissite\fR [ \fIsite\fR ]\.\.\. +. +.br +. +.SH "DESCRIPTION" +This manual page documents briefly the nginx_ensite and nginx_dissite commands\. +. +.P +nginx_ensite is a script that \fBenables\fR the specified site which is included in a http block within the nginx configuration\. It does this by creating symlinks within \fB/etc/nginx/sites\-enabled\fR\. +. +.P +Likewise, nginx_dissite disables a site by removing those symlinks\. It is not an error to enable a site which is already enabled, or to disable one which is already disabled\. +. +.P +The default site is handled specially: the resulting symlink will be called \fB000\-default\fR in order to be listed first\. Note that listing \(em as done by \fBls\fR \(em orders the files lexicographically\. Nginx loads the files by the OS provided order\. To make sure a specific server configuration is loaded first specify the \fBdefault_server\fR parameter on the \fBlisten\fR \fIhttp://wiki\.nginx\.org/HttpCoreModule#listen\fR directive of that server configuration\. +. +.SH "EXAMPLES" +Enable the default site: +. +.IP "" 4 +. +.nf + +nginx_ensite 000\-default +. +.fi +. +.IP "" 0 +. +.P +Disable the default site: +. +.IP "" 4 +. +.nf + +nginx_dissite 000\-default +. +.fi +. +.IP "" 0 +. +.P +Enable the example\.org site: +. +.IP "" 4 +. +.nf + +nginx_ensite example\.org +. +.fi +. +.IP "" 0 +. +.SH "FILES" +\fB/etc/nginx/sites\-available\fR +. +.br +Directory with files providing information on available sites\. +. +.P +\fB/etc/nginx/sites\-enabled\fR +. +.br +Directory with links to the files in \fBsites\-available\fR for enabled sites\. +. +.SH "SEE ALSO" +a2ensite(8), a2dissite(8), nginx(1) +. +.SH "COPYRIGHT" +nginx_ensite is Copyright (C) 2010\-2011 Antonio P\. P\. Almeida under the terms of a MIT license\. +. +.SH "AVAILABILITY" +The latest version of nginx_ensite is available from: \fIhttps://github\.com/perusio/nginx_ensite\fR\. +. +.SH "AUTHOR" +nginx_ensite was written by Antonio P\. P\. Almeida that also wrote the manual page based on the \fBa2ensite\fR manual page by Stefan Fritsch for the Debian GNU/Linux distribution\. diff --git a/man/nginx_ensite.8.ronn b/man/nginx_ensite.8.ronn index 88aefec..f239069 100644 --- a/man/nginx_ensite.8.ronn +++ b/man/nginx_ensite.8.ronn @@ -1,5 +1,5 @@ nginx\_dissite, nginx\_ensite -- enable/disable an nginx site/virtual host -================================================================================ +========================================================================== ## SYNOPSIS @@ -20,17 +20,26 @@ symlinks. It is not an error to enable a site which is already enabled, or to disable one which is already disabled. The default site is handled specially: the resulting symlink will be -called `000-default` in order to be loaded first. +called `000-default` in order to be listed first. Note that listing +— as done by `ls` — orders the files +lexicographically. Nginx loads the files by the OS provided order. To +make sure a specific server configuration is loaded first specify the +`default_server` parameter on the +[`listen`](http://wiki.nginx.org/HttpCoreModule#listen) directive of +that server configuration. ## EXAMPLES Enable the default site: - nginx_ensite default + + nginx_ensite 000-default Disable the default site: - nginx_dissite default + + nginx_dissite 000-default Enable the example.org site: + nginx_ensite example.org ## FILES @@ -41,12 +50,23 @@ Directory with files providing information on available sites. `/etc/nginx/sites-enabled`
Directory with links to the files in `sites-available` for enabled sites. -## AUTHOR +## SEE ALSO -This manual page was written by Antonio Almeida \ -— based on the `a2ensite` manual page by Stefan Fritsch -\ for the Debian GNU/Linux distribution. +a2ensite(8), a2dissite(8), nginx(1) -## SEE ALSO +## COPYRIGHT + +nginx_ensite is Copyright (C) 2010-2011 Antonio P. P. Almeida +\ under the terms of a MIT license. + +## AVAILABILITY + +The latest version of nginx_ensite is available from: +[https://github.com/perusio/nginx_ensite](https://github.com/perusio/nginx_ensite). + +## AUTHOR + +nginx_ensite was written by Antonio P. P. Almeida \ +that also wrote the manual page based on the `a2ensite` manual page by +Stefan Fritsch \ for the Debian GNU/Linux distribution. -a2ensite(8), a2dissite(8)