Apache HTTP Server 2.1 Documentation Status File.
-Last modified: $Date: 2003/05/01 00:39:16 $
+Last modified: $Date: 2003/05/02 00:58:26 $
For more information on how to contribute to the Apache Documentation
Project, please see http://httpd.apache.org/docs-project/
developer/API.html
# converting from nroff to xml
-programs/htpasswd.html
programs/other.html
-.TH htpasswd 1 "May 2000"
-.\" The Apache Software License, Version 1.1
-.\"
-.\" Copyright (c) 2000-2003 The Apache Software Foundation. All rights
-.\" reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\"
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\"
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in
-.\" the documentation and/or other materials provided with the
-.\" distribution.
-.\"
-.\" 3. The end-user documentation included with the redistribution,
-.\" if any, must include the following acknowledgment:
-.\" "This product includes software developed by the
-.\" Apache Software Foundation (http://www.apache.org/)."
-.\" Alternately, this acknowledgment may appear in the software itself,
-.\" if and wherever such third-party acknowledgments normally appear.
-.\"
-.\" 4. The names "Apache" and "Apache Software Foundation" must
-.\" not be used to endorse or promote products derived from this
-.\" software without prior written permission. For written
-.\" permission, please contact apache@apache.org.
-.\"
-.\" 5. Products derived from this software may not be called "Apache",
-.\" nor may "Apache" appear in their name, without prior written
-.\" permission of the Apache Software Foundation.
-.\"
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
-.\" WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-.\" DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
-.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
-.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\" This software consists of voluntary contributions made by many
-.\" individuals on behalf of the Apache Software Foundation. For more
-.\" information on the Apache Software Foundation, please see
-.\" <http://www.apache.org/>.
-.\"
-.SH NAME
-htpasswd \- Create and update user authentication files
-.SH SYNOPSIS
-.B htpasswd
-[
-.B \-c
-]
-[
-.B \-m
-]
-.I passwdfile
-.I username
-.br
-.B htpasswd
-.B \-b
-[
-.B \-c
-]
-[
-.B \-m
-|
-.B \-d
-|
-.B \-p
-|
-.B \-s
-]
-.I passwdfile
-.I username
-.I password
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.\" DO NOT EDIT! Generated from XML source.
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.de Sh \" Subsection
.br
-.B htpasswd
-.B \-n
-[
-.B \-m
-|
-.B \-d
-|
-.B \-s
-|
-.B \-p
-]
-.I username
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
.br
-.B htpasswd
-.B \-nb
-[
-.B \-m
-|
-.B \-d
-|
-.B \-s
-|
-.B \-p
-]
-.I username
-.I password
-.SH DESCRIPTION
-.B htpasswd
-is used to create and update the flat-files used to store
-usernames and password for basic authentication of HTTP users.
-If
-.B htpasswd
-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.
-.PP
-Resources available from the
-.B httpd
-Apache web server can be restricted to just the users listed
-in the files created by
-.B htpasswd.
-This program can only manage usernames and passwords
-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
-\fBdbmmanage\fP.
-.PP
-.B htpasswd
-encrypts passwords using either a version of MD5 modified for Apache,
-or the system's \fIcrypt()\fP routine. Files managed by
-.B htpasswd
-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 \fIcrypt()\fP.
-.PP
-This manual page only lists the command line arguments. For details of
-the directives necessary to configure user authentication in
-.B httpd
-see
-the Apache manual, which is part of the Apache distribution or can be
-found at <URL:http://www.apache.org/>.
-.SH OPTIONS
-.IP \-b
-Use batch mode; \fIi.e.\fP, get the password from the command line
-rather than prompting for it. \fBThis option should be used with
-extreme care, since the password is clearly visible on the command
-line.\fP
-.IP \-c
-Create the \fIpasswdfile\fP. If \fIpasswdfile\fP already exists, it
-is rewritten and truncated. This option cannot be combined with
-the \fB-n\fP option.
-.IP \-n
-Display the results on standard output rather than updating a file.
-This is useful for generating password records acceptable to Apache
-for inclusion in non-text data stores. This option changes the
-syntax of the command line, since the \fIpasswdfile\fP argument
-(usually the first one) is omitted. It cannot be combined with
-the \fB-c\fP option.
-.IP \-m
-Use MD5 encryption for passwords. On Windows and TPF, this is the default.
-.IP \-d
-Use crypt() encryption for passwords. The default on all platforms but
-Windows and TPF. Though possibly supported by
-.B htpasswd
-on all platforms, it is not supported by the
-.B httpd
-server on Windows and TPF.
-.IP \-s
-Use SHA encryption for passwords. Facilitates migration from/to Netscape
-servers using the LDAP Directory Interchange Format (ldif).
-.IP \-p
-Use plaintext passwords. Though
-.B htpasswd
-will support creation on all platforms, the
-.B httpd
-daemon will only accept plain text passwords on Windows and TPF.
-.IP \fB\fIpasswdfile\fP
-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.
-.IP \fB\fIusername\fP
-The username to create or update in \fBpasswdfile\fP. If
-\fIusername\fP does not exist in this file, an entry is added. If it
-does exist, the password is changed.
-.IP \fB\fIpassword\fP
-The plaintext password to be encrypted and stored in the file. Only used
-with the \fI-b\fP flag.
-.SH EXIT STATUS
-.B htpasswd
-returns a zero status ("true") if the username and password have
-been successfully added or updated in the \fIpasswdfile\fP.
-.B htpasswd
-returns 1 if it encounters some problem accessing files, 2 if there
-was a syntax problem with the command line, 3 if the password was
-entered interactively and the verification entry didn't match, 4 if
-its operation was interrupted, 5 if a value is too long (username,
-filename, password, or final computed record), and 6 if the username
-contains illegal characters (see the \fBRESTRICTIONS\fP section).
-.SH EXAMPLES
-\fBhtpasswd /usr/local/etc/apache/.htpasswd-users jsmith\fP
-.IP
-Adds or modifies the password for user \fIjsmith\fP.
-The user is prompted for the password. If executed
-on a Windows system, the password will be encrypted using the
-modified Apache MD5 algorithm; otherwise, the system's
-\fIcrypt()\fP routine will be used. If the file does not
-exist,
-.B htpasswd
-will do nothing except return an error.
-.LP
-\fBhtpasswd -c /home/doe/public_html/.htpasswd jane\fP
-.IP
-Creates a new file and stores a record in it for user \fIjane\fP.
-The user is prompted for the password.
-If the file exists and cannot be read, or cannot be written,
-it is not altered and
-.B htpasswd
-will display a message and return an error status.
-.LP
-\fBhtpasswd -mb /usr/web/.htpasswd-all jones Pwd4Steve\fP
-.IP
-Encrypts the password from the command line (\fIPwd4Steve\fP) using
-the MD5 algorithm, and stores it in the specified file.
-.LP
-.SH SECURITY CONSIDERATIONS
-Web password files such as those managed by
-.B htpasswd
-should \fBnot\fP be within the Web server's URI space -- that is,
-they should not be fetchable with a browser.
-.PP
-The use of the \fI-b\fP option is discouraged, since when it is
-used the unencrypted password appears on the command line.
-.SH RESTRICTIONS
-On the Windows and MPE platforms, passwords encrypted with
-.B htpasswd
-are limited to no more than 255 characters in length. Longer
-passwords will be truncated to 255 characters.
-.PP
-The MD5 algorithm used by
-.B htpasswd
-is specific to the Apache software; passwords encrypted using it will not be
-usable with other Web servers.
-.PP
-Usernames are limited to 255 bytes and may not include the character ':'.
-.SH SEE ALSO
-.BR httpd(8)
-and the scripts in support/SHA1 which come with the distribution.
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "HTPASSWD" 1 "2003-05-02" "Apache HTTP Server" "htpasswd"
+
+.SH NAME
+htpasswd \- Manage user files for basic authentication
+
+.SH "SYNOPSIS"
+
+.PP
+\fBhtpasswd\fR [ -\fBc\fR ] [ -\fBm\fR ] \fIpasswdfile\fR \fIusername\fR
+
+.PP
+\fBhtpasswd\fR -\fBb\fR [ -\fBc\fR ] [ -\fBm\fR | -\fBd\fR | -\fBp\fR | -\fBs\fR ] \fIpasswdfile\fR \fIusername\fR \fIpassword\fR
+
+.PP
+\fBhtpasswd\fR -\fBn\fR [ -\fBm\fR | -\fBd\fR | -\fBs\fR | -\fBp\fR ] \fIusername\fR
+
+.PP
+\fBhtpasswd\fR -\fBnb\fR [ -\fBm\fR | -\fBd\fR | -\fBs\fR | -\fBp\fR ] \fIusername\fR \fIpassword\fR
+
+
+.SH "SUMMARY"
+
+.PP
+htpasswd is used to create and update the flat-files used to store usernames and password for basic authentication of HTTP users\&. If htpasswd 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\&.
+
+.PP
+Resources available from the Apache HTTP server can be restricted to just the users listed in the files created by htpasswd\&. This program can only manage usernames and passwords 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 dbmmanage\&.
+
+.PP
+htpasswd encrypts passwords using either a version of MD5 modified for Apache, or the system's crypt() routine\&. Files managed by htpasswd 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 crypt()\&.
+
+.PP
+This manual page only lists the command line arguments\&. For details of the directives necessary to configure user authentication in httpd see the Apache manual, which is part of the Apache distribution or can be found at http://httpd\&.apache\&.org/\&.
+
+
+.SH "OPTIONS"
+
+.RS
+
+.TP
+-b
+Use batch mode; \fIi\&.e\&.\fR, get the password from the command line rather than prompting for it\&. This option should be used with extreme care, since \fBthe password is clearly visible\fR on the command line\&.
+.TP
+-c
+Create the \fIpasswdfile\fR\&. If \fIpasswdfile\fR already exists, it is rewritten and truncated\&. This option cannot be combined with the -n option\&.
+.TP
+-n
+Display the results on standard output rather than updating a file\&. This is useful for generating password records acceptable to Apache for inclusion in non-text data stores\&. This option changes the syntax of the command line, since the \fIpasswdfile\fR argument (usually the first one) is omitted\&. It cannot be combined with the -c option\&.
+.TP
+-m
+Use MD5 encryption for passwords\&. On Windows, Netware and TPF, this is the default\&.
+.TP
+-d
+Use crypt() encryption for passwords\&. The default on all platforms but Windows, Netware and TPF\&. Though possibly supported by htpasswd on all platforms, it is not supported by the httpd server on Windows, Netware and TPF\&.
+.TP
+-s
+Use SHA encryption for passwords\&. Facilitates migration from/to Netscape servers using the LDAP Directory Interchange Format (ldif)\&.
+.TP
+-p
+Use plaintext passwords\&. Though htpasswd will support creation on all platforms, the httpd daemon will only accept plain text passwords on Windows, Netware and TPF\&.
+.TP
+\fIpasswdfile\fR
+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\&.
+.TP
+\fIusername\fR
+The username to create or update in \fIpasswdfile\fR\&. If \fIusername\fR does not exist in this file, an entry is added\&. If it does exist, the password is changed\&.
+.TP
+\fIpassword\fR
+The plaintext password to be encrypted and stored in the file\&. Only used with the -b flag\&.
+.RE
+
+.SH "EXIT STATUS"
+
+.PP
+htpasswd returns a zero status ("true") if the username and password have been successfully added or updated in the \fIpasswdfile\fR\&. htpasswd returns 1 if it encounters some problem accessing files, 2 if there was a syntax problem with the command line, 3 if the password was entered interactively and the verification entry didn't match, 4 if its operation was interrupted, 5 if a value is too long (username, filename, password, or final computed record), and 6 if the username contains illegal characters (see the Restrictions section)\&.
+
+.SH "EXAMPLES"
+
+.nf
+
+ htpasswd /usr/local/etc/apache/\&.htpasswd-users jsmith
+
+.fi
+
+.PP
+Adds or modifies the password for user jsmith\&. The user is prompted for the password\&. If executed on a Windows system, the password will be encrypted using the modified Apache MD5 algorithm; otherwise, the system's crypt() routine will be used\&. If the file does not exist, htpasswd will do nothing except return an error\&.
+
+.nf
+
+ htpasswd -c /home/doe/public_html/\&.htpasswd jane
+
+.fi
+
+.PP
+Creates a new file and stores a record in it for user jane\&. The user is prompted for the password\&. If the file exists and cannot be read, or cannot be written, it is not altered and htpasswd will display a message and return an error status\&.
+
+.nf
+
+ htpasswd -mb /usr/web/\&.htpasswd-all jones Pwd4Steve
+
+.fi
+
+.PP
+Encrypts the password from the command line (Pwd4Steve) using the MD5 algorithm, and stores it in the specified file\&.
+
+.SH "SECURITY CONSIDERATIONS"
+
+.PP
+Web password files such as those managed by htpasswd should \fInot\fR be within the Web server's URI space -- that is, they should not be fetchable with a browser\&.
+
+.PP
+The use of the -b option is discouraged, since when it is used the unencrypted password appears on the command line\&.
+
+.SH "RESTRICTIONS"
+
+.PP
+On the Windows and MPE platforms, passwords encrypted with htpasswd are limited to no more than 255 characters in length\&. Longer passwords will be truncated to 255 characters\&.
+
+.PP
+The MD5 algorithm used by htpasswd is specific to the Apache software; passwords encrypted using it will not be usable with other Web servers\&.
+
+.PP
+Usernames are limited to 255 bytes and may not include the character :\&.
+
+++ /dev/null
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
- <title>Manual Page: htpasswd - Apache HTTP Server</title>
- </head>
-
- <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 2.1</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> ] <em>passwdfile username</em>
- <strong>htpasswd</strong> -<strong>b</strong> [ -<strong>c</strong> ] [ -<strong>m</strong> | -<strong>d</strong> | -<strong>p</strong> | -<strong>s</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 MD5 encryption for passwords. On Windows and TPF,
- this 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. Facilitates 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> daemon 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 2.1</h3>
- <a href="./"><img src="../images/index.gif" alt="Index" /></a>
- <a href="../"><img src="../images/home.gif" alt="Home" /></a>
-
-
- </body>
-</html>
-
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ -->
+<title>htpasswd - Manage user files for basic authentication - Apache HTTP Server</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body id="manual-page"><div id="page-header">
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.1</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>htpasswd - Manage user files for basic authentication</h1>
+<div class="toplang">
+<p><span>Available Languages: </span><a href="../en/programs/htpasswd.html"> en </a></p>
+</div>
+
+ <p><code>htpasswd</code> is used to create and update the flat-files used to
+ store usernames and password for basic authentication of HTTP users. If
+ <code>htpasswd</code> 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.</p>
+
+ <p>Resources available from the Apache HTTP server can be restricted to
+ just the users listed in the files created by <code>htpasswd</code>. This
+ program can only manage usernames and passwords 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 <a href="dbmmanage.html">dbmmanage</a>.</p>
+
+ <p><code>htpasswd</code> encrypts passwords using either a version of MD5
+ modified for Apache, or the system's <code>crypt()</code> routine. Files
+ managed by <code>htpasswd</code> 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 <code>crypt()</code>.</p>
+
+ <p>This manual page only lists the command line arguments. For details of
+ the directives necessary to configure user authentication in
+ <a href="httpd.html">httpd</a> see the Apache manual, which is part of the
+ Apache distribution or can be found at <a href="http://httpd.apache.org">http://httpd.apache.org/</a>.</p>
+</div>
+<div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#exit">Exit Status</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#security">Security Considerations</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#restrictions">Restrictions</a></li>
+</ul><h3>See also</h3><ul class="seealso"><li><a href="httpd.html">httpd</a></li><li><p>The scripts in support/SHA1 which come with the
+distribution.</p></li></ul></div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
+ <p><code><strong>htpasswd</strong>
+ [ -<strong>c</strong> ]
+ [ -<strong>m</strong> ] <var>passwdfile</var> <var>username</var></code></p>
+
+ <p><code><strong>htpasswd</strong> -<strong>b</strong>
+ [ -<strong>c</strong> ]
+ [ -<strong>m</strong> |
+ -<strong>d</strong> |
+ -<strong>p</strong> |
+ -<strong>s</strong> ] <var>passwdfile</var> <var>username</var>
+ <var>password</var></code></p>
+
+ <p><code><strong>htpasswd</strong> -<strong>n</strong>
+ [ -<strong>m</strong> |
+ -<strong>d</strong> |
+ -<strong>s</strong> |
+ -<strong>p</strong> ] <var>username</var></code></p>
+
+ <p><code><strong>htpasswd</strong> -<strong>nb</strong>
+ [ -<strong>m</strong> |
+ -<strong>d</strong> |
+ -<strong>s</strong> |
+ -<strong>p</strong> ] <var>username</var> <var>password</var></code></p>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="options" id="options">Options</a></h2>
+ <dl>
+ <dt><code>-b</code></dt>
+ <dd>Use batch mode; <em>i.e.</em>, get the password from the command line
+ rather than prompting for it. This option should be used with extreme care,
+ since <strong>the password is clearly visible</strong> on the command
+ line.</dd>
+
+ <dt><code>-c</code></dt>
+ <dd>Create the <var>passwdfile</var>. If <var>passwdfile</var> already
+ exists, it is rewritten and truncated. This option cannot be combined with
+ the <code>-n</code> option.</dd>
+
+ <dt><code>-n</code></dt>
+ <dd>Display the results on standard output rather than updating a file.
+ This is useful for generating password records acceptable to Apache for
+ inclusion in non-text data stores. This option changes the syntax of the
+ command line, since the <var>passwdfile</var> argument (usually the first
+ one) is omitted. It cannot be combined with the <code>-c</code> option.</dd>
+
+ <dt><code>-m</code></dt>
+ <dd>Use MD5 encryption for passwords. On Windows, Netware and TPF, this is
+ the default.</dd>
+
+ <dt><code>-d</code></dt>
+ <dd>Use <code>crypt()</code> encryption for passwords. The default on all
+ platforms but Windows, Netware and TPF. Though possibly supported by
+ <code>htpasswd</code> on all platforms, it is not supported by the
+ <a href="httpd.html">httpd</a> server on Windows, Netware and TPF.</dd>
+
+ <dt><code>-s</code></dt>
+ <dd>Use SHA encryption for passwords. Facilitates migration from/to Netscape
+ servers using the LDAP Directory Interchange Format (ldif).</dd>
+
+ <dt><code>-p</code></dt>
+ <dd>Use plaintext passwords. Though <code>htpasswd</code> will support
+ creation on all platforms, the <a href="httpd.html">httpd</a> daemon will
+ only accept plain text passwords on Windows, Netware and TPF.</dd>
+
+ <dt><code><var>passwdfile</var></code></dt>
+ <dd>Name of the file to contain the user name and password. If
+ <code>-c</code> is given, this file is created if it does not already exist,
+ or rewritten and truncated if it does exist.</dd>
+
+ <dt><code><var>username</var></code></dt>
+ <dd>The username to create or update in <var>passwdfile</var>. If
+ <var>username</var> does not exist in this file, an entry is added. If it
+ does exist, the password is changed.</dd>
+
+ <dt><code><var>password</var></code></dt>
+ <dd>The plaintext password to be encrypted and stored in the file. Only
+ used with the <code>-b</code> flag.</dd>
+ </dl>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="exit" id="exit">Exit Status</a></h2>
+ <p><code>htpasswd</code> returns a zero status ("true") if the username and
+ password have been successfully added or updated in the
+ <var>passwdfile</var>. <code>htpasswd</code> returns <code>1</code> if it
+ encounters some problem accessing files, <code>2</code> if there was a
+ syntax problem with the command line, <code>3</code> if the password was
+ entered interactively and the verification entry didn't match,
+ <code>4</code> if its operation was interrupted, <code>5</code> if a value
+ is too long (username, filename, password, or final computed record), and
+ <code>6</code> if the username contains illegal characters (see the
+ <a href="#restrictions">Restrictions section</a>).</p>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="examples" id="examples">Examples</a></h2>
+ <div class="example"><p><code>
+ htpasswd /usr/local/etc/apache/.htpasswd-users jsmith
+ </code></p></div>
+
+ <p>Adds or modifies the password for user <code>jsmith</code>. The user
+ is prompted for the password. If executed on a Windows system, the password
+ will be encrypted using the modified Apache MD5 algorithm; otherwise, the
+ system's <code>crypt()</code> routine will be used. If the file does not
+ exist, <code>htpasswd</code> will do nothing except return an error.</p>
+
+ <div class="example"><p><code>
+ htpasswd -c /home/doe/public_html/.htpasswd jane
+ </code></p></div>
+
+ <p>Creates a new file and stores a record in it for user <code>jane</code>.
+ The user is prompted for the password. If the file exists and cannot be
+ read, or cannot be written, it is not altered and <code>htpasswd</code>
+ will display a message and return an error status.</p>
+
+ <div class="example"><p><code>
+ htpasswd -mb /usr/web/.htpasswd-all jones Pwd4Steve
+ </code></p></div>
+
+ <p>Encrypts the password from the command line (<code>Pwd4Steve</code>)
+ using the MD5 algorithm, and stores it in the specified file.</p>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="security" id="security">Security Considerations</a></h2>
+ <p>Web password files such as those managed by <code>htpasswd</code> should
+ <em>not</em> be within the Web server's URI space -- that is, they should
+ not be fetchable with a browser.</p>
+
+ <p>The use of the <code>-b</code> option is discouraged, since when it is
+ used the unencrypted password appears on the command line.</p>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="restrictions" id="restrictions">Restrictions</a></h2>
+ <p>On the Windows and MPE platforms, passwords encrypted with
+ <code>htpasswd</code> are limited to no more than <code>255</code>
+ characters in length. Longer passwords will be truncated to 255
+ characters.</p>
+
+ <p>The MD5 algorithm used by <code>htpasswd</code> is specific to the Apache
+ software; passwords encrypted using it will not be usable with other Web
+ servers.</p>
+
+ <p>Usernames are limited to <code>255</code> bytes and may not include the
+ character <code>:</code>.</p>
+</div></div>
+<div class="bottomlang">
+<p><span>Available Languages: </span><a href="../en/programs/htpasswd.html"> en </a></p>
+</div><div id="footer">
+<p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
+</body></html>
\ No newline at end of file
--- /dev/null
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<manualpage metafile="htpasswd.xml.meta">
+<parentdocument href="./">Programs</parentdocument>
+
+<title>htpasswd - Manage user files for basic authentication</title>
+
+<summary>
+ <p><code>htpasswd</code> is used to create and update the flat-files used to
+ store usernames and password for basic authentication of HTTP users. If
+ <code>htpasswd</code> 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.</p>
+
+ <p>Resources available from the Apache HTTP server can be restricted to
+ just the users listed in the files created by <code>htpasswd</code>. This
+ program can only manage usernames and passwords 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 <a
+ href="dbmmanage.html">dbmmanage</a>.</p>
+
+ <p><code>htpasswd</code> encrypts passwords using either a version of MD5
+ modified for Apache, or the system's <code>crypt()</code> routine. Files
+ managed by <code>htpasswd</code> 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 <code>crypt()</code>.</p>
+
+ <p>This manual page only lists the command line arguments. For details of
+ the directives necessary to configure user authentication in
+ <a href="httpd.html">httpd</a> see the Apache manual, which is part of the
+ Apache distribution or can be found at <a href="http://httpd.apache.org"
+ >http://httpd.apache.org/</a>.</p>
+</summary>
+<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><p>The scripts in support/SHA1 which come with the
+distribution.</p></seealso>
+
+<section id="synopsis"><title>Synopsis</title>
+ <p><code><strong>htpasswd</strong>
+ [ -<strong>c</strong> ]
+ [ -<strong>m</strong> ] <var>passwdfile</var> <var>username</var></code></p>
+
+ <p><code><strong>htpasswd</strong> -<strong>b</strong>
+ [ -<strong>c</strong> ]
+ [ -<strong>m</strong> |
+ -<strong>d</strong> |
+ -<strong>p</strong> |
+ -<strong>s</strong> ] <var>passwdfile</var> <var>username</var>
+ <var>password</var></code></p>
+
+ <p><code><strong>htpasswd</strong> -<strong>n</strong>
+ [ -<strong>m</strong> |
+ -<strong>d</strong> |
+ -<strong>s</strong> |
+ -<strong>p</strong> ] <var>username</var></code></p>
+
+ <p><code><strong>htpasswd</strong> -<strong>nb</strong>
+ [ -<strong>m</strong> |
+ -<strong>d</strong> |
+ -<strong>s</strong> |
+ -<strong>p</strong> ] <var>username</var> <var>password</var></code></p>
+</section>
+
+<section id="options"><title>Options</title>
+ <dl>
+ <dt><code>-b</code></dt>
+ <dd>Use batch mode; <em>i.e.</em>, get the password from the command line
+ rather than prompting for it. This option should be used with extreme care,
+ since <strong>the password is clearly visible</strong> on the command
+ line.</dd>
+
+ <dt><code>-c</code></dt>
+ <dd>Create the <var>passwdfile</var>. If <var>passwdfile</var> already
+ exists, it is rewritten and truncated. This option cannot be combined with
+ the <code>-n</code> option.</dd>
+
+ <dt><code>-n</code></dt>
+ <dd>Display the results on standard output rather than updating a file.
+ This is useful for generating password records acceptable to Apache for
+ inclusion in non-text data stores. This option changes the syntax of the
+ command line, since the <var>passwdfile</var> argument (usually the first
+ one) is omitted. It cannot be combined with the <code>-c</code> option.</dd>
+
+ <dt><code>-m</code></dt>
+ <dd>Use MD5 encryption for passwords. On Windows, Netware and TPF, this is
+ the default.</dd>
+
+ <dt><code>-d</code></dt>
+ <dd>Use <code>crypt()</code> encryption for passwords. The default on all
+ platforms but Windows, Netware and TPF. Though possibly supported by
+ <code>htpasswd</code> on all platforms, it is not supported by the
+ <a href="httpd.html">httpd</a> server on Windows, Netware and TPF.</dd>
+
+ <dt><code>-s</code></dt>
+ <dd>Use SHA encryption for passwords. Facilitates migration from/to Netscape
+ servers using the LDAP Directory Interchange Format (ldif).</dd>
+
+ <dt><code>-p</code></dt>
+ <dd>Use plaintext passwords. Though <code>htpasswd</code> will support
+ creation on all platforms, the <a href="httpd.html">httpd</a> daemon will
+ only accept plain text passwords on Windows, Netware and TPF.</dd>
+
+ <dt><code><var>passwdfile</var></code></dt>
+ <dd>Name of the file to contain the user name and password. If
+ <code>-c</code> is given, this file is created if it does not already exist,
+ or rewritten and truncated if it does exist.</dd>
+
+ <dt><code><var>username</var></code></dt>
+ <dd>The username to create or update in <var>passwdfile</var>. If
+ <var>username</var> does not exist in this file, an entry is added. If it
+ does exist, the password is changed.</dd>
+
+ <dt><code><var>password</var></code></dt>
+ <dd>The plaintext password to be encrypted and stored in the file. Only
+ used with the <code>-b</code> flag.</dd>
+ </dl>
+</section>
+
+<section id="exit"><title>Exit Status</title>
+ <p><code>htpasswd</code> returns a zero status ("true") if the username and
+ password have been successfully added or updated in the
+ <var>passwdfile</var>. <code>htpasswd</code> returns <code>1</code> if it
+ encounters some problem accessing files, <code>2</code> if there was a
+ syntax problem with the command line, <code>3</code> if the password was
+ entered interactively and the verification entry didn't match,
+ <code>4</code> if its operation was interrupted, <code>5</code> if a value
+ is too long (username, filename, password, or final computed record), and
+ <code>6</code> if the username contains illegal characters (see the
+ <a href="#restrictions">Restrictions section</a>).</p>
+</section>
+
+<section id="examples"><title>Examples</title>
+ <example>
+ htpasswd /usr/local/etc/apache/.htpasswd-users jsmith
+ </example>
+
+ <p>Adds or modifies the password for user <code>jsmith</code>. The user
+ is prompted for the password. If executed on a Windows system, the password
+ will be encrypted using the modified Apache MD5 algorithm; otherwise, the
+ system's <code>crypt()</code> routine will be used. If the file does not
+ exist, <code>htpasswd</code> will do nothing except return an error.</p>
+
+ <example>
+ htpasswd -c /home/doe/public_html/.htpasswd jane
+ </example>
+
+ <p>Creates a new file and stores a record in it for user <code>jane</code>.
+ The user is prompted for the password. If the file exists and cannot be
+ read, or cannot be written, it is not altered and <code>htpasswd</code>
+ will display a message and return an error status.</p>
+
+ <example>
+ htpasswd -mb /usr/web/.htpasswd-all jones Pwd4Steve
+ </example>
+
+ <p>Encrypts the password from the command line (<code>Pwd4Steve</code>)
+ using the MD5 algorithm, and stores it in the specified file.</p>
+</section>
+
+<section id="security"><title>Security Considerations</title>
+ <p>Web password files such as those managed by <code>htpasswd</code> should
+ <em>not</em> be within the Web server's URI space -- that is, they should
+ not be fetchable with a browser.</p>
+
+ <p>The use of the <code>-b</code> option is discouraged, since when it is
+ used the unencrypted password appears on the command line.</p>
+</section>
+
+<section id="restrictions"><title>Restrictions</title>
+ <p>On the Windows and MPE platforms, passwords encrypted with
+ <code>htpasswd</code> are limited to no more than <code>255</code>
+ characters in length. Longer passwords will be truncated to 255
+ characters.</p>
+
+ <p>The MD5 algorithm used by <code>htpasswd</code> is specific to the Apache
+ software; passwords encrypted using it will not be usable with other Web
+ servers.</p>
+
+ <p>Usernames are limited to <code>255</code> bytes and may not include the
+ character <code>:</code>.</p>
+</section>
+
+</manualpage>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<metafile>
+ <basename>htpasswd</basename>
+ <path>/programs/</path>
+ <relpath>..</relpath>
+
+ <variants>
+ <variant>en</variant>
+ </variants>
+</metafile>
<!-- documents not converted (yet?). -->
<not-exists>
<file>developer/API.xml</file>
- <file>programs/htpasswd.xml</file>
<file>programs/other.xml</file>
</not-exists>
</xsl:template>
projects / apache / commitdiff