Fix, clean up and sync docs and completions

This commit is contained in:
Olegs Jeremejevs 2019-09-12 18:15:18 +03:00 committed by Drew DeVault
parent ba31e2eaee
commit 426e1ce93d
5 changed files with 183 additions and 106 deletions

View File

@ -6,25 +6,78 @@ _swaylock()
_get_comp_words_by_ref -n : cur prev
short=(
-h
-C
-c
-d
-e
-f
-F
-h
-i
-k
-K
-L
-l
-n
-r
-s
-t
-v
-i
-u
-f
-v
)
long=(
--help
--bs-hl-color
--caps-lock-bs-hl-color
--caps-lock-key-hl-color
--color
--config
--daemonize
--debug
--disable-caps-lock-text
--font
--font-size
--help
--hide-keyboard-layout
--ignore-empty-password
--image
--indicator-caps-lock
--indicator-idle-visible
--indicator-radius
--indicator-thickness
--inside-caps-lock-color
--inside-clear-color
--inside-color
--inside-ver-color
--inside-wrong-color
--key-hl-color
--layout-bg-color
--layout-border-color
--layout-text-color
--line-caps-lock-color
--line-clear-color
--line-color
--line-uses-inside
--line-uses-ring
--line-ver-color
--line-wrong-color
--no-unlock-indicator
--ring-caps-lock-color
--ring-clear-color
--ring-color
--ring-ver-color
--ring-wrong-color
--scaling
--separator-color
--show-failed-attempts
--show-keyboard-layout
--text-caps-lock-color
--text-clear-color
--text-color
--text-ver-color
--text-wrong-color
--tiling
--version
--image
--no-unlock-indicator
--daemonize
)
scaling=(
@ -33,6 +86,7 @@ _swaylock()
'fit'
'center'
'tile'
'solid_color'
)
case $prev in

View File

