-
Notifications
You must be signed in to change notification settings - Fork 49
wf‐locker
wf-locker provides a screen locker for wlroots environments that support session locking.
Accepted Values : boolean
Default Value : true
Whether to use the current image shown by wf-background. If true then it will update to match the currently shown background image from wf-background.
Accepted Values : any valid CSS color
Default Value: #0000 - transparent
A CSS color to display if background_image is false or if wf-background has not provided an image to show.
Accepted Values: double, Minimum 0.0 Default Value: 5.0
The time frame, in seconds, after the last user interaction in which the lockscreen contents (password box, currently playing etc) will hide themselves again.
Accepted Values: See table below Default Value: 1
The animation with which lockscreen contents show and hide themselves.
| Value | Name | Description |
|---|---|---|
| 0 | None | No transition, instant |
| 1 | Fade | Contents fade in and out |
| 2 | Slide Down | Contents slide down from their original location |
| 3 | Slide Left | |
| 4 | Slide Right | |
| 5 | Slide Up | |
| 6 | Swing Down | Content swing down from their original location |
| 7 | Swing Left | |
| 8 | Swing Right | |
| 9 | Swing Up |
Accepted Values: double, minimum of 0.0 Default Value: 0.4
The time, in seconds, that hide_anim takes to transition.
Accepted Values: double, minimum of 0.0 and maximum of 9.0 Default Value: 1.0
The time, in seconds, in which the user may interupt the lockscreen without any authentication.
When the lockscreen starts this timer begins, and if the user:
- presses a key
- touches the touchscreen
- jogs the cursor
then the lockscreen is dismissed as if the user had fully authenticated.
Accepted Values: integer, minimum 1 Default Value: 5
The number of failed authentications which will cause a lockout. During lockout all the available authentication methods are disabled.
Accepted Values: integer, minimum 10 Default Value: 10
The time, in seconds, that a lockout remains in effect.
Accepted Values: Positions Default Value : center-center
Where the password entry should be placed on the lockscreen.
Accepted Values: boolean Default: false
If the password entry should remain visible even when the lockscreen is inactive.
Accepted Values: boolean Default: true
If the PIN pad should be visible and usable for authentication. If the user has no saved PIN-hash then this setting is ignored and the PIN pad remains hidden.
Accepted Values: Positions Default Value: bottom-center
The position of the PIN pad in the lockscreen
Accepted Values: Font Default Value: 2em default
The font to use for the buttons of the PIN pad.
Accepted Values: Font Default Value: 2em default
The font to use for the asterisks shown above the PIN pad
Accepted Values: boolean Default Value: false
If the PIN pad should remain visible when the lockscreen is idle
Accepted Values: boolean Default Value: true
If the fingerprint reader can be used for authentication. If fprintd is not intalled or there is no valid hardware then this is ignored and the module remains disabled.
Accepted Values: Positions Default Value: center-right
The position to show the fingerprint reader status on the lockscreen
Accepted Values: Font Default Value: 2em default
The font used to relay messages from the fingerprint reader
Accepted Values: double, minimum 0.5, maximum 20 Default Value: 10.0
The size of the fingerprint icon. Scale is in em, where 1em is 1x the font-size.
Accepted Values: double, minimum 0.5, maximum 20 Default Values: 7.0
The size of the status icon over top of the fingerprint. Used to give quick feedback on the state of the fingerprint reader. Size is in em as above.
Accepted Values: boolean Default Value: false
If the fingerprint reader should remain visible when the lockscreen is inactive. Please note the reader remains functional even if the widget is hidden by inactivity.
Accepted Values: boolean Default Value: true
If the network widget should be shown
Accepted Values: Positions Default Value: top-right
The position of the network widget on the lockscreen
Accepted Values: boolean Default Value: true
If the network widget should remain visible when the lockscreen is inactive
Accepted Values: Font Default Value: 2em default
The font used for the label of the network widget
Accepted Values: double, minimum 0.1, maximum 10.0 Default Value: 1.0
The size of the icon of the network widget, in em
Accepted Values: boolean Default Value: true
If the clock should be shown on the lockscreen
Accepted Values: Positions Default Value: top-center
The position of the clock widget on the lockscreen
Accepted Values: See description
Default Value: %H:%M%n<span font-size='xx-small'>%e %b %Y</span>
The contents of the clock label.
Uses Pango Markup for sizes, colors. The string MUST NOT contain < and > and MAY contain > and < to portray these characters
Also Uses Date formatting which is duplicated below:
| Symbols | Meaning |
|---|---|
| %% | a literal % |
| %a | locale's abbreviated weekday name (e.g., Sun) |
| %A | locale's full weekday name (e.g., Sunday) |
| %b | locale's abbreviated month name (e.g., Jan) |
| %B | locale's full month name (e.g., January) |
| %c | locale's date and time (e.g., Thu Mar 3 23:05:25 2005) |
| %C | century; like %Y, except omit last two digits (e.g., 20) |
| %d | day of month (e.g., 01) |
| %D | date (ambiguous); same as %m/%d/%y |
| %e | day of month, space padded; same as %_d |
| %F | full date; like %+4Y-%m-%d |
| %g | last two digits of year of ISO week number (ambiguous; 00-99); see %G |
| %G | year of ISO week number; normally useful only with %V |
| %h | same as %b |
| %H | hour (00..23) |
| %I | hour (01..12) |
| %j | day of year (001..366) |
| %k | hour, space padded ( 0..23); same as %_H |
| %l | hour, space padded ( 1..12); same as %_I |
| %m | month (01..12) |
| %M | minute (00..59) |
| %n | a newline |
| %N | nanoseconds (000000000..999999999) |
| %p | locale's equivalent of either AM or PM; blank if not known |
| %P | like %p, but lower case |
| %q | quarter of year (1..4) |
| %r | locale's 12-hour clock time (e.g., 11:11:04 PM) |
| %R | 24-hour hour and minute; same as %H:%M |
| %s | seconds since the Epoch (1970-01-01 00:00 UTC) |
| %S | second (00..60) |
| %t | a tab |
| %T | time; same as %H:%M:%S |
| %u | day of week (1..7); 1 is Monday |
| %U | week number of year, with Sunday as first day of week (00..53) |
| %V | ISO week number, with Monday as first day of week (01..53) |
| %w | day of week (0..6); 0 is Sunday |
| %W | week number of year, with Monday as first day of week (00..53) |
| %x | locale's date (can be ambiguous; e.g., 12/31/99) |
| %X | locale's time representation (e.g., 23:13:48) |
| %y | last two digits of year (ambiguous; 00..99) |
| %Y | year |
| %z | +hhmm numeric time zone (e.g., -0400) |
| %:z | +hh:mm numeric time zone (e.g., -04:00) |
| %::z | +hh:mm:ss numeric time zone (e.g., -04:00:00) |
| %:::z | numeric time zone with : to necessary precision (e.g., -04, +05:30) |
| %Z | alphabetic time zone abbreviation (e.g., EDT) |
By default, date pads numeric fields with zeroes. The following optional flags may follow '%':
| - (hyphen) | do not pad the field |
| _ (underscore) | pad with spaces |
| 0 (zero) | pad with zeros |
| + | pad with zeros, and put '+' before future years with >4 digits |
| ^ | use upper case if possible |
| # | use opposite case if possible |
Accepted Values: boolean Default Value: true
If the clock widget should show even when lockscreen is idle
Accepted Values: Font Default Value: 3em default
The font used to show the clock widget
Accepted Values: boolean Default Value: true
Requires Weather Data. If Weather data is unavailable then this setting is ignored and the widget is hidden
Accepted Values: Positions Default Value: bottom-left
The position of the weather widget on the lockscreen
Accepted Values: Font Default Value: 4em default
The font used to show the weather widget
Accepted Values: double, minimum 0.5, maximum 10 Default Value: 5.0
The size of the status icon on the weather widget. Size is in em as above.
Accepted Values: boolean Default Value: true
If the weather widget should remain visible when the lockscreen is inactive.
Accepted Values: boolean Default Value: true
If the user avatar icon and name should be shown on lockscreen
Accepted Values: Positions Default Value: center-center
The position of the user widget on the lockscreen
Accepted Values: Font Default Value: 3em default
The font to use for the user name.
Accepted Values: double, minimum 0.5, maximum 20 Default Value: 10.0
The size of the users avatar image. Scale is in em, where 1em is 1x the font-size.
Accepted Values: boolean Default Value: true
If the user name and avatar image should remain shown when the lockscreen is inactive
Accepted Values: boolean Default Value: true
If widgets and controls for media playback are shown on the lockscreen. Will show one controller for each player playing or paused.
Accepted Values: See below
Default Value: Now Playing:%n%track%n%album%n%artist
The message to show next to the album art.
| tag | contents |
|---|---|
| %n | Newline |
| %track | The track name |
| %album | The album name |
| %artist | The artist |
Accepted Values: boolean Default Value: true
If controls should be added to the widget. Without it, the unauthenticated user may only see the state of the players, and not interact with them.
Accepted Values: Positions Default Value: bottom-right
The position of the widget on the lockscreen
Accepted Values: boolean Default Value: false
If the widget should remain visible when the lockscreen is inactive. It is worth noting that when a players state changes (eg, started, stopped, track changed) the widget will temporarily be shown again, even if the lockscreen is inactive.
Accepted Values: double, minimum 0.5, maximum 20 Default Value: 5.0
The size of the album art. Scale is in em, where 1em is 1x the font-size.
Accepted Values: Font Default Value: 1em default
The font to use for the player information
Accepted Values: boolean Default Value: true
Show the battery status widget. If there is no system battery available, this setting is ignored and the widget is not shown.
Accepted Values: icon, percentage, full
Default Value: percentage
How to display information about the battery status.
| type | description |
|---|---|
| icon | Only show an icon |
| percentage | Show an icon and the percentage next to it |
| full | Show an icon, the percentage and a longer description of the charging or discharging state |
Accepted Values: Positions Default Value: top-left
The position of the widget on the lockscreen
Accepted Values: Font Default Value: 3em default
The font to use for the battery percentage
Accepted Values: Font Default Value: 0em default
The font to use for the battery status
Accepted Values: double, minimum 0.5, maximum 10 Default Value: 3.0
The size of the battery icon. Scale is in em, where 1em is 1x the font-size.
Accepted Values: boolean Default Value: true
If the widget should show even when the lockscreen is inactive
Accepted Values: boolean Default Value: true
If volume controls should be displayed on the lockscreen.
Accepted Values: Positions Default Value: top-right
The position of the widget on the lockscreen
Accepted Values: boolean Default Value: false
If the controls should be visible even when the lockscreen is inactive
Accepted Values: double, minimum 0.5, maximum 10 Default Value: 2.0
The size of the volume controls. Scale is in em, where 1em is 1x the font-size.
Please note this feature is intentionally insecure and should not be used. It displays a button which, when clicked, counts as a complete user authentication. Obviously this is stupidly insecure. It is here for debugging purposes only.
Accepted Values: boolean Default Value: false
If the instant unlock widget should be shown and used to authentication
Accepted Values: Positions Default Value: top-right
The position of the widget on the lockscreen.
Accepted Values: boolean Default Value: false
If the widget should remain visible even when the lockscreen is inactive
Accepted Values: Font Default Value: default
The font to use unlock button
There are 9 locations in the lockscreen :
| top-left | top-center | top-right |
|---|---|---|
| center-left | center-center | center-right |
| bottom-left | bottom-center | bottom-right |
If multiple widgets are assigned to the same position then they are placed in name order, top-to-bottom