diff xml/en/docs/install.xml @ 271:4c6d2c614d2c

Cleaned up XML tag mess: - all of <parameter> and <code>, and some of <dirname>, <value>, and <command> were replaced by <literal>; - the rest of <dirname> were replaced by links; - <argument> were replaced by <value>; - <value> is now rendered in HTML in italic; - <literal> and <path> can now contain <value>. Cleaned up terminology mess: - directives take "parameters".
author Ruslan Ermilov <ru@nginx.com>
date Fri, 23 Dec 2011 17:29:59 +0000
parents 06b4c1f3149d
children 64107bc400c4
line wrap: on
line diff
--- a/xml/en/docs/install.xml
+++ b/xml/en/docs/install.xml
@@ -10,87 +10,87 @@
 The build is configured using the <command>configure</command> command.
 It defines various aspects of the system, including the methods nginx
 is allowed to use for connection processing.
-At the end it creates a <command>Makefile</command>.
+At the end it creates a <path>Makefile</path>.
 The <command>configure</command> command supports the following parameters:
 <list>
 
 <listitem>
 <para>
-<command>--prefix=&lt;<value>path</value>&gt;</command>&mdash;defines
+<literal>--prefix=<value>path</value></literal>&mdash;defines
 a directory that will keep server files.
 This same directory will also be used for all relative paths set by
-<command>./configure</command> (except for paths to libraries sources)
-and in the <command>nginx.conf</command> configuration file.
-It is set to the <command>/usr/local/nginx</command> directory by default.
+<command>configure</command> (except for paths to libraries sources)
+and in the <path>nginx.conf</path> configuration file.
+It is set to the <path>/usr/local/nginx</path> directory by default.
 </para>
 </listitem>
 
 <listitem>
 <para>
-<command>--sbin-path=&lt;<value>path</value>&gt;</command>&mdash;sets
+<literal>--sbin-path=<value>path</value></literal>&mdash;sets
 the name of an nginx executable file.
 This name is used only during installation.
 By default the file is named
-<command>&lt;<value>prefix</value>&gt;/sbin/nginx</command>.
+<path><value>prefix</value>/sbin/nginx</path>.
 </para>
 </listitem>
 
 <listitem>
 <para>
-<command>--conf-path=&lt;<value>path</value>&gt;</command>&mdash;sets
-the name of an <command>nginx.conf</command> configuration file.
+<literal>--conf-path=<value>path</value></literal>&mdash;sets
+the name of an <path>nginx.conf</path> configuration file.
 If needs be, nginx can always be started with a different configuration file,
 by specifying it in the command-line parameter
-<nobr><command>-c &lt;<value>file</value>&gt;</command></nobr>.
+<nobr><literal>-c <value>file</value></literal></nobr>.
 By default the file is named
-<command>&lt;<value>prefix</value>&gt;/conf/nginx.conf</command>.
+<path><value>prefix</value>/conf/nginx.conf</path>.
 </para>
 </listitem>
 
 <listitem>
 <para>
-<command>--pid-path=&lt;<value>path</value>&gt;</command>&mdash;sets
+<literal>--pid-path=<value>path</value></literal>&mdash;sets
 the name of an nginx.pid file that will store the process ID
 of the main process.
 After installation, the file name can always be changed in the
-<command>nginx.conf</command> configuration file using the
+<path>nginx.conf</path> configuration file using the
 <link doc="ngx_core_module.xml" id="pid"/> directive.
 By default the file is named
-<command>&lt;<value>prefix</value>&gt;/logs/nginx.pid</command>.
+<path><value>prefix</value>/logs/nginx.pid</path>.
 </para>
 </listitem>
 
 <listitem>
 <para>
-<command>--error-log-path=&lt;<value>path</value>&gt;</command>&mdash;sets
+<literal>--error-log-path=<value>path</value></literal>&mdash;sets
 the name of the primary error, warnings, and diagnostic file.
 After installation, the file name can always be changed in the
-<command>nginx.conf</command> configuration file using the
+<path>nginx.conf</path> configuration file using the
 <link doc="ngx_core_module.xml" id="error_log"/> directive.
 By default the file is named
-<command>&lt;<value>prefix</value>&gt;/logs/error.log</command>.
+<path><value>prefix</value>/logs/error.log</path>.
 </para>
 </listitem>
 
 <listitem>
 <para>
-<command>--http-log-path=&lt;<value>path</value>&gt;</command>&mdash;sets
+<literal>--http-log-path=<value>path</value></literal>&mdash;sets
 the name of the primary request log file of the HTTP server.
 After installation, the file name can always be changed in the
-<command>nginx.conf</command> configuration file using the
+<path>nginx.conf</path> configuration file using the
 <link doc="http/ngx_http_log_module.xml" id="access_log"/> directive.
 By default the file is named
-<command>&lt;<value>prefix</value>&gt;/logs/access.log</command>.
+<path><value>prefix</value>/logs/access.log</path>.
 </para>
 </listitem>
 
 <listitem>
 <para>
-<command>--user=&lt;<value>name</value>&gt;</command>&mdash;sets
+<literal>--user=<value>name</value></literal>&mdash;sets
 the name of an unprivileged user whose credentials will be used
 by worker processes.
 After installation, the name can always be changed in the
