XDM-SCREENSAVER.CONF(5)

NAME
xdm-screensaver.conf -configuration file for extension xdm-screensaver.

DESCRIPTION
xdm-screensaver.conf is the (default) configuration file for the Xsetup extension xdm-screensaver. On system with multiple X servers, there might be a configuration file per X server. The xdm-screensaver configuration file dedicated to an X server must be named xdm-screensaver.<XDISP>.conf and stored in same directory as script xdm-screensaver. <XDISP> is the X server display name, without field screennumber, and to XDM resource name format, that is, with underscores in place of dots and colons. For instance the value of XDISP for the X server display name :0 is _0. It is _1 in case of X server display name :0, and so on. When there is no configuration file dedicated to a given X server, xdm-screensaver loads the default configuration file : xdm-screensaver.conf. The default configuration file xdm-screensaver.conf can be used as a base configuration inside the configuration file dedicated to a given X server, like in example below :
  ---- xdm-screensaver._1.conf -----
  # Loads defaults
  #
  source ${EXTDIR}/xdm-screensaver.conf
  # Change screensaver used on Xserver :1
  #
  SCREENSAVER=glmatrix
  # Sets extra-arguments for glmatrix screensaver on Xserver :1
  #
  SCREENSAVER_EXTRA_ARGS=( -dna -clock )
  -------------------------------
Below the variables defined in script Xsetup that can be useful in xdm-screensaver configuration file :
    SCRIPTDIR - Absolute path to Xsetup's directory EXTDIR - Absolute path to Xsetup extensions directory XDISP - The X server display name, without field 'screennumber', and to XDM resource name format.

PROPERTIES

SCREENSAVER_MODE = <mode>
    Defines the operating mode of xdm-screensaver extension. Can be set to one of the following (default to windowed) :
        • fullscreen
            The screensaver is draw on the root window. Attention, when this mode is selected :
                • The screensaver is not visible when compton is enabled (i.e. the Xsetup property WITH_COMPTON is set to on). • The background image specified by Xsetup property XDMBGIMG is erased by the screensaver. • Parts of the top/bottom border on which is placed the buttons-bar and/or the xclock widget might be erased by the screensaver.
        • windowed
            The screensaver is draw on a newly-created window on the physical display specified by property SCREENSAVER_DISPLAY. Attention, when this mode is selected, the screensaver's window might overlap any other windows (ex. the xdm login window) on the same physical display.

SCREENSAVER_DISPLAY = <screen>
    Defines the physical display on which to draw the screensaver when SCREENSAVER_MODE is set to windowed. This can be one of the following (default to 1) : • The name of any output supported by xrandr (ex. VGA-0, HDMI-0, ...) • the number of the corresponding display in the list returned by command 'xrandr --listmonitors' (ex. 1, 2, ..) • the keyword primary to select the primary display.

SCREENSAVER_WINDOW_POS = <position>
    Defines the position of the window on which to draw the screensaver when SCREENSAVER_MODE is set to windowed. The position is relative to the physical display specified by property SCREENSAVER_DISPLAY. Can be one of the following (default to TOP_LEFT) :
                  TOP_LEFT   TOP_MIDDLE    TOP_RIGHT
                MIDDLE_LEFT MIDDLE_MIDDLE MIDDLE_RIGHT
                BOTTOM_LEFT BOTTOM_MIDDLE BOTTOM_RIGHT

SCREENSAVER_WINDOW_SIZE = ( <width> <height> )
    Defines the dimensions of the window on which to draw the screensaver when SCREENSAVER_MODE is set to windowed. The dimensions can be expressed in pixel, or in percent of the width/height of the physical display specified by property SCREENSAVER_DISPLAY. Default to ( 100% 100% ).

SCREENSAVER_WINDOW_MARGIN = ( <x-margin> <y-margin> )
    Defines the margins around the window on which to draw the screensaver when SCREENSAVER_MODE is set to windowed. Default to ( 8 8 ).

SCREENSAVER_DIR = <path>
    Defines the location of screensavers. Default to /usr/libexec/xscreensaver.

SCREENSAVER = <program-name>
     Defines the screensaver to run. Default to gltext.

SCREENSAVER_EXTRA_ARGS = ( <arg> ... )
    Defines the extra-arguments to pass to the screensaver specified by property SCREENSAVER. Default to :
      ( "-text" "$(head -n 1 /etc/slackware-version)" )

SEE ALSO
Xsetup.conf(5)

AUTHORS
Sébastien Ballet <slacker6896@gmail.com>