blob: 59aaa5f52b4e9070b1b936c051bf9dc9384e1e6f [file] [log] [blame]
.TH htdigest 1 "February 2004"
.\" Licensed to the Apache Software Foundation (ASF) under one or more
.\" contributor license agreements. See the NOTICE file distributed with
.\" this work for additional information regarding copyright ownership.
.\" The ASF licenses this file to You under the Apache License, Version 2.0
.\" (the "License"); you may not use this file except in compliance with
.\" the License. You may obtain a copy of the License at
.\"
.\" http://www.apache.org/licenses/LICENSE-2.0
.\"
.\" Unless required by applicable law or agreed to in writing, software
.\" distributed under the License is distributed on an "AS IS" BASIS,
.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.SH NAME
htdigest \- Create and update user authentication files
.SH SYNOPSIS
.B htdigest
[
.B \-c
]
.I passwdfile
.I realm
.I username
.SH DESCRIPTION
.B htdigest
is used to create and update the flat-files used to store
usernames, realm and password for digest authentication of HTTP users.
Resources available from the
.B httpd
Apache web server can be restricted to just the users listed
in the files created by
.B htdigest.
.PP
This manual page only lists the command line arguments. For details of
the directives necessary to configure digest authentication in
.B httpd
see
the Apache manual, which is part of the Apache distribution or can be
found at http://httpd.apache.org/.
.SH OPTIONS
.IP \-c
Create the \fIpasswdfile\fP. If \fIpasswdfile\fP already exists, it
is deleted first.
.IP \fB\fIpasswdfile\fP
Name of the file to contain the username, realm and password. If \-c
is specified, this file is created if it does not already exist,
or deleted and recreated if it does exist.
.IP \fB\fIrealm\fP
The realm name to which the user name belongs.
.IP \fB\fIusername\fP
The user name to create or update in \fBpasswdfile\fP. If
\fIusername\fP does not exist is this file, an entry is added. If it
does exist, the password is changed.
.SH SEE ALSO
.BR httpd(8)
.