XBUTTONS_BAR.CONF(5)

NAME
Xbuttons_bar.conf -configuration file for Xbuttons_bar.

DESCRIPTION
Xbuttons_bar.conf is the (default) configuration file for the XDM script Xbuttons_bar. On system with multiple X servers, there might be a configuration file per X server. The Xbuttons_bar configuration file dedicated to an X server must be named Xbuttons_bar.<XDISP>.conf and stored in same directory as script Xbuttons_bar. <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, Xbuttons_bar loads the default configuration file : Xbuttons_bar.conf. The default configuration file Xbuttons_bar.conf can be used as a base configuration inside the configuration file dedicated to a given X server, like in example below :
  ---- Xbuttons_bar._0.conf -----
  # Loads defaults
  #
  source ${SCRIPTDIR}/Xbuttons_bar.conf

  # Redefines buttons for X server :0
  #
  BUTTONS_ORDER="SYSTEM SESSIONS SCREENSHOT"

  # Redefines label of buttons to take screenshot for server :0
  #
  SCREENSHOT_BTLABEL="[ o ]"
  -------------------------
Below the variables defined in script Xbuttons_bar that can be useful in Xbuttons_bar configuration file :
    SCRIPTDIR - Absolute path to Xbuttons_bar's directory XDISP - The X server display name, without field 'screennumber', and to XDM resource name format.

PROPERTIES

DISABLE_LOG = <on|yes|true|1|off|no|false|0>
    Defines whether or not logging of Xbuttons_bar activity must be disabled. Default to off. Activity is logged in :
      /var/log/xdm-xbuttons_bar.${XDISP}.log

BUTTONS_ORDER = "<identifier> ..."
    Defines, as a space separated list of identifiers, the buttons present in the buttons-bar and their order. Below the supported identifiers :
        SESSIONS - Identifier of button to access the sessions menu. SYSTEM - Identifier of button to access the system menu. SCREENSHOT - Identifier of button to take a screenshot of XDM screen.
    Default to "SESSIONS SYSTEM"

SYSMENU_BUTTONS_ORDER = "<identifier> ..."
    Defines, as a space separated list of identifiers, the buttons present in the system menu and their order. Below the supported identifiers :
        SUSPEND - Identifier of button to suspend the system. HIBERNATE - Identifier of button to hibernate the system. REBOOT - Identifier of button to reboot the system. HALT - Identifier of button to shutdown the system.
    Default to "SUSPEND HIBERNATE REBOOT HALT"

SESMENU_BTLABEL = "<label>"
    Defines the label of the button to access the sessions menu. When the tag @SESSION_NAME@ is present, it is replaced by the name of the current selected session, if any, by the string specified by property NOSESSION_STR otherwise. Default to "Session[@SESSION_NAME@]"

NOSESSION_STR = "<string>"
    The string by which the tag @SESSION_NAME@, if present in property SESMENU_BTLABEL, must be replaced when there is no selected session. Default to "default"

SYSMENU_BTLABEL = "<label>"
    Defines the label of the button to access the system menu. Default to "System"

SCREENSHOT_BTLABEL = "<label>"
    Defines the label of the button to take a screenshot of XDM screen. Default to "Screenshot" To make this button invisible on the screenshots, simply set this property to " ".

SUSPEND_BTLABEL = "<label>"
     Defines the label of the button to suspend the system. Default to "Suspend".

HIBERNATE_BTLABEL = "<label>"
    Defines the label of the button to hibernate the system. Default to "Hibernate".

REBOOT_BTLABEL =  "<label>"
    Defines the label of the button to reboot the system. Default to "Reboot".

HALT_BTLABEL = "<label>"
    Defines the label of the button to halt the system. Default to "Halt".

EXITMENU_BTLABEL = "<label>"
    Defines the label of the button to exit from system/sessions menu. Default to "Exit".

RESET_BTLABEL = "<label>"
    Defines the reset button label of sessions menu selection. Default to "Reset".

FONT = <font>
    Defines the buttons-bar font. Default to :
        -misc-dejavu sans light-extralight-r-normal--17-*-*-*-*-*-*-*

FG_COLOR = <color>
    Defines the buttons bar foreground color. Can be an X11 color names or an hex triplet to the format #rrggbb. Default to "grey90".

SYSMENU_FONT = <font>
    Defines the system menu font. Default to ${FONT}.

SESMENU_FONT = <font>
    Defines the sessions menu font. Default to ${FONT}.

SYSMENU_FG_COLOR = <color>
    Defines the system menu foreground color. Can be an X11 color names or an hex triplet to the format #rrggbb. Default to "grey90".

SESMENU_FG_COLOR = <color>
    Defines the sessions menu foreground color. Can be an X11 color names or an hex triplet to the format #rrggbb. Default to "grey90".

XINITRC_FILES_DIR = <path>
    The location of xinitrc.* session files used to populate the sessions menu. Default to /etc/X11/xinit.

SESSIONS_BLACKLIST = ( <session-name> ... )
    The sessions to exclude from the sessions menu. Default to ().

SESMENU_VIEWPORT_SIZE = <int>
    The maximum number of items visible at a time in the sessions menu. Default to 10. When there is more items than that in the sessions menu, scroll buttons are added accordingly.

SESMENU_LSCROLL_BTLABEL =  "<label>"
    Defines the label of the sessions menu left-scroll button. Default to " < ".

SESMENU_RSCROLL_BTLABEL = "<label>"
    Defines the label of the sessions menu right-scroll button. Default to ">"

PERSISTENT_SESSION = <on|yes|true|1|off|no|false|0>
    Defines whether or not the (last) selected session in the sessions menu must persist (across XDM resets and system reboots). Default to off.

SCREENSHOT_DELAY = <int>
    Defines the delay (in seconds) before taking a screenshot. Default to 5.

SCREENSHOT_DIR = <path>
    Defines the screenshot folder. Default to /tmp. screenshot names are to the format :
      xdm.${XDISP}.$(date +%Y%m%d_%H%M%S).png

SCREENSHOT_NTFY_MSG = "<string>"
    Defines the message displayed before taking a screenshot. The tag @SCREENSHOT_DELAY@ is replaced at runtime by the value of property SCREENSHOT_DELAY.

SCREENSHOT_NOW_BTLABEL = "<label>"
    Defines the label of button to dismiss the timeout and take a screenshot immediately. Default to "Now".

SCREENSHOT_CANCEL_BTLABEL = "<label>"
    Defines the label of button to cancel taking a screenshot. Default to "Cancel".

SCREENSHOT_TAKEN_MSG = "<string>"
    Defines the message displayed after taking a screenshot. The tag @SCREENSHOT_FILENAME@ is replaced at runtime by the full path to the screenshot file.

SCREENSHOT_FAIL_MSG = "<string>"
    Defines the message displayed when taking a screenshot failed.

SCREENSHOT_DLG_FONT = <font>
    Defines the font of the message displayed before/after taking a screenshot, and in case of error. Default to :
        -misc-dejavu sans light-extralight-r-normal--17-*-*-*-*-*-*-*

SCREENSHOT_ALWAYS_FULL = <on|yes|true|1|off|no|false|0>
    Defines whether or not to always take full screenshots, even when XDM is configured for primary display only (Xsetup.PRIMARY_ONLY=on). Default to off.

SEE ALSO
Xsetup.conf(5), Xsession.conf(5)

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