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