XDMCHOOSE.CONF(5)

NAME
xdmchoose.conf - configuration file for xdmchoose

DESCRIPTION
This page documents the format for the xdmchoose.conf file. This can either be specified on the commandline to xdmchoose, or by default is read from SYSCONFDIR/ or the current directory. SYSCONFDIR is specified at built time, typically either /etc or /usr/local/etc.

GENERAL SYNTAX
The configuration file is formatted as a series of:

    component.property value

style entries. The application behaviour is controlled through the special `app' component, whose properties are described below (PROGRAM BEHAVIOUR). Default settings (for the various visual gadgets) are set through the `unknown' component. The visual gadgets and their properties are described below (APPEARANCE).

PROGRAM BEHAVIOUR
Program behaviour is controlled using the `app' component, that has the following properties:

hidequery int
    if non-zero then the `query' button is not shown.

allowbroadcast int
    if non-zero a broadcast address may be entered in the `host' selection.

startscript string
    if set, the path to a script that is executed after the chooser window has been displayed. This might be used to fire up `Xdialog' with some suitable MOTD, and set the background, for instance. The script is executed with an X environment.

startscriptkill string
    when selecting a host, other connected clients should be disconnected first. If set, windows with their WM_NAME or STRING property set to string are destroyed. The `xwininfo' utility can be used to discover this property for things.

extratext int
    if non-zero, the extratext gadget is shown. This is an extra label that sits below the existing copyright/information label (copylabel).

allowctrlc int
    if non-zero, Ctrl-C may be used to exit the chooser. In general, this will reset the X server and cause the chooser to come back (if not being run from the command-line).

ctrlcexitcode int
    the exit-code from xdmchoose when Ctrl-C is used to terminate the chooser. 13 appears to be the right value for most things.

stripdomain int
    if non-zero, domain suffixes are stripped from various hostnames (when subsituting strings, for instance).

allowtype int
    if zero, typing in the host-entry box is disabled. This typically only makes sense if a list of hosts is provided in the `hostlist' setting.

hostlist stringlist
    if set, a comma-seperated list of quoted hostname strings to be offered in a drop-down style list.

grabkybd int
    if set, specifies whether the keyboard should be grabbed. In most (real) cases, this will either be unset (defaults to 1), or explicitly 1. Without if, typing on the keyboard might not work. When running from the command-line, the -g or --nograbkybd option may be used to explicitly avoid grabbing the keyboard (regardless of any configuration-file setting).

APPEARANCE
Visual components are configured using the following properties:

foreground string
    foreground colour. This can be any X-understood colour spec - either a name in the colour database (Xlib Volume 1) or a #RRGGBB style definition.

background string
    background colour. For the panel, this can be a path to an xpm image.

highlight string
    highlight colour for creating 3D effects.

shadow string
    shadow colour for creating 3D effects.

tentry string
    text-entry colour. This is the background colour used for the host edit-box and ignored by other components.

text string
    text or label of the component, if applicable. This can be used on the `hostedit' component to set a default host selection.

font string
    font for any text in the component, if applicable. This should either be a font alias or a full font specification. If the requested font is unavailable, `fixed' will be used. See the `xfontsel' utility for font discovery.

The various visual components are:

panel
    the main application window. The background property may be set to the path of an XPM image.

title
    the title-label.

hostlabel
    label to the left of the edit-box. Typically `host :', but you might have a preferred language or something.

hostedit
    the host edit-box.

combobutton
    drop-down button to the right of host edit-box. This is only shown if the app.hostlist option is set. Setting the text property of this is not recommended; by default, a small downward arrow will be drawn.

hostlist
    list-box dropped down to select hosts, shown when combobutton is clicked.

errorlabel
    label under the host edit-box used to display errors.

statuslabel
    label under the host edit-box used to display information messages (e.g. host query responses and ``connecting to ...'').

loginbutton
    host login button.

querybutton
    host query button.

copylabel
    label under the buttons.

extratext
    an additional label. This is only shown if the app.extratext option is set and non-zero.

Most string settings allow various subsitutions. Currently these are:

%SERVER%
    hostname of the X server, without the domain if app.stripdomain is set.

%SERVER.IP
    IP address of the X server.

%XDMHOST%
    hostname of the machine providing the chooser, without the domain if app.stripdomain is set.

%XDMHOST.IP%
    IP address of the machine providing the chooser.

%VERSION%
    xdmchooser version.

EXAMPLE
See the example xdmchoose.conf supplied in the source distribution.

AUTHOR
Fred Barnes <fred@frmb.org>

SEE ALSO
xdmchoose(1)

REPORTING BUGS
Please report bugs to <fred@frmb.org>

COPYRIGHT
Copyright © 2000-2003 Fred Barnes.