diff options
Diffstat (limited to 'usr.sbin/httpd/htdocs/manual/programs')
| -rw-r--r-- | usr.sbin/httpd/htdocs/manual/programs/apachectl.html | 112 | ||||
| -rw-r--r-- | usr.sbin/httpd/htdocs/manual/programs/htpasswd.html | 192 | ||||
| -rw-r--r-- | usr.sbin/httpd/htdocs/manual/programs/httpd.html | 147 | ||||
| -rw-r--r-- | usr.sbin/httpd/htdocs/manual/programs/index.html | 77 | ||||
| -rw-r--r-- | usr.sbin/httpd/htdocs/manual/programs/suexec.html | 58 |
5 files changed, 586 insertions, 0 deletions
diff --git a/usr.sbin/httpd/htdocs/manual/programs/apachectl.html b/usr.sbin/httpd/htdocs/manual/programs/apachectl.html new file mode 100644 index 00000000000..42ce09a5aaf --- /dev/null +++ b/usr.sbin/httpd/htdocs/manual/programs/apachectl.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> + <title>Manual Page: apachectl - Apache HTTP Server</title> +</head> + + <!-- Background white, links blue (unvisited), navy (visited), red (active) --> + <body + bgcolor="#ffffff" + text="#000000" + link="#0000ff" + vlink="#000080" + alink="#ff0000" + > + <DIV ALIGN="CENTER"> + <IMG SRC="../images/sub.gif" ALT="[APACHE DOCUMENTATION]"> + <H3> + Apache HTTP Server Version 1.3 + </H3> +</DIV> + + + + <h1 align="center">Manual Page: apachectl</h1> + +<!-- This document was autogenerated from the man page --> +<pre> +<strong>NAME</strong> + apachectl - Apache HTTP server control interface + +<strong>SYNOPSIS</strong> + <strong>apachectl </strong><em>command </em>[...] + +<strong>DESCRIPTION</strong> + <strong>apachectl </strong>is a front end to the Apache HyperText Transfer + Protocol (HTTP) server. It is designed to help the adminis- + trator control the functioning of the Apache <strong>httpd </strong>daemon. + + <strong>NOTE: </strong>If your Apache installation uses non-standard paths, + you will need to edit the <strong>apachectl </strong>script to set the + appropriate paths to your PID file and your <strong>httpd </strong>binary. + See the comments in the script for details. + + The <strong>apachectl </strong>script returns a 0 exit value on success, and + >0 if an error occurs. For more details, view the comments + in the script. + + Full documentation for Apache is available at + <strong>http://www.apache.org/</strong> + +<strong>OPTIONS</strong> + The <em>command </em>can be any one or more of the following options: + + <strong>start </strong>Start the Apache daemon. Gives an error if it + is already running. + + <strong>stop </strong>Stops the Apache daemon. + + <strong>restart </strong>Restarts the Apache daemon by sending it a + SIGHUP. If the daemon is not running, it is + started. This command automatically checks the + configuration files via <strong>configtest </strong>before ini- + tiating the restart to make sure Apache doesn't + die. + + <strong>fullstatus </strong>Displays a full status report from <strong>mod_status.</strong> + For this to work, you need to have mod_status + enabled on your server and a text-based browser + such as <em>lynx </em>available on your system. The URL + used to access the status report can be set by + editing the <strong>STATUSURL </strong>variable in the script. + + <strong>status </strong>Displays a brief status report. Similar to the + fullstatus option, except that the list of + requests currently being served is omitted. + + <strong>graceful </strong>Gracefully restarts the Apache daemon by sending + it a SIGUSR1. If the daemon is not running, it + is started. This differs from a normal restart + in that currently open connections are not + aborted. A side effect is that old log files + will not be closed immediately. This means that + if used in a log rotation script, a substantial + delay may be necessary to ensure that the old + log files are closed before processing them. + This command automatically checks the configura- + tion files via <strong>configtest </strong>before initiating the + restart to make sure Apache doesn't die. + + <strong>configtest </strong>Run a configuration file syntax test. It parses + the configuration files and either reports <strong>Syn-</strong> + <strong>tax Ok </strong>or detailed information about the partic- + ular syntax error. + + <strong>help </strong>Displays a short help message. + +<strong>SEE ALSO</strong> + <strong>httpd(8)</strong> + +</pre> + + +<HR> + +<H3 ALIGN="CENTER"> + Apache HTTP Server Version 1.3 +</H3> + +<A HREF="./"><IMG SRC="../images/index.gif" ALT="Index"></A> +<A HREF="../"><IMG SRC="../images/home.gif" ALT="Home"></A> + +</body></html> diff --git a/usr.sbin/httpd/htdocs/manual/programs/htpasswd.html b/usr.sbin/httpd/htdocs/manual/programs/htpasswd.html new file mode 100644 index 00000000000..9f816b68601 --- /dev/null +++ b/usr.sbin/httpd/htdocs/manual/programs/htpasswd.html @@ -0,0 +1,192 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> + <title>Manual Page: htpasswd - Apache HTTP Server</title> +</head> + + <!-- Background white, links blue (unvisited), navy (visited), red (active) --> + <body + bgcolor="#ffffff" + text="#000000" + link="#0000ff" + vlink="#000080" + alink="#ff0000" + > + <DIV ALIGN="CENTER"> + <IMG SRC="../images/sub.gif" ALT="[APACHE DOCUMENTATION]"> + <H3> + Apache HTTP Server Version 1.3 + </H3> +</DIV> + + + + <h1 align="center">Manual Page: htpasswd</h1> + +<!-- This document was autogenerated from the man page --> +<pre> +<strong>NAME</strong> + htpasswd - Create and update user authentication files + +<strong>SYNOPSIS</strong> + <strong>htpasswd </strong>[ -<strong>c </strong>] [ -<strong>m </strong>| -<strong>d </strong>| -<strong>s </strong>| -<strong>p </strong>] <em>passwdfile username</em> + <strong>htpasswd </strong>-<strong>b </strong>[ -<strong>c </strong>] [ -<strong>m </strong>| -<strong>d </strong>| -<strong>s </strong>| -<strong>p </strong>] <em>passwdfile username</em> + <em>password</em> + <strong>htpasswd </strong>-<strong>n </strong>[ -<strong>m </strong>| -<strong>d </strong>| -<strong>s </strong>| -<strong>p </strong>] <em>username</em> + <strong>htpasswd </strong>-<strong>nb </strong>[ -<strong>m </strong>| -<strong>d </strong>| -<strong>s </strong>| -<strong>p </strong>] <em>username password</em> + +<strong>DESCRIPTION</strong> + <strong>htpasswd </strong>is used to create and update the flat-files used to + store usernames and password for basic authentication of + HTTP users. If <strong>htpasswd </strong>cannot access a file, such as not + being able to write to the output file or not being able to + read the file in order to update it, it returns an error + status and makes no changes. + + Resources available from the <strong>httpd </strong>Apache web server can be + restricted to just the users listed in the files created by + <strong>htpasswd. </strong>This program can only manage usernames and pass- + words stored in a flat-file. It can encrypt and display + password information for use in other types of data stores, + though. To use a DBM database see <strong>dbmmanage</strong>. + + <strong>htpasswd </strong>encrypts passwords using either a version of MD5 + modified for Apache, or the system's <em>crypt</em>() routine. Files + managed by <strong>htpasswd </strong>may contain both types of passwords; + some user records may have MD5-encrypted passwords while + others in the same file may have passwords encrypted with + <em>crypt</em>(). + + This manual page only lists the command line arguments. For + details of the directives necessary to configure user + authentication in <strong>httpd </strong>see the Apache manual, which is part + of the Apache distribution or can be found at + <URL:http://www.apache.org/>. + +<strong>OPTIONS</strong> + -b Use batch mode; <em>i</em>.<em>e</em>., get the password from the command + line rather than prompting for it. <strong>This option should</strong> + <strong>be used with extreme care, since the password is</strong> + <strong>clearly visible on the command line.</strong> + + -c Create the <em>passwdfile</em>. If <em>passwdfile </em>already exists, it + is rewritten and truncated. This option cannot be com- + bined with the <strong>-n </strong>option. + + -n Display the results on standard output rather than + updating a file. This is useful for generating pass- + word records acceptable to Apache for inclusion in + non-text data stores. This option changes the syntax + of the command line, since the <em>passwdfile </em>argument + (usually the first one) is omitted. It cannot be com- + bined with the <strong>-c </strong>option. + + -m Use Apache's modified MD5 algorithm for passwords. + Passwords encrypted with this algorithm are transport- + able to any platform (Windows, Unix, BeOS, et cetera) + running Apache 1.3.9 or later. On Windows and TPF, + this flag is the default. + + -d Use crypt() encryption for passwords. The default on + all platforms but Windows and TPF. Though possibly sup- + ported by <strong>htpasswd </strong>on all platforms, it is not sup- + ported by the <strong>httpd </strong>server on Windows and TPF. + + -s Use SHA encryption for passwords. Faciliates migration + from/to Netscape servers using the LDAP Directory + Interchange Format (ldif). + + -p Use plaintext passwords. Though <strong>htpasswd </strong>will support + creation on all platforms, the <strong>httpd </strong>deamon will only + accept plain text passwords on Windows and TPF. + + <em>passwdfile</em> + Name of the file to contain the user name and password. + If -c is given, this file is created if it does not + already exist, or rewritten and truncated if it does + exist. + + <em>username</em> + The username to create or update in <strong>passwdfile</strong>. If + <em>username </em>does not exist in this file, an entry is + added. If it does exist, the password is changed. + + <em>password</em> + The plaintext password to be encrypted and stored in + the file. Only used with the -<em>b </em>flag. + +<strong>EXIT STATUS</strong> + <strong>htpasswd </strong>returns a zero status ("true") if the username and + password have been successfully added or updated in the + <em>passwdfile</em>. <strong>htpasswd </strong>returns 1 if it encounters some prob- + lem accessing files, 2 if there was a syntax problem with + the command line, 3 if the password was entered interac- + tively and the verification entry didn't match, 4 if its + operation was interrupted, 5 if a value is too long (user- + name, filename, password, or final computed record), and 6 + if the username contains illegal characters (see the <strong>RES-</strong> + <strong>TRICTIONS </strong>section). + +<strong>EXAMPLES</strong> + <strong>htpasswd /usr/local/etc/apache/.htpasswd-users jsmith</strong> + + Adds or modifies the password for user <em>jsmith</em>. The user + is prompted for the password. If executed on a Windows + system, the password will be encrypted using the modi- + fied Apache MD5 algorithm; otherwise, the system's + <em>crypt</em>() routine will be used. If the file does not + exist, <strong>htpasswd </strong>will do nothing except return an error. + + <strong>htpasswd -c /home/doe/public_html/.htpasswd jane</strong> + + Creates a new file and stores a record in it for user + <em>jane</em>. The user is prompted for the password. If the + file exists and cannot be read, or cannot be written, + it is not altered and <strong>htpasswd </strong>will display a message + and return an error status. + + <strong>htpasswd -mb /usr/web/.htpasswd-all jones Pwd4Steve</strong> + + Encrypts the password from the command line (<em>Pwd4Steve</em>) + using the MD5 algorithm, and stores it in the specified + file. + +<strong>SECURITY CONSIDERATIONS</strong> + Web password files such as those managed by <strong>htpasswd </strong>should + <strong>not </strong>be within the Web server's URI space -- that is, they + should not be fetchable with a browser. + + The use of the -<em>b </em>option is discouraged, since when it is + used the unencrypted password appears on the command line. + +<strong>RESTRICTIONS</strong> + On the Windows and MPE platforms, passwords encrypted with + <strong>htpasswd </strong>are limited to no more than 255 characters in + length. Longer passwords will be truncated to 255 charac- + ters. + + The MD5 algorithm used by <strong>htpasswd </strong>is specific to the Apache + software; passwords encrypted using it will not be usable + with other Web servers. + + Usernames are limited to 255 bytes and may not include the + character ':'. + +<strong>SEE ALSO</strong> + <strong>httpd(8) </strong>and the scripts in support/SHA1 which come with the + distribution. + +</pre> + + +<HR> + +<H3 ALIGN="CENTER"> + Apache HTTP Server Version 1.3 +</H3> + +<A HREF="./"><IMG SRC="../images/index.gif" ALT="Index"></A> +<A HREF="../"><IMG SRC="../images/home.gif" ALT="Home"></A> + +</body> +</html> diff --git a/usr.sbin/httpd/htdocs/manual/programs/httpd.html b/usr.sbin/httpd/htdocs/manual/programs/httpd.html new file mode 100644 index 00000000000..8fa0a7c5336 --- /dev/null +++ b/usr.sbin/httpd/htdocs/manual/programs/httpd.html @@ -0,0 +1,147 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> + <title>Manual Page: httpd - Apache HTTP Server</title> +</head> + + <!-- Background white, links blue (unvisited), navy (visited), red (active) --> + <body + bgcolor="#ffffff" + text="#000000" + link="#0000ff" + vlink="#000080" + alink="#ff0000" + > + <DIV ALIGN="CENTER"> + <IMG SRC="../images/sub.gif" ALT="[APACHE DOCUMENTATION]"> + <H3> + Apache HTTP Server Version 1.3 + </H3> +</DIV> + + + + <h1 align="center">Manual Page: httpd</h1> + +<!-- This document was autogenerated from the man page --> +<pre> +<strong>NAME</strong> + httpd - Apache hypertext transfer protocol server + +<strong>SYNOPSIS</strong> + <strong>httpd </strong>[ -<strong>X </strong>] [ -<strong>R </strong><em>libexecdir </em>] [ -<strong>d </strong><em>serverroot </em>] [ -<strong>f </strong><em>config</em> + ] [ -<strong>C </strong><em>directive </em>] [ -<strong>c </strong><em>directive </em>] [ -<strong>D </strong><em>parameter </em>] + + <strong>httpd </strong>[ -<strong>h </strong>] [ -<strong>l </strong>] [ -<strong>L </strong>] [ -<strong>v </strong>] [ -<strong>V </strong>] [ -<strong>S </strong>] [ -<strong>t </strong>] [ -<strong>T</strong> + ] + +<strong>DESCRIPTION</strong> + <strong>httpd </strong>is the Apache HyperText Transfer Protocol (HTTP) + server program. It is designed to be run as a standalone + daemon process. When used like this it will create a pool of + child processes to handle requests. To stop it, send a TERM + signal to the initial (parent) process. The PID of this pro- + cess is written to a file as given in the configuration + file. Alternatively <strong>httpd </strong>may be invoked by the Internet + daemon inetd(8) each time a connection to the HTTP service + is made. + + This manual page only lists the command line arguments. For + details of the directives necessary to configure <strong>httpd </strong>see + the Apache manual, which is part of the Apache distribution + or can be found at http://www.apache.org/. Paths in this + manual may not reflect those compiled into <strong>httpd.</strong> + +<strong>OPTIONS</strong> + -<strong>R </strong><em>libexecdir</em> + This option is only available if Apache was + built with the <em>SHARED</em>_<em>CORE </em>rule enabled which + forces the Apache core code to be placed into a + dynamic shared object (DSO) file. This file is + searched in a hardcoded path under ServerRoot + per default. Use this option if you want to + override it. + + -<strong>d </strong><em>serverroot</em> + Set the initial value for the ServerRoot direc- + tive to <em>serverroot</em>. This can be overridden by + the ServerRoot command in the configuration + file. The default is <strong>/usr/local/apache</strong>. + + -<strong>f </strong><em>config </em>Execute the commands in the file <em>config </em>on + startup. If <em>config </em>does not begin with a /, then + it is taken to be a path relative to the Server- + Root. The default is <strong>conf/httpd.conf</strong>. + + -<strong>C </strong><em>directive</em> + Process the configuration <em>directive </em>before read- + ing config files. + + -<strong>c </strong><em>directive</em> + Process the configuration <em>directive </em>after read- + ing config files. + + -<strong>D </strong><em>parameter</em> + Sets a configuration <em>parameter </em>which can be used + with <IfDefine>...</IfDefine> sections in the + configuration files to conditionally skip or + process commands. + + -<strong>h </strong>Output a short summary of available command line + options. + + -<strong>l </strong>Output a list of modules compiled into the + server. + + -<strong>L </strong>Output a list of directives together with + expected arguments and places where the direc- + tive is valid. + + -<strong>S </strong>Show the settings as parsed from the config file + (currently only shows the virtualhost settings). + + -<strong>t </strong>Run syntax tests for configuration files only. + The program immediately exits after these syntax + parsing with either a return code of 0 (Syntax + OK) or return code not equal to 0 (Syntax + Error). + + -<strong>T </strong>Same as option -<strong>t </strong>but does not check the config- + ured document roots. + + -<strong>X </strong>Run in single-process mode, for internal debug- + ging purposes only; the daemon does not detach + from the terminal or fork any children. Do NOT + use this mode to provide ordinary web service. + + -<strong>v </strong>Print the version of <strong>httpd </strong>, and then exit. + + -<strong>V </strong>Print the version and build parameters of <strong>httpd</strong> + , and then exit. + +<strong>FILES</strong> + <strong>/usr/local/apache/conf/httpd.conf</strong> + <strong>/usr/local/apache/conf/srm.conf</strong> + <strong>/usr/local/apache/conf/access.conf</strong> + <strong>/usr/local/apache/conf/mime.types</strong> + <strong>/usr/local/apache/conf/magic</strong> + <strong>/usr/local/apache/logs/error_log</strong> + <strong>/usr/local/apache/logs/access_log</strong> + <strong>/usr/local/apache/logs/httpd.pid</strong> + +<strong>SEE ALSO</strong> + <strong>inetd</strong>(8). + +</pre> + + +<HR> + +<H3 ALIGN="CENTER"> + Apache HTTP Server Version 1.3 +</H3> + +<A HREF="./"><IMG SRC="../images/index.gif" ALT="Index"></A> +<A HREF="../"><IMG SRC="../images/home.gif" ALT="Home"></A> + +</body></html> diff --git a/usr.sbin/httpd/htdocs/manual/programs/index.html b/usr.sbin/httpd/htdocs/manual/programs/index.html new file mode 100644 index 00000000000..3a5dd34d3a9 --- /dev/null +++ b/usr.sbin/httpd/htdocs/manual/programs/index.html @@ -0,0 +1,77 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> + <head> + <title>Apache HTTP Server and Supporting Programs</title> + </head> + + <!-- Background white, links blue (unvisited), navy (visited), red (active) --> + <body + bgcolor="#ffffff" + text="#000000" + link="#0000ff" + vlink="#000080" + alink="#ff0000" + > + <DIV ALIGN="CENTER"> + <IMG SRC="../images/sub.gif" ALT="[APACHE DOCUMENTATION]"> + <H3> + Apache HTTP Server Version 1.3 + </H3> +</DIV> + + + + <h1 align="center">Server and Supporting Programs</h1> + +<p>This page documents all the executable programs included with the +Apache HTTP Server.</p> + +<dl> + + <dt><a href="httpd.html">httpd</a></dt> + <dd>Apache hypertext transfer protocol server</dd> + + <dt><a href="apachectl.html">apachectl</a></dt> + <dd>Apache HTTP server control interface</dd> + + <dt><a href="ab.html">ab</a></dt> + <dd>Apache HTTP server benchmarking tool</dd> + + <dt><a href="apxs.html">apxs</a></dt> + <dd>APache eXtenSion tool</dd> + + <dt><a href="dbmmanage.html">dbmmanage</a></dt> + <dd>Create and update user authentication files in DBM format for basic + authentication</dd> + + <dt><a href="htdigest.html">htdigest</a></dt> + <dd>Create and update user authentication files for digest authentication</dd> + + <dt><a href="htpasswd.html">htpasswd</a></dt> + <dd>Create and update user authentication files for basic authentication</dd> + + <dt><a href="logresolve.html">logresolve</a></dt> + <dd>Resolve hostnames for IP-addresses in Apache logfiles</dd> + + <dt><a href="rotatelogs.html">rotatelogs</a></dt> + <dd>Rotate Apache logs without having to kill the server</dd> + + <dt><a href="suexec.html">suexec</a></dt> + <dd>Switch User For Exec</dd> + + <dt><a href="other.html">Other Programs</a></dt> + +</dl> + + + <HR> + +<H3 ALIGN="CENTER"> + Apache HTTP Server Version 1.3 +</H3> + +<A HREF="./"><IMG SRC="../images/index.gif" ALT="Index"></A> +<A HREF="../"><IMG SRC="../images/home.gif" ALT="Home"></A> + + </body> +</html> diff --git a/usr.sbin/httpd/htdocs/manual/programs/suexec.html b/usr.sbin/httpd/htdocs/manual/programs/suexec.html new file mode 100644 index 00000000000..b33e048ed07 --- /dev/null +++ b/usr.sbin/httpd/htdocs/manual/programs/suexec.html @@ -0,0 +1,58 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> + <title>Manual Page: suexec - Apache HTTP Server</title> +</head> + + <!-- Background white, links blue (unvisited), navy (visited), red (active) --> + <body + bgcolor="#ffffff" + text="#000000" + link="#0000ff" + vlink="#000080" + alink="#ff0000" + > + <DIV ALIGN="CENTER"> + <IMG SRC="../images/sub.gif" ALT="[APACHE DOCUMENTATION]"> + <H3> + Apache HTTP Server Version 1.3 + </H3> +</DIV> + + + + <h1 align="center">Manual Page: suexec</h1> + +<!-- This document was autogenerated from the man page --> +<pre> +<strong>NAME</strong> + suexec - Switch User For Exec + +<strong>SYNOPSIS</strong> + No synopsis for usage, because this program is used inter- + nally by Apache only. + +<strong>DESCRIPTION</strong> + <strong>suexec </strong>is the "wrapper" support program for the suEXEC + behaviour for Apache. It is run from within Apache automat- + ically to switch the user when an external program has to be + run under a different user. For more information about + suEXEC see the document `Apache suEXEC Support' under + http://www.apache.org/docs/suexec.html . + +<strong>SEE ALSO</strong> + <strong>httpd(8)</strong> + +</pre> + +<HR> + +<H3 ALIGN="CENTER"> + Apache HTTP Server Version 1.3 +</H3> + +<A HREF="./"><IMG SRC="../images/index.gif" ALT="Index"></A> +<A HREF="../"><IMG SRC="../images/home.gif" ALT="Home"></A> + +</body> +</html> |