man: Add weston-bindings(7) describing desktop shell shortcuts
The desktop-shell-specific bindings were identified from shell_add_bindings in desktop-shell/shell.c. Various general shortcuts (like Ctrl+Alt+F) are provided by files in libweston/ and compositor/ . Also introduce references to the new manual in weston(1) and weston.ini(5). Signed-off-by: Manuel Stoeckl <code@mstoeckl.com>
This commit is contained in:
parent
cda278dd1d
commit
6666dee52b
|
@ -15,6 +15,14 @@ configure_file(
|
|||
configuration: man_conf
|
||||
)
|
||||
|
||||
configure_file(
|
||||
input: 'weston-bindings.man',
|
||||
output: 'weston-bindings.7',
|
||||
install: true,
|
||||
install_dir: join_paths(dir_man, 'man7'),
|
||||
configuration: man_conf
|
||||
)
|
||||
|
||||
configure_file(
|
||||
input: 'weston-debug.man',
|
||||
output: 'weston-debug.1',
|
||||
|
|
|
@ -0,0 +1,137 @@
|
|||
.\" shorthand for double quote that works everywhere.
|
||||
.ds q \N'34'
|
||||
.TH weston-bindings 7 "2019-03-27" "Weston @version@"
|
||||
.SH NAME
|
||||
weston-bindings \- a list of keyboard bindings for
|
||||
.B Weston
|
||||
\- the reference Wayland
|
||||
compositor
|
||||
.SH INTRODUCTION
|
||||
The Weston desktop shell has a number of keyboard shortcuts. They are listed here.
|
||||
.SH DESCRIPTION
|
||||
Almost all keyboard shortcuts for
|
||||
.B Weston
|
||||
include a specified modifier
|
||||
.I mod
|
||||
which is determined in the file
|
||||
.BR weston.ini (5).
|
||||
.\" Begin list
|
||||
.P
|
||||
.RE
|
||||
.B mod + Shift + F
|
||||
.RS 4
|
||||
Make active window fullscreen
|
||||
.P
|
||||
.RE
|
||||
.B mod + K
|
||||
.RS 4
|
||||
Kill active window
|
||||
.P
|
||||
.RE
|
||||
.B mod + Shift + M
|
||||
.RS 4
|
||||
Maximize active window
|
||||
.P
|
||||
.RE
|
||||
.B mod + PageUp, mod + PageDown
|
||||
.RS 4
|
||||
Zoom desktop in (or out)
|
||||
.P
|
||||
.RE
|
||||
.B mod + Tab
|
||||
.RS 4
|
||||
Switch active window
|
||||
.P
|
||||
.RE
|
||||
.B mod + Up, mod + Down
|
||||
.RS 4
|
||||
Increment/decrement active workspace number, if there are multiple
|
||||
.P
|
||||
.RE
|
||||
.B mod + Shift + Up, mod + Shift + Down
|
||||
.RS 4
|
||||
Move active window to the succeeding/preceding workspace, if possible
|
||||
.P
|
||||
.RE
|
||||
.B mod + F1/F2/F3/F4/F5/F6
|
||||
.RS 4
|
||||
Jump to the numbered workspace, if it exists
|
||||
.P
|
||||
.RE
|
||||
.B Ctrl + Alt + Backspace
|
||||
.RS 4
|
||||
If supported, terminate Weston. (Note this combination often is used to hard restart Xorg.)
|
||||
.P
|
||||
.RE
|
||||
.B Ctrl + Alt + F
|
||||
.RS 4
|
||||
Toggle if Weston is fullscreen; only works when nested under a Wayland compositor
|
||||
.P
|
||||
.RE
|
||||
.B Ctrl + Alt + S
|
||||
.RS 4
|
||||
Share output screen, if possible
|
||||
.P
|
||||
.RE
|
||||
.B Ctrl + Alt + F1/F2/F3/F4/F5/F6/F7/F8
|
||||
.RS 4
|
||||
Switch virtual terminal, if possible
|
||||
.P
|
||||
.RE
|
||||
.B Super + S
|
||||
.RS 4
|
||||
Make a screenshot of the desktop
|
||||
.P
|
||||
.RE
|
||||
.B Super + R
|
||||
.RS 4
|
||||
Start or stop recording video of the desktop
|
||||
|
||||
.SS "TOUCH / MOUSE BINDINGS"
|
||||
|
||||
There are also a number of bindings involving a mouse:
|
||||
.P
|
||||
.RE
|
||||
.B \fI<Touch>\fI, \fI<Left button>\fB, \fI<Right button>\fB
|
||||
.RS 4
|
||||
Activate clicked window
|
||||
.P
|
||||
.RE
|
||||
.B Super + Alt + \fI<Vertical Scroll>\fB
|
||||
.RS 4
|
||||
Change the opacity of a window
|
||||
.P
|
||||
.RE
|
||||
.B mod + \fI<Vertical Scroll>\fB
|
||||
.RS 4
|
||||
Zoom/magnify the visible desktop
|
||||
.P
|
||||
.RE
|
||||
.B mod + \fI<Left button>\fB
|
||||
.RS 4
|
||||
Click and drag to move a window
|
||||
.P
|
||||
.RE
|
||||
.B mod + Shift + \fI<Left button>\fB, mod + \fI<Right button>\fB, mod + \fI<Touch>\fB
|
||||
.RS 4
|
||||
Click and drag to resize a window
|
||||
.P
|
||||
.RE
|
||||
.B mod + \fI<Middle button>\fB
|
||||
.RS 4
|
||||
Rotate the window (if supported)
|
||||
|
||||
.SS DEBUG BINDINGS
|
||||
The combination \fBmod + Shift + Space\fR begins a debug binding. Debug
|
||||
bindings are completed by pressing an additional key. For example, pressing
|
||||
T next may toggle timeline recording, and F may toggle texture mesh
|
||||
wireframes with the GL renderer. (In fact, most debug effects can be
|
||||
disabled again by repeating the command.) Debug bindings are often tied to
|
||||
specific backends.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
.BR weston (1),
|
||||
.BR weston-launch (1),
|
||||
.BR weston-drm (7),
|
||||
.BR weston.ini (5),
|
||||
.BR xkeyboard-config (7)
|
|
@ -1,6 +1,6 @@
|
|||
.\" shorthand for double quote that works everywhere.
|
||||
.ds q \N'34'
|
||||
.TH weston.ini 5 "2013-01-17" "Weston @version@"
|
||||
.TH weston.ini 5 "2019-03-26" "Weston @version@"
|
||||
.SH NAME
|
||||
weston.ini \- configuration file for
|
||||
.B Weston
|
||||
|
@ -423,8 +423,9 @@ pressed
|
|||
.BI "binding-modifier=" ctrl
|
||||
sets the modifier key used for common bindings (string), such as moving
|
||||
surfaces, resizing, rotating, switching, closing and setting the transparency
|
||||
for windows, controlling the backlight and zooming the desktop. Possible values:
|
||||
none, ctrl, alt, super (default)
|
||||
for windows, controlling the backlight and zooming the desktop. See
|
||||
.BR weston-bindings (7).
|
||||
Possible values: none, ctrl, alt, super (default)
|
||||
.TP 7
|
||||
.BI "num-workspaces=" 6
|
||||
defines the number of workspaces (unsigned integer). The user can switch
|
||||
|
@ -642,6 +643,6 @@ sets the command to start a fullscreen-shell server for screen sharing (string).
|
|||
.RE
|
||||
.SH "SEE ALSO"
|
||||
.BR weston (1),
|
||||
.BR weston-launch (1),
|
||||
.BR weston-bindings (7),
|
||||
.BR weston-drm (7),
|
||||
.BR xkeyboard-config (7)
|
||||
|
|
|
@ -358,6 +358,7 @@ weston
|
|||
.
|
||||
.\" ***************************************************************
|
||||
.SH "SEE ALSO"
|
||||
.BR weston-bindings (7),
|
||||
.BR weston-debug (1),
|
||||
.BR weston-drm (7),
|
||||
.BR weston-rdp (7),
|
||||
|
|
Loading…
Reference in New Issue