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

+ 38 - 0
docs/klish3.ru.md

@@ -235,6 +235,9 @@ VIEW. Можно определить VIEW со "стандартными" ко
 Фильтры могут использоваться один за другим, с разделителем '|', как это
 делается в shell.
 
+Если команда не является фильтром, то она не может использоваться после символа
+'|'.
+
 Фильтр задается в файлах конфигурации с помощью тега 'FILTER'.
 
 
@@ -261,6 +264,41 @@ VIEW. Можно определить VIEW со "стандартными" ко
 SEQ сам может быть элементом контейнера SWITCH.
 
 
+### Приглашения командной строки
+
+Для формирования приглашения командной строки, которую видит оператор,
+используется конструкция 'PROMPT'. Тег PROMPT должен быть вложен внутрь VIEW.
+Разные VIEW могут иметь разные приглашения. Т.е. в зависимости от текущего
+пути, оператор видит разное приглашение. Приглашение может быть динамическим
+и генерироваться действиями 'ACTION', заданными внутри PROMPT.
+
+
+### Автодополнение и подсказки
+
+Для удобства работы оператора для команд и параметров могут быть реализованы
+подсказки и автодополнение. Подсказки (help), поясняющие предназначение и
+формат возможных параметров, отображаются в клиенте klish по нажатию клавиши
+'?'. Список возможных дополнений печатается при нажатии оператором клавиши 'Tab'.
+
+Для задания подсказок и списка возможных дополнений в конфигурации используются
+теги 'HELP' и 'COMPL'. Эти теги должны быть вложенными относительно
+соответствующих команд и параметров. Для простоты подсказки для параметра или
+команды могут быть заданы аттрибутом основного тега, если подказка является
+статическим текстом и ее не нужно генерировать. Если подсказка динамическая, то
+ее содержимое генерируется действиями ACTION, вложенными внутрь HELP. Для
+дополнений COMPL действия ACTION генерируют список возможных значений
+параметра, разделенных переводом строки.
+
+
+### Условный элемент
+
+Команды и параметры могут быть скрыты от оператора на основании динамических
+условий. Условие задается с помощью тега 'COND', вложенного внутрь
+соответствующей команды или параметра. Внутри COND находятся одно или несколько
+действий ACTION. Если код возврата ACTION '0', т.е. успех, то параметр доступен
+оператору. Если ACTION вернули ошибку, то элемент будет скрыт.
+
+
 ### Плугин
 
 Процесс klishd загружает не все существующие плугины функций подряд, а только