xref: /netbsd-src/lib/libutil/ttyaction.3 (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1.\" $NetBSD: ttyaction.3,v 1.12 2003/04/16 13:35:15 wiz Exp $
2.\"
3.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Gordon W. Ross.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd August 24, 1996
38.Dt TTYACTION 3
39.Os
40.Sh NAME
41.Nm ttyaction
42.Nd ttyaction utility function
43.Sh LIBRARY
44.Lb libutil
45.Sh SYNOPSIS
46.In util.h
47.Ft int
48.Fn ttyaction "char *ttyname" "char *action" "char *username"
49.Sh DESCRIPTION
50The
51.Fn ttyaction
52function is used by
53.Xr login 1 ,
54.Xr getty 8 ,
55.Xr telnetd 8
56and
57.Xr rlogind 8
58to execute site-specific commands
59when a login session begins and ends.
60.Pp
61The
62.Fn ttyaction
63function scans the
64.Pa /etc/ttyaction
65file for any records that match the current
66.Fa ttyname
67and
68.Fa action
69parameters, and for each matching record,
70runs the shell command shown in that record.
71The record format is described in
72.Xr ttyaction 5 .
73The parameter
74.Fa username
75is the name of the new owner of the
76.Fa ttyname
77device.
78Note that the
79.Fa ttyname
80parameter may be passed as a fully qualified pathname, and the
81.Fn ttyaction
82function will skip the leading "/dev/" part of the string.
83(This is a convenience for login and getty.)
84.Sh RETURN VALUES
85.Fn ttyaction
86returns the status of the last command it executed,
87or zero if no matching commands were found.
88.Sh FILES
89.Bl -tag -width /etc/ttyaction -compact
90.It Pa /dev/\(**
91.It Pa /etc/ttyaction
92.El
93.Sh SEE ALSO
94.Xr ttyaction 5
95.Sh AUTHORS
96.An Gordon W. Ross
97.Aq gwr@NetBSD.org ,
98.An Chris G. Demetriou
99.Aq cgd@NetBSD.org ,
100.An Ty Sarna
101.Aq tsarna@endicor.com .
102.Sh BUGS
103There should be some
104.Em other
105mechanism to allow selection of different access control policies
106on a per-line basis.
107It has been suggested that the same
108.Nm ttyaction
109mechanism should also be used for determining access control, but
110it was decided (after much discussion) that
111.Nm ttyaction
112should only describe actions to be performed
113.Em after
114the system has decided to change the ownership of some tty.
115Access control policies will be handled by a separate mechanism.
116