@ -1,40 +1,53 @@
# swaylock(1) completion
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.'
complete -c swaylock -s h -l help --description "Show help message and quit."
complete -c swaylock -s f -l daemonize --description "Fork into the background after spawning. Note: this is the default bahavior of i3lock."
complete -c swaylock -s v -l version --description "Show the version number and quit."
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)."
complete -c swaylock -s e -l ignore-empty-password --description 'When an empty password is provided by the user, do not validate it.'
# Appearance
complete -c swaylock -s u -l no-unlock-indicator --description "Disable the unlock indicator."
complete -c swaylock -s i -l image --description "Display the given image, optionally on the given output. Use -c to set a background color."
complete -c swaylock -s s -l scaling --description "Scaling mode for images: stretch, fill, fit, center, or tile."
complete -c swaylock -s t -l tiling --description "Same as --scaling=tile."
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."
complete -c swaylock -l bs-hl-color --description 'Sets the color of backspace highlight segments.'
complete -c swaylock -l font --description 'Sets the font of the text inside the indicator.'
complete -c swaylock -l indicator-idle-visible --description 'Sets the indicator to show even if idle.'
complete -c swaylock -l indicator-radius --description 'Sets the radius of the indicator to radius pixels. Default: 50'
complete -c swaylock -l indicator-thickness --description 'Sets the thickness of the indicator to thickness pixels. Default: 10'
complete -c swaylock -l inside-color --description 'Sets the color of the inside of the indicator when typing or idle.'
complete -c swaylock -l inside-clear-color --description 'Sets the color of the inside of the indicator when cleared.'
complete -c swaylock -l inside-ver-color --description 'Sets the color of the inside of the indicator when verifying.'
complete -c swaylock -l inside-wrong-color --description 'Sets the color of the inside of the indicator when invalid.'
complete -c swaylock -l key-hl-color --description 'Sets the color of key press highlight segments.'
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.'
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.'
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.'
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.'
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.'
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.'
complete -c swaylock -l ring-color --description 'Sets the color of the outside of the indicator when typing or idle.'
complete -c swaylock -l ring-clear-color --description 'Sets the color of the outside of the indicator when cleared.'
complete -c swaylock -l ring-ver-color --description 'Sets the color of the outside of the indicator when verifying.'
complete -c swaylock -l ring-wrong-color --description 'Sets the color of the outside of the indicator when invalid.'
complete -c swaylock -l separator-color --description 'Sets the color of the lines that separate highlight segments.'
complete -c swaylock -l text-color --description 'Sets the color of the text inside the indicator when typing or idle.'
complete -c swaylock -l text-clear-color --description 'Sets the color of the text inside the indicator when cleared.'
complete -c swaylock -l text-ver-color --description 'Sets the color of the text inside the indicator when verifying.'
complete -c swaylock -l text-wrong-color --description 'Sets the color of the text inside the indicator when invalid.'
complete -c swaylock -l bs-hl-color --description "Sets the color of backspace highlight segments."
complete -c swaylock -l caps-lock-bs-hl-color --description "Sets the color of backspace highlight segments when Caps Lock is active."
complete -c swaylock -l caps-lock-key-hl-color --description "Sets the color of the key press highlight segments when Caps Lock is active."
complete -c swaylock -l color -s c --description "Turn the screen into the given color instead of white."
complete -c swaylock -l config -s C --description "Path to the config file."
complete -c swaylock -l daemonize -s f --description "Detach from the controlling terminal after locking."
complete -c swaylock -l debug -s d --description "Enable debugging output."
complete -c swaylock -l disable-caps-lock-text -s L --description "Disable the Caps Lock text."
complete -c swaylock -l font --description "Sets the font of the text."
complete -c swaylock -l font-size --description "Sets a fixed font size for the indicator text."
complete -c swaylock -l help -s h --description "Show help message and quit."
complete -c swaylock -l hide-keyboard-layout -s K --description "Hide the current xkb layout while typing."
complete -c swaylock -l ignore-empty-password -s e --description "When an empty password is provided, do not validate it."
complete -c swaylock -l image -s i --description "Display the given image, optionally only on the given output."
complete -c swaylock -l indicator-caps-lock -s l --description "Show the current Caps Lock state also on the indicator."
complete -c swaylock -l indicator-idle-visible --description "Sets the indicator to show even if idle."
complete -c swaylock -l indicator-radius --description "Sets the indicator radius."
complete -c swaylock -l indicator-thickness --description "Sets the indicator thickness."
complete -c swaylock -l inside-caps-lock-color --description "Sets the color of the inside of the indicator when Caps Lock is active."
complete -c swaylock -l inside-clear-color --description "Sets the color of the inside of the indicator when cleared."
complete -c swaylock -l inside-color --description "Sets the color of the inside of the indicator."
complete -c swaylock -l inside-ver-color --description "Sets the color of the inside of the indicator when verifying."
complete -c swaylock -l inside-wrong-color --description "Sets the color of the inside of the indicator when invalid."
complete -c swaylock -l key-hl-color --description "Sets the color of the key press highlight segments."
complete -c swaylock -l layout-bg-color --description "Sets the background color of the box containing the layout text."
complete -c swaylock -l layout-border-color --description "Sets the color of the border of the box containing the layout text."
complete -c swaylock -l layout-text-color --description "Sets the color of the layout text."
complete -c swaylock -l line-caps-lock-color --description "Sets the color of the line between the inside and ring when Caps Lock is active."
complete -c swaylock -l line-clear-color --description "Sets the color of the line between the inside and ring when cleared."
complete -c swaylock -l line-color --description "Sets the color of the line between the inside and ring."
complete -c swaylock -l line-uses-inside -s n --description "Use the inside color for the line between the inside and ring."
complete -c swaylock -l line-uses-ring -s r --description "Use the ring color for the line between the inside and ring."
complete -c swaylock -l line-ver-color --description "Sets the color of the line between the inside and ring when verifying."
complete -c swaylock -l line-wrong-color --description "Sets the color of the line between the inside and ring when invalid."
complete -c swaylock -l no-unlock-indicator -s u --description "Disable the unlock indicator."
complete -c swaylock -l ring-caps-lock-color --description "Sets the color of the ring of the indicator when Caps Lock is active."
complete -c swaylock -l ring-clear-color --description "Sets the color of the ring of the indicator when cleared."
complete -c swaylock -l ring-color --description "Sets the color of the ring of the indicator."
complete -c swaylock -l ring-ver-color --description "Sets the color of the ring of the indicator when verifying."
complete -c swaylock -l ring-wrong-color --description "Sets the color of the ring of the indicator when invalid."
complete -c swaylock -l scaling -s s --description "Image scaling mode: stretch, fill, fit, center, tile, solid_color."
complete -c swaylock -l separator-color --description "Sets the color of the lines that separate highlight segments."
complete -c swaylock -l show-failed-attempts -s F --description "Show current count of failed authentication attempts."
complete -c swaylock -l show-keyboard-layout -s k --description "Display the current xkb layout while typing."
complete -c swaylock -l text-caps-lock-color --description "Sets the color of the text when Caps Lock is active."
complete -c swaylock -l text-clear-color --description "Sets the color of the text when cleared."
complete -c swaylock -l text-color --description "Sets the color of the text."
complete -c swaylock -l text-ver-color --description "Sets the color of the text when verifying."
complete -c swaylock -l text-wrong-color --description "Sets the color of the text when invalid."
complete -c swaylock -l tiling -s t --description "Same as --scaling=tile."
complete -c swaylock -l version -s v --description "Show the version number and quit."

