Customisable, minimalist screen locker for Wayland
doc: move defaults into examples directory
+61
-61
+3
-61
doc/config.md
+3
-61
doc/config.md
···
5
5
- `/etc/nlock/nlock.toml`, system-wide configuration
6
6
- `~/.config/nlock/nlock.toml`, user configuration
7
7
8
-
Configuration files are TOML formatted. The following example demonstrates all
9
-
the available configuration options (this might not be up-to-date).
10
-
11
-
```toml
12
-
# The values defined in this example are the defaults used by nlock
13
-
14
-
# General configuration options
15
-
[general]
16
-
allowEmptyPassword = false # allow a blank password to be validated
17
-
hideCursor = true # hide the mouse cursor
18
-
backgroundType = "color" # background type "color", or "image"
19
-
20
-
# Colors section configures, well, colors.
21
-
[colors]
22
-
# Colors are in either #RRGGBBAA or #RRGGBB format,
23
-
# both #RRGGBBAA in this case.
24
-
background = "#000000FF" # background color, same as "#000000"
25
-
text = "#FFFFFFFF" # text color, same as "#FFFFFF"
26
-
inputBackground = "#000000FF" # input box background color
27
-
inputBorder = "#000000FF" # input box border color
28
-
frameBorderIdle = "#00000000" # frame border idle color
29
-
frameBorderSuccess = "#00000000" # frame border success color
30
-
frameBorderFail = "#FF0000FF" # frame border error color
31
-
32
-
# Font section configures text display.
33
-
[font]
34
-
size = 72.0 # font size, in points
35
-
useDpiScaling = false # whether to scale font size based on output DPI
36
-
37
-
# Font family uses Cairo's toy font API, generally, standard CSS names
38
-
# like `monospace`, `serif`, etc. should work. Leaving it empty (or invalid)
39
-
# will select the system default.
40
-
family = ""
41
-
42
-
slant = "normal" # font slant, either "normal", "italic", or "oblique"
43
-
weight = "normal" # font weight, either "normal", or "bold"
44
-
45
-
# Input section configures the password input box.
46
-
[input]
47
-
maskChar = "*" # character displayed in place of password characters
48
-
width = 0.5 # width of the input box, relative to display width
49
-
paddingX = 0.05 # input box horizontal padding, relative to display width
50
-
paddingY = 0.05 # input box vertical padding, relative to display height
51
-
radius = 0.0 # radius of input box corners, relative to total box height
52
-
border = 0.0 # width of input box border, absolute, typically pixels
53
-
54
-
visible = "always" # input box visibility, "never", "content", "always"
55
-
fitToContent = false # resize input box to fit password, up to `width`
56
-
57
-
# Frame section configures everything around the input box.
58
-
[frame]
59
-
border = 25.0 # width of frame border, absolute units, typically pixels
60
-
radius = 0.0 # radius of frame border, absolute units, typically pixels
61
-
62
-
[image]
63
-
path = "" # full path to background image, does not support shell expansions
64
-
scale = "fill" # background image scaling, "center", "fit", "fill", "stretch", "tile"
65
-
```
66
-
67
-
Further configuration values are likely to be added in the future. Hopefully,
68
-
the above example will be updated when they are.
8
+
Configuration files are TOML formatted. The example configuration file can
9
+
be found [here](../examples/default.toml) demonstrating all available
10
+
configuration options.
69
11
70
12
If you specify invalid values in a configuration file, nlock will either show
71
13
an error, or continue with defaults if possible.
+5
examples/README.md
+5
examples/README.md
+53
examples/default.toml
+53
examples/default.toml
···
1
+
# The values defined in this example are the defaults used by nlock
2
+
3
+
# General configuration options
4
+
[general]
5
+
allowEmptyPassword = false # allow a blank password to be validated
6
+
hideCursor = true # hide the mouse cursor
7
+
backgroundType = "color" # background type "color", or "image"
8
+
9
+
# Colors section configures, well, colors.
10
+
[colors]
11
+
# Colors are in either #RRGGBBAA or #RRGGBB format,
12
+
# both #RRGGBBAA in this case.
13
+
background = "#000000FF" # background color, same as "#000000"
14
+
text = "#FFFFFFFF" # text color, same as "#FFFFFF"
15
+
inputBackground = "#000000FF" # input box background color
16
+
inputBorder = "#000000FF" # input box border color
17
+
frameBorderIdle = "#00000000" # frame border idle color
18
+
frameBorderSuccess = "#00000000" # frame border success color
19
+
frameBorderFail = "#FF0000FF" # frame border error color
20
+
21
+
# Font section configures text display.
22
+
[font]
23
+
size = 72.0 # font size, in points
24
+
useDpiScaling = false # whether to scale font size based on output DPI
25
+
26
+
# Font family uses Cairo's toy font API, generally, standard CSS names
27
+
# like `monospace`, `serif`, etc. should work. Leaving it empty (or invalid)
28
+
# will select the system default.
29
+
family = ""
30
+
31
+
slant = "normal" # font slant, either "normal", "italic", or "oblique"
32
+
weight = "normal" # font weight, either "normal", or "bold"
33
+
34
+
# Input section configures the password input box.
35
+
[input]
36
+
maskChar = "*" # character displayed in place of password characters
37
+
width = 0.5 # width of the input box, relative to display width
38
+
paddingX = 0.05 # input box horizontal padding, relative to display width
39
+
paddingY = 0.05 # input box vertical padding, relative to display height
40
+
radius = 0.0 # radius of input box corners, relative to total box height
41
+
border = 0.0 # width of input box border, absolute, typically pixels
42
+
43
+
visible = "always" # input box visibility, "never", "content", "always"
44
+
fitToContent = false # resize input box to fit password, up to `width`
45
+
46
+
# Frame section configures everything around the input box.
47
+
[frame]
48
+
border = 25.0 # width of frame border, absolute units, typically pixels
49
+
radius = 0.0 # radius of frame border, absolute units, typically pixels
50
+
51
+
[image]
52
+
path = "" # full path to background image, does not support shell expansions
53
+
scale = "fill" # background image scaling, "center", "fit", "fill", "stretch", "tile"