Documentation for pw_getconf(). From OpenBSD.
This commit is contained in:
parent
82be161e7c
commit
7b3efebed5
|
@ -1,4 +1,4 @@
|
|||
# $NetBSD: Makefile,v 1.25 2000/05/12 18:31:55 mjl Exp $
|
||||
# $NetBSD: Makefile,v 1.26 2000/07/06 11:08:19 ad Exp $
|
||||
# @(#)Makefile 8.1 (Berkeley) 6/4/93
|
||||
|
||||
LIB= util
|
||||
|
@ -10,7 +10,7 @@ SRCS= fparseln.c getmaxpartitions.c getrawpartition.c \
|
|||
|
||||
MAN= fparseln.3 getmaxpartitions.3 getrawpartition.3 \
|
||||
login.3 login_cap.3 opendisk.3 \
|
||||
openpty.3 pidfile.3 pidlock.3 pw_init.3 pw_lock.3 \
|
||||
openpty.3 pidfile.3 pidlock.3 pw_getconf.3 pw_init.3 pw_lock.3 \
|
||||
securepath.3 ttyaction.3 ttymsg.3
|
||||
|
||||
.PATH: ${.CURDIR}/../libc/gen
|
||||
|
|
|
@ -0,0 +1,74 @@
|
|||
.\" $NetBSD: pw_getconf.3,v 1.1 2000/07/06 11:08:19 ad Exp $
|
||||
.\"
|
||||
.\" Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de>
|
||||
.\" 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. All advertising materials mentioning features or use of this software
|
||||
.\" must display the following acknowledgement:
|
||||
.\" This product includes software developed by Niels Provos.
|
||||
.\" 4. The name of the author may not be used to endorse or promote products
|
||||
.\" derived from this software without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 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 AUTHOR 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.
|
||||
.\"
|
||||
.\" from OpenBSD: pw_getconf.3,v 1.5 1999/09/21 04:52:46 csapuntz Exp
|
||||
.\"
|
||||
.Dd July 6, 2000
|
||||
.Dt PW_GETCONF 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm pw_getconf
|
||||
.Nd passwd configuration access function
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <util.h>
|
||||
.Ft void
|
||||
.Fn pw_getconf "char *data" "size_t len" "const char *key" "const char *option"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn pw_getconf
|
||||
function reads
|
||||
.Pa /etc/passwd.conf
|
||||
and retrieves the value of the option specified
|
||||
by
|
||||
.Pa option
|
||||
from the section given be
|
||||
.Pa key .
|
||||
If no suitable entry is found
|
||||
for the
|
||||
.Pa key
|
||||
an empty string will be returned in data.
|
||||
.Pp
|
||||
For default values the key
|
||||
.Pa default
|
||||
can be used, this might be useful when no entry was found
|
||||
for a specific key or option.
|
||||
.Pp
|
||||
An empty string is also returned for other errors.
|
||||
.Sh FILES
|
||||
.Bl -tag -width /etc/passwd.conf -compact
|
||||
.It Pa /etc/passwd.conf
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr passwd 5 ,
|
||||
.Xr passwd.conf 5
|
||||
.Sh HISTORY
|
||||
.Fn pw_getconf
|
||||
first appeared in
|
||||
.Nx 1.6 .
|
Loading…
Reference in New Issue