diff options
Diffstat (limited to 'upstream/opensuse-tumbleweed/man5/icewm-keys.5')
| -rw-r--r-- | upstream/opensuse-tumbleweed/man5/icewm-keys.5 | 220 |
1 files changed, 220 insertions, 0 deletions
diff --git a/upstream/opensuse-tumbleweed/man5/icewm-keys.5 b/upstream/opensuse-tumbleweed/man5/icewm-keys.5 new file mode 100644 index 00000000..d6e959b7 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man5/icewm-keys.5 @@ -0,0 +1,220 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "ICEWM-KEYS 5" +.TH ICEWM-KEYS 5 2023-12-28 "icewm 3.4.5" "Standards, Environments and Macros" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SS NAME +.IX Subsection "NAME" +.Vb 1 +\& icewm\-keys \- icewm keys configuration file +.Ve +.SS SYNOPSIS +.IX Subsection "SYNOPSIS" +.Vb 5 +\& $ICEWM_PRIVCFG/keys +\& $XDG_CONFIG_HOME/icewm/keys +\& $HOME/.icewm/keys +\& /etc/icewm/keys +\& /usr/share/icewm/keys +.Ve +.SS DESCRIPTION +.IX Subsection "DESCRIPTION" +The \f(CW\*(C`keys\*(C'\fR file defines global keybindings to launch applications. +A keybinding has three parts: the word \fBkey\fR, a double-quoted string +with an X11 key combination and a program with its arguments. +These are separated by one or more spaces. Empty lines are allowed. +Comment lines start with a hash. +.PP +For example, the following defines a hotkey to restart \fBicewm\fR: +.PP +.Vb 1 +\& key "Ctrl+Shift+r" icesh restart +.Ve +.PP +See the output of \f(CW\*(C`xmodmap \-pk\*(C'\fR for a list of the many keystroke names +you can use in icewm key definitions. Since IceWM version 3.4.0, +bindings can not only be defined by their keystroke name, but also by +their key label. In addition, the shifted key is now definable as well. +For example, the key with + and = can be bound in either of the +following four ways, which are identical: +.PP +.Vb 4 +\& key "Ctrl+Shift+equal" xterm +\& key "Ctrl+Shift+=" xterm +\& key "Ctrl+plus" xterm +\& key "Ctrl++" xterm +.Ve +.PP +To bind the mouse use \f(CW\*(C`Pointer_Button1\*(C'\fR for button 1, and so on. +The command \f(CW\*(C`icesh keys\*(C'\fR instructs icewm to reload this file. +.SS FORMAT +.IX Subsection "FORMAT" +The syntax of the \fIkeys\fR file is as follows: +.RS 4 +.IP "\fBkey\fR \fB""\fR\fIkey_combination\fR\fB""\fR \fIprogram\fR \fIoptions\fR" 4 +.IX Item "key ""key_combination"" program options" +.RE +.RS 4 +.RE +.PP +Where, +.IP \fBkey\fR 4 +.IX Item "key" +The word \fBkey\fR begins the definition of a keybinding. +.IP \fIkey_combination\fR 4 +.IX Item "key_combination" +A combination of modifiers and a key, like \f(CW\*(C`Ctrl+Alt+Delete\*(C'\fR. +Valid modifiers are Alt, AltGr, Ctrl, Hyper, Meta, Shift, Super. +Each modifier must be followed by a single plus-sign. +The key is either a keystroke name or a key label. +Instead of a key, mouse pointer buttons can be specified by +\&\f(CW\*(C`Pointer_Button1\*(C'\fR and up, like \f(CW\*(C`Shift+Pointer_Button3\*(C'\fR. +.IP "\fIprogram\fR \fIoptions\fR" 4 +.IX Item "program options" +\&\fIprogram\fR is the name of the executable or its path. +It may start with a tilde or an environment variable, +which will be expanded. +The \fIoptions\fR are passed as arguments to the \fIprogram\fR. +.IP \fBswitchkey\fR 4 +.IX Item "switchkey" +Is an alternative to \fBkey\fR. In this case the \fIprogram\fR must print on +standard output the definition of a dynamic \fBicewm\-menu\fR\|(1). +This menu will presented as a popup menu. +.SS EXAMPLES +.IX Subsection "EXAMPLES" +Following is the example \fIkeys\fR file that ships with \fBicewm\fR\|(1): +.PP +.Vb 10 +\& # This is an example for IceWM\*(Aqs hotkey definition file. +\& # +\& # A list of all valid keyboard symbols can be found in +\& # /usr/include/X11/keysymdef.h, XF86keysym.h, ... +\& # Omit the XK_ prefixs and replace XF86XK_ prefixes by XF86. +\& # Valid modifiers are Alt, AltGr, Ctrl, Shift, Meta, Super, Hyper. +\& # +\& key "Alt+Ctrl+t" xterm +\& key "Alt+Ctrl+b" xdg\-open about:blank +\& key "Alt+Ctrl+s" xdg\-open https://www.google.com +\& +\& key "Super+KP_Subtract" amixer sset PCM 5%\- +\& key "Super+KP_Add" amixer sset PCM 5%+ +\& +\& # "Multimedia key" bindings for XFree86. Gather the +\& # keycodes of your advanced function keys by watching the +\& # output of the xev command whilst pressing those keys +\& # and map those symbols using xmodmap. +\& +\& key "XF86AudioLowerVolume" amixer sset PCM 5%\- +\& key "XF86AudioRaiseVolume" amixer sset PCM 5%+ +\& key "XF86AudioMute" amixer sset PCM 0% +\& key "XF86HomePage" xdg\-open about:blank +\& key "XF86Search" xdg\-open https://www.google.com +\& key "XF86Eject" eject +\& +\& # display and select monitor setup configurations +\& switchkey "Super+p" icewm\-menu\-xrandr +.Ve +.PP +Following shows how to add mouse button bindings on the root window to +change the current workspace rolling the mouse wheel on the desktop: +.PP +.Vb 2 +\& key "Pointer_Button4" icesh goto prev +\& key "Pointer_Button5" icesh goto next +.Ve +.PP +These are key bindings for single window tile operations to replace the +\&\fIKeyWinArrange\fR key bindings from the \fIpreferences\fR file: +.PP +.Vb 9 +\& key "Ctrl+Alt+KP_Home" icesh \-f sizeto 49% 49% top left +\& key "Ctrl+Alt+KP_Up" icesh \-f sizeto 100% 49% top left +\& key "Ctrl+Alt+KP_Prior" icesh \-f sizeto 49% 49% top right +\& key "Ctrl+Alt+KP_Right" icesh \-f sizeto 49% 100% top right +\& key "Ctrl+Alt+KP_Next" icesh \-f sizeto 49% 49% bottom right +\& key "Ctrl+Alt+KP_Down" icesh \-f sizeto 100% 49% bottom left +\& key "Ctrl+Alt+KP_End" icesh \-f sizeto 49% 49% bottom left +\& key "Ctrl+Alt+KP_Left" icesh \-f sizeto 49% 100% top left +\& key "Ctrl+Alt+KP_Begin" icesh \-f sizeto 49% 49% center +.Ve +.SS FILES +.IX Subsection "FILES" +Locations for the \fIkeys\fR file are as follows: +.PP +.Vb 5 +\& $ICEWM_PRIVCFG/keys +\& $XDG_CONFIG_HOME/icewm/keys +\& $HOME/.icewm/keys +\& /etc/icewm/keys +\& /usr/share/icewm/keys +.Ve +.PP +The locations are searched in the order listed; the first file found is +read and the remainder ignored. +.SS "SEE ALSO" +.IX Subsection "SEE ALSO" +\&\fBicewm\fR\|(1). +.SS AUTHOR +.IX Subsection "AUTHOR" +Brian Bidulock <mailto:bidulock@openss7.org>. +.SS LICENSE +.IX Subsection "LICENSE" +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution. |