share/man/man5/ttyaction.5

   1 .\" $NetBSD: ttyaction.5,v 1.7 2001/09/11 01:01:58 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 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd August 24, 1996
  31 .Dt TTYACTION 5
  32 .Os
  33 .Sh NAME
  34 .Nm ttyaction
  35 .Nd ttyaction file format
  36 .Sh DESCRIPTION
  37 The
  38 .Nm ttyaction
  39 file specifies site-specific commands to run
  40 when a login session begins and ends. The
  41 .Nm ttyaction
  42 file contains a list of newline separated records, where
  43 each record has the following three fields:
  44 .Bl -tag -width username
  45 .It ttyname
  46 Name of the tty line(s) on which this line should apply.
  47 The name is relative to the
  48 .Pa /dev
  49 directory, similar to how such devices are named in the
  50 .Pa /etc/ttys
  51 file.
  52 .It action
  53 Name of the action for which this line should apply.
  54 The action names currently defined are "login", "getty",
  55 "telnetd" and "rlogind"
  56 which indicate which program is processing this file.
  57 (Note that "login" begins a login session, while the other
  58 three are run after a login session ends.)
  59 .It command
  60 What command to run if this record matches.
  61 .El
  62 .Pp
  63 The first two fields are delimited with blanks or tabs,
  64 and the command field is all text to the end of the line.
  65 Either or both of first two fields may contain wildcard
  66 match patterns as implemented by the
  67 .Fn fnmatch
  68 library function.
  69 .Pp
  70 All command strings are executed by passing them to
  71 .Pa /bin/sh \-c
  72 running as "root," with an environment containing:
  73 .Bd -literal -offset indent
  74 TTY=ttyname
  75 ACT=action
  76 USER=username
  77 PATH=_PATH_STDPATH
  78 .Ed
  79 .Pp
  80 These variables may be used directly in the shell command
  81 part of the record for simple tasks such as changing the
  82 ownership of related devices.  For example:
  83 .Bd -literal -offset indent
  84 console  *      chown ${USER}:tty /dev/mouse
  85 .Ed
  86 .Pp
  87 will
  88 .Fa chown
  89 the mouse appropriately when the console owner changes.
  90 .Sh EXAMPLES
  91 Here are some more example records:
  92 .Bd -literal -offset indent
  93 tty0    login   /somewhere/tty_setup ${TTY}
  94 tty0    getty   /somewhere/tty_clean ${TTY}
  95 *       *       /somewhere/ttyfrob ${TTY} ${ACT}
  96 .Ed
  97 .Sh SEE ALSO
  98 .Xr fnmatch 3 ,
  99 .Xr ttyaction 3
 100 .Sh HISTORY
 101 The ideas for the
 102 .Pa /etc/ttyaction
 103 file were inspired by the
 104 .Pa /etc/fbtab
 105 file under SunOS.