From 709fbe9015e088c6ec99d947e258015364ca52cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dag-Erling=20Sm=C3=B8rgrav?= Date: Thu, 7 Feb 2002 12:31:39 +0000 Subject: [PATCH] Regenerate man pages for functions that have changed, and add man pages for new functions. The man pages have been backdated to minimize diffs. Sponsored by: DARPA, NAI Labs git-svn-id: svn+ssh://svn.openpam.org/svn/openpam/trunk@41 185d5e19-27fe-0310-9dcf-9bff6b9f3609 --- doc/man/pam.3 | 22 +++++++++--- doc/man/pam_get_authtok.3 | 2 +- doc/man/pam_get_item.3 | 2 +- doc/man/pam_get_user.3 | 2 +- doc/man/pam_prompt.3 | 4 +-- doc/man/pam_verror.3 | 73 +++++++++++++++++++++++++++++++++++++++ doc/man/pam_vinfo.3 | 73 +++++++++++++++++++++++++++++++++++++++ doc/man/pam_vprompt.3 | 73 +++++++++++++++++++++++++++++++++++++++ 8 files changed, 241 insertions(+), 10 deletions(-) create mode 100644 doc/man/pam_verror.3 create mode 100644 doc/man/pam_vinfo.3 create mode 100644 doc/man/pam_vprompt.3 diff --git a/doc/man/pam.3 b/doc/man/pam.3 index f2fdc1b..b3eb092 100644 --- a/doc/man/pam.3 +++ b/doc/man/pam.3 @@ -58,7 +58,10 @@ .Nm pam_setcred , .Nm pam_setenv , .Nm pam_start , -.Nm pam_strerror +.Nm pam_strerror , +.Nm pam_verror , +.Nm pam_vinfo , +.Nm pam_vprompt .Nd Pluggable Authentication Modules .Sh LIBRARY .Lb libpam @@ -77,13 +80,13 @@ .Ft int .Fn pam_error "pam_handle_t *pamh" "const char *fmt" "..." .Ft int -.Fn pam_get_authtok "pam_handle_t *pamh" "char **authtok" "const char *prompt" +.Fn pam_get_authtok "pam_handle_t *pamh" "const char **authtok" "const char *prompt" .Ft int .Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "void **data" .Ft int -.Fn pam_get_item "pam_handle_t *pamh" "int item_type" "void **item" +.Fn pam_get_item "pam_handle_t *pamh" "int item_type" "const void **item" .Ft int -.Fn pam_get_user "pam_handle_t *pamh" "char **user" "const char *prompt" +.Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt" .Ft char * .Fn pam_getenv "pam_handle_t *pamh" "const char *name" .Ft char ** @@ -93,7 +96,7 @@ .Ft int .Fn pam_open_session "pam_handle_t *pamh" "int flags" .Ft int -.Fn pam_prompt "pam_handle_t *pamh" "char **resp" "int echo" "const char *fmt" "..." +.Fn pam_prompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..." .Ft int .Fn pam_putenv "pam_handle_t *pamh" "const char *namevalue" .Ft int @@ -108,6 +111,12 @@ .Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh" .Ft const char * .Fn pam_strerror "pam_handle_t *pamh" "int error_number" +.Ft int +.Fn pam_verror "pam_handle_t *pamh" "const char *fmt" "va_list ap" +.Ft int +.Fn pam_vinfo "pam_handle_t *pamh" "const char *fmt" "va_list ap" +.Ft int +.Fn pam_vprompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap" .Sh DESCRIPTION Foo .Sh RETURN VALUES @@ -134,6 +143,9 @@ Foo .Xr pam_setenv 3 , .Xr pam_start 3 , .Xr pam_strerror 3 , +.Xr pam_verror 3 , +.Xr pam_vinfo 3 , +.Xr pam_vprompt 3 , .Xr pam.conf 5 .Sh STANDARDS .Rs diff --git a/doc/man/pam_get_authtok.3 b/doc/man/pam_get_authtok.3 index 6354e0d..64d9c19 100644 --- a/doc/man/pam_get_authtok.3 +++ b/doc/man/pam_get_authtok.3 @@ -44,7 +44,7 @@ .Sh SYNOPSIS .In security/pam_appl.h .Ft int -.Fn pam_get_authtok "pam_handle_t *pamh" "char **authtok" "const char *prompt" +.Fn pam_get_authtok "pam_handle_t *pamh" "const char **authtok" "const char *prompt" .Sh DESCRIPTION The .Nm diff --git a/doc/man/pam_get_item.3 b/doc/man/pam_get_item.3 index 7433e3d..db58adf 100644 --- a/doc/man/pam_get_item.3 +++ b/doc/man/pam_get_item.3 @@ -44,7 +44,7 @@ .Sh SYNOPSIS .In security/pam_appl.h .Ft int -.Fn pam_get_item "pam_handle_t *pamh" "int item_type" "void **item" +.Fn pam_get_item "pam_handle_t *pamh" "int item_type" "const void **item" .Sh DESCRIPTION The .Nm diff --git a/doc/man/pam_get_user.3 b/doc/man/pam_get_user.3 index fcb4e76..110e256 100644 --- a/doc/man/pam_get_user.3 +++ b/doc/man/pam_get_user.3 @@ -44,7 +44,7 @@ .Sh SYNOPSIS .In security/pam_appl.h .Ft int -.Fn pam_get_user "pam_handle_t *pamh" "char **user" "const char *prompt" +.Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt" .Sh DESCRIPTION The .Nm diff --git a/doc/man/pam_prompt.3 b/doc/man/pam_prompt.3 index 44979ca..1788cca 100644 --- a/doc/man/pam_prompt.3 +++ b/doc/man/pam_prompt.3 @@ -38,13 +38,13 @@ .Os .Sh NAME .Nm pam_prompt -.Nd prompt the user for information +.Nd call the conversation function .Sh LIBRARY .Lb libpam .Sh SYNOPSIS .In security/pam_appl.h .Ft int -.Fn pam_prompt "pam_handle_t *pamh" "char **resp" "int echo" "const char *fmt" "..." +.Fn pam_prompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..." .Sh DESCRIPTION The .Nm diff --git a/doc/man/pam_verror.3 b/doc/man/pam_verror.3 new file mode 100644 index 0000000..18a1bbb --- /dev/null +++ b/doc/man/pam_verror.3 @@ -0,0 +1,73 @@ +.\"- +.\" Copyright (c) 2002 Networks Associates Technologies, Inc. +.\" All rights reserved. +.\" +.\" This software was developed for the FreeBSD Project by ThinkSec AS and +.\" NAI Labs, the Security Research Division of Network Associates, Inc. +.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the +.\" DARPA CHATS research program. +.\" +.\" 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 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 AND CONTRIBUTORS ``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 OR 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. +.\" +.\" $Id$ +.\" +.Dd February 4, 2002 +.Dt PAM_VERROR 3 +.Os +.Sh NAME +.Nm pam_verror +.Nd display an error message +.Sh LIBRARY +.Lb libpam +.Sh SYNOPSIS +.In security/pam_appl.h +.Ft int +.Fn pam_verror "pam_handle_t *pamh" "const char *fmt" "va_list ap" +.Sh DESCRIPTION +The +.Nm +function is not yet documented. +.Sh RETURN VALUES +The +.Fn +function returns one of the following values: +.Bl -tag -width PAM_AUTHTOK_DISABLE_AGING +.El +.Sh SEE ALSO +.Xr pam_strerror 3 , +.Xr pam 3 +.Sh STANDARDS +.Rs +.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" +.%D "June 1997" +.Re +.Sh AUTHORS +The +.Nm +function and this manual page were developed for the FreeBSD Project +by ThinkSec AS and NAI Labs, the Security Research Division of Network +Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 +.Pq Dq CBOSS , +as part of the DARPA CHATS research program. diff --git a/doc/man/pam_vinfo.3 b/doc/man/pam_vinfo.3 new file mode 100644 index 0000000..0309eac --- /dev/null +++ b/doc/man/pam_vinfo.3 @@ -0,0 +1,73 @@ +.\"- +.\" Copyright (c) 2002 Networks Associates Technologies, Inc. +.\" All rights reserved. +.\" +.\" This software was developed for the FreeBSD Project by ThinkSec AS and +.\" NAI Labs, the Security Research Division of Network Associates, Inc. +.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the +.\" DARPA CHATS research program. +.\" +.\" 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 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 AND CONTRIBUTORS ``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 OR 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. +.\" +.\" $Id$ +.\" +.Dd February 4, 2002 +.Dt PAM_VINFO 3 +.Os +.Sh NAME +.Nm pam_vinfo +.Nd display an information message +.Sh LIBRARY +.Lb libpam +.Sh SYNOPSIS +.In security/pam_appl.h +.Ft int +.Fn pam_vinfo "pam_handle_t *pamh" "const char *fmt" "va_list ap" +.Sh DESCRIPTION +The +.Nm +function is not yet documented. +.Sh RETURN VALUES +The +.Fn +function returns one of the following values: +.Bl -tag -width PAM_AUTHTOK_DISABLE_AGING +.El +.Sh SEE ALSO +.Xr pam_strerror 3 , +.Xr pam 3 +.Sh STANDARDS +.Rs +.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" +.%D "June 1997" +.Re +.Sh AUTHORS +The +.Nm +function and this manual page were developed for the FreeBSD Project +by ThinkSec AS and NAI Labs, the Security Research Division of Network +Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 +.Pq Dq CBOSS , +as part of the DARPA CHATS research program. diff --git a/doc/man/pam_vprompt.3 b/doc/man/pam_vprompt.3 new file mode 100644 index 0000000..f9d4777 --- /dev/null +++ b/doc/man/pam_vprompt.3 @@ -0,0 +1,73 @@ +.\"- +.\" Copyright (c) 2002 Networks Associates Technologies, Inc. +.\" All rights reserved. +.\" +.\" This software was developed for the FreeBSD Project by ThinkSec AS and +.\" NAI Labs, the Security Research Division of Network Associates, Inc. +.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the +.\" DARPA CHATS research program. +.\" +.\" 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 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 AND CONTRIBUTORS ``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 OR 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. +.\" +.\" $Id$ +.\" +.Dd February 4, 2002 +.Dt PAM_VPROMPT 3 +.Os +.Sh NAME +.Nm pam_vprompt +.Nd call the conversation function +.Sh LIBRARY +.Lb libpam +.Sh SYNOPSIS +.In security/pam_appl.h +.Ft int +.Fn pam_vprompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap" +.Sh DESCRIPTION +The +.Nm +function is not yet documented. +.Sh RETURN VALUES +The +.Fn +function returns one of the following values: +.Bl -tag -width PAM_AUTHTOK_DISABLE_AGING +.El +.Sh SEE ALSO +.Xr pam_strerror 3 , +.Xr pam 3 +.Sh STANDARDS +.Rs +.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" +.%D "June 1997" +.Re +.Sh AUTHORS +The +.Nm +function and this manual page were developed for the FreeBSD Project +by ThinkSec AS and NAI Labs, the Security Research Division of Network +Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 +.Pq Dq CBOSS , +as part of the DARPA CHATS research program.