xref: /freebsd/contrib/openpam/doc/man/pam_info.3 (revision f0a75d274af375d15b97b830966b99a02b7db911)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" Network Associates Laboratories, the Security Research Division of
7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
8.\" ("CBOSS"), as part of the 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$
35.\"
36.Dd June 16, 2005
37.Dt PAM_INFO 3
38.Os
39.Sh NAME
40.Nm pam_info
41.Nd display an information message
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In sys/types.h
46.In security/pam_appl.h
47.Ft "int"
48.Fn pam_info "pam_handle_t *pamh" "const char *fmt" "..."
49.Sh DESCRIPTION
50The
51.Nm
52function displays an informational message through the
53intermediary of the given PAM context's conversation function.
54.Pp
55.Sh RETURN VALUES
56The
57.Nm
58function returns one of the following values:
59.Bl -tag -width 18n
60.It Bq Er PAM_BUF_ERR
61Memory buffer error.
62.It Bq Er PAM_CONV_ERR
63Conversation failure.
64.It Bq Er PAM_SYSTEM_ERR
65System error.
66.El
67.Sh SEE ALSO
68.Xr pam 3 ,
69.Xr pam_error 3 ,
70.Xr pam_prompt 3 ,
71.Xr pam_strerror 3 ,
72.Xr pam_vinfo 3
73.Sh STANDARDS
74The
75.Nm
76function is an OpenPAM extension.
77.Sh AUTHORS
78The
79.Nm
80function and this manual page were developed for the
81.Fx
82Project by ThinkSec AS and Network Associates Laboratories, the
83Security Research Division of Network Associates, Inc.\& under
84DARPA/SPAWAR contract N66001-01-C-8035
85.Pq Dq CBOSS ,
86as part of the DARPA CHATS research program.
87