xref: /netbsd-src/lib/libpam/modules/pam_echo/pam_echo.8 (revision 9601c032f2246b74d756ed05b35310ddd1f8324a)
1.\" $NetBSD: pam_echo.8,v 1.3 2010/05/13 23:07:46 joerg Exp $
2.\" Copyright (c) 2001,2003 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" Portions of this software were developed for the FreeBSD Project by
6.\" ThinkSec AS and NAI Labs, the Security Research Division of Network
7.\" 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.\" $FreeBSD: src/lib/libpam/modules/pam_echo/pam_echo.8,v 1.4 2004/07/02 23:52:16 ru Exp $
35.\"
36.Dd February 6, 2003
37.Dt PAM_ECHO 8
38.Os
39.Sh NAME
40.Nm pam_echo
41.Nd Echo PAM module
42.Sh SYNOPSIS
43.Op Ar service-name
44.Ar module-type
45.Ar control-flag
46.Pa pam_echo
47.Op Ar arguments
48.Sh DESCRIPTION
49The echo service module for PAM displays its arguments to the user,
50separated by spaces, using the current conversation function.
51.Pp
52If the
53.Cm %
54character occurs anywhere in the arguments to
55.Nm ,
56it is assumed to introduce one of the following escape sequences:
57.Bl -tag -width 4n
58.It Cm %H
59The name of the host on which the client runs
60.Pq Dv PAM_RHOST .
61.\".It Cm %h
62.\"The name of the host on which the server runs.
63.It Cm %s
64The current service name
65.Pq Dv PAM_SERVICE .
66.It Cm %t
67The name of the controlling tty
68.Pq Dv PAM_TTY .
69.It Cm \&%U
70The applicant's user name
71.Pq Dv PAM_RUSER .
72.It Cm %u
73The target account's user name
74.Pq Dv PAM_USER .
75.El
76.Pp
77Any other two-character sequence beginning with
78.Cm %
79expands to the character following the
80.Cm %
81character.
82.Sh SEE ALSO
83.Xr pam.conf 5 ,
84.Xr pam 8
85.Sh AUTHORS
86The
87.Nm
88module and this manual page were developed for the
89.Fx
90Project by
91ThinkSec AS and NAI Labs, the Security Research Division of Network
92Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
93.Pq Dq CBOSS ,
94as part of the DARPA CHATS research program.
95