Merge pull request #3001 from madblobfish/swaylock-completions-and-manpage

Reworked fish completions and moved stuff in swaylock manpage
master
Drew DeVault 6 years ago committed by GitHub
commit 707f3ad275
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,3 @@
# swayidle
complete -c swayidle -s h --description 'show help'
complete -c swayidle -s d --description 'debug'

@ -1,11 +1,39 @@
# swaylock(1) completion # 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 h -l help --description "Show help message and quit."
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 -s f -l daemonize --description "Fork into the background after spawning. Note: this is the default bahavior of i3lock." 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 i -l image --description "Display the given image, optionally on the given output. Use -c to set a background color."
complete -c swaylock -l scaling --description "Scaling mode for images: stretch, fill, fit, center, or tile." 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 t -l tiling --description "Same as --scaling=tile."
complete -c swaylock -s u -l no-unlock-indicator --description "Disable the unlock indicator." 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 -s v -l version --description "Show the version number and quit." complete -c swaylock -l bs-hl-color --description 'Sets the color of backspace highlight segments.'
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)." complete -c swaylock -l font --description 'Sets the font of the text inside the indicator.'
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.'

@ -0,0 +1,29 @@
# swaynag
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.'
complete -c swaynag -s d -l debug --description 'Enable debugging.'
complete -c swaynag -s e -l edge --description 'Set the edge to use: top or bottom'
complete -c swaynag -s f -l font --description 'Set the font to use.'
complete -c swaynag -s h -l help --description 'Show help message and quit.'
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.'
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.'
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".'
complete -c swaynag -s m -l message --description 'Set the message text.'
complete -c swaynag -s o -l output --description 'Set the output to use.'
complete -c swaynag -s s -l dismiss-button --description 'Sets the text for the dismiss nagbar button. The default is "X".'
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.'
complete -c swaynag -s v -l version --description 'Show the version number and quit.'
# Appearance
complete -c swaynag -l background --description 'Set the color of the background.'
complete -c swaynag -l border --description 'Set the color of the border.'
complete -c swaynag -l border-bottom --description 'Set the color of the bottom border.'
complete -c swaynag -l button-background --description 'Set the color for the background for buttons.'
complete -c swaynag -l text --description 'Set the text color.'
complete -c swaynag -l border-bottom-size --description 'Set the thickness of the bottom border.'
complete -c swaynag -l message-padding --description 'Set the padding for the message.'
complete -c swaynag -l details-border-size --description 'Set the thickness for the details border.'
complete -c swaynag -l button-border-size --description 'Set the thickness for the button border.'
complete -c swaynag -l button-gap --description 'Set the size of the gap between buttons.'
complete -c swaynag -l button-dismiss-gap --description 'Set the size of the gap between the dismiss button and another button.'
complete -c swaynag -l button-margin-right --description 'Set the margin from the right of the dismiss button to edge.'
complete -c swaynag -l button-padding --description 'Set the padding for the button text.'

@ -244,8 +244,10 @@ endif
if (get_option('fish-completions')) if (get_option('fish-completions'))
fish_files = files( fish_files = files(
'completions/fish/sway.fish', 'completions/fish/sway.fish',
'completions/fish/swayidle.fish',
'completions/fish/swaylock.fish', 'completions/fish/swaylock.fish',
'completions/fish/swaymsg.fish', 'completions/fish/swaymsg.fish',
'completions/fish/swaynag.fish',
) )
fish_install_dir = datadir + '/fish/completions' fish_install_dir = datadir + '/fish/completions'

@ -21,20 +21,25 @@ Locks your Wayland session.
All leading dashes should be omitted and the equals sign is required for All leading dashes should be omitted and the equals sign is required for
flags that take an argument. flags that take an argument.
*-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), or
transparent (00000000) if an image is in use.
*-e, --ignore-empty-password* *-e, --ignore-empty-password*
When an empty password is provided by the user, do not validate it. When an empty password is provided by the user, do not validate it.
*-f, --daemonize* *-f, --daemonize*
Detach from the controlling terminal after locking. Detach from the controlling terminal after locking.
Note: this is the default bahavior of i3lock.
*-h, --help* *-h, --help*
Show help message and quit. Show help message and quit.
*-v, --version*
Show the version number and quit.
# APPEARANCE
*-u, --no-unlock-indicator*
Disable the unlock indicator.
*-i, --image* [<output>:]<path> *-i, --image* [<output>:]<path>
Display the given image, optionally only on the given output. Use -c to set Display the given image, optionally only on the given output. Use -c to set
a background color. a background color.
@ -45,13 +50,10 @@ Locks your Wayland session.
*-t, --tiling* *-t, --tiling*
Same as --scaling=tile. Same as --scaling=tile.
*-u, --no-unlock-indicator* *-c, --color* <rrggbb[aa]>
Disable the unlock indicator. 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), or
*-v, --version* transparent (00000000) if an image is in use.
Show the version number and quit.
# APPEARANCE
*--bs-hl-color* <rrggbb[aa]> *--bs-hl-color* <rrggbb[aa]>
Sets the color of backspace highlight segments. Sets the color of backspace highlight segments.

Loading…
Cancel
Save