Spec-Zone.ru › Fish 3.3

функции - функции печати или удаления

Описание

functions [ -a | --all ] [ -n | --names ]
functions [ -D | --details ] [ -v ] FUNCTION
functions -c OLDNAME NEWNAME
functions -d DESCRIPTION FUNCTION
functions [ -e | -q ] FUNCTIONS...

Описание

functions печатает или удаляет функции.

Доступны следующие параметры:

  • -a или --all отображает все функции, включая те, чьё имя начинается с нижнего подчеркивания.
  • -c OLDNAME NEWNAME или --copy OLDNAME NEWNAME создаёт новую функцию с именем NEWNAME, используя определение функции OLDNAME.
  • -d DESCRIPTION или --description=DESCRIPTION изменяет описание этой функции.
  • -e или --erase приводит к удалению указанных функций. Это также означает, что их автоматическая загрузка будет запрещена.
  • -D или --details сообщает путь к определению указанной функции или место её автоматической загрузки, stdin если функция была определена интерактивно или в командной строке, или путём считывания из stdin, - если функция была создана через source, и n/a если функция недоступна. (Функции, созданные через alias, вернут -, потому что alias использует source внутри.) Если также указан параметр --verbose, выводятся пять строк:

    • путь, как описано выше,
    • autoloaded, not-autoloaded или n/a,
    • номер строки в файле или ноль, если не применимо,
    • scope-shadowing если функция затеняет переменные в вызывающей функции (обычный случай, если она не была определена с --no-scope-shadowing), иначе no-scope-shadowing, или n/a если функция не определена,
    • описание функции с минимальными экранированиями, чтобы это была одна строка, или n/a если функция не определена.

Не следует предполагать, что будет выведено только пять строк, так как в будущем мы можем добавить дополнительную информацию в вывод.

  • --no-details отключает вывод пути к функциям, поэтому будет выведено только определение.
  • -n или --names выводит имена всех определённых функций.
  • -q или --query проверяет, существуют ли указанные функции.
  • -v или --verbose сделает вывод более подробным.
  • -H или --handlers покажет все обработчики событий.
  • -t или --handlers-type TYPE покажет все обработчики событий, соответствующие заданному типу.

По умолчанию functions, вызываемый без аргументов, печатает имена всех определённых функций. Если не указан параметр -a, функции, начинающиеся с нижнего подчеркивания, в выводе не отображаются.

Если указаны какие-либо параметры, не являющиеся опциональными, будет выведено определение указанных функций.

Копирование функции с помощью -c копирует только тело функции и не прикрепляет какие-либо уведомления об событиях из исходной функции.

Описание только одной функции может быть изменено в одном вызове functions -d.

Код возврата functions — это количество функций, указанных в списке аргументов, которых не существует. Это можно использовать совместно с параметром -q.

Примеры

functions -n
# Displays a list of currently-defined functions

functions -c foo bar
# Copies the 'foo' function to a new function called 'bar'

functions -e bar
# Erases the function ``bar``

См. также

Для более подробного объяснения того, как функции используются в Fish, см. Функции.

© 2021 fish-shell developers
Licensed under the GNU General Public License, version 2.
https://fishshell.com/docs/3.3/cmds/functions.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API