xref: /freebsd/contrib/openpam/doc/man/pam_vinfo.3 (revision c6ec7d31830ab1c80edae95ad5e4b9dba10c47ac)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
4.\" All rights reserved.
5.\"
6.\" This software was developed for the FreeBSD Project by ThinkSec AS and
7.\" Network Associates Laboratories, the Security Research Division of
8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9.\" ("CBOSS"), as part of the DARPA CHATS research program.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. The name of the author may not be used to endorse or promote
20.\"    products derived from this software without specific prior written
21.\"    permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\" $Id$
36.\"
37.Dd May 26, 2012
38.Dt PAM_VINFO 3
39.Os
40.Sh NAME
41.Nm pam_vinfo
42.Nd display an information message
43.Sh LIBRARY
44.Lb libpam
45.Sh SYNOPSIS
46.In sys/types.h
47.In security/pam_appl.h
48.Ft "int"
49.Fn pam_vinfo "const pam_handle_t *pamh" "const char *fmt" "va_list ap"
50.Sh DESCRIPTION
51The
52.Fn pam_vinfo
53function passes its arguments to
54.Xr pam_vprompt 3
55with a
56style argument of
57.Dv PAM_TEXT_INFO ,
58and discards the response.
59.Pp
60.Sh RETURN VALUES
61The
62.Fn pam_vinfo
63function returns one of the following values:
64.Bl -tag -width 18n
65.It Bq Er PAM_BUF_ERR
66Memory buffer error.
67.It Bq Er PAM_CONV_ERR
68Conversation failure.
69.It Bq Er PAM_SYSTEM_ERR
70System error.
71.El
72.Sh SEE ALSO
73.Xr pam 3 ,
74.Xr pam_info 3 ,
75.Xr pam_strerror 3 ,
76.Xr pam_verror 3 ,
77.Xr pam_vprompt 3
78.Sh STANDARDS
79The
80.Fn pam_vinfo
81function is an OpenPAM extension.
82.Sh AUTHORS
83The
84.Fn pam_vinfo
85function and this manual page were
86developed for the
87.Fx
88Project by ThinkSec AS and Network Associates Laboratories, the
89Security Research Division of Network Associates, Inc.\& under
90DARPA/SPAWAR contract N66001-01-C-8035
91.Pq Dq CBOSS ,
92as part of the DARPA CHATS research program.
93