source: trunk/athena/bin/session/session_gate.1 @ 3889

Revision 3889, 2.5 KB checked in by probe, 34 years ago (diff)
Document the -logout option [mar - xdm project]
Line 
1.\"     $Source: /afs/dev.mit.edu/source/repository/athena/bin/session/session_gate.1,v $
2.\"     $Header: /afs/dev.mit.edu/source/repository/athena/bin/session/session_gate.1,v 1.2 1990-11-30 17:58:32 probe Exp $
3.\"     $Author: probe $
4.\"
5.TH SESSION_GATE 1 "30 November 1990"
6.ds ]W MIT Project Athena
7.SH NAME
8session_gate, end_session \- control lifetime of a session
9
10.SH SYNOPSIS
11.nf
12session_gate [-logout]
13end_session [ -force | -f ]
14.fi
15.SH DESCRIPTION
16
17\fISession_gate\fR is a process that waits for a user's session to
18end, and then optionally executes their logout script.  Normally,
19\fIsession_gate\fR appears at or near the end of a session file used
20by \fIxlogin\fR(1).  When used in this fashion, \fIsession_gate\fR
21should not be run in the background.  If invoked with the
22\fI-logout\fR option, it will run a \fI/bin/csh\fR on the file
23\fI\&.logout\fR in the directory it was started in.
24
25\fIEnd_session\fR is a command that attempts to send a hangup signal to
26each \fIsession_gate\fR process that is running.  Normally, the user
27invokes \fIend_session\fR to indicate that the current session is to be
28terminated.  The \fIlogout\fR can be aliased (in the shell) to invoke
29\fIend_session\fR, for example.
30
31\fIEnd_session\fR determines the process id of each \fIsession_gate\fR
32process by reading the file /tmp/session_gate_pid.\fIuid\fR, where
33\fIuid\fR is the user's uid number.  If the \fI-force\fR or \fI-f\fR option
34is specified, then a combination of \fIps\fR(1) and \fIawk\fR(1) is used
35for determining the process id's.
36
37Note that at Athena, the environment variable \fBXSESSION\fR is
38usually set to the process ID of the \fIsession_gate\fR so that logout
39is just aliased to 'kill -HUP $XSESSION' and \fIend_session\fR is now
40obsolete.
41
42.SH DIAGNOSTICS
43
44\fISession_gate\fR always exits with status 0.
45
46\fIEnd_session\fR will exit with one of the following status values:
47.TP 5
480
49No error encountered.
50.TP 5
511
52Bad arguments.
53.TP 5
542
55No \fIsession_gate\fR processes found (\fI-force\fR or \fI-f\fR option).
56.TP 5
573
58The file /tmp/session_gate_pid.\fIuid\fR does not exist or is not readable.
59.TP 5
604
61The file /tmp/session_gate_pid.\fIuid\fR has been modified.
62.PP
63
64.SH FILES
65/tmp/session_gate_pid.\fIuid\fR
66
67.SH "SEE ALSO"
68\fIxlogin\fR(1)
69
70.SH AUTHOR
71.nf
72David J Flanagan, John E Elsbree
73MIT Project Athena
74Copyright 1989, Massachusetts Institute of Technology
75.fi
76
77.SH BUGS
78The \fI-force\fR (\fI-f\fR) option is, admittedly, a kludge.  It is very
79dependent on the format of the output produced by \fIps\fR(1).
Note: See TracBrowser for help on using the repository browser.