This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
wiki:advanced:nx-keyboard-shortcuts [2015/04/26 23:57] ionic Remove extraneous newlines. |
wiki:advanced:nx-keyboard-shortcuts [2019/05/11 16:33] (current) uli42 [File Format] |
||
---|---|---|---|
Line 7: | Line 7: | ||
This Wiki page is largely a copy of the ''README.keystrokes'' in | This Wiki page is largely a copy of the ''README.keystrokes'' in | ||
- | [[http://code.x2go.org/gitweb?p=nx-libs.git;a=summary]]. Please keep them in | + | [[http://code.x2go.org/gitweb?p=nx-libs.git;a=summary]] which in turn is a copy of the same file in NX ([[https://github.com/ArcticaProject/nx-libs/tree/3.6.x/doc/nxagent]]). Please keep them in sync. |
- | sync. | + | |
==== About nxagent ==== | ==== About nxagent ==== | ||
- | ''nxagent'' is the process that an X2Go Server executes. Therefore the configuration described below | + | ''nxagent'' is the process that an X2Go Server executes (under the name ''x2goagenbt''). Therefore the configuration described below |
is evaluated on an **X2Go Server** and you have to place your configuration file on the **server**. | is evaluated on an **X2Go Server** and you have to place your configuration file on the **server**. | ||
Line 57: | Line 56: | ||
</file> | </file> | ||
- | Each ''action'' defines an action to be executed when receiving that keystroke. A | + | Each 'action' defines an action to be executed when receiving that |
- | list of possible actions is given below. Some of those actions are only | + | keystroke. A list of possible actions is given below. Some of those |
- | available with debug builds of nxagent. | + | actions are only available with debug builds of nxagent. |
- | Keys are given as a combination of ''key'' and (optionally) a number of | + | Keys are given as a combination of 'key' and (optionally) a number of |
modifiers. The key attribute is evaluated into a X11 key via the usual | modifiers. The key attribute is evaluated into a X11 key via the usual | ||
- | ''XStringToKeysym'' function. A list of possible keys can be found in | + | XStringToKeysym function. A list of possible keys can be found in |
- | ''/usr/include/X11/keysymdef.h'', the names are specified without the leading | + | /usr/include/X11/keysymdef.h, the names are specified without the |
- | ''XK_''. Evaluation is case-sensitive, so, ''space'' and ''Escape'' will work while | + | leading 'XK_'. Evaluation is case-sensitive, so, 'space' and 'Escape' |
- | ''Space'' and ''escape'' won't. | + | will work while 'Space' and 'escape' won't. |
- | Modifiers are given as boolean attributes, possible modifiers are ''Mod1'', ''Mod2'', | + | Modifiers are given as boolean attributes, possible modifiers are |
- | ''Mod3'', ''Mod4'', ''Control'', ''Shift'', ''Lock''. Sensible combinations strongly depend on your | + | Mod1, Mod2, Mod3, Mod4, Mod5, Control, Shift, Lock. Sensible |
- | keyboard configuration, but usually you will need ''Mod1'' and ''Control''. Boolean in | + | combinations strongly depend on your keyboard configuration, but |
- | this context means ''0'', ''false'' and an unspecified attribute are false, anything | + | usually you will need Mod1 and Control. Boolean in this context means |
- | else is considered true. | + | '0', 'false' and an unspecified attribute are false, anything else is |
+ | considered true. | ||
- | Everything in this file is case-sensitive. Unknown lines are ignored. | + | Everything in this file is case-sensitive. Unknown lines are ignored |
- | Keybindings are evaluated from top to bottom, so if a keybinding matches, other | + | (accompanied by a warning in the session log). Keybindings are |
- | keybindings further down will be ignored. The contents of the file replaces the | + | evaluated from top to bottom, so if a keybinding matches, other |
- | default keybindings, and only one file is read, no merging between different | + | keybindings further down will be ignored. The contents of the file |
- | configuration files is done. This also means that an empty or invalid configuration | + | replaces the default keybindings, and only one file is read, no |
- | file deactivates all keybindings. | + | merging between different configuration files is done. This also means |
+ | that an empty or invalid configuration file deactivates all | ||
+ | keybindings. | ||
+ | |||
+ | If an attribute occurs more than once in a line the last one wins. | ||
+ | |||
+ | Some of the actions can open a dialog window. Depending on the user's | ||
+ | answer the selected action will be taken. Some actions will only show | ||
+ | a dialog informing the user about the taken action. All these dialogs | ||
+ | will only work if the nxagent/x2goagent process has a properly | ||
+ | configured NX_CLIENT environment variable pointing to an executable | ||
+ | (like nxdialog) that is responsible for showing the dialogs and taking | ||
+ | the action(s). If that executable cannot be run no dialog will show up | ||
+ | and no action will be taken. | ||
===== List of possible ''action'' attributes ===== | ===== List of possible ''action'' attributes ===== | ||
Line 95: | Line 108: | ||
* This action switches between the auto-resize and viewport mode (static size). The default is auto-resize. In viewport mode one can use the 'viewport_move_up', 'viewport_move_down', 'viewport_move_left' and 'viewport_move_right' actions to move within the image. | * This action switches between the auto-resize and viewport mode (static size). The default is auto-resize. In viewport mode one can use the 'viewport_move_up', 'viewport_move_down', 'viewport_move_left' and 'viewport_move_right' actions to move within the image. | ||
* **defer** | * **defer** | ||
- | * Works like 'ignore' to make some keys be ignored/defunct inside the session. | + | * Disables deferred screen updates. |
* **ignore** | * **ignore** | ||
* Makes it possible to add 'ignore', as in nothing happens when certain keys are pressed. | * Makes it possible to add 'ignore', as in nothing happens when certain keys are pressed. |