xref: /freebsd/contrib/openpam/doc/man/pam_info.3 (revision aca5021d5f7dcab1e11692923266373e35322d9a)
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_INFO 3
39.Os
40.Sh NAME
41.Nm pam_info
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_info "const pam_handle_t *pamh" "const char *fmt" "..."
50.Sh DESCRIPTION
51The
52.Fn pam_info
53function displays an informational message through the
54intermediary of the given PAM context's conversation function.
55.Pp
56.Sh RETURN VALUES
57The
58.Fn pam_info
59function returns one of the following values:
60.Bl -tag -width 18n
61.It Bq Er PAM_BUF_ERR
62Memory buffer error.
63.It Bq Er PAM_CONV_ERR
64Conversation failure.
65.It Bq Er PAM_SYSTEM_ERR
66System error.
67.El
68.Sh SEE ALSO
69.Xr pam 3 ,
70.Xr pam_error 3 ,
71.Xr pam_prompt 3 ,
72.Xr pam_strerror 3 ,
73.Xr pam_vinfo 3
74.Sh STANDARDS
75The
76.Fn pam_info
77function is an OpenPAM extension.
78.Sh AUTHORS
79The
80.Fn pam_info
81function and this manual page were
82developed for the
83.Fx
84Project by ThinkSec AS and Network Associates Laboratories, the
85Security Research Division of Network Associates, Inc.\& under
86DARPA/SPAWAR contract N66001-01-C-8035
87.Pq Dq CBOSS ,
88as part of the DARPA CHATS research program.
89