1.\" Copyright (c) 1998-2003 Joe Marcus Clarke <marcus@marcuscom.com>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $MCom: gone/gone.man,v 1.4 2010/08/01 05:53:03 marcus Exp $
26.\"
27.Dd October 13, 2003
28.Dt GONE 1
29.Os
30.Sh NAME
31.Nm gone
32.Nd a terminal locking utility with many improvements over lock
33.Sh SYNOPSIS
34.Nm
35.Op Fl bvpxl
36.Op Fl y | n
37.Op Fl t Ar timeout
38.Sh DESCRIPTION
39.Nm
40is a utility that locks a terminal with a password chosen by
41the user.
42.Nm
43will prompt the user for a password, then print the \fBgone\fR banner,
44then drop into the
45.Nm
46shell.  From this shell, only a restricted set of commands can be run.
47.Nm
48will also disallow messages by removing permissions on the parent tty.
49After the timeout period (10 minutes by default),
50.Nm
51will automatically log the user out.
52.Pp
53If
54.Nm
55is installed setuid to root, then specifying the
56.Fl p
57option will instruct gone to read the password from the system password
58file/database instead of prompting the user.  Setuid'ing the program is
59done by setting the environmental variable with_setuid to ``yes'' then
60running configure.
61.Pp
62Options:
63.Pp
64.Bl -tag -width Fl
65.It Fl b
66Supress printing the
67.Nm
68banner.
69.It Fl v
70Print the version number and exit.
71.It Fl p
72Read the password from the system password database (must be setuid root
73at install-time).
74.It Fl x
75Supress processing of extended shell commands (see the section on shell
76commands below).
77.It Fl l
78Prevent VTY switching if supported by the platform.
79.It Fl y
80By default
81.Nm
82turns messages off (see
83.Xr mesg 1
84).  This option will turn messages on.
85.It Fl n
86Same as the
87.Fl y
88option (deprecated).
89.It Fl t Ar timeout
90Specify an optional timeout value in minutes.  Default is 10 minutes.
91If set to 0,
92.Nm
93will lock the terminal indefinitely.
94.El
95.Pp
96.Nm
97also accepts an optional string that is visible by using the
98.Xr w 1
99command.  Use this, and other users can see why you are gone.
100.Sh SHELL COMMANDS
101Commands for the
102.Nm
103shell (these commands can be abbreviated):
104.Pp
105.Bl -tag -width finger
106.It Ar w
107Invoke a UNIX
108.Xr w 1
109command (extended command).
110.It Ar finger
111Invoke a UNIX
112.Xr finger 1
113command.  When you type
114.Ar finger
115, you will be prompted for optional arguments (extended command).
116.It Ar whoami
117Invoke a UNIX
118.Xr whoami 1
119command (extended command).
120.It Ar help
121Print the
122.Nm
123banner, and list of valid commands.
124.It Ar cls
125Clear the screen and print the
126.Nm
127banner.
128.It Ar date
129Invoke the UNIX
130.Xr date 1
131command (extended command).
132.It Ar unlock
133Unlock the terminal; prompts for unlock password.
134.El
135.Sh FILES
136.Bl -tag -width _BINPATH_ -compact
137.It Pa _BINPATH_
138Gone binary application
139.El
140.Sh MINUTIAE
141*
142.Nm
143will only run if the user is logged into a valid tty.
144.br
145* Invoking a \fBSIGINT\fR, a \fBSIGSTP\fR, or a \fBSIGQUIT\fR
146will cause
147.Nm
148to print the time remaining before the user is logged out.
149.Sh BUGS
150No known bugs, but I welcome any bug reports or comments to
151<marcus@marcuscom.com>
152.Sh AUTHOR
153Joe Marcus Clarke <marcus@marcuscom.com>
154.Sh ACKNOWLEDGEMENTS
155Dr. Burt "THE Doctor" Rosenberg, for motivating, for being a good
156friend, and for having a great jump shot.
157.br
158Alexandra Loubeau, for using the damn thing.
159.br
160Jason Glick for giving me the quota to do most of the initial work...and
161for Joe Satriani.
162.br
163Craig Kolthoff for installing it on jaguar....finally; and for giving me
164a monster quota for FreeBSD.
165.br
166Blake Winton <bwinton@iname.com>, for contributing the patch for indefinite
167terminal locking.
168