mirror of
https://github.com/swaywm/sway.git
synced 2024-11-25 17:31:28 +00:00
Add swaylock(1) and swaymsg(1)
This commit is contained in:
parent
7a964651fb
commit
22f52b91ed
|
@ -57,6 +57,8 @@ if scdoc.found()
|
|||
'sway/sway.5.scd',
|
||||
'sway/sway-bar.5.scd',
|
||||
'sway/sway-input.5.scd',
|
||||
'swaylock/swaylock.1.scd',
|
||||
'swaymsg/swaymsg.1.scd',
|
||||
]
|
||||
foreach filename : man_files
|
||||
topic = filename.split('.')[-3].split('/')[-1]
|
||||
|
|
103
swaylock/swaylock.1.scd
Normal file
103
swaylock/swaylock.1.scd
Normal file
|
@ -0,0 +1,103 @@
|
|||
swaylock(1)
|
||||
|
||||
# NAME
|
||||
|
||||
swaylock - Screen locker for Wayland
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
_swaylock_ [options...]
|
||||
|
||||
Locks your Wayland session.
|
||||
|
||||
# OPTIONS
|
||||
|
||||
*-h, --help*
|
||||
Show help message and quit.
|
||||
|
||||
*-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.
|
||||
|
||||
*-f, --daemonize*
|
||||
Fork into the background after spawning. Note: this is the default behavior
|
||||
of i3lock.
|
||||
|
||||
*-i, --image* [<output>:]<path>
|
||||
Display the given image, optionally only on the given output. Use -c to set
|
||||
a background color.
|
||||
|
||||
*--scaling*
|
||||
Scaling mode for images: _stretch_, _fill_, _fit_, _center_, or _tile_.
|
||||
|
||||
*-t, --tiling*
|
||||
Same as --scaling=tile.
|
||||
|
||||
*-u, --no-unlock-indicator*
|
||||
Disable the unlock indicator.
|
||||
|
||||
*-v, --version*
|
||||
Show the version number and quit.
|
||||
|
||||
# APPEARANCE
|
||||
|
||||
*--bshlcolor* <rrggbb[aa]>
|
||||
Sets the color of backspace highlight segments.
|
||||
|
||||
*--font* <font>
|
||||
Sets the font of the text inside the indicator.
|
||||
|
||||
*--insidecolor* <rrggbb[aa]>
|
||||
Sets the color of the inside of the indicator when typing or idle.
|
||||
|
||||
*--insidevercolor* <rrggbb[aa]>
|
||||
Sets the color of the inside of the indicator when verifying.
|
||||
|
||||
*--insidewrongcolor* <rrggbb[aa]>
|
||||
Sets the color of the inside of the indicator when invalid.
|
||||
|
||||
*--keyhlcolor* <rrggbb[aa]>
|
||||
Sets the color of keypress highlight segments.
|
||||
|
||||
*--linecolor* <rrggbb[aa]>
|
||||
Sets the color of the lines that separate the inside and outside of the
|
||||
indicator.
|
||||
|
||||
*-s, --line-uses-inside*
|
||||
Use the color of the inside of the indicator for the line separating the
|
||||
inside and outside of the indicator.
|
||||
|
||||
*-r, --line-uses-ring*
|
||||
Use the outer ring's color for the line separating the inside and outside of
|
||||
the indicator.
|
||||
|
||||
*--ringcolor* <rrggbb[aa]>
|
||||
Sets the color of the outside of the indicator when typing or idle.
|
||||
|
||||
*--ringvercolor* <rrggbb[aa]>
|
||||
Sets the color of the outside of the indicator when verifying.
|
||||
|
||||
*--ringwrongcolor* <rrggbb[aa]>
|
||||
Sets the color of the outside of the indicator when invalid.
|
||||
|
||||
*--separatorcolor* <rrggbb[aa]>
|
||||
Sets the color of the lines that seperate highlight segments.
|
||||
|
||||
*--textcolor* <rrggbb[aa]>
|
||||
Sets the color of the text inside the indicator.
|
||||
|
||||
*--indicator-radius* <radius>
|
||||
Sets the radius of the indicator to _radius_ pixels. The default value is
|
||||
50.
|
||||
|
||||
*--indicator-thickness* <thickness>
|
||||
Sets the thickness of the indicator to _thickness_ pixels. The default value
|
||||
is 10.
|
||||
|
||||
# AUTHORS
|
||||
|
||||
Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
|
||||
source contributors. For more information about sway development, see
|
||||
https://github.com/swaywm/sway.
|
||||
|
66
swaymsg/swaymsg.1.scd
Normal file
66
swaymsg/swaymsg.1.scd
Normal file
|
@ -0,0 +1,66 @@
|
|||
swaymsg(1)
|
||||
|
||||
# NAME
|
||||
|
||||
swaymsg - Send messages to a running instance of sway over the IPC socket.
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
_swaymsg_ [options...] [message]
|
||||
|
||||
# OPTIONS
|
||||
|
||||
*-h, --help*
|
||||
Show help message and quit.
|
||||
|
||||
*-q, --quiet*
|
||||
Sends the IPC message but does not print the response from sway.
|
||||
|
||||
*-r, --raw*
|
||||
Use raw output even if using a tty.
|
||||
|
||||
*-s, --socket* <path>
|
||||
Use the specified socket path. Otherwise, swaymsg will ask sway where the
|
||||
socket is (which is the value of $SWAYSOCK, then of $I3SOCK).
|
||||
|
||||
*-t, --type* <type>
|
||||
Specify the type of IPC message. See below.
|
||||
|
||||
*-v, --version*
|
||||
Print the version (of swaymsg) and quit.
|
||||
|
||||
# IPC MESSAGE TYPES
|
||||
|
||||
*<command>*
|
||||
The message is a sway command (the same commands you can bind to keybindings
|
||||
in your sway config file). It will be executed immediately.
|
||||
|
||||
See **sway**(5) for a list of commands.
|
||||
|
||||
*get\_workspaces*
|
||||
Gets a JSON-encoded list of workspaces and their status.
|
||||
|
||||
*get\_inputs*
|
||||
Gets a JSON-encoded list of current inputs.
|
||||
|
||||
*get\_outputs*
|
||||
Gets a JSON-encoded list of current outputs.
|
||||
|
||||
*get\_tree*
|
||||
Gets a JSON-encoded layout tree of all open windows, containers, outputs,
|
||||
workspaces, and so on.
|
||||
|
||||
*get\_marks*
|
||||
Get a JSON-encoded list of marks.
|
||||
|
||||
*get\_bar\_config*
|
||||
Get a JSON-encoded configuration for swaybar.
|
||||
|
||||
*get\_version*
|
||||
Get JSON-encoded version information for the running instance of sway.
|
||||
|
||||
*get\_clipboard*
|
||||
Get JSON-encoded information about the clipboard.
|
||||
Returns the current clipboard mime-types if called without
|
||||
arguments, otherwise returns the clipboard data in the requested
|
||||
formats. Encodes the data using base64 for non-text mime types.
|
Loading…
Reference in a new issue