-<command>nginx.conf</command> configuration file using the
+<path>nginx.conf</path> configuration file using the
 <link doc="ngx_core_module.xml" id="user"/> directive.
 The default user name is nobody.
 </para>
@@ -98,11 +98,11 @@ The default user name is nobody.
 
 <listitem>
 <para>
-<command>--group=&lt;<value>name</value>&gt;</command>&mdash;sets
+<literal>--group=<value>name</value></literal>&mdash;sets
 the name of a group whose credentials will be used
 by worker processes.
 After installation, the name can always be changed in the
-<command>nginx.conf</command> configuration file using the
+<path>nginx.conf</path> configuration file using the
 <link doc="ngx_core_module.xml" id="user"/> directive.
 By default, a group name is set to the name of an unprivileged user.
 </para>
@@ -110,8 +110,8 @@ By default, a group name is set to the n
 
 <listitem>
 <para>
-<command>--with-select_module</command><br/>
-<command>--without-select_module</command>&mdash;enables or disables
+<literal>--with-select_module</literal><br/>
+<literal>--without-select_module</literal>&mdash;enables or disables
 building a module that allows the server to work with the
 <c-func>select</c-func> method.
 This module is built automatically if the platform does not appear
@@ -121,8 +121,8 @@ to support more appropriate methods such
 
 <listitem>
 <para>
-<command>--with-poll_module</command><br/>
-<command>--without-poll_module</command>&mdash;enables or disables
+<literal>--with-poll_module</literal><br/>
+<literal>--without-poll_module</literal>&mdash;enables or disables
 building a module that allows the server to work with the
 <c-func>poll</c-func> method.
 This module is built automatically if the platform does not appear
@@ -132,7 +132,7 @@ to support more appropriate methods such
 
 <listitem>
 <para>
-<command>--without-http_gzip_module</command>&mdash;disables building a module
+<literal>--without-http_gzip_module</literal>&mdash;disables building a module
 that <link doc="http/ngx_http_gzip_module.xml">compresses responses</link>
 of an HTTP server.
 The zlib library is required to build and run this module.
@@ -141,7 +141,7 @@ The zlib library is required to build an
 
 <listitem>
 <para>
-<command>--without-http_rewrite_module</command>&mdash;disables building a
+<literal>--without-http_rewrite_module</literal>&mdash;disables building a
 module that allows an HTTP server to
 <link doc="http/ngx_http_rewrite_module.xml">redirect requests and change URI
 of requests</link>.
@@ -152,7 +152,7 @@ The module is experimental&mdash;its dir
 
 <listitem>
 <para>
-<command>--without-http_proxy_module</command>&mdash;disables building an
+<literal>--without-http_proxy_module</literal>&mdash;disables building an
 HTTP server <link doc="http/ngx_http_proxy_module.xml">proxying module</link>.
 <!--
 The MD5 library is required to build and run this module.
@@ -162,7 +162,7 @@ The MD5 library is required to build and
 
 <listitem>
 <para>
-<command>--with-http_ssl_module</command>&mdash;enables building a module
+<literal>--with-http_ssl_module</literal>&mdash;enables building a module
 that adds the <link doc="http/ngx_http_ssl_module.xml">HTTPS protocol
 support</link> to an HTTP server.
 This module is not built by default.
@@ -172,7 +172,7 @@ The OpenSSL library is required to build
 
 <listitem>
 <para>
-<command>--with-pcre=&lt;<value>path</value>&gt;</command>&mdash;sets
+<literal>--with-pcre=<value>path</value></literal>&mdash;sets
 the path to the sources of the PCRE library.
 The library distribution (version
 4.4&mdash;6.1) needs to be downloaded from the
@@ -188,7 +188,7 @@ module.
 
 <listitem>
 <para>
-<command>--with-zlib=&lt;<value>path</value>&gt;</command>&mdash;sets
+<literal>--with-zlib=<value>path</value></literal>&mdash;sets
 the path to the sources of the zlib library.
 The library distribution (version
 1.1.3&mdash;1.2.2) needs to be downloaded from the
@@ -201,23 +201,23 @@ The library is required for the
 
 <listitem>
 <para>
-<command>--with-cc-opt=&lt;<value>parameters</value>&gt;</command>&mdash;sets
+<literal>--with-cc-opt=<value>parameters</value></literal>&mdash;sets
 additional parameters that will be added to the CFLAGS variable.
 When using the system PCRE library under FreeBSD,
-<command>--with-cc-opt="-I /usr/local/include"</command>
+<literal>--with-cc-opt="-I /usr/local/include"</literal>
 should be specified.
 If the number of files supported by <c-func>select</c-func> needs to be
 increased it can also be specified here such as this:
-<command>--with-cc-opt="-D FD_SETSIZE=2048"</command>.
+<literal>--with-cc-opt="-D FD_SETSIZE=2048"</literal>.
 </para>
 </listitem>
 
 <listitem>
 <para>
-<command>--with-ld-opt=&lt;<value>parameters</value>&gt;</command>&mdash;sets
+<literal>--with-ld-opt=<value>parameters</value></literal>&mdash;sets
 additional parameters that will be used during linking.
 When using the system PCRE library under FreeBSD,
-<command>--with-ld-opt="-L /usr/local/lib"</command>
+<literal>--with-ld-opt="-L /usr/local/lib"</literal>
 should be specified.
 </para>
 </listitem>