diff options
author | Drew DeVault <sir@cmpwn.com> | 2018-10-27 17:10:00 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-10-27 17:10:00 +0200 |
commit | 707f3ad2750d74a46ff859439e87acc661b599f5 (patch) | |
tree | b1cb2dff1279ee02107add85cf6563d60b8af860 | |
parent | Revert "Fix #2992" (diff) | |
parent | added fish completions for swaynag (diff) | |
download | sway-707f3ad2750d74a46ff859439e87acc661b599f5.tar.gz sway-707f3ad2750d74a46ff859439e87acc661b599f5.tar.zst sway-707f3ad2750d74a46ff859439e87acc661b599f5.zip |
Merge pull request #3001 from madblobfish/swaylock-completions-and-manpage
Reworked fish completions and moved stuff in swaylock manpage
-rw-r--r-- | completions/fish/swayidle.fish | 3 | ||||
-rw-r--r-- | completions/fish/swaylock.fish | 38 | ||||
-rw-r--r-- | completions/fish/swaynag.fish | 29 | ||||
-rw-r--r-- | meson.build | 2 | ||||
-rw-r--r-- | swaylock/swaylock.1.scd | 26 |
5 files changed, 81 insertions, 17 deletions
diff --git a/completions/fish/swayidle.fish b/completions/fish/swayidle.fish new file mode 100644 index 00000000..71279925 --- /dev/null +++ b/completions/fish/swayidle.fish | |||
@@ -0,0 +1,3 @@ | |||
1 | # swayidle | ||
2 | complete -c swayidle -s h --description 'show help' | ||
3 | complete -c swayidle -s d --description 'debug' | ||
diff --git a/completions/fish/swaylock.fish b/completions/fish/swaylock.fish index 965a22d2..99dff48f 100644 --- a/completions/fish/swaylock.fish +++ b/completions/fish/swaylock.fish | |||
@@ -1,11 +1,39 @@ | |||
1 | # swaylock(1) completion | 1 | # swaylock(1) completion |
2 | 2 | ||
3 | complete -c swaylock -s C -l config --description 'The config file to use. Default: $HOME/.swaylock/config, $XDG_CONFIG_HOME/swaylock/config, and SYSCONFDIR/swaylock/config.' | ||
3 | complete -c swaylock -s h -l help --description "Show help message and quit." | 4 | complete -c swaylock -s h -l help --description "Show help message and quit." |
4 | complete -c swaylock -s c -l color --description "Turn the screen into the given color. If -i is used, this sets the background of the image into the given color. Defaults to white (ffffff), or transparent (00000000) if an image is in use." | ||
5 | complete -c swaylock -s f -l daemonize --description "Fork into the background after spawning. Note: this is the default bahavior of i3lock." | 5 | complete -c swaylock -s f -l daemonize --description "Fork into the background after spawning. Note: this is the default bahavior of i3lock." |
6 | complete -c swaylock -s v -l version --description "Show the version number and quit." | ||
7 | complete -c swaylock -s s -l socket --description "Use the specified socket path. Otherwise, swaymsg will as sway where the socket is (which is the value of $SWAYSOCK, then of $I350CK)." | ||
8 | complete -c swaylock -s e -l ignore-empty-password --description 'When an empty password is provided by the user, do not validate it.' | ||
9 | |||
10 | # Appearance | ||
11 | complete -c swaylock -s u -l no-unlock-indicator --description "Disable the unlock indicator." | ||
6 | complete -c swaylock -s i -l image --description "Display the given image, optionally on the given output. Use -c to set a background color." | 12 | complete -c swaylock -s i -l image --description "Display the given image, optionally on the given output. Use -c to set a background color." |
7 | complete -c swaylock -l scaling --description "Scaling mode for images: stretch, fill, fit, center, or tile." | 13 | complete -c swaylock -s s -l scaling --description "Scaling mode for images: stretch, fill, fit, center, or tile." |
8 | complete -c swaylock -s t -l tiling --description "Same as --scaling=tile." | 14 | complete -c swaylock -s t -l tiling --description "Same as --scaling=tile." |
9 | complete -c swaylock -s u -l no-unlock-indicator --description "Disable the unlock indicator." | 15 | complete -c swaylock -s c -l color --description "Turn the screen into the given color. If -i is used, this sets the background of the image into the given color. Defaults to white (ffffff), or transparent (00000000) if an image is in use." |
10 | complete -c swaylock -s v -l version --description "Show the version number and quit." | 16 | complete -c swaylock -l bs-hl-color --description 'Sets the color of backspace highlight segments.' |
11 | complete -c swaylock -l socket --description "Use the specified socket path. Othherwise, swaymsg will as sway where the socket is (which is the value of $SWAYSOCK, then of $I350CK)." | 17 | complete -c swaylock -l font --description 'Sets the font of the text inside the indicator.' |
18 | complete -c swaylock -l indicator-radius --description 'Sets the radius of the indicator to radius pixels. Default: 50' | ||
19 | complete -c swaylock -l indicator-thickness --description 'Sets the thickness of the indicator to thickness pixels. Default: 10' | ||
20 | complete -c swaylock -l inside-color --description 'Sets the color of the inside of the indicator when typing or idle.' | ||
21 | complete -c swaylock -l inside-clear-color --description 'Sets the color of the inside of the indicator when cleared.' | ||
22 | complete -c swaylock -l inside-ver-color --description 'Sets the color of the inside of the indicator when verifying.' | ||
23 | complete -c swaylock -l inside-wrong-color --description 'Sets the color of the inside of the indicator when invalid.' | ||
24 | complete -c swaylock -l key-hl-color --description 'Sets the color of key press highlight segments.' | ||
25 | complete -c swaylock -l line-color --description 'Sets the color of the lines that separate the inside and outside of the indicator when typing or idle.' | ||
26 | complete -c swaylock -l line-clear-color --description 'Sets the color of the lines that separate the inside and outside of the indicator when cleared.' | ||
27 | complete -c swaylock -l line-ver-color --description 'Sets the color of the lines that separate the inside and outside of the indicator when verifying.' | ||
28 | complete -c swaylock -l line-wrong-color --description 'Sets the color of the lines that separate the inside and outside of the indicator when invalid.' | ||
29 | complete -c swaylock -s n -l line-uses-inside --description 'Use the color of the inside of the indicator for the line separating the inside and outside of the indicator.' | ||
30 | complete -c swaylock -s r -l line-uses-ring --description 'Use the outer ring\'s color for the line separating the inside and outside of the indicator.' | ||
31 | complete -c swaylock -l ring-color --description 'Sets the color of the outside of the indicator when typing or idle.' | ||
32 | complete -c swaylock -l ring-clear-color --description 'Sets the color of the outside of the indicator when cleared.' | ||
33 | complete -c swaylock -l ring-ver-color --description 'Sets the color of the outside of the indicator when verifying.' | ||
34 | complete -c swaylock -l ring-wrong-color --description 'Sets the color of the outside of the indicator when invalid.' | ||
35 | complete -c swaylock -l separator-color --description 'Sets the color of the lines that separate highlight segments.' | ||
36 | complete -c swaylock -l text-color --description 'Sets the color of the text inside the indicator when typing or idle.' | ||
37 | complete -c swaylock -l text-clear-color --description 'Sets the color of the text inside the indicator when cleared.' | ||
38 | complete -c swaylock -l text-ver-color --description 'Sets the color of the text inside the indicator when verifying.' | ||
39 | complete -c swaylock -l text-wrong-color --description 'Sets the color of the text inside the indicator when invalid.' | ||
diff --git a/completions/fish/swaynag.fish b/completions/fish/swaynag.fish new file mode 100644 index 00000000..784d7fad --- /dev/null +++ b/completions/fish/swaynag.fish | |||
@@ -0,0 +1,29 @@ | |||
1 | # swaynag | ||
2 | complete -c swaynag -s C -l config --description 'The config file to use. Default: $HOME/.swaylock/config, $XDG_CONFIG_HOME/swaylock/config, and SYSCONFDIR/swaylock/config.' | ||
3 | complete -c swaynag -s d -l debug --description 'Enable debugging.' | ||
4 | complete -c swaynag -s e -l edge --description 'Set the edge to use: top or bottom' | ||
5 | complete -c swaynag -s f -l font --description 'Set the font to use.' | ||
6 | complete -c swaynag -s h -l help --description 'Show help message and quit.' | ||
7 | complete -c swaynag -s b -l button --description 'Create a button with a text and an action which is executed when pressed. Multiple buttons can be defined by providing the flag multiple times.' | ||
8 | complete -c swaynag -s l -l detailed-message --description 'Read a detailed message from stdin. A button to toggle details will be added. Details are shown in a scrollable multi-line text area.' | ||
9 | complete -c swaynag -s L -l detailed-button --description 'Set the text for the button that toggles details. This has no effect if there is not a detailed message. The default is "Toggle details".' | ||
10 | complete -c swaynag -s m -l message --description 'Set the message text.' | ||
11 | complete -c swaynag -s o -l output --description 'Set the output to use.' | ||
12 | complete -c swaynag -s s -l dismiss-button --description 'Sets the text for the dismiss nagbar button. The default is "X".' | ||
13 | complete -c swaynag -s t -l type --description 'Set the message type. Two types are created by default "error" and "warning". Custom types can be defined in the config file.' | ||
14 | complete -c swaynag -s v -l version --description 'Show the version number and quit.' | ||
15 | |||
16 | # Appearance | ||
17 | complete -c swaynag -l background --description 'Set the color of the background.' | ||
18 | complete -c swaynag -l border --description 'Set the color of the border.' | ||
19 | complete -c swaynag -l border-bottom --description 'Set the color of the bottom border.' | ||
20 | complete -c swaynag -l button-background --description 'Set the color for the background for buttons.' | ||
21 | complete -c swaynag -l text --description 'Set the text color.' | ||
22 | complete -c swaynag -l border-bottom-size --description 'Set the thickness of the bottom border.' | ||
23 | complete -c swaynag -l message-padding --description 'Set the padding for the message.' | ||
24 | complete -c swaynag -l details-border-size --description 'Set the thickness for the details border.' | ||
25 | complete -c swaynag -l button-border-size --description 'Set the thickness for the button border.' | ||
26 | complete -c swaynag -l button-gap --description 'Set the size of the gap between buttons.' | ||
27 | complete -c swaynag -l button-dismiss-gap --description 'Set the size of the gap between the dismiss button and another button.' | ||
28 | complete -c swaynag -l button-margin-right --description 'Set the margin from the right of the dismiss button to edge.' | ||
29 | complete -c swaynag -l button-padding --description 'Set the padding for the button text.' | ||
diff --git a/meson.build b/meson.build index 1e2b53fa..6b23b4e3 100644 --- a/meson.build +++ b/meson.build | |||
@@ -244,8 +244,10 @@ endif | |||
244 | if (get_option('fish-completions')) | 244 | if (get_option('fish-completions')) |
245 | fish_files = files( | 245 | fish_files = files( |
246 | 'completions/fish/sway.fish', | 246 | 'completions/fish/sway.fish', |
247 | 'completions/fish/swayidle.fish', | ||
247 | 'completions/fish/swaylock.fish', | 248 | 'completions/fish/swaylock.fish', |
248 | 'completions/fish/swaymsg.fish', | 249 | 'completions/fish/swaymsg.fish', |
250 | 'completions/fish/swaynag.fish', | ||
249 | ) | 251 | ) |
250 | fish_install_dir = datadir + '/fish/completions' | 252 | fish_install_dir = datadir + '/fish/completions' |
251 | 253 | ||
diff --git a/swaylock/swaylock.1.scd b/swaylock/swaylock.1.scd index 3107124f..8ddc7d3a 100644 --- a/swaylock/swaylock.1.scd +++ b/swaylock/swaylock.1.scd | |||
@@ -21,20 +21,25 @@ Locks your Wayland session. | |||
21 | All leading dashes should be omitted and the equals sign is required for | 21 | All leading dashes should be omitted and the equals sign is required for |
22 | flags that take an argument. | 22 | flags that take an argument. |
23 | 23 | ||
24 | *-c, --color* <rrggbb[aa]> | ||
25 | Turn the screen into the given color. If -i is used, this sets the | ||
26 | background of the image to the given color. Defaults to white (FFFFFF), or | ||
27 | transparent (00000000) if an image is in use. | ||
28 | |||
29 | *-e, --ignore-empty-password* | 24 | *-e, --ignore-empty-password* |
30 | When an empty password is provided by the user, do not validate it. | 25 | When an empty password is provided by the user, do not validate it. |
31 | 26 | ||
32 | *-f, --daemonize* | 27 | *-f, --daemonize* |
33 | Detach from the controlling terminal after locking. | 28 | Detach from the controlling terminal after locking. |
34 | 29 | ||
30 | Note: this is the default bahavior of i3lock. | ||
31 | |||
35 | *-h, --help* | 32 | *-h, --help* |
36 | Show help message and quit. | 33 | Show help message and quit. |
37 | 34 | ||
35 | *-v, --version* | ||
36 | Show the version number and quit. | ||
37 | |||
38 | # APPEARANCE | ||
39 | |||
40 | *-u, --no-unlock-indicator* | ||
41 | Disable the unlock indicator. | ||
42 | |||
38 | *-i, --image* [<output>:]<path> | 43 | *-i, --image* [<output>:]<path> |
39 | Display the given image, optionally only on the given output. Use -c to set | 44 | Display the given image, optionally only on the given output. Use -c to set |
40 | a background color. | 45 | a background color. |
@@ -45,13 +50,10 @@ Locks your Wayland session. | |||
45 | *-t, --tiling* | 50 | *-t, --tiling* |
46 | Same as --scaling=tile. | 51 | Same as --scaling=tile. |
47 | 52 | ||
48 | *-u, --no-unlock-indicator* | 53 | *-c, --color* <rrggbb[aa]> |
49 | Disable the unlock indicator. | 54 | Turn the screen into the given color. If -i is used, this sets the |
50 | 55 | background of the image to the given color. Defaults to white (FFFFFF), or | |
51 | *-v, --version* | 56 | transparent (00000000) if an image is in use. |
52 | Show the version number and quit. | ||
53 | |||
54 | # APPEARANCE | ||
55 | 57 | ||
56 | *--bs-hl-color* <rrggbb[aa]> | 58 | *--bs-hl-color* <rrggbb[aa]> |
57 | Sets the color of backspace highlight segments. | 59 | Sets the color of backspace highlight segments. |