source: trunk/athena/etc/xdm/xlogin/xlogin.8 @ 12350

Revision 12350, 5.1 KB checked in by ghudson, 26 years ago (diff)
Some RCS ID cleanup: delete $Log$ and replace other RCS keywords with $Id$.
Line 
1.\" $Id: xlogin.8,v 1.9 1999-01-22 23:16:26 ghudson Exp $
2.TH XLOGIN 8 "25 May 1994"
3.ds ]W MIT Project Athena
4.SH NAME
5xlogin \- open X login window with pre-login options and screen saver
6.SH SYNOPSIS
7.nf
8xlogin -config \fIdirectory\fR [X-options]
9.fi
10.SH DESCRIPTION
11\fIXlogin\fR is used to login users on the display head of a
12workstation.  It handles a number of login options, applications that
13can be run without logging in, and a screensaver mode.  It also
14handles reactivating the workstation while it is or should be idle.
15.PP
16If the user requests a console login, \fIXlogin\fR will exit with
17status 3.  On successful login, it will exec the session script.  On
18fatal errors or non recoverable login failures, it will exit.
19.SH OPTIONS
20The following command line options are available in addition to the
21usual X toolkit options and the resource file:
22.TP
23.B -config \fIdirectory\fR
24Names the directory the resource files are found in.  It will first
25load \fBXlogin\fR from that directory, then if \fBXlogin.local\fR
26exists, resources in this file will override those in the first file.
27.TP
28.B -save \fIseconds\fR
29Amount of idle time before the screen saver kicks in
30.TP
31.B -move \fIseconds\fR
32How often the message on the screen saver moves around the screen
33.TP
34.B -blink \fImilliseconds\fR
35How long to wait between show successive frames while blinking the
36owl's eyes.
37.TP
38.B -blankall
39Turns on blanking of all screens on a multi-screened X server.
40.TP
41.B -noblankall
42Turns off blanking of all screens on a multi-screened X server.
43.TP
44.B -reactivate \fIscript\fR
45Name of script to run to reactivate the workstation. \fIXlogin\fR runs
46this script once when it starts up, prior to prompting the user to log
47in and regardless of whether anyone is logged in, with the
48\fB-prelogin\fR option. It is also runs the script periodically later
49only if no one is logged in, occasionally with the \fB-detach\fR
50option.
51.TP
52.B -idle \fIseconds\fR
53How long to let the machine lie idle before attempting to reactivate it.
54.TP
55.B -wait
56How long to wait for a reactivation to finish before giving up and
57continuing.
58.TP
59.B -restart
60How long to spend in screensaver state before exiting so that the X
61server will be restarted.
62.TP
63.B -tty
64Name of the tty to log the user in on.
65.TP
66.B -session
67Name of the global session script to run when logging the user in.
68.TP
69.B -motdfile
70Name of the file to find the global message of the day to display in
71the idle screen.
72.TP
73.B -motd2file
74Name of the second motd file.  This is for a local message of the day
75to be appended to the global motd file.
76.SH RESOURCES
77There are keyboard accelerators for the menu items.  The six
78things on the "Login Options" menu may be selected using keys F1
79through F6, respectively.  The first nine things on the "Other
80Options" menu may be selected using keys SHIFT-F1 through SHIFT-F9.
81The "Page Up" or "Prev Screen" key will display the console window,
82while the "Page Down" or "Next Screen" key will remove it.  CONTROL-P
83will shutdown the window system.
84.PP
85The following resources correspond to the options named above:
86.TP
87.B *saveTimeout
88Amount of idle time before the screen saver kicks in
89.TP
90.B *moveTimeout
91How often the message on the screen saver moves around the screen
92.TP
93.B *blinkTimeout
94How long to wait between show successive frames while blinking the
95owl's eyes.
96.TP
97.B *blankAll
98Boolean value that determines whether to blank all screens on a
99multi-screened X server.  Default is "True".
100.TP
101.B *reactivateProg
102Name of script to run to reactivate the workstation. Same as
103\fB-reactivate\fR above.
104.TP
105.B *reactivateTimeout
106How long to let the machine lie idle before attempting to reactivate it.
107.TP
108.B *activateTimeout
109How long to wait for a reactivation to finish before giving up and
110continuing.
111.TP
112.B *restartTimeout
113How long to spend in screensaver state before exiting so that the X
114server will be restarted.
115.TP
116.B *loginTty
117Name of the tty to log the user in on.
118.TP
119.B *sessionScript
120Name of the global session script to run when logging the user in.
121.PP
122The following resources may also be specified (typically in Xlogin.local):
123.TP
124.B *loginName
125Name to be displayed in Username field when logging in.  This is provided
126for private workstation owners.  Ctrl-U in the Username field may be used
127to erase the name so that others may log in.
128.TP
129.B *showMotd
130Boolean value that determines whether or not to display global
131Message-Of-The-Day in xlogin idle screen.  Default is "True".
132.TP
133.B *motdFile
134Name of the file in which to find the global message of the day for
135displaying in the idle screen, of the showMotd resource is True.  This
136defaults to /afs/athena.mit.edu/system/config/motd/login.74.
137.TP
138.B *motd2File
139Name of the file in which to find a local message of the day to append
140to the global one for the idle screen.  This defaults to an empty
141string, in which case it is ignored.
142.SH "SEE ALSO"
143dm(8), console(8), reactivate(8), access(5)
144.SH "BUGS"
145The login window sometimes looks strange when the moon is full.
146.SH AUTHORS
147Mark Rosenstein, Chris VanHaren, Craig Fields of MIT Project Athena
148.br
149Copyright (c) 1990, 1992, 1994 Massachusetts Institute of Technology
Note: See TracBrowser for help on using the repository browser.