xref: /netbsd-src/lib/libutil/ttyaction.3 (revision 76dfffe33547c37f8bdd446e3e4ab0f3c16cea4b)
1.\" $NetBSD: ttyaction.3,v 1.3 1996/11/16 20:50:12 fvdl 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 REGENTS OR CONTRIBUTORS BE
29.\" 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 SYNOPSIS
44.Fd #include <util.h>
45.Ft void
46.Fn ttyaction "char *ttyname" "char *action" "char *username"
47.Sh DESCRIPTION
48The
49.Fn ttyaction
50function is used by
51.Nm login
52and
53.Nm getty
54to execute site-specific commands
55when a login session begins and ends.
56.Pp
57The
58.Fn ttyaction
59function scans the
60.Pa /etc/ttyaction
61file for any records that match the current
62.Fa ttyname
63and
64.Fa action
65parameters, and for each matching record, runs the shell command
66shown in that record.  The record format is described in
67.Xr ttyaction 5 .
68The parameter
69.Fa username
70is the name of the new owner of the
71.Fa ttyname
72device.  Note that the
73.Fa ttyname
74parameter may be passed as a fully qualified pathname, and the
75.Fn ttyaction
76function will skip the leading "/dev/" part of the string.
77(This is a conveinence for login and getty.)
78.Sh RETURN VALUES
79.Fn ttyaction
80returns the status of the last command it executed,
81or zero if no matching commands were found.
82.Sh FILES
83.Bl -tag -width /etc/ttyaction -compact
84.It Pa /dev/\(**
85.It Pa /etc/ttyaction
86.El
87.Sh SEE ALSO
88.Xr ttyaction 5
89.Sh AUTHORS
90The following people contributed to this design:
91.Bd -literal -offset indent
92Gordon W. Ross <gwr@netbsd.org>
93Chris G. Demetriou <cgd@netbsd.org>
94Ty Sarna <tsarna@endicor.com>
95.Ed
96.Sh BUGS
97There should be some
98.Em other
99mechanism to allow selection of different access control policies
100on a per-line basis.  It has been suggested that the same
101.Nm ttyaction
102mechanism should also be used for determining access control, but
103it was decided (after much discussion) that
104.Nm ttyaction
105should only describe actions to be performed
106.Em after
107the system has decided to change the ownership of some tty.
108Access control policies will be handled by a separate mechanism.
109