`use`

Вывод сообщения об использовании

Синтаксис:

use [-aeis] [-d каталог] [-f список_файлов] файлы

Опции:

-a: Извлечь всю информации об использовании из загрузочного модуля в исходной форме, пригодной для направления по каналу в утилиту usemsg.
-d каталог: Рекурсивно вывести информацию для всех файлов в каталоге.
-e: Включить только файлы ELF.
-f список_файлов: Считать список файлов, по одному на строку, из файла, указанного аргументом список_файлов, и вывести информацию для каждого из файлов в списке.
-i: Отобразить свойства сборки загрузочного модуля.
-s: Отобразить номера версий исходных файлов, использованных в исполняемом файле.
файлы: Один или несколько исполняемых загрузочных модулей или сценариев командного интерпретатора, содержащих сообщения об использовании.

Платформы:

ЗОСРВ «Нейтрино», GNU/Linux, Microsoft Windows

Целевые архитектуры:

arm, armv7, aarch64, e2k, mips, ppc, x86

Описание:

Утилита use выводит сообщение об использовании для указанных исполняемых программ или сценариев командного интерпретатора.

Независимо от текущих параметров настройки терминала, утилита use автоматически вставляет перенос строки после 80 символов.

Утилита use выполняет поиск файлов с помощью поиска команд по умолчанию (используется переменная окружения PATH) и выводит сообщение об использовании (если таковое присутствует), обнаруженное в файлах загрузки или сценариях командного интерпретатора.

Если установлена переменная среды LANG, сообщение об использовании выводится на указанном языке, если оно доступно. Для сценариев командного интерпретатора сообщения об использовании на альтернативных языках недоступны. Однако сообщения сценариев командного интерпретатора можно с легкостью изменить. В стандартные версии ЗОСРВ «Нейтрино» включены сообщения об использовании только на английском языке, однако сообщения об использовании на альтернативных языках можно добавить путем размещения измененного сообщения об использовании в отдельном файле и вызова утилиты usemsg для вставки сообщения об использовании в рассматриваемый исполняемый файл.

Сообщения об использовании в сценариях командного интерпретатора

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

В сценариях командного интерпретатора утилита use выполняет сканирование каждой строки с начала сценария в поисках строки, начинающейся с символа # (то есть комментария) и содержащей строку __USAGE. Сообщение об использовании начинается со следующей строки и состоит из всех последующих строк (не включительно) вплоть до строки, начинающейся либо с #endif, либо с любого символа кроме #.

Пример сообщения об использовании в сценарии командного интерпретатора:

#ifdef __USAGE
#%C thread_id
#Where:
# thread_id is the thread ID you want to act on
#endif

Если сценарий командного интерпретатора называется foo, то при вызове команды $ use foo выводится следующее сообщение об использовании:

$ use foo foo thread_id Where: thread_id is the thread ID you want to act on

В приведенном выше фрагменте сценария командного интерпретатора сообщение начинается со строки:

#%C thread_id

и заканчивается строкой:

# thread_id is the thread ID you want to act on

В пределах тела сообщения об использовании начальные символы # отбрасываются утилитой use и не является частью выводимого сообщения. Как и в случае правил написания сообщений об использовании языка C (см. usemsg), сочетание символов %C и символ табуляции в начале строки заменяется именем программы (или именем файла сценария командного интерпретатора), а символ табуляции в начале строки смещает вывод на количество пробелов, равное длине предыдущего сочетания %C-табуляция.

Сообщение об использовании можно разместить практически в любой точке большинства сценариев командного интерпретатора. Размещение сообщения в начале файла позволяет снизить время отклика при извлечении сообщения об использовании, однако приводит к незначительному замедлению выполнения сценария. Если в запущенном командном интерпретаторе строки, начинающиеся с символа # в качестве комментариев, не поддерживаются, то сообщение об использовании следует разместить после явного вызова exit.

Примеры:

Просмотр сообщения об использовании для утилиты ls:

$ use ls

Возвращаемое значение:

0: Успешное завершение.
≠0: Утилита завершилась с ошибками.

Классификация:

Инструментальные средства ЗОСРВ «Нейтрино»

Тематические ссылки:

usemsg

Предыдущий раздел: Справочник по утилитам