env_helpstr.inc

Go to the documentation of this file.

"*   `XSECURELOCK_AUTH`: specifies the desired authentication module (the part\n"
"    that displays the authentication prompt).\n"
"*   `XSECURELOCK_AUTHPROTO`: specifies the desired authentication protocol\n"
"    module (the part that talks to the system).\n"
"*   `XSECURELOCK_AUTH_BACKGROUND_COLOR`: specifies the X11 color (see manpage of\n"
"    XParseColor) for the background of the auth dialog.\n"
"*   `XSECURELOCK_AUTH_CURSOR_BLINK`: if set, the cursor will blink in the auth\n"
"    dialog. Enabled by default, can be set to 0 to disable.\n"
"*   `XSECURELOCK_AUTH_SOUNDS`: specifies whether to play sounds during\n"
"    authentication to indicate status. Sounds are defined as follows:\n"
"    *   High-pitch ascending: prompt for user input.\n"
"    *   High-pitch constant: an info message was displayed.\n"
"    *   Low-pitch descending: an error message was displayed.\n"
"    *   Medium-pitch ascending: authentication successful.\n"
"*   `XSECURELOCK_AUTH_FOREGROUND_COLOR`: specifies the X11 color (see manpage of\n"
"    XParseColor) for the foreground text of the auth dialog.\n"
"*   `XSECURELOCK_AUTH_TIMEOUT`: specifies the time (in seconds) to wait for\n"
"    response to a prompt by `auth_x11` before giving up and reverting to\n"
"    the screen saver.\n"
"*   `XSECURELOCK_AUTH_WARNING_COLOR`: specifies the X11 color (see manpage of\n"
"    XParseColor) for the warning text of the auth dialog.\n"
"*   `XSECURELOCK_BACKGROUND_COLOR`: specifies the X11 color (see manpage\n"
"    of XParseColor) for the background of the main and saver windows.\n"
"*   `XSECURELOCK_BLANK_TIMEOUT`: specifies the time (in seconds) before telling\n"
"    X11 to fully blank the screen; a negative value disables X11 blanking. The\n"
"    time is measured since the closing of the auth window or xsecurelock\n"
"    startup. Setting this to 0 is rather nonsensical, as key-release events\n"
"    (e.g. from the keystroke to launch xsecurelock or from pressing escape to\n"
"    close the auth dialog) always wake up the screen.\n"
"*   `XSECURELOCK_BLANK_DPMS_STATE`: specifies which DPMS state to put the screen\n"
"    in when blanking (one of standby, suspend, off and on, where \"on\" means to\n"
"    not invoke DPMS at all).\n"
"*   `XSECURELOCK_BURNIN_MITIGATION`: specifies the number of pixels the prompt\n"
"    of `auth_x11` may be moved at startup to mitigate possible burn-in\n"
"    effects due to the auth dialog being displayed all the time (e.g. when\n"
"    spurious mouse events wake up the screen all the time).\n"
"*   `XSECURELOCK_BURNIN_MITIGATION_DYNAMIC`: if set to a non-zero value,\n"
"    `auth_x11` will move the prompt while it is being displayed, but stay\n"
"    within the bounds of `XSECURELOCK_BURNIN_MITIGATION`. The value of this\n"
"    variable is the maximum allowed shift per screen refresh. This mitigates\n"
"    short-term burn-in effects but is probably annoying to most users, and thus\n"
"    disabled by default.\n"
"*   `XSECURELOCK_COMPOSITE_OBSCURER`: create a second full-screen window to\n"
"    obscure window content in case a running compositor unmaps its own window.\n"
"    Helps with some instances of bad compositor behavior (such as compositor\n"
"    crashes/restarts, but also compton has been caught at drawing notification\n"
"    icons above the screen locker when not using the GLX backend), should\n"
"    prevent compositors from unredirecting as it's 1 pixel smaller than the\n"
"    screen from every side, and should otherwise be harmless, so it's enabled\n"
"    by default.\n"
"*   `XSECURELOCK_DATETIME_FORMAT`: the date format to show. Defaults to the\n"
"    locale settings. (see `man date` for possible formats)\n"
"*   `XSECURELOCK_DEBUG_ALLOW_LOCKING_IF_INEFFECTIVE`: Normally we don't allow\n"
"    locking sessions that are likely not any useful to lock, such as the X11\n"
"    part of a Wayland session (one could still use Wayland applicatione when\n"
"    locked) or VNC sessions (as it'd only lock the server side session while\n"
"    users will likely think they locked the client, allowing for an easy\n"
"    escape). These checks can be bypassed by setting this variable to 1. Not\n"
"    recommended other than for debugging XSecureLock itself via such\n"
"    connections.\n"
"*   `XSECURELOCK_DEBUG_WINDOW_INFO`: When complaining about another window\n"
"    misbehaving, print not just the window ID but also some info about it. Uses\n"
"    the `xwininfo` and `xprop` tools.\n"
"*   `XSECURELOCK_DIM_ALPHA`: Linear-space opacity to fade the screen to.\n"
"*   `XSECURELOCK_DIM_COLOR`: X11 color to fade the screen to.\n"
"*   `XSECURELOCK_DIM_FPS`: Target framerate to attain during the dimming effect\n"
"    of `dimmer`. Ideally matches the display refresh rate.\n"
"*   `XSECURELOCK_DIM_MAX_FILL_SIZE`: Maximum size (in width or height) to fill\n"
"    at once using an XFillRectangle call. Low values may cause performance loss\n"
"    or noticeable tearing during dimming; high values may cause crashes or hangs\n"
"    with some graphics drivers or a temporarily unresponsive X server.\n"
"*   `XSECURELOCK_DIM_OVERRIDE_COMPOSITOR_DETECTION`: When set to 1, always try\n"
"    to use transparency for dimming; when set to 0, always use a dither\n"
"    pattern. Default is to autodetect whether transparency will likely work.\n"
"*   `XSECURELOCK_DIM_TIME_MS`: Milliseconds to dim for when above xss-lock\n"
"    command line with `dimmer` is used; also used by `wait_nonidle` to know when\n"
"    to assume dimming and waiting has finished and exit.\n"
"*   `XSECURELOCK_DISCARD_FIRST_KEYPRESS`: If set to 0, the key pressed to stop\n"
"    the screen saver and spawn the auth child is sent to the auth child (and\n"
"    thus becomes part of the password entry). By default we always discard the\n"
"    key press that started the authentication flow, to prevent users from\n"
"    getting used to type their password on a blank screen (which could be just\n"
"    powered off and have a chat client behind or similar).\n"
"*   `XSECURELOCK_FONT`: X11 or FontConfig font name to use for `auth_x11`.\n"
"    You can get a list of supported font names by running `xlsfonts` and\n"
"    `fc-list`.\n"
"*   `XSECURELOCK_FORCE_GRAB`: When grabbing fails, try stealing the grab from\n"
"    other windows (a value of `2` steals from all descendants of the root\n"
"    window, while a value of `1` only steals from client windows). This works\n"
"    only sometimes and is incompatible with many window managers, so use with\n"
"    care. See the \"Forcing Grabs\" section below for details.\n"
"*   `XSECURELOCK_GLOBAL_SAVER`: specifies the desired global screen saver module\n"
"    (by default this is a multiplexer that runs `XSECURELOCK_SAVER` on each\n"
"    screen).\n"
"*   `XSECURELOCK_IDLE_TIMERS`: comma-separated list of idle time counters used\n"
"    by `until_nonidle`. Typical values are either empty (relies on the X Screen\n"
"    Saver extension instead), \"IDLETIME\" and \"DEVICEIDLETIME <n>\" where n is an\n"
"    XInput device index (run `xinput` to see them). If multiple time counters\n"
"    are specified, the idle time is the minimum of them all. All listed timers\n"
"    must have the same unit.\n"
"*   `XSECURELOCK_IMAGE_DURATION_SECONDS`: how long to show each still image\n"
"    played by `saver_mpv`. Defaults to 1.\n"
"*   `XSECURELOCK_KEY_%s_COMMAND` where `%s` is the name of an X11 keysym (find\n"
"    using `xev`): a shell command to execute when the specified key is pressed.\n"
"    Useful e.g. for media player control. Beware: be cautious about what you\n"
"    run with this, as it may yield attackers control over your computer.\n"
"*   `XSECURELOCK_LIST_VIDEOS_COMMAND`: shell command to list all video files to\n"
"    potentially play by `saver_mpv` or `saver_mplayer`. Defaults to\n"
"    `find ~/Videos -type f`.\n"
"*   `XSECURELOCK_NO_COMPOSITE`: disables covering the composite overlay window.\n"
"    This switches to a more traditional way of locking, but may allow desktop\n"
"    notifications to be visible on top of the screen lock. Not recommended.\n"
"*   `XSECURELOCK_NO_PAM_RHOST`: do not set `PAM_RHOST` to `localhost`, despite\n"
"    [recommendation](http://www.linux-pam.org/Linux-PAM-html/adg-security-user-identity.html)\n"
"    to do so by the Linux-PAM Application Developers' Guide. This may work\n"
"    around bugs in third-party PAM authentication modules. If this solves a\n"
"    problem for you, please report a bug against said PAM module.\n"
"*   `XSECURELOCK_NO_XRANDR`: disables multi monitor support using XRandR.\n"
"*   `XSECURELOCK_NO_XRANDR15`: disables multi monitor support using XRandR 1.5\n"
"    and fall back to XRandR 1.2. Not recommended.\n"
"*   `XSECURELOCK_PAM_SERVICE`: pam service name. You should have a file with\n"
"    that name in `/etc/pam.d`.\n"
"*   `XSECURELOCK_PASSWORD_PROMPT`: Choose password prompt mode:\n"
"    *   `asterisks`: shows asterisks, like classic password prompts. This is\n"
"        the least secure option because password length is visible.\n"
"            ***_\n"
"            *******_\n"
"    *   `cursor`: shows a cursor that jumps around on each key press. This is\n"
"        the default.\n"
"            ________|_______________________\n"
"            ___________________|____________\n"
"    *   `disco`: shows dancers, which dance around on each key press. Requires a\n"
"        font that can handle Unicode line drawing characters, and FontConfig.\n"
"            ┏(･o･)┛ ♪ ┗(･o･)┓ ♪ ┏(･o･)┛ ♪ ┗(･o･)┓ ♪ ┏(･o･)┛\n"
"            ┗(･o･)┓ ♪ ┏(･o･)┛ ♪ ┏(･o･)┛ ♪ ┏(･o･)┛ ♪ ┏(･o･)┛\n"
"    *   `emoji`: shows an emoji, changing which one on each key press. Requires\n"
"        a font that can handle emoji, and FontConfig.\n"
"            👍\n"
"            🎶\n"
"            💕\n"
"    *   `emoticon`: shows an ascii emoticon, changing which one on each key\n"
"        press.\n"
"            :-O\n"
"            d-X\n"
"            X-\\\n"
"    *   `hidden`: completely hides the password, and there's no feedback for\n"
"        keypresses. This would almost be most secure - however as it gives no\n"
"        feedback to input whatsoever, you may not be able to notice accidentally\n"
"        typing to another computer and sending your password to some chatroom.\n"
"        ```\n"
"        ```\n"
"    *   `kaomoji`: shows a kaomoji (Japanese emoticon), changing which one on\n"
"        each key press. Requires a Japanese font, and FontConfig.\n"
"            (͡°͜ʖ͡°)\n"
"            (＾ｕ＾)\n"
"            ¯\\_(ツ)_/¯\n"
"    *   `time`: shows the current time since the epoch on each keystroke. This\n"
"        may be the most secure mode, as it gives feedback to keystroke based\n"
"        exclusively on public information, and does not carry over any state\n"
"        between keystrokes whatsoever - not even some form of randomness.\n"
"            1559655410.922329\n"
"    *   `time_hex`: same as `time`, but in microseconds and hexadecimal.\n"
"        \"Because we can\".\n"
"            0x58a7f92bd7359\n"
"*   `XSECURELOCK_SAVER`: specifies the desired screen saver module.\n"
"*   `XSECURELOCK_SAVER_RESET_ON_AUTH_CLOSE`: specifies whether to reset the\n"
"    saver module when the auth dialog closes. Resetting is done by sending\n"
"    `SIGUSR1` to the saver, which may either just terminate, or handle this\n"
"    specifically to do a cheaper reset.\n"
"*   `XSECURELOCK_SHOW_DATETIME`: whether to show local date and time on the\n"
"    login. Disabled by default.\n"
"*   `XSECURELOCK_SHOW_HOSTNAME`: whether to show the hostname on the login\n"
"    screen of `auth_x11`. Possible values are 0 for not showing the\n"
"    hostname, 1 for showing the short form, and 2 for showing the long form.\n"
"*   `XSECURELOCK_SHOW_KEYBOARD_LAYOUT`: whether to show the name of the current\n"
"    keyboard layout. Enabled by default.\n"
"*   `XSECURELOCK_SHOW_USERNAME`: whether to show the username on the login\n"
"    screen of `auth_x11`.\n"
"*   `XSECURELOCK_SINGLE_AUTH_WINDOW`: whether to show only a single auth window\n"
"    from `auth_x11`, as opposed to one per screen.\n"
"*   `XSECURELOCK_SWITCH_USER_COMMAND`: shell command to execute when `Win-O` or\n"
"    `Ctrl-Alt-O` are pressed (think \"_other_ user\"). Typical values could be\n"
"    `lxdm -c USER_SWITCH`, `dm-tool switch-to-greeter`, `gdmflexiserver` or\n"
"    `kdmctl reserve`, depending on your desktop environment.\n"
"*   `XSECURELOCK_VIDEOS_FLAGS`: flags to append when invoking mpv/mplayer with\n"
"    `saver_mpv` or `saver_mplayer`. Defaults to empty.\n"
"*   `XSECURELOCK_WAIT_TIME_MS`: Milliseconds to wait after dimming (and before\n"
"    locking) when above xss-lock command line is used. Should be at least as\n"
"    large as the period time set using \"xset s\". Also used by `wait_nonidle` to\n"
"    know when to assume dimming and waiting has finished and exit.\n"
"*   `XSECURELOCK_SAVER_DELAY_MS`: Milliseconds to wait after starting\n"
"    children process and before mapping windows to let children be\n"
"    ready to display and reduce the black flash.\n"
"*   `XSECURELOCK_SAVER_STOP_ON_DPMS`: specifies if saver is stopped\n"
"    when DPMS blanks the screen (to save power).\n"
"*   `XSECURELOCK_XSCREENSAVER_PATH`: Location where XScreenSaver hacks are\n"
"    installed for use by `saver_xscreensaver`.\n"