Options' reference

programs.snenslock.enable

Whether to enable snenslock.

Type: boolean

Default: false

Example: true

programs.snenslock.disableFallbackToRoot

Whether to disable authenticating as root after each N failed attempts.

Type: boolean

Default: false

programs.snenslock.fixExternalMonitorsInSway

Whether to enable fixing mode of external monitors in sway.

Type: boolean

Default: false

Example: true

programs.snenslock.greeter

Which greeter to use to unlock the machine.

Type: one of “minimal”, “tui”

Default: "minimal"

programs.snenslock.greeterCfg.tui.asterisk_char

Character to use as asterisk.

Type: string matching the pattern ^.{1}$

Default: "*"

programs.snenslock.greeterCfg.tui.clock_format

Format of the clock in the lockscreen.

Type: string

Default: "%a %d %b %H:%M"

programs.snenslock.greeterCfg.tui.form_width

Width of the TUI login form.

Type: positive integer, meaning >0

Default: 50

programs.snenslock.greeterCfg.tui.no_asterisks

Whether to disable asterisks for passwords.

Type: boolean

Default: false

programs.snenslock.greeterCfg.tui.refresh_seconds

Seconds after which the clock gets refreshed.

Type: positive integer, meaning >0

Default: 1

programs.snenslock.greeterCfg.tui.relative_battery_refresh

Update times of the battery indicator relative to the refresh time of the UI itself (currently configured via ).

By default this is 10 whereas the UI gets refreshed every second (implying that the tui renderer loop gets executed 10 times). Every tenth iteration (=every ~10 seconds) the battery status also gets updated.

Type: unsigned integer, meaning >=0

Default: 10

programs.snenslock.greeterCfg.tui.show_battery_status

Whether to enable displaying battery capacity & charging status at the bottom right.

Type: boolean

Default: false

Example: true

programs.snenslock.hooks.afterLockCommands

Commands to execute after the lock has finished. Useful to perform commands such as resuming running music, clearing cached gpg passphrases etc.

Type: strings concatenated with “\n”

Default: ""

programs.snenslock.hooks.beforeLockCommands

Commands to execute before starting the lcokscreen. Useful for e.g. pausing music etc.

Type: strings concatenated with “\n”

Default: ""

programs.snenslock.poweroffAfter

After how many failed attempts the machine should be powered off.

Type: null or (positive integer, meaning >0)

Default: null

programs.snenslock.rootAtAuthTimes

After each N attempts to authenticate as the locking user, an unlock as root is attempted.

Type: positive integer, meaning >0

Default: 5

programs.snenslock.screenlockGroup

Name of the group that’s allowed to invoke the screen-lock. If the group is the default group (snenslock), it is created by the module. If you choose another group, you need to create it on your own (since it indicates that you want to use a custom group that you manage on yoru own for locking).

Type: string

Default: "screenlock"