Browse Source

lua klish plugin: help updated

Peter Kosyh 1 year ago
parent
commit
8d61f5cebd
1 changed files with 21 additions and 6 deletions
  1. 21 6
      docs/klish3.ru.md

+ 21 - 6
docs/klish3.ru.md

@@ -2122,13 +2122,13 @@ backtrace=1
 
 При выполнении Lua `ACTION` доступны следующие функции:
 
-#### klish.par()
+#### klish.pars()
 
 Возвращает информацию о параметрах. Возможно два варианта применения этой
 функции.
 
 ```
-local pars = klish.par()
+local pars = klish.pars()
 for k, v in ipairs(pars) do
   for i, p in ipairs(pars[v]) do
     print(string.format("%s[%d] = %s", v, i, p))
@@ -2141,18 +2141,24 @@ end
 имён, так и массив значений для каждого имени. В примере выше показан итератор
 по всем параметрам с выводом их значений.
 
-Кроме того, klish.par может быть вызван для взятия значений конкретного
+Кроме того, klish.pars может быть вызван для взятия значений конкретного
 параметра, например:
 
 ```
-print("int_val = ", klish.par('int_val')[1])
+print("int_val = ", klish.pars('int_val')[1])
 ```
 
-#### klish.ppar()
+#### klish.ppars()
 
-Работает точно так же как и `klish.par()`, но только для родительских
+Работает точно так же как и `klish.ppars()`, но только для родительских
 параметров, если они есть в данном контексте.
 
+#### klish.par() и klish.ppar()
+
+Работают так же как и `klish.pars()`, `klish.ppars()` с заданием конкретного
+параметра, но возвращают не массив, а значение. Если параметров с таким именем
+несколько, то вернётся первый.
+
 #### klish.path()
 
 Возвращает текущий путь в виде массива строк. Например:
@@ -2160,3 +2166,12 @@ print("int_val = ", klish.par('int_val')[1])
 ```
 print(table.concat(klish.path(), "/"))
 ```
+
+#### klish.context()
+
+Позволяет получить некоторые параметры контекста команды. Принимает на вход
+строку -- имя параметра контекста:
+
+- val;
+- cmd;
+- pcmd.