1
<!-- generated from ../../kdm/config.def - DO NOT EDIT! -->
3
<chapter id="kdm-files">
4
<title>The Files &kdm; Uses for Configuration</title>
6
<para>This chapter documents the files that control &kdm;'s behavior.
7
Some of this can be also controlled from the &systemsettings; module, but
11
<title>&kdmrc; - The &kdm; master configuration file</title>
13
<para>The basic format of the file is <quote>INI-like</quote>.
14
Options are key/value pairs, placed in sections.
15
Everything in the file is case sensitive.
16
Syntactic errors and unrecognized key/section identifiers cause &kdm; to
17
issue non-fatal error messages.</para>
19
<para>Lines beginning with <literal>#</literal> are comments; empty lines
20
are ignored as well.</para>
22
<para>Sections are denoted by
23
<literal>[</literal><replaceable>Name of Section</replaceable><literal>]</literal>.
26
<para>You can configure every X-display individually.</para>
27
<para>Every display has a display name, which consists of a host name
28
(which is empty for local displays specified in <option>StaticServers</option>
29
or <option>ReserveServers</option>), a colon, and a display number.
30
Additionally, a display belongs to a
31
display class (which can be ignored in most cases).</para>
33
<para>Sections with display-specific settings have the formal syntax
34
<literal>[X-</literal> <replaceable>host</replaceable> [ <literal>:</literal> <replaceable>number</replaceable> [ <literal>_</literal> <replaceable>class</replaceable> ] ] <literal>-</literal> <replaceable>sub-section</replaceable> <literal>]</literal>
36
<para>All sections with the same <replaceable>sub-section</replaceable>
37
make up a section class.</para>
39
<para>You can use the wildcard <literal>*</literal> (match any) for
40
<replaceable>host</replaceable>, <replaceable>number</replaceable>,
41
and <replaceable>class</replaceable>. You may omit trailing components;
42
they are assumed to be <literal>*</literal> then. The host part may be a
43
domain specification like <replaceable>.inf.tu-dresden.de</replaceable>
44
or the wildcard <literal>+</literal> (match non-empty).</para>
46
<para>From which section a setting is actually taken is determined by
51
<para>An exact match takes precedence over a partial match (for the
52
host part), which in turn takes precedence over a wildcard
53
(<literal>+</literal> taking precendence over <literal>*</literal>).</para>
57
<para>Precedence decreases from left to right for equally exact matches.</para>
63
Example: display name <quote>myhost.foo:0</quote>, class <quote>dpy</quote>
67
<para>[X-myhost.foo:0_dpy] precedes</para>
70
<para>[X-myhost.foo:0_*] (same as [X-myhost.foo:0]) precedes</para>
73
<para>[X-myhost.foo:*_dpy] precedes</para>
76
<para>[X-myhost.foo:*_*] (same as [X-myhost.foo]) precedes</para>
79
<para>[X-.foo:*_*] (same as [X-.foo]) precedes</para>
82
<para>[X-+:0_dpy] precedes</para>
85
<para>[X-*:0_dpy] precedes</para>
88
<para>[X-*:0_*] (same as [X-*:0]) precedes</para>
91
<para>[X-*:*_*] (same as [X-*]).</para>
94
<para>These sections do <emphasis>not</emphasis> match this display:</para>
95
<para>[X-hishost], [X-myhost.foo:0_dec], [X-*:1], [X-:*]</para>
103
<para>Common sections are [X-*] (all displays), [X-:*] (all local displays)
104
and [X-:0] (the first local display).</para>
106
<para>The format for all keys is
107
<userinput><option><replaceable>key</replaceable></option> <literal>=</literal> <parameter>value</parameter></userinput>.
108
Keys are only valid in the section class they are defined for.
109
Some keys do not apply to particular displays, in which case they are ignored.
112
<para>If a setting is not found in any matching section, the default
115
<para>Special characters need to be backslash-escaped (leading and trailing
116
spaces (<literal>\s</literal>), tab (<literal>\t</literal>), linefeed
117
(<literal>\n</literal>), carriage return (<literal>\r</literal>) and the
118
backslash itself (<literal>\\</literal>)).</para>
119
<para>In lists, fields are separated with commas without whitespace in between.
121
<para>Some command strings are subject to simplified sh-style word splitting:
122
single quotes (<literal>'</literal>) and double quotes (<literal>"</literal>)
123
have the usual meaning; the backslash quotes everything (not only special
124
characters). Note that the backslashes need to be doubled because of the
125
two levels of quoting.</para>
127
<note><para>A pristine &kdmrc; is very thoroughly commented.
128
All comments will be lost if you change this file with the
129
&systemsettings; frontend.</para></note>
132
<sect2 id="kdmrc-general">
133
<title>The [General] section of &kdmrc;</title>
136
This section contains global options that do not fit into any specific section.
142
<term id="option-configversion"><option>ConfigVersion</option></term>
145
This option exists solely for the purpose of clean automatic upgrades.
146
<emphasis>Do not</emphasis> change it, you may interfere with future
147
upgrades and this could result in &kdm; failing to run.
153
<term id="option-staticservers"><option>StaticServers</option></term>
156
List of displays (&X-Server;s) permanently managed by &kdm;. Displays with a
157
hostname are foreign displays which are expected to be already running,
158
the others are local displays for which &kdm; starts an own &X-Server;;
159
see <option>ServerCmd</option>. Each display may belong to a display class;
160
append it to the display name separated by an underscore.
161
See <xref linkend="kdmrc-xservers"/> for the details.
163
<para>The default is <quote>:0</quote>.</para>
168
<term id="option-reserveservers"><option>ReserveServers</option></term>
171
List of on-demand displays. See <option>StaticServers</option> for syntax.
173
<para>Empty by default.</para>
178
<term id="option-servervts"><option>ServerVTs</option></term>
181
List of Virtual Terminals to allocate to &X-Server;s. For negative numbers the
182
absolute value is used, and the <acronym>VT</acronym> will be allocated only
183
if the kernel says it is free. If &kdm; exhausts this list, it will allocate
184
free <acronym>VT</acronym>s greater than the absolute value of the last entry
186
Currently Linux only.
188
<para>Empty by default.</para>
193
<term id="option-consolettys"><option>ConsoleTTYs</option></term>
196
This option is for operating systems (<acronym>OS</acronym>s) with support
197
for virtual terminals (<acronym>VT</acronym>s), by both &kdm; and the
198
<acronym>OS</acronym>s itself.
199
Currently this applies only to Linux.
201
When &kdm; switches to console mode, it starts monitoring all
202
<acronym>TTY</acronym> lines listed here (without the leading
203
<literal>/dev/</literal>).
204
If none of them is active for some time, &kdm; switches back to the X login.
206
<para>Empty by default.</para>
211
<term id="option-pidfile"><option>PidFile</option></term>
214
The filename specified will be created to contain an ASCII representation
215
of the process ID of the main &kdm; process; the PID will not be stored
216
if the filename is empty.
218
<para>Empty by default.</para>
223
<term id="option-lockpidfile"><option>LockPidFile</option></term>
226
This option controls whether &kdm; uses file locking to keep multiple
227
display managers from running onto each other.
229
<para>The default is <quote>true</quote>.</para>
234
<term id="option-authdir"><option>AuthDir</option></term>
237
This names a directory under which &kdm; stores &X-Server; authorization
238
files while initializing the session. &kdm; expects the system to clean up
239
this directory from stale files on reboot.
241
The authorization file to be used for a particular display can be
242
specified with the <option>AuthFile</option> option in [X-*-Core].
244
<para>The default is <quote>/var/run/xauth</quote>.</para>
249
<term id="option-autorescan"><option>AutoRescan</option></term>
252
This boolean controls whether &kdm; automatically re-reads its
253
configuration files if it finds them to have changed.
255
<para>The default is <quote>true</quote>.</para>
260
<term id="option-exportlist"><option>ExportList</option></term>
263
Additional environment variables &kdm; should pass on to all programs it runs.
264
<envar>LD_LIBRARY_PATH</envar> and <envar>XCURSOR_THEME</envar> are good candidates;
265
otherwise, it should not be necessary very often.
267
<para>Empty by default.</para>
272
<term id="option-randomfile"><option>RandomFile</option></term>
275
If the system has no native entropy source like /dev/urandom (see
276
<option>RandomDevice</option>) and no entropy daemon like EGD (see
277
<option>PrngdSocket</option> and <option>PrngdPort</option>) is running,
278
&kdm; will fall back to its own pseudo-random number generator
279
that will, among other things, successively checksum parts of this file
280
(which, obviously, should change frequently).
282
This option does not exist on Linux and various BSDs.
284
<para>The default is <quote>/dev/mem</quote>.</para>
289
<term id="option-prngdsocket"><option>PrngdSocket</option></term>
292
If the system has no native entropy source like /dev/urandom (see
293
<option>RandomDevice</option>), read random data from a Pseudo-Random
294
Number Generator Daemon,
295
like EGD (http://egd.sourceforge.net) via this UNIX domain socket.
297
This option does not exist on Linux and various BSDs.
299
<para>Empty by default.</para>
304
<term id="option-prngdport"><option>PrngdPort</option></term>
307
Same as <option>PrngdSocket</option>, only use a TCP socket on localhost.
313
<term id="option-randomdevice"><option>RandomDevice</option></term>
316
The path to a character device which &kdm; should read random data from.
317
Empty means to use the system's preferred entropy device if there is one.
319
This option does not exist on OpenBSD, as it uses the arc4_random
322
<para>Empty by default.</para>
327
<term id="option-fifodir"><option>FifoDir</option></term>
330
The directory in which the command sockets should
331
be created; make it empty to disable them.
333
<para>The default is <quote>/var/run/xdmctl</quote>.</para>
338
<term id="option-fifogroup"><option>FifoGroup</option></term>
341
The group to which the global command socket should belong;
342
can be either a name or a numerical ID.
348
<term id="option-greeteruid"><option>GreeterUID</option></term>
351
The user the greeter should run as. Empty results in <systemitem class="username">root</systemitem>.
352
Consider the impact on <option>LogSource</option> when setting it.
354
<para>Empty by default.</para>
359
<term id="option-datadir"><option>DataDir</option></term>
362
The directory in which &kdm; should store persistent working data; such data
363
is, for example, the previous user that logged in on a particular display.
365
<para>The default is <quote>/var/lib/kdm</quote>.</para>
370
<term id="option-dmrcdir"><option>DmrcDir</option></term>
373
The directory in which &kdm; should store users' <filename>.dmrc</filename> files. This is only
374
needed if the home directories are not readable before actually logging in
377
<para>Empty by default.</para>
385
<sect2 id="kdmrc-xdmcp">
386
<title>The [Xdmcp] section of &kdmrc;</title>
389
This section contains options that control &kdm;'s handling of
396
<term id="option-enable"><option>Enable</option></term>
399
Whether &kdm; should listen to incoming &XDMCP; requests.
401
<para>The default is <quote>true</quote>.</para>
406
<term id="option-port"><option>Port</option></term>
409
This indicates the UDP port number which &kdm; uses to listen for incoming
410
&XDMCP; requests. Unless you need to debug the system, leave this with its
413
<para>The default is <quote>177</quote>.</para>
418
<term id="option-keyfile"><option>KeyFile</option></term>
421
XDM-AUTHENTICATION-1 style &XDMCP; authentication requires a private
422
key to be shared between &kdm; and the terminal. This option specifies
423
the file containing those values. Each entry in the file consists of a
424
display name and the shared key.
426
<para>Empty by default.</para>
431
<term id="option-xaccess"><option>Xaccess</option></term>
434
To prevent unauthorized &XDMCP; service and to allow forwarding of &XDMCP;
435
IndirectQuery requests, this file contains a database of hostnames which
436
are either allowed direct access to this machine, or have a list of hosts
437
to which queries should be forwarded to. The format of this file is
438
described in <xref linkend="kdmrc-xaccess"/>.
440
<para>The default is <quote>${<envar>kde_confdir</envar>}/kdm/Xaccess</quote>.</para>
445
<term id="option-choicetimeout"><option>ChoiceTimeout</option></term>
448
Number of seconds to wait for the display to respond after the user has
449
selected a host from the chooser. If the display sends an &XDMCP;
450
IndirectQuery within this time, the request is forwarded to the chosen
451
host; otherwise, it is assumed to be from a new session and the chooser
454
<para>The default is <quote>15</quote>.</para>
459
<term id="option-removedomainname"><option>RemoveDomainname</option></term>
462
When computing the display name for &XDMCP; clients, the name resolver will
463
typically create a fully qualified host name for the terminal. As this is
464
sometimes confusing, &kdm; will remove the domain name portion of the host
465
name if it is the same as the domain name of the local host when this option
468
<para>The default is <quote>true</quote>.</para>
473
<term id="option-sourceaddress"><option>SourceAddress</option></term>
476
Use the numeric IP address of the incoming connection on multihomed hosts
477
instead of the host name. This is to avoid trying to connect on the wrong
478
interface which might be down at this time.
480
<para>The default is <quote>false</quote>.</para>
485
<term id="option-willing"><option>Willing</option></term>
488
This specifies a program which is run (as
489
<systemitem class="username">root</systemitem>) when an &XDMCP;
490
DirectQuery or BroadcastQuery is received and this host is configured
491
to offer &XDMCP; display management. The output of this program may be
492
displayed in a chooser window. If no program is specified, the string
493
<quote>Willing to manage</quote> is sent.
495
<para>Empty by default.</para>
503
<sect2 id="kdmrc-shutdown">
504
<title>The [Shutdown] section of &kdmrc;</title>
507
This section contains global options concerning system shutdown.
513
<term id="option-haltcmd"><option>HaltCmd</option></term>
516
The command (subject to word splitting) to run to halt/poweroff the system.
518
The default is something reasonable for the system on which &kdm; was built, like
519
<command>/sbin/shutdown <option>-h</option> <parameter>now</parameter></command>.
525
<term id="option-rebootcmd"><option>RebootCmd</option></term>
528
The command (subject to word splitting) to run to reboot the system.
530
The default is something reasonable for the system &kdm; on which was built, like
531
<command>/sbin/shutdown <option>-r</option> <parameter>now</parameter></command>.
537
<term id="option-allowfifo"><option>AllowFifo</option></term>
540
Whether it is allowed to shut down the system via the global command socket.
542
<para>The default is <quote>false</quote>.</para>
547
<term id="option-allowfifonow"><option>AllowFifoNow</option></term>
550
Whether it is allowed to abort active sessions when shutting down the
551
system via the global command socket.
553
This will have no effect unless <option>AllowFifo</option> is enabled.
555
<para>The default is <quote>true</quote>.</para>
560
<term id="option-bootmanager"><option>BootManager</option></term>
563
The boot manager &kdm; should use for offering boot options in the
568
<term><parameter>None</parameter></term>
569
<listitem><para>no boot manager</para></listitem>
572
<term><parameter>Grub</parameter></term>
573
<listitem><para>Grub boot manager</para></listitem>
576
<term><parameter>Lilo</parameter></term>
577
<listitem><para>Lilo boot manager (Linux on i386 & x86-64 only)</para></listitem>
580
<para>The default is <quote>None</quote>.</para>
588
<sect2 id="kdmrc-core">
589
<title>The [X-*-Core] section class of &kdmrc;</title>
592
This section class contains options concerning the configuration
593
of the &kdm; backend (core).
599
<term id="option-opendelay"><option>OpenDelay</option></term>
602
See <option>OpenRepeat</option>.
604
<para>The default is <quote>15</quote>.</para>
609
<term id="option-opentimeout"><option>OpenTimeout</option></term>
612
See <option>OpenRepeat</option>.
614
<para>The default is <quote>120</quote>.</para>
619
<term id="option-openrepeat"><option>OpenRepeat</option></term>
622
These options control the behavior of &kdm; when attempting to open a
623
connection to an &X-Server;. <option>OpenDelay</option> is the length
624
of the pause (in seconds) between successive attempts,
625
<option>OpenRepeat</option> is the number of attempts to make and
626
<option>OpenTimeout</option> is the amount of time to spend on a
627
connection attempt. After <option>OpenRepeat</option> attempts have been
628
made, or if <option>OpenTimeout</option> seconds elapse in any particular
629
connection attempt, the start attempt is considered failed.
631
<para>The default is <quote>5</quote>.</para>
636
<term id="option-startattempts"><option>StartAttempts</option></term>
639
How many times &kdm; should attempt to start a <literal>foreign</literal>
640
display listed in <option>StaticServers</option> before giving up
642
Local displays are attempted only once, and &XDMCP; displays are retried
643
indefinitely by the client (unless the option <option>-once</option>
644
was given to the &X-Server;).
646
<para>The default is <quote>4</quote>.</para>
651
<term id="option-serverattempts"><option>ServerAttempts</option></term>
654
How many times &kdm; should attempt to start up a local &X-Server;.
655
Starting up includes executing it and waiting for it to come up.
657
<para>The default is <quote>1</quote>.</para>
662
<term id="option-servertimeout"><option>ServerTimeout</option></term>
665
How many seconds &kdm; should wait for a local &X-Server; to come up.
667
<para>The default is <quote>30</quote>.</para>
672
<term id="option-servercmd"><option>ServerCmd</option></term>
675
The command line to start the &X-Server;, without display number and VT spec.
676
Note that with some &X-Server;s (in particular, OpenSolaris') it is necessary
677
to put most additional arguments into <option>ServerArgsLocal</option> and
678
<option>ServerArgsRemote</option> even if they are the same for both.
679
This string is subject to word splitting.
681
The default is something reasonable for the system on which &kdm; was built,
682
like <command>/usr/X11R6/bin/X</command>.
688
<term id="option-serverargslocal"><option>ServerArgsLocal</option></term>
691
Additional arguments for the &X-Server;s for local sessions.
692
This string is subject to word splitting.
694
<para>Empty by default.</para>
699
<term id="option-serverargsremote"><option>ServerArgsRemote</option></term>
702
Additional arguments for the &X-Server;s for remote sessions.
703
This string is subject to word splitting.
705
<para>Empty by default.</para>
710
<term id="option-servervt"><option>ServerVT</option></term>
713
The VT the &X-Server; should run on.
714
<option>ServerVTs</option> should be used instead of this option.
715
Leave it zero to let &kdm; assign a <acronym>VT</acronym> automatically.
716
Set it to <literal>-1</literal> to avoid assigning a <acronym>VT</acronym>
717
alltogether - this is required for setups with multiple physical consoles.
718
Currently Linux only.
724
<term id="option-servertty"><option>ServerTTY</option></term>
727
This option is for <acronym>OS</acronym>s without support for
728
<acronym>VT</acronym>s, either by &kdm; or the <acronym>OS</acronym> itself.
729
Currently this applies to all <acronym>OS</acronym>s but Linux.
731
When &kdm; switches to console mode, it starts monitoring this
732
<acronym>TTY</acronym> line (specified without the leading
733
<literal>/dev/</literal>) for activity. If the line is not used for some time,
734
&kdm; switches back to the X login.
736
<para>Empty by default.</para>
741
<term id="option-serveruid"><option>ServerUID</option></term>
744
The user the &X-Server; should run as. Empty results in <systemitem class="username">root</systemitem>.
746
<para>Empty by default.</para>
751
<term id="option-pinginterval"><option>PingInterval</option></term>
754
See <option>PingTimeout</option>.
756
<para>The default is <quote>5</quote>.</para>
761
<term id="option-pingtimeout"><option>PingTimeout</option></term>
764
To discover when <emphasis>remote</emphasis> displays disappear, &kdm;
765
regularly pings them.
766
<option>PingInterval</option> specifies the time (in minutes) between the
767
pings and <option>PingTimeout</option> specifies the maximum amount of
768
time (in minutes) to wait for the terminal to respond to the request. If
769
the terminal does not respond, the session is declared dead and terminated.
771
If you frequently use X terminals which can become isolated from
772
the managing host, you may wish to increase the timeout. The only worry
773
is that sessions will continue to exist after the terminal has been
774
accidentally disabled.
776
<para>The default is <quote>5</quote>.</para>
781
<term id="option-terminateserver"><option>TerminateServer</option></term>
784
Whether &kdm; should restart the local &X-Server; after session exit instead
785
of resetting it. Use this if the &X-Server; leaks memory or crashes the system
788
<para>The default is <quote>false</quote>.</para>
793
<term id="option-authorize"><option>Authorize</option></term>
796
Controls whether &kdm; generates and uses authorization for
797
<emphasis>local</emphasis> &X-Server; connections.
798
For &XDMCP; displays the authorization requested by the display is used;
799
foreign non-&XDMCP; displays do not support authorization at all.
801
<para>The default is <quote>true</quote>.</para>
806
<term id="option-authnames"><option>AuthNames</option></term>
809
If <option>Authorize</option> is true, use the authorization mechanisms
810
listed herein. The MIT-MAGIC-COOKIE-1 authorization is always available;
811
XDM-AUTHORIZATION-1, SUN-DES-1 and MIT-KERBEROS-5 might be available as well,
812
depending on the build configuration.
814
<para>The default is <quote>DEF_AUTH_NAME</quote>.</para>
819
<term id="option-resetforauth"><option>ResetForAuth</option></term>
822
Some <emphasis>old</emphasis> &X-Server;s re-read the authorization file
823
at &X-Server; reset time, instead of when checking the initial connection.
824
As &kdm; generates the authorization information just before connecting to
825
the display, an old &X-Server; would not get up-to-date authorization
826
information. This option causes &kdm; to send SIGHUP to the &X-Server;
827
after setting up the file, causing an additional &X-Server; reset to occur,
828
during which time the new authorization information will be read.
830
<para>The default is <quote>false</quote>.</para>
835
<term id="option-authfile"><option>AuthFile</option></term>
838
This file is used to communicate the authorization data from &kdm; to
839
the &X-Server;, using the <option>-auth</option> &X-Server; command line
840
option. It should be kept in a directory which is not world-writable
841
as it could easily be removed, disabling the authorization mechanism in
842
the &X-Server;. If not specified, a random name is generated from
843
<option>AuthDir</option> and the name of the display.
845
<para>Empty by default.</para>
850
<term id="option-resources"><option>Resources</option></term>
853
This option specifies the name of the file to be loaded by
854
<command>xrdb</command> as the resource database onto the root window
855
of screen 0 of the display. KDE programs generally do not use
856
X-resources, so this option is only needed if the <option>Setup</option>
857
program needs some X-resources.
859
<para>Empty by default.</para>
864
<term id="option-xrdb"><option>Xrdb</option></term>
867
The <command>xrdb</command> program to use to read the X-resources file
868
specified in <option>Recources</option>.
869
The command is subject to word splitting.
871
<para>The default is <quote>${<envar>x_bindir</envar>}/xrdb</quote>.</para>
876
<term id="option-setup"><option>Setup</option></term>
879
This string is subject to word splitting.
880
It specifies a program which is run (as
881
<systemitem class="username">root</systemitem>) before offering the
882
greeter window. This may be used to change the appearance of the screen
883
around the greeter window or to put up other windows (e.g., you may want
884
to run <command>xconsole</command> here).
885
Usually, a script named <command>Xsetup</command> is used here.
886
See <xref linkend="kdmrc-xsetup"/>.
888
<para>Empty by default.</para>
893
<term id="option-startup"><option>Startup</option></term>
896
This string is subject to word splitting.
897
It specifies a program which is run (as
898
<systemitem class="username">root</systemitem>) after the user
899
authentication process succeeds.
900
Usually, a script named <command>Xstartup</command> is used here.
901
See <xref linkend="kdmrc-xstartup"/>.
903
<para>Empty by default.</para>
908
<term id="option-reset"><option>Reset</option></term>
911
This string is subject to word splitting.
912
It specifies a program which is run (as
913
<systemitem class="username">root</systemitem>) after the session
915
Usually, a script named <command>Xreset</command> is used here.
916
See <xref linkend="kdmrc-xreset"/>.
918
<para>Empty by default.</para>
923
<term id="option-session"><option>Session</option></term>
926
This string is subject to word splitting.
927
It specifies the session program to be executed (as the user owning
929
Usually, a script named <command>Xsession</command> is used here.
930
See <xref linkend="kdmrc-xsession"/>.
932
<para>The default is <quote>${<envar>x_bindir</envar>}/xterm -ls -T</quote>.</para>
937
<term id="option-failsafeclient"><option>FailsafeClient</option></term>
940
If the <option>Session</option> program fails to execute, &kdm; will
941
fall back to this program. This program is executed with no arguments,
942
but executes using the same environment variables as the session would
943
have had (see <xref linkend="kdmrc-xsession"/>).
945
<para>The default is <quote>${<envar>x_bindir</envar>}/xterm</quote>.</para>
950
<term id="option-userpath"><option>UserPath</option></term>
953
The <envar>PATH</envar> environment variable for
954
non-<systemitem class="username">root</systemitem> <option>Session</option>s.
956
The default depends on the system &kdm; was built on.
962
<term id="option-systempath"><option>SystemPath</option></term>
965
The <envar>PATH</envar> environment variable for all programs but
966
non-<systemitem class="username">root</systemitem>
967
<option>Session</option>s. Note that it is good practice not to include
968
<literal>.</literal> (the current directory) into this entry.
970
The default depends on the system &kdm; was built on.
976
<term id="option-systemshell"><option>SystemShell</option></term>
979
The <envar>SHELL</envar> environment variable for all programs but the
980
<option>Session</option>.
982
<para>The default is <quote>/bin/sh</quote>.</para>
987
<term id="option-userauthdir"><option>UserAuthDir</option></term>
990
When &kdm; is unable to write to the usual user authorization file
991
($<envar>HOME</envar>/.Xauthority), it creates a unique file name in this
992
directory and points the environment variable <envar>XAUTHORITY</envar>
995
<para>The default is <quote>/tmp</quote>.</para>
1000
<term id="option-forceuserauthdir"><option>ForceUserAuthDir</option></term>
1003
If true, <option>UserAuthDir</option> will be used unconditionally.
1005
<para>The default is <quote>false</quote>.</para>
1010
<term id="option-autorelogin"><option>AutoReLogin</option></term>
1013
If enabled, &kdm; will automatically restart a session after an &X-Server;
1014
crash (or if it is killed by Alt-Ctrl-BackSpace). Note that enabling this
1015
feature opens a security hole: a secured display lock can be circumvented
1016
(unless &kde;'s built-in screen locker is used).
1018
<para>The default is <quote>false</quote>.</para>
1023
<term id="option-allowrootlogin"><option>AllowRootLogin</option></term>
1026
If disabled, do not allow <systemitem class="username">root</systemitem>
1027
(and any other user with UID = 0) to log in directly.
1029
<para>The default is <quote>true</quote>.</para>
1034
<term id="option-allownullpasswd"><option>AllowNullPasswd</option></term>
1037
If disabled, only users that have passwords assigned can log in.
1039
<para>The default is <quote>true</quote>.</para>
1044
<term id="option-allowshutdown"><option>AllowShutdown</option></term>
1047
Who is allowed to shut down the system. This applies both to the
1048
greeter and to the command sockets.
1052
<term><parameter>None</parameter></term>
1053
<listitem><para>no <guilabel>Shutdown...</guilabel> menu entry is shown at all</para></listitem>
1056
<term><parameter>Root</parameter></term>
1057
<listitem><para>the <systemitem class="username">root</systemitem> password must be entered to shut down</para></listitem>
1060
<term><parameter>All</parameter></term>
1061
<listitem><para>everybody can shut down the machine</para></listitem>
1064
<para>The default is <quote>All</quote>.</para>
1069
<term id="option-allowsdforcenow"><option>AllowSdForceNow</option></term>
1072
Who is allowed to abort active sessions when shutting down.
1076
<term><parameter>None</parameter></term>
1077
<listitem><para>no forced shutdown is allowed at all</para></listitem>
1080
<term><parameter>Root</parameter></term>
1081
<listitem><para>the <systemitem class="username">root</systemitem> password must be entered to shut down forcibly</para></listitem>
1084
<term><parameter>All</parameter></term>
1085
<listitem><para>everybody can shut down the machine forcibly</para></listitem>
1088
<para>The default is <quote>All</quote>.</para>
1093
<term id="option-defaultsdmode"><option>DefaultSdMode</option></term>
1096
The default choice for the shutdown condition/timing.
1100
<term><parameter>Schedule</parameter></term>
1101
<listitem><para>shut down after all active sessions exit (possibly at once)</para></listitem>
1104
<term><parameter>TryNow</parameter></term>
1105
<listitem><para>shut down, if no active sessions are open; otherwise, do nothing</para></listitem>
1108
<term><parameter>ForceNow</parameter></term>
1109
<listitem><para>shut down unconditionally</para></listitem>
1112
<para>The default is <quote>Schedule</quote>.</para>
1117
<term id="option-scheduledsd"><option>ScheduledSd</option></term>
1120
How to offer shutdown scheduling options:
1124
<term><parameter>Never</parameter></term>
1125
<listitem><para>not at all</para></listitem>
1128
<term><parameter>Optional</parameter></term>
1129
<listitem><para>as a button in the simple shutdown dialogs</para></listitem>
1132
<term><parameter>Always</parameter></term>
1133
<listitem><para>instead of the simple shutdown dialogs</para></listitem>
1136
<para>The default is <quote>Never</quote>.</para>
1141
<term id="option-nopassenable"><option>NoPassEnable</option></term>
1144
Enable password-less logins on this display. <emphasis>Use with extreme care!</emphasis>
1146
<para>The default is <quote>false</quote>.</para>
1151
<term id="option-nopassusers"><option>NoPassUsers</option></term>
1154
The users that do not need to provide a password to log in.
1155
Items which are prefixed with <literal>@</literal> represent all users in the
1156
user group named by that item.
1157
<literal>*</literal> means all users but
1158
<systemitem class="username">root</systemitem>
1159
(and any other user with UID = 0).
1160
<emphasis>Never</emphasis> list <systemitem class="username">root</systemitem>.
1162
<para>Empty by default.</para>
1167
<term id="option-autologinenable"><option>AutoLoginEnable</option></term>
1170
Enable automatic login. <emphasis>Use with extreme care!</emphasis>
1172
<para>The default is <quote>false</quote>.</para>
1177
<term id="option-autologinagain"><option>AutoLoginAgain</option></term>
1180
If true, auto-login after logout. If false, auto-login is performed only
1181
when a display session starts up.
1183
<para>The default is <quote>false</quote>.</para>
1188
<term id="option-autologindelay"><option>AutoLoginDelay</option></term>
1191
The delay in seconds before automatic login kicks in. This is also known as
1192
<quote>Timed Login</quote>.
1198
<term id="option-autologinuser"><option>AutoLoginUser</option></term>
1201
The user to log in automatically. <emphasis>Never</emphasis> specify <systemitem class="username">root</systemitem>!
1203
<para>Empty by default.</para>
1208
<term id="option-autologinpass"><option>AutoLoginPass</option></term>
1211
The password for the user to log in automatically. This is <emphasis>not</emphasis> required
1212
unless the user is logged into a <acronym>NIS</acronym> or Kerberos domain. If you use this
1213
option, you should <command>chmod <option>600</option> <filename>kdmrc</filename></command> for obvious reasons.
1215
<para>Empty by default.</para>
1220
<term id="option-autologinlocked"><option>AutoLoginLocked</option></term>
1223
Immediately lock the automatically started session. This works only with
1226
<para>The default is <quote>false</quote>.</para>
1231
<term id="option-sessionsdirs"><option>SessionsDirs</option></term>
1234
A list of directories containing session type definitions.
1235
Ordered by falling priority.
1237
<para>The default is <quote>${<envar>kde_datadir</envar>}/kdm/sessions</quote>.</para>
1242
<term id="option-clientlogfile"><option>ClientLogFile</option></term>
1245
The file (relative to the user's home directory) to redirect the session
1248
The following character pairs are replaced by their value:
1251
<term><parameter>%d</parameter></term>
1252
<listitem><para>name of the current display</para></listitem>
1255
<term><parameter>%u</parameter></term>
1256
<listitem><para>login name of the current user</para></listitem>
1259
<term><parameter>%r</parameter></term>
1260
<listitem><para>empty at first. See below.</para></listitem>
1263
<term><parameter>%%</parameter></term>
1264
<listitem><para>a single <literal>%</literal></para></listitem>
1267
When the constructed filename cannot be used safely and the specification
1269
<literal>%</literal><replaceable>stuff</replaceable><literal>r</literal>,
1270
other names will be tried - this time expanding
1271
<literal>%</literal><replaceable>stuff</replaceable><literal>r</literal>
1272
to <replaceable>stuff</replaceable> followed by a random number.
1274
<para>The default is <quote>.xsession-errors</quote>.</para>
1279
<term id="option-clientlogfallback"><option>ClientLogFallback</option></term>
1282
Fallback when <option>ClientLogFile</option> cannot be used. The same expansions are
1283
supported. <emphasis>Do not</emphasis> use relative paths here.
1285
<para>The default is <quote>/tmp/xerr-%u-%d%-r</quote>.</para>
1290
<term id="option-usesessreg"><option>UseSessReg</option></term>
1293
Specify whether &kdm;'s built-in utmp/wtmp/lastlog registration should
1294
be used. If it is not, the tool <command>sessreg</command> should be used
1295
in the <option>Startup</option> and <option>Reset</option> scripts, or,
1296
alternatively, the pam_lastlog module should be used on
1297
<acronym>PAM</acronym>-enabled systems.
1299
<para>The default is <quote>true</quote>.</para>
1307
<sect2 id="kdmrc-greeter">
1308
<title>The [X-*-Greeter] section class of &kdmrc;</title>
1311
This section class contains options concerning the configuration
1312
of the &kdm; frontend (greeter).
1318
<term id="option-guistyle"><option>GUIStyle</option></term>
1321
Specify the widget style for the greeter. Empty means to use the
1322
built-in default which currently is <literal>Oxygen-air</literal>.
1324
<para>Empty by default.</para>
1329
<term id="option-colorscheme"><option>ColorScheme</option></term>
1332
Specify the widget color scheme for the greeter. Empty means to use the
1333
built-in default which currently is <literal>Oxygen-air</literal>.
1335
<para>Empty by default.</para>
1340
<term id="option-logoarea"><option>LogoArea</option></term>
1343
What should be shown in the greeter righthand of the input lines (if
1344
<option>UserList</option> is disabled) or above them (if
1345
<option>UserList</option> is enabled):
1349
<term><parameter>None</parameter></term>
1350
<listitem><para>nothing</para></listitem>
1353
<term><parameter>Logo</parameter></term>
1354
<listitem><para>the image specified by <option>LogoPixmap</option></para></listitem>
1357
<term><parameter>Clock</parameter></term>
1358
<listitem><para>a neat analog clock</para></listitem>
1361
<para>The default is <quote>Clock</quote>.</para>
1366
<term id="option-logopixmap"><option>LogoPixmap</option></term>
1369
The image to show in the greeter if <option>LogoArea</option> is
1370
<literal>Logo</literal>.
1372
<para>Empty by default.</para>
1377
<term id="option-greeterpos"><option>GreeterPos</option></term>
1380
The relative coordinates (percentages of the screen size; X,Y) at which
1381
the center of the greeter is put. &kdm; aligns the greeter to the edges
1382
of the screen it would cross otherwise.
1384
<para>The default is <quote>50,50</quote>.</para>
1389
<term id="option-greeterscreen"><option>GreeterScreen</option></term>
1392
The screen the greeter should be displayed on in multi-headed and Xinerama
1393
setups. The numbering starts with 0. For Xinerama, it corresponds to the
1394
listing order in the active ServerLayout section of XF86Config; -1 means
1395
to use the upper-left screen, -2 means to use the upper-right screen.
1401
<term id="option-greetstring"><option>GreetString</option></term>
1404
The headline in the greeter. An empty greeting means none at all.
1406
The following character pairs are replaced by their value:
1409
<term><parameter>%d</parameter></term>
1410
<listitem><para>name of the current display</para></listitem>
1413
<term><parameter>%h</parameter></term>
1414
<listitem><para>local host name, possibly with the
1415
domain name</para></listitem>
1418
<term><parameter>%n</parameter></term>
1419
<listitem><para>local node name, most probably the host name without the
1420
domain name</para></listitem>
1423
<term><parameter>%s</parameter></term>
1424
<listitem><para>operating system</para></listitem>
1427
<term><parameter>%r</parameter></term>
1428
<listitem><para>operating system version</para></listitem>
1431
<term><parameter>%m</parameter></term>
1432
<listitem><para>machine (hardware) type</para></listitem>
1435
<term><parameter>%%</parameter></term>
1436
<listitem><para>a single <literal>%</literal></para></listitem>
1440
<para>The default is <quote>Welcome to %s at %n</quote>.</para>
1445
<term id="option-antialiasing"><option>AntiAliasing</option></term>
1448
Whether the fonts used in the greeter should be antialiased.
1450
<para>The default is <quote>false</quote>.</para>
1455
<term id="option-greetfont"><option>GreetFont</option></term>
1458
The font for the greeter headline.
1460
<para>The default is <quote>Serif,20,bold</quote>.</para>
1465
<term id="option-stdfont"><option>StdFont</option></term>
1468
The normal font used in the greeter.
1470
<para>The default is <quote>Sans Serif,10</quote>.</para>
1475
<term id="option-failfont"><option>FailFont</option></term>
1478
The font used for the <quote>Login Failed</quote> message.
1480
<para>The default is <quote>Sans Serif,10,bold</quote>.</para>
1485
<term id="option-numlock"><option>NumLock</option></term>
1488
What to do with the Num Lock modifier for the time the greeter is running:
1492
<term><parameter>Off</parameter></term>
1493
<listitem><para>turn off</para></listitem>
1496
<term><parameter>On</parameter></term>
1497
<listitem><para>turn on</para></listitem>
1500
<term><parameter>Keep</parameter></term>
1501
<listitem><para>do not change the state</para></listitem>
1504
<para>The default is <quote>Keep</quote>.</para>
1509
<term id="option-language"><option>Language</option></term>
1512
Language and locale to use in the greeter, encoded like $<envar>LANGUAGE</envar>.
1513
If empty, the settings from the environment are used.
1515
<para>Empty by default.</para>
1520
<term id="option-usercompletion"><option>UserCompletion</option></term>
1523
Enable autocompletion in the username line edit.
1525
<para>The default is <quote>false</quote>.</para>
1530
<term id="option-userlist"><option>UserList</option></term>
1533
Show a user list with unix login names, real names, and images in the greeter.
1535
<para>The default is <quote>true</quote>.</para>
1540
<term id="option-showusers"><option>ShowUsers</option></term>
1543
This option controls which users will be shown in the user view
1544
(<option>UserList</option>) and/or offered for autocompletion
1545
(<option>UserCompletion</option>).
1546
If it is <literal>Selected</literal>, <option>SelectedUsers</option> contains
1547
the final list of users.
1548
If it is <literal>NotHidden</literal>, the initial user list contains all
1549
users found on the system. Users contained in <option>HiddenUsers</option> are
1550
removed from the list, just like all users with a UID greater than specified
1551
in <option>MaxShowUID</option> and users with a non-zero UID less than
1552
specified in <option>MinShowUID</option>.
1553
Items in <option>SelectedUsers</option> and <option>HiddenUsers</option>
1554
which are prefixed with <literal>@</literal> represent all users in the
1555
user group named by that item.
1556
Finally, the user list will be sorted alphabetically, if
1557
<option>SortUsers</option> is enabled.
1559
<para>The default is <quote>NotHidden</quote>.</para>
1564
<term id="option-selectedusers"><option>SelectedUsers</option></term>
1567
See <option>ShowUsers</option>.
1569
<para>Empty by default.</para>
1574
<term id="option-hiddenusers"><option>HiddenUsers</option></term>
1577
See <option>ShowUsers</option>.
1579
<para>Empty by default.</para>
1584
<term id="option-minshowuid"><option>MinShowUID</option></term>
1587
See <option>ShowUsers</option>.
1593
<term id="option-maxshowuid"><option>MaxShowUID</option></term>
1596
See <option>ShowUsers</option>.
1598
<para>The default is <quote>65535</quote>.</para>
1603
<term id="option-sortusers"><option>SortUsers</option></term>
1606
See <option>ShowUsers</option>.
1608
<para>The default is <quote>true</quote>.</para>
1613
<term id="option-facesource"><option>FaceSource</option></term>
1616
If <option>UserList</option> is enabled, this specifies where &kdm; gets the
1621
<term><parameter>AdminOnly</parameter></term>
1622
<listitem><para>from <filename><<option>FaceDir</option>>/$<envar>USER</envar>.face[.icon]</filename></para></listitem>
1625
<term><parameter>PreferAdmin</parameter></term>
1626
<listitem><para>prefer <<option>FaceDir</option>>, fallback on $<envar>HOME</envar></para></listitem>
1629
<term><parameter>PreferUser</parameter></term>
1630
<listitem><para>... and the other way round</para></listitem>
1633
<term><parameter>UserOnly</parameter></term>
1634
<listitem><para>from the user's <filename>$<envar>HOME</envar>/.face[.icon]</filename></para></listitem>
1639
The images can be in any format Qt recognizes, but the filename
1640
must match &kdm;'s expectations: <literal>.face.icon</literal> should be a
1641
48x48 icon, while <literal>.face</literal> should be a 300x300 image.
1642
Currently the big image is used only as a fallback and is scaled down,
1643
but in the future it might be displayed full-size in the logo area or a
1645
To be accessible to &kdm;, the images must be world readable and their
1646
parent directories must be world executable.
1648
<para>The default is <quote>AdminOnly</quote>.</para>
1653
<term id="option-facedir"><option>FaceDir</option></term>
1656
See <option>FaceSource</option>.
1658
<para>The default is <quote>${<envar>kde_datadir</envar>}/kdm/faces</quote>.</para>
1663
<term id="option-preselectuser"><option>PreselectUser</option></term>
1666
Specify, if/which user should be preselected for log in:
1670
<term><parameter>None</parameter></term>
1671
<listitem><para>do not preselect any user</para></listitem>
1674
<term><parameter>Previous</parameter></term>
1675
<listitem><para>the user which successfully logged in last time</para></listitem>
1678
<term><parameter>Default</parameter></term>
1679
<listitem><para>the user specified in the <option>DefaultUser</option> option</para></listitem>
1684
If <option>FocusPasswd</option> is enabled and a user was preselected,
1685
the cursor is placed in the password input field automatically.
1687
<note><para>Enabling user preselection can be considered a security hole,
1688
as it presents a valid login name to a potential attacker, so he
1689
<quote>only</quote> needs to guess the password. On the other hand,
1690
one could set <option>DefaultUser</option> to a fake login name.</para></note>
1693
<para>The default is <quote>None</quote>.</para>
1698
<term id="option-defaultuser"><option>DefaultUser</option></term>
1701
See <option>PreselectUser</option>.
1703
<para>Empty by default.</para>
1708
<term id="option-focuspasswd"><option>FocusPasswd</option></term>
1711
See <option>PreselectUser</option>.
1713
<para>The default is <quote>false</quote>.</para>
1718
<term id="option-echopasswd"><option>EchoPasswd</option></term>
1721
If this is true, the entered password is echoed as bullets. Otherwise,
1722
no feedback is given at all.
1724
<para>The default is <quote>true</quote>.</para>
1729
<term id="option-usebackground"><option>UseBackground</option></term>
1732
If enabled, &kdm; will automatically start the <command>krootimage</command>
1733
program to set up the background; otherwise, the <option>Setup</option>
1734
program is responsible for the background.
1736
<para>The default is <quote>true</quote>.</para>
1741
<term id="option-backgroundcfg"><option>BackgroundCfg</option></term>
1744
The configuration file to be used by <command>krootimage</command>.
1745
It contains a section named <literal>[Desktop0]</literal> like
1746
<filename>kdesktoprc</filename> does. Its options are not described
1747
herein; guess their meanings or use the control center.
1749
<para>The default is <quote>${<envar>kde_confdir</envar>}/kdm/backgroundrc</quote>.</para>
1754
<term id="option-grabinput"><option>GrabInput</option></term>
1757
To improve security, the greeter may grab mouse and keyboard input so
1758
no other X clients can eavesdrop it. However, the X authorization
1759
mechanism will usually prevent malicious X clients from connecting
1760
in the first place. Consequently, enabling grabs for local displays
1761
is pointless and only marginally improves security for remote displays.
1763
<note><para>The mouse grab will make on-screen keyboards unusable.
1769
<term><parameter>Never</parameter></term>
1770
<listitem><para>never grab</para></listitem>
1773
<term><parameter>IfNoAuth</parameter></term>
1774
<listitem><para>grab if the display requires no X authorization</para></listitem>
1777
<term><parameter>Always</parameter></term>
1778
<listitem><para>always grab</para></listitem>
1781
<para>The default is <quote>IfNoAuth</quote>.</para>
1786
<term id="option-grabserver"><option>GrabServer</option></term>
1789
To improve security, the greeter grabs the &X-Server; and then the input
1790
when it starts up. This option specifies if the &X-Server; grab should be held
1791
for the duration of the name/password reading. When disabled, the &X-Server;
1792
is ungrabbed after the input grabs succeed; otherwise, the &X-Server; is
1793
grabbed until just before the session begins.
1795
<note><para>Enabling this option disables <option>UseBackground</option> and
1796
<option>Setup</option>.</para></note>
1799
<para>The default is <quote>false</quote>.</para>
1804
<term id="option-grabtimeout"><option>GrabTimeout</option></term>
1807
This option specifies the maximum time &kdm; will wait for the grabs to
1808
succeed. A grab may fail if some other X-client has the &X-Server; or the
1809
keyboard grabbed, or possibly if the network latencies are very high. You
1810
should be cautious when raising the timeout, as a user can be spoofed by
1811
a look-alike window on the display. If a grab fails, &kdm; kills and
1812
restarts the &X-Server; (if possible) and the session.
1814
<para>The default is <quote>3</quote>.</para>
1819
<term id="option-authcomplain"><option>AuthComplain</option></term>
1822
Warn, if a display has no X-authorization. This will be the case if
1825
the authorization file for a local &X-Server; could not be created,
1828
a remote display from &XDMCP; did not request any authorization or
1831
the display is a <quote>foreign</quote> display specified in
1832
<option>StaticServers</option>.
1836
<para>The default is <quote>true</quote>.</para>
1841
<term id="option-loginmode"><option>LoginMode</option></term>
1844
Specify whether the greeter of local displays should start up in host chooser
1845
(remote) or login (local) mode and whether it is allowed to switch to the
1850
<term><parameter>LocalOnly</parameter></term>
1851
<listitem><para>only local login possible</para></listitem>
1854
<term><parameter>DefaultLocal</parameter></term>
1855
<listitem><para>start up in local mode, but allow switching to remote mode</para></listitem>
1858
<term><parameter>DefaultRemote</parameter></term>
1859
<listitem><para>... and the other way round</para></listitem>
1862
<term><parameter>RemoteOnly</parameter></term>
1863
<listitem><para>only choice of remote host possible</para></listitem>
1866
<para>The default is <quote>LocalOnly</quote>.</para>
1871
<term id="option-chooserhosts"><option>ChooserHosts</option></term>
1874
A list of hosts to be automatically added to the remote login menu.
1875
The special name <literal>*</literal> means broadcast.
1876
Has no effect if <option>LoginMode</option> is <literal>LocalOnly</literal>.
1878
<para>The default is <quote>*</quote>.</para>
1883
<term id="option-forgingseed"><option>ForgingSeed</option></term>
1886
Use this number as a random seed when forging saved session types, etc. of
1887
unknown users. This is used to avoid telling an attacker about existing users
1888
by reverse conclusion. This value should be random but constant across the
1895
<term id="option-showlog"><option>ShowLog</option></term>
1898
Enable &kdm;'s built-in <command>xconsole</command>.
1899
Note that this can be enabled for only one display at a time.
1900
This option is available only if &kdm; was <command>configure</command>d
1901
with <option>--enable-kdm-xconsole</option>.
1903
<para>The default is <quote>false</quote>.</para>
1908
<term id="option-logsource"><option>LogSource</option></term>
1911
The data source for &kdm;'s built-in <command>xconsole</command>.
1912
If empty, a console log redirection is requested from
1913
<filename>/dev/console</filename>.
1914
Has no effect if <option>ShowLog</option> is disabled.
1916
<para>Empty by default.</para>
1921
<term id="option-pluginslogin"><option>PluginsLogin</option></term>
1924
Specify conversation plugins for the login dialog; the first in the list
1925
is selected initially.
1926
Each plugin can be specified as a base name (which expands to
1927
<filename>$<envar>kde_modulesdir</envar>/kgreet_<replaceable>base</replaceable></filename>)
1928
or as a full pathname.
1930
Conversation plugins are modules for the greeter which obtain authentication
1931
data from the user. Currently only the <literal>classic</literal> plugin is
1932
shipped with &kde;; it presents the well-known username and password form.
1934
<para>The default is <quote>classic</quote>.</para>
1939
<term id="option-pluginsshutdown"><option>PluginsShutdown</option></term>
1942
Same as <option>PluginsLogin</option>, but for the shutdown dialog.
1944
<para>The default is <quote>classic</quote>.</para>
1949
<term id="option-pluginoptions"><option>PluginOptions</option></term>
1952
A list of options of the form
1953
<replaceable>Key</replaceable><literal>=</literal><replaceable>Value</replaceable>.
1954
The conversation plugins can query these settings; it is up to them what
1957
<para>Empty by default.</para>
1962
<term id="option-allowconsole"><option>AllowConsole</option></term>
1965
Show the <guilabel>Console Login</guilabel> action in the greeter (if <option>ServerTTY</option>/<option>ConsoleTTYs</option>
1968
<para>The default is <quote>true</quote>.</para>
1973
<term id="option-allowclose"><option>AllowClose</option></term>
1976
Show the <guilabel>Restart X Server</guilabel>/<guilabel>Close Connection</guilabel> action in the greeter.
1978
<para>The default is <quote>true</quote>.</para>
1983
<term id="option-preloader"><option>Preloader</option></term>
1986
A program to run while the greeter is visible. It is supposed to preload
1987
as much as possible of the session that is going to be started (most
1990
<para>Empty by default.</para>
1995
<term id="option-usetheme"><option>UseTheme</option></term>
1998
Whether the greeter should be themed.
2000
<para>The default is <quote>false</quote>.</para>
2005
<term id="option-theme"><option>Theme</option></term>
2008
The theme to use for the greeter. Can point to either a directory or an XML
2011
<para>Empty by default.</para>
2016
<term id="option-allowthemedebug"><option>AllowThemeDebug</option></term>
2019
Enable the Alt-Ctrl-D shortcut to toggle greeter theme debugging.
2021
<para>The default is <quote>false</quote>.</para>
2032
<sect1 id="kdmrc-xservers">
2033
<title>Specifying permanent &X-Server;s</title>
2035
<para>Each entry in the <option>StaticServers</option> list indicates a
2036
display which should constantly be
2037
managed and which is not using &XDMCP;. This method is typically used only for
2038
local &X-Server;s that are started by &kdm;, but &kdm; can manage externally
2039
started (<quote>foreign</quote>) &X-Server;s as well, may they run on the
2040
local machine or rather remotely.</para>
2042
<para>The formal syntax of a specification is
2044
<userinput><replaceable>display name</replaceable> [<literal>_</literal><replaceable>display class</replaceable>]</userinput>
2046
for all &X-Server;s. <quote>Foreign</quote> displays differ in having
2047
a host name in the display name, may it be <literal>localhost</literal>.</para>
2049
<para>The <replaceable>display name</replaceable> must be something that can
2050
be passed in the <option>-display</option> option to an X program. This string
2051
is used to generate the display-specific section names, so be careful to match
2053
The display name of &XDMCP; displays is derived from the display's address by
2054
reverse host name resolution. For configuration purposes, the
2055
<literal>localhost</literal> prefix from locally running &XDMCP; displays is
2056
<emphasis>not</emphasis> stripped to make them distinguishable from local
2057
&X-Server;s started by &kdm;.</para>
2059
<para>The <replaceable>display class</replaceable> portion is also used in the
2060
display-specific sections. This is useful if you have a large collection of
2061
similar displays (such as a corral of X terminals) and would like to set
2062
options for groups of them.
2063
When using &XDMCP;, the display is required to specify the display class,
2064
so the manual for your particular X terminal should document the display
2065
class string for your device. If it does not, you can run &kdm; in debug
2066
mode and <command>grep</command> the log for <quote>class</quote>.</para>
2068
<para>The displays specified in <option>ReserveServers</option> will not be
2069
started when &kdm; starts up, but when it is explicitly requested via
2071
If reserve displays are specified, the &kde; menu will have a
2072
<guilabel>Start New Session</guilabel> item near the bottom; use that to
2073
activate a reserve display with a new login session. The monitor will switch
2074
to the new display, and you will have a minute to login. If there are no more
2075
reserve displays available, the menu item will be disabled.</para>
2077
<para>When &kdm; starts a session, it sets up authorization data for the
2078
&X-Server;. For local servers, &kdm; passes
2079
<command><option>-auth</option> <filename><replaceable>filename</replaceable></filename></command>
2080
on the &X-Server;'s command line to point it at its authorization data.
2081
For &XDMCP; displays, &kdm; passes the authorization data to the &X-Server;
2082
via the <quote>Accept</quote> &XDMCP; message.</para>
2086
<sect1 id="kdmrc-xaccess">
2087
<title>&XDMCP; access control</title>
2089
<para>The file specified by the <option>AccessFile</option> option provides
2090
information which &kdm; uses to control access from displays requesting service
2092
The file contains four types of entries: entries which control the response
2093
to <quote>Direct</quote> and <quote>Broadcast</quote> queries, entries which
2094
control the response to <quote>Indirect</quote> queries, macro definitions,
2095
and entries which control on which network interfaces &kdm; listens for &XDMCP;
2097
Blank lines are ignored, <literal>#</literal> is treated as a comment
2098
delimiter causing the rest of that line to be ignored, and <literal>\</literal>
2099
causes an immediately following newline to be ignored, allowing host lists
2100
to span multiple lines.
2103
<para>The format of the <quote>Direct</quote> entries is simple, either a
2104
host name or a pattern, which is compared against the host name of the display
2105
device. Alternatively, a macro may be used to make the entry match everything
2106
the macro expands to.
2107
Patterns are distinguished from host names by the inclusion of one or more
2108
meta characters; <literal>*</literal> matches any sequence of 0 or more
2109
characters, and <literal>?</literal> matches any single character.
2110
If the entry is a host name, all comparisons are done using network addresses,
2111
so any name which converts to the correct network address may be used. Note
2112
that only the first network address returned for a host name is used.
2113
For patterns, only canonical host names are used in the comparison, so ensure
2114
that you do not attempt to match aliases.
2115
Host names from &XDMCP; queries always contain the local domain name
2116
even if the reverse lookup returns a short name, so you can use
2117
patterns for the local domain.
2118
Preceding the entry with a <literal>!</literal> character causes hosts which
2119
match that entry to be excluded. Preceding it with an <literal>=</literal> has
2120
no effect but is required when specifying a macro to distinguish the entry
2121
from a macro definition.
2122
To only respond to <quote>Direct</quote> queries for a host or pattern,
2123
it can be followed by the optional <literal>NOBROADCAST</literal> keyword.
2124
This can be used to prevent a &kdm; server from appearing on menus based on
2125
<quote>Broadcast</quote> queries.</para>
2127
<para>An <quote>Indirect</quote> entry also contains a host name, pattern or
2128
macro, but follows it with a list of host names or macros to which the queries
2129
should be forwarded. <quote>Indirect</quote> entries can be excluding as well,
2130
in which case a (valid) dummy host name must be supplied to make the entry
2131
distinguishable from a <quote>Direct</quote> entry.
2132
If compiled with IPv6 support, multicast address groups may also be included
2133
in the list of addresses the queries are forwarded to.
2134
<!-- Not actually implemented!
2135
Multicast addresses may be followed by an optional <literal>/</literal>
2136
character and hop count. If no hop count is specified, the multicast hop count
2137
defaults to 1, keeping the packet on the local network. For IPv4 multicasting,
2138
the hop count is used as the TTL.
2140
If the indirect host list contains the keyword <literal>CHOOSER</literal>,
2141
<quote>Indirect</quote> queries are not forwarded, but instead a host chooser
2142
dialog is displayed by &kdm;. The chooser will send a <quote>Direct</quote>
2143
query to each of the remaining host names in the list and offer a menu of
2144
all the hosts that respond. The host list may contain the keyword
2145
<literal>BROADCAST</literal>, to make the chooser send a
2146
<quote>Broadcast</quote> query as well; note that on some operating systems,
2147
UDP packets cannot be broadcast, so this feature will not work.
2150
<para>When checking access for a particular display host, each entry is scanned
2151
in turn and the first matching entry determines the response.
2152
<quote>Direct</quote> and <quote>Broadcast</quote> entries are ignored when
2153
scanning for an <quote>Indirect</quote> entry and vice-versa.</para>
2155
<para>A macro definition contains a macro name and a list of host names and
2156
other macros that the macro expands to. To distinguish macros from hostnames,
2157
macro names start with a <literal>%</literal> character.</para>
2159
<para>The last entry type is the <literal>LISTEN</literal> directive.
2160
The formal syntax is
2162
<userinput> <literal>LISTEN</literal> [<replaceable>interface</replaceable> [<replaceable>multicast list</replaceable>]]</userinput>
2164
If one or more <literal>LISTEN</literal> lines are specified, &kdm; listens
2165
for &XDMCP; requests only on the specified interfaces.
2166
<replaceable>interface</replaceable> may be a hostname or IP address
2167
representing a network interface on this machine, or the wildcard
2168
<literal>*</literal> to represent all available network interfaces.
2169
If multicast group addresses are listed on a <literal>LISTEN</literal> line,
2170
&kdm; joins the multicast groups on the given interface. For IPv6 multicasts,
2171
the IANA has assigned ff0<replaceable>X</replaceable>:0:0:0:0:0:0:12b as the
2172
permanently assigned range of multicast addresses for &XDMCP;. The
2173
<replaceable>X</replaceable> in the prefix may be replaced by any valid scope
2174
identifier, such as 1 for Node-Local, 2 for Link-Local, 5 for Site-Local, and
2175
so on (see IETF RFC 2373 or its replacement for further details and scope
2176
definitions). &kdm; defaults to listening on the Link-Local scope address
2177
ff02:0:0:0:0:0:0:12b to most closely match the IPv4 subnet broadcast behavior.
2178
If no <literal>LISTEN</literal> lines are given, &kdm; listens on all
2179
interfaces and joins the default &XDMCP; IPv6 multicast group (when
2180
compiled with IPv6 support).
2181
To disable listening for &XDMCP; requests altogether, a
2182
<literal>LISTEN</literal> line with no addresses may be specified, but using
2183
the <literal>[Xdmcp]</literal> <option>Enable</option> option is preferred.
2188
<sect1 id="kdm-scripts">
2189
<title>Supplementary programs</title>
2192
The following programs are run by &kdm; at various stages of a session.
2193
They typically are shell scripts.
2197
The Setup, Startup and Reset programs are run as
2198
<systemitem class="username">root</systemitem>, so they should be careful
2200
Their first argument is <literal>auto</literal> if the session results
2201
from an automatic login; otherwise, no arguments are passed to them.
2204
<sect2 id="kdmrc-xsetup">
2205
<title>Setup program</title>
2208
The <filename>Xsetup</filename> program is run after the &X-Server; is
2209
started or reset, but before the greeter is offered.
2210
This is the place to change the root background (if
2211
<option>UseBackground</option> is disabled) or bring up other windows that
2212
should appear on the screen along with the greeter. Resources for this
2213
program can be put into the file named by <option>Resources</option>.
2217
In addition to any specified by <option>ExportList</option>,
2218
the following environment variables are passed:</para>
2221
<term>DISPLAY</term>
2222
<listitem><para>the associated display name</para></listitem>
2226
<listitem><para>the value of <option>SystemPath</option></para></listitem>
2230
<listitem><para>the value of <option>SystemShell</option></para></listitem>
2233
<term>XAUTHORITY</term>
2234
<listitem><para>may be set to an authority file</para></listitem>
2237
<term>DM_CONTROL</term>
2238
<listitem><para>the value of <option>FifoDir</option></para></listitem>
2242
<note><para><option>GrabInput</option> can make &kdm; grab the
2243
keyboard and mouse, making any other windows unable to receive input.
2244
If <option>GrabServer</option> is set, <filename>Xsetup</filename>
2245
will not be able to connect to the display at all.</para></note>
2249
<sect2 id="kdmrc-xstartup">
2250
<title>Startup program</title>
2252
<para>The <filename>Xstartup</filename> program is run as
2253
<systemitem class="username">root</systemitem> when the user logs in.
2254
This is the place to put commands which add entries to
2255
<filename>utmp</filename> (the <command>sessreg</command> program
2256
may be useful here), mount users' home directories from file servers,
2257
or abort the session if some requirements are not met (but note that on
2258
modern systems, many of these tasks are already taken care of by
2259
<acronym>PAM</acronym> modules).</para>
2261
<para>In addition to any specified by <option>ExportList</option>,
2262
the following environment variables are passed:</para>
2265
<term>DISPLAY</term>
2266
<listitem><para>the associated display name</para></listitem>
2270
<listitem><para>the initial working directory of the user</para></listitem>
2273
<term>LOGNAME</term>
2274
<listitem><para>the username</para></listitem>
2278
<listitem><para>the username</para></listitem>
2282
<listitem><para>the value of <option>SystemPath</option></para></listitem>
2286
<listitem><para>the value of <option>SystemShell</option></para></listitem>
2289
<term>XAUTHORITY</term>
2290
<listitem><para>may be set to an authority file</para></listitem>
2293
<term>DM_CONTROL</term>
2294
<listitem><para>the value of <option>FifoDir</option></para></listitem>
2298
<para>&kdm; waits until this program exits before starting the user session.
2299
If the exit value of this program is non-zero, &kdm; discontinues the session
2300
and starts another authentication cycle.</para>
2304
<sect2 id="kdmrc-xsession">
2305
<title>Session program</title>
2307
<para>The <filename>Xsession</filename> program is the command which is run
2308
as the user's session. It is run with the permissions of the authorized user.
2309
One of the keywords <literal>failsafe</literal>, <literal>default</literal>
2310
or <literal>custom</literal>, or a string to <command>eval</command> by a
2311
Bourne-compatible shell is passed as the first argument.</para>
2313
<para>In addition to any specified by <option>ExportList</option>,
2314
the following environment variables are passed:</para>
2317
<term>DISPLAY</term>
2318
<listitem><para>the associated display name</para></listitem>
2322
<listitem><para>the initial working directory of the user</para></listitem>
2325
<term>LOGNAME</term>
2326
<listitem><para>the username</para></listitem>
2330
<listitem><para>the username</para></listitem>
2334
<listitem><para>the value of <option>UserPath</option>
2335
(or <option>SystemPath</option> for
2336
<systemitem class="username">root</systemitem> user sessions)</para>
2341
<listitem><para>the user's default shell</para></listitem>
2344
<term>XAUTHORITY</term>
2345
<listitem><para>may be set to a non-standard authority file</para></listitem>
2348
<term>KRBTKFILE</term>
2349
<listitem><para>may be set to a Kerberos4 credentials cache name</para>
2353
<term>KRB5CCNAME</term>
2354
<listitem><para>may be set to a Kerberos5 credentials cache name</para>
2358
<term>DM_CONTROL</term>
2359
<listitem><para>the value of <option>FifoDir</option></para></listitem>
2362
<term>XDM_MANAGED</term>
2363
<listitem><para>will contain a comma-separated list of parameters the
2364
session might find interesting, like which conversation
2365
plugin was used for the login</para>
2369
<term>DESKTOP_SESSION</term>
2370
<listitem><para>the name of the session the user has chosen to run</para>
2377
<sect2 id="kdmrc-xreset">
2378
<title>Reset program</title>
2380
<para>Symmetrical with <filename>Xstartup</filename>, the
2381
<filename>Xreset</filename> program is run after the user session has
2382
terminated. Run as <systemitem class="username">root</systemitem>, it should
2383
contain commands that undo the effects of commands in
2384
<filename>Xstartup</filename>, removing entries from <filename>utmp</filename>
2385
or unmounting directories from file servers.</para>
2387
<para>The environment variables that were passed to
2388
<filename>Xstartup</filename> are also passed to <filename>Xreset</filename>.
added
removed
doc/kdm/kdmrc-ref.docbook
