| 1 |
.TH autolog.conf 5 "Configuration Files" "Linux" \" -*- nroff -*- |
| 2 |
.SH NAME |
| 3 |
autolog.conf \- Configuration file for the autolog command |
| 4 |
.SH DESCRIPTION |
| 5 |
The configuration file consists of multiple lines, each of which describes |
| 6 |
a class of processes subject (or not subject) to a certain auto logout |
| 7 |
procedure. A line consists of any number of switches. Value switches are |
| 8 |
of the form: "name=value". Boolean switches are of the form: "name" or |
| 9 |
"noname". |
| 10 |
.PP |
| 11 |
Using these switches, you can define a username, a group, and a tty line. |
| 12 |
These descriptions can contain wildcard characters (regular expressions). |
| 13 |
You can also define an idle time, a grace period and a few other options. |
| 14 |
When reading the configuration file, the program creates a record for each |
| 15 |
configuration line. A value is assigned to each variable in the record |
| 16 |
regardless of whether or not you specify one explicitly. Values for |
| 17 |
missing variables are provided by defaults which are compiled in and can |
| 18 |
be modified from the command line. |
| 19 |
.PP |
| 20 |
If no entries are found matching a given process, that process will be |
| 21 |
spared from an untimely demise. Therefore, it is a good idea to always |
| 22 |
have a "cleanup" line at the end of the configuration file to catch |
| 23 |
anything that might have been missed by the more explicit definitions. |
| 24 |
Since the default name, group, and line are all ".+", a simple line like: |
| 25 |
|
| 26 |
idle=30 |
| 27 |
|
| 28 |
will do. Actually, any one switch can be specified on the line and all the |
| 29 |
others will get the default values. |
| 30 |
.PP |
| 31 |
If no configuration file is found, the program will create a single |
| 32 |
entry which has all values set from the defaults. This entry will match |
| 33 |
any process on any port (name=.+ line=.+ group=.+). Therefore, the default |
| 34 |
action is to kill all processes. |
| 35 |
.SH ENTRIES |
| 36 |
.TP |
| 37 |
.B name= |
| 38 |
A regular expression specifying which username(s) to match. |
| 39 |
.TP |
| 40 |
.B group= |
| 41 |
A regular expression specifying which group(s) to match. |
| 42 |
.TP |
| 43 |
.B line= |
| 44 |
A regular expression specifying which tty line(s) to match. |
| 45 |
Omit the "/dev/" part of the special name. |
| 46 |
.TP |
| 47 |
.B idle= |
| 48 |
An integer specifying the number of \-\-minutes\-\- of idle |
| 49 |
(or connect) time to allow before beginning automatic logoff. |
| 50 |
An idle time of 0 exempts the process from automatic logoff. |
| 51 |
.TP |
| 52 |
.B grace= |
| 53 |
An integer specifying the number of \-\-seconds\-\- from the initial |
| 54 |
warning to killing the process. |
| 55 |
.TP |
| 56 |
.B ban= |
| 57 |
An integer specifying the number of \-\-minutes\-\- from killing the process |
| 58 |
to the moment, the user may login again. (after exceeding his session). |
| 59 |
|
| 60 |
.TP |
| 61 |
.B hard |
| 62 |
A boolean value indicating total connect time will be |
| 63 |
considered rather than idle time. |
| 64 |
.TP |
| 65 |
.B mail |
| 66 |
A boolean value indicating that mail will be sent to the |
| 67 |
user explaining that he was killed. |
| 68 |
.TP |
| 69 |
.B clear |
| 70 |
A boolean value indicating that the screen will be cleared |
| 71 |
before a warning message is sent. |
| 72 |
.TP |
| 73 |
.B warn |
| 74 |
A boolean value indicating that a warning message will be |
| 75 |
sent at the beginning of the "grace" period. |
| 76 |
.TP |
| 77 |
.B log |
| 78 |
A boolean value indicating that activities will be logged |
| 79 |
to the logfile (if it exists). |
| 80 |
|
| 81 |
.SH FURTHER ENTRIES |
| 82 |
.PP |
| 83 |
There is another group of entries, which allows one to set some |
| 84 |
general options. Each of them takes a whole line. |
| 85 |
Don't mix them with the other entries from before. |
| 86 |
.TP |
| 87 |
.B nolostkill |
| 88 |
A boolean value indicating whether lost processes should be killed. |
| 89 |
If there is a process with uid between 500 and 60000 and the owner |
| 90 |
is not logged in, it is assumed as lost and will be killed. |
| 91 |
|
| 92 |
.TP |
| 93 |
.B ps=command |
| 94 |
on some strange or old systems the ps-command has different parameters. |
| 95 |
This makes it possible to set a completely different command. It is only |
| 96 |
important, that this command delivers one heading line and then lines |
| 97 |
with usernames and process-ids (pid). e.g.: ps=ps aux |
| 98 |
|
| 99 |
.SH EXAMPLE |
| 100 |
name=root line=tty[1-7] idle=0 |
| 101 |
name=guest idle=5 grace=60 nomail hard warn |
| 102 |
group=lynx-.* idle=10 grace=60 clear |
| 103 |
idle=60 grace=30 |
| 104 |
|
| 105 |
.SH AUTHOR |
| 106 |
Kyle Bateman <[email protected]> (autolog 0.35), |
| 107 |
.PD 0 |
| 108 |
.TP |
| 109 |
James Dingwall <[email protected]> |
| 110 |
.TP |
| 111 |
(autolog 0.42.2) |
| 112 |
.PD |
| 113 |
.PP |
| 114 |
This manual page was modified for \fBDebian\fP by Paul Telford <[email protected]> |