Browse Source

doc: hotkey

Serj Kalichev 1 year ago
parent
commit
b6db7e5b2d
1 changed files with 40 additions and 0 deletions
  1. 40 0
      docs/klish3.ru.md

+ 40 - 0
docs/klish3.ru.md

@@ -441,6 +441,46 @@ SEQ сам может быть элементом контейнера SWITCH.
 
 ### HOTKEY
 
+Для более удобной работы в интерфейсе командной строки, для часто используемых
+команд могут быть заданы "горячие клавиши". Горячая клавиша определяется с
+помощью тега `HOTKEY`.
+
+Для работы горячих клавиш нужна поддержка в клиентской программе, которая
+подключается к серверу klishd. Клиент "klish" имеет такую поддержку.
+
+Тег `HOTKEY` не может иметь вложенных тегов. Какие либо дополнительные данные
+внутри тега не предусмотрены.
+
+
+#### Атрибут `key`
+
+Атрибут определяет, что именно должен нажать оператор для активации горячей
+клавиши. Поддерживаются комбинации с клавишей "Ctrl". Например `^Z` означает,
+что должна быть нажата комбинация клавиш "Ctrl" и "Z".
+
+```
+<HOTKEY key="^Z" cmd="exit"\>
+```
+
+
+#### Атрибут `cmd`
+
+Атрибут определяет какое именно действие будет выполнено при нажатии оператором
+горячей клавиши. Значение атрибута `cmd` разбирается по тем же правилам, как
+любая другая команда вручную введенная оператором.
+
+```
+<COMMAND name="exit" help="Exit view or shell">
+	<ACTION sym="nav">pop</ACTION>
+</COMMAND>
+
+<HOTKEY key="^Z" cmd="exit"\>
+```
+
+Команда, используемая в качестве значения атрибута `cmd` должно быть определена
+в файлай конфигурации. Приведенный пример выполнит ранее определенную команду
+`exit` при нажатии сочетания клавиш "Ctrl^Z".
+
 
 ### ACTION