View File

@ -4,38 +4,54 @@
#
_arguments -s \
'(-C --config)'{-C,--config}'[Path to the config file]:filename:_files' \
'(-c --color)'{-c,--color}'[Turn the screen into the given color instead of white]:color:' \
'(-e --ignore-empty-password)'{-e,--ignore-empty-password}'[When an empty password is provided, do not validate it]' \
'(-f --daemonize)'{-f,--daemonize}'[Detach from the controlling terminal after locking]' \
'(-h --help)'{-h,--help}'[Show help message and quit]' \
'(-i --image)'{-i,--image}'[Display an image]:filename:_files' \
'(-s --scaling)'{-s,--scaling}'[Scaling mode]:mode:(stretch fill fit center tile)' \
'(-t --tiling)'{-t,--tiling}'[Same as --scaling=tile]' \
'(-u --no-unlock-indicator)'{-u,--no-unlock-indicator}'[Disable the unlock indicator]' \
'(-v --version)'{-v,--version}'[Show the version number and quit]' \
'(--bs-hl-color)'--bs-hl-color'[Sets the color of backspace highlights segments]:color:' \
'(--bs-hl-color)'--bs-hl-color'[Sets the color of backspace highlight segments]:color:' \
'(--caps-lock-bs-hl-color)'--caps-lock-bs-hl-color'[Sets the color of backspace highlight segments when Caps Lock is active]:color:' \
'(--caps-lock-key-hl-color)'--caps-lock-key-hl-color'[Sets the color of the key press highlight segments when Caps Lock is active]:color:' \
'(--color -c)'{--color,-c}'[Turn the screen into the given color instead of white]:color:' \
'(--config -C)'{--config,-C}'[Path to the config file]:filename:_files' \
'(--daemonize -f)'{--daemonize,-f}'[Detach from the controlling terminal after locking]' \
'(--debug -d)'{--debug,-d}'[Enable debugging output]' \
'(--disable-caps-lock-text -L)'{--disable-caps-lock-text,-L}'[Disable the Caps Lock text]' \
'(--font)'--font'[Sets the font of the text]:font:' \
'(--font-size)'--font-size'[Sets a fixed font size for the indicator text]' \
'(--help -h)'{--help,-h}'[Show help message and quit]' \
'(--hide-keyboard-layout -K)'{--hide-keyboard-layout,-K}'[Hide the current xkb layout while typing]' \
'(--ignore-empty-password -e)'{--ignore-empty-password,-e}'[When an empty password is provided, do not validate it]' \
'(--image -i)'{--image,-i}'[Display the given image, optionally only on the given output]:filename:_files' \
'(--indicator-caps-lock -l)'{--indicator-caps-lock,-l}'[Show the current Caps Lock state also on the indicator]' \
'(--indicator-idle-visible)'--indicator-idle-visible'[Sets the indicator to show even if idle]' \
'(--indicator-radius)'--indicator-radius'[Sets the indicator radius]:radius:' \
'(--indicator-thickness)'--indicator-thickness'[Sets the indicator thickness]:thickness:' \
'(--inside-color)'--inside-color'[Sets the color of the inside of the indicator]:color:' \
'(--inside-caps-lock-color)'--inside-caps-lock-color'[Sets the color of the inside of the indicator when Caps Lock is active]:color:' \
'(--inside-clear-color)'--inside-clear-color'[Sets the color of the inside of the indicator when cleared]:color:' \
'(--inside-clear-color)'--inside-clear-color'[Sets the color of the inside of the indicator when verifying]:color:' \
'(--inside-color)'--inside-color'[Sets the color of the inside of the indicator]:color:' \
'(--inside-ver-color)'--inside-ver-color'[Sets the color of the inside of the indicator when verifying]:color:' \
'(--inside-wrong-color)'--inside-wrong-color'[Sets the color of the inside of the indicator when invalid]:color:' \
'(--key-hl-color)'--key-hl-color'[Sets the color of the key press highlight segments]:color:' \
'(--line-color)'--line-color'[Sets the color of the line between the inside and ring]:color:' \
'(--layout-bg-color)'--layout-bg-color'[Sets the background color of the box containing the layout text]:color:' \
'(--layout-border-color)'--layout-border-color'[Sets the color of the border of the box containing the layout text]:color:' \
'(--layout-text-color)'--layout-text-color'[Sets the color of the layout text]:color:' \
'(--line-caps-lock-color)'--line-caps-lock-color'[Sets the color of the line between the inside and ring when Caps Lock is active]:color:' \
'(--line-clear-color)'--line-clear-color'[Sets the color of the line between the inside and ring when cleared]:color:' \
'(--line-color)'--line-color'[Sets the color of the line between the inside and ring]:color:' \
'(--line-uses-inside -n)'{--line-uses-inside,-n}'[Use the inside color for the line between the inside and ring]' \
'(--line-uses-ring -r)'{--line-uses-ring,-r}'[Use the ring color for the line between the inside and ring]' \
'(--line-ver-color)'--line-ver-color'[Sets the color of the line between the inside and ring when verifying]:color:' \
'(--line-wrong-color)'--line-wrong-color'[Sets the color of the line between the inside and ring when invalid]:color:' \
'(-n --line-uses-inside)'{-n,--line-uses-inside}'[Use the inside color for the line between the inside and ring]' \
'(-r --line-uses-ring)'{-r,--line--uses-ring}'[Use the ring color for the line between the inside and ring]' \
'(--ring-color)'--ring-color'[Sets the color of the ring of the indicator]:color:' \
'(--no-unlock-indicator -u)'{--no-unlock-indicator,-u}'[Disable the unlock indicator]' \
'(--ring-caps-lock-color)'--ring-caps-lock-color'[Sets the color of the ring of the indicator when Caps Lock is active]:color:' \
'(--ring-clear-color)'--ring-clear-color'[Sets the color of the ring of the indicator when cleared]:color:' \
'(--ring-color)'--ring-color'[Sets the color of the ring of the indicator]:color:' \
'(--ring-ver-color)'--ring-ver-color'[Sets the color of the ring of the indicator when verifying]:color:' \
'(--ring-wrong-color)'--ring-wrong-color'[Sets the color of the ring of the indicator when invalid]:color:' \
'(--scaling -s)'{--scaling,-s}'[Image scaling mode: stretch, fill, fit, center, tile, solid_color]:mode:(stretch fill fit center tile solid_color)' \
'(--separator-color)'--separator-color'[Sets the color of the lines that separate highlight segments]:color:' \
'(--text-color)'--text-color'[Sets the color of the text]:color:' \
'(--show-failed-attempts -F)'{--show-failed-attempts,-F}'[Show current count of failed authentication attempts]' \
'(--show-keyboard-layout -k)'{--show-keyboard-layout,-k}'[Display the current xkb layout while typing]' \
'(--text-caps-lock-color)'--text-caps-lock-color'[Sets the color of the text when Caps Lock is active]:color:' \
'(--text-clear-color)'--text-clear-color'[Sets the color of the text when cleared]:color:' \
'(--text-color)'--text-color'[Sets the color of the text]:color:' \
'(--text-ver-color)'--text-ver-color'[Sets the color of the text when verifying]:color:' \
'(--text-wrong-color)'--text-wrong-color'[Sets the color of the text when invalid]:color:'
'(--text-wrong-color)'--text-wrong-color'[Sets the color of the text when invalid]:color:' \
'(--tiling -t)'{--tiling,-t}'[Same as --scaling=tile]' \
'(--version -v)'{--version,-v}'[Show the version number and quit]'

5
main.c
View File

@ -548,7 +548,6 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
{"disable-caps-lock-text", no_argument, NULL, 'L'},
{"indicator-caps-lock", no_argument, NULL, 'l'},
{"line-uses-inside", no_argument, NULL, 'n'},
{"socket", required_argument, NULL, 'p'},
{"line-uses-ring", no_argument, NULL, 'r'},
{"scaling", required_argument, NULL, 's'},
{"tiling", no_argument, NULL, 't'},
@ -611,7 +610,7 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
" -h, --help "
"Show help message and quit.\n"
" -i, --image [[<output>]:]<path> "
"Display the given image.\n"
"Display the given image, optionally only on the given output.\n"
" -k, --show-keyboard-layout "
"Display the current xkb layout while typing.\n"
" -K, --hide-keyboard-layout "
@ -621,7 +620,7 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
" -l, --indicator-caps-lock "
"Show the current Caps Lock state also on the indicator.\n"
" -s, --scaling <mode> "
"Scaling mode: stretch, fill, fit, center, tile.\n"
"Image scaling mode: stretch, fill, fit, center, tile, solid_color.\n"
" -t, --tiling "
"Same as --scaling=tile.\n"
" -u, --no-unlock-indicator "

View File

@ -25,10 +25,10 @@ Locks your Wayland session.
Enable debugging output.
*-e, --ignore-empty-password*
When an empty password is provided by the user, do not validate it.
When an empty password is provided, do not validate it.
*-F, --show-failed-attempts*
Show the number of failed authentication attempts on the indicator.
Show current count of failed authentication attempts.
*-f, --daemonize*
Detach from the controlling terminal after locking.
@ -52,30 +52,30 @@ Locks your Wayland session.
':' to prevent interpreting part of it as <output>.
*-k, --show-keyboard-layout*
Force displaying the current xkb layout while typing, even if only one layout
is configured.
Display the current xkb layout while typing.
*-K, --hide-keyboard-layout*
Force hiding the current xkb layout while typing, even if more than one layout
is configured or the show-keyboard-layout option is set.
*-L, --disable-caps-lock-text*
Disable the Caps Lock Text.
Disable the Caps Lock text.
*-l, --indicator-caps-lock*
Show the current Caps Lock state also on the indicator.
*-s, --scaling*
Scaling mode for images: _stretch_, _fill_, _fit_, _center_, or _tile_. Use
the additional mode _solid\_color_ to display only the background color, even
Image scaling mode: _stretch_, _fill_, _fit_, _center_, _tile_,
_solid\_color_. Use _solid\_color_ to display only the background color, even
if a background image is specified.
*-t, --tiling*
Same as --scaling=tile.
*-c, --color* <rrggbb[aa]>
Turn the screen into the given color. If -i is used, this sets the
background of the image to the given color. Defaults to white (FFFFFF).
Turn the screen into the given color instead of white. If -i is used, this
sets the background of the image to the given color. Defaults to white
(FFFFFF).
*--bs-hl-color* <rrggbb[aa]>
Sets the color of backspace highlight segments.
@ -87,21 +87,22 @@ Locks your Wayland session.
Sets the color of the key press highlight segments when Caps Lock is active.
*--font* <font>
Sets the font of the text inside the indicator.
Sets the font of the text.
*--font-size* <size>
Sets a fixed font size for the indicator text.
*--indicator-idle-visible*
Sets the indicator to show even if idle.
*--indicator-radius* <radius>
Sets the radius of the indicator to _radius_ pixels. The default value is
50.
Sets the indicator radius. The default value is 50.
*--indicator-thickness* <thickness>
Sets the thickness of the indicator to _thickness_ pixels. The default value
is 10.
Sets the indicator thickness. The default value is 10.
*--inside-color* <rrggbb[aa]>
Sets the color of the inside of the indicator when typing or idle.
Sets the color of the inside of the indicator.
*--inside-clear-color* <rrggbb[aa]>
Sets the color of the inside of the indicator when cleared.
@ -116,7 +117,7 @@ Locks your Wayland session.
Sets the color of the inside of the indicator when invalid.
*--key-hl-color* <rrggbb[aa]>
Sets the color of key press highlight segments.
Sets the color of the key press highlight segments.
*--layout-bg-color* <rrggbb[aa]>
Sets the background color of the box containing the layout text.
@ -128,65 +129,59 @@ Locks your Wayland session.
Sets the color of the layout text.
*--line-color* <rrggbb[aa]>
Sets the color of the lines that separate the inside and outside of the
indicator when typing or idle.
Sets the color of the line between the inside and ring.
*--line-clear-color* <rrggbb[aa]>
Sets the color of the lines that separate the inside and outside of the
indicator when cleared.
Sets the color of the line between the inside and ring when cleared.
*--line-caps-lock-color* <rrggbb[aa]>
Sets the color of the line between the inside and ring when Caps Lock
is active.
Sets the color of the line between the inside and ring when Caps Lock is
active.
*--line-ver-color* <rrggbb[aa]>
Sets the color of the lines that separate the inside and outside of the
indicator when verifying.
Sets the color of the line between the inside and ring when verifying.
*--line-wrong-color* <rrggbb[aa]>
Sets the color of the lines that separate the inside and outside of the
indicator when invalid.
Sets the color of the line between the inside and ring when invalid.
*-n, --line-uses-inside*
Use the color of the inside of the indicator for the line separating the
inside and outside of the indicator.
Use the inside color for the line between the inside and ring.
*-r, --line-uses-ring*
Use the outer ring's color for the line separating the inside and outside of
the indicator.
Use the ring color for the line between the inside and ring.
*--ring-color* <rrggbb[aa]>
Sets the color of the outside of the indicator when typing or idle.
Sets the color of the ring of the indicator when typing or idle.
*--ring-clear-color* <rrggbb[aa]>
Sets the color of the outside of the indicator when cleared.
Sets the color of the ring of the indicator when cleared.
*--ring-caps-lock-color* <rrggbb[aa]>
Sets the color of the ring of the indicator when Caps Lock is active.
*--ring-ver-color* <rrggbb[aa]>
Sets the color of the outside of the indicator when verifying.
Sets the color of the ring of the indicator when verifying.
*--ring-wrong-color* <rrggbb[aa]>
Sets the color of the outside of the indicator when invalid.
Sets the color of the ring of the indicator when invalid.
*--separator-color* <rrggbb[aa]>
Sets the color of the lines that separate highlight segments.
*--text-color* <rrggbb[aa]>
Sets the color of the text inside the indicator when typing or idle.
Sets the color of the text.
*--text-clear-color* <rrggbb[aa]>
Sets the color of the text inside the indicator when cleared.
Sets the color of the text when cleared.
*--text-caps-lock-color* <rrggbb[aa]>
Sets the color of the text when Caps Lock is active.
*--text-ver-color* <rrggbb[aa]>
Sets the color of the text inside the indicator when verifying.
Sets the color of the text when verifying.
*--text-wrong-color* <rrggbb[aa]>
Sets the color of the text inside the indicator when invalid.
Sets the color of the text when invalid.
# AUTHORS