2.3 Команды для получения справки

Весь текст этого руководства доступен из командной строки Octave с помощью команды doc. Кроме того, документация по отдельным функциям и переменным, написанным пользователем, также доступна с помощью команды help. В этом разделе описываются команды, используемые для чтения руководства и строк документации для функций и переменных, предоставленных пользователем. См. Файлы функций для получения дополнительной информации о документировании функций, которые вы пишете.

: help name ¶

: help --list ¶

: help . ¶

: help ¶

Отобразить текст справки для name.

Например, команда help help выводит короткое сообщение, описывающее команду help.

При единственном аргументе --list, перечислить все операторы, ключевые слова, встроенные функции и загружаемые функции, доступные в текущем сеансе Octave.

При единственном аргументе ., перечислить все доступные в текущем сеансе Octave операторы.

Если вызвана без аргументов, help отображает инструкции по доступу к справке из командной строки.

Команда help может предоставить информацию о большинстве операторов, но name необходимо заключить в одинарные или двойные кавычки, чтобы предотвратить обработку name интерпретатором Octave. Например, help "+" отображает справку по оператору сложения.

См. также: doc, lookfor, which, info.

: doc function_name ¶

: doc ¶

Отобразить документацию для функции function_name непосредственно из онлайн-версии печатного руководства, используя браузер GNU Info.

Если вызвана без аргумента, руководство отображается с самого начала.

Например, команда doc rand запускает браузер GNU Info в узле rand в онлайн-версии руководства.

После запуска браузера GNU Info, справка по его использованию доступна с помощью команды C-h.

См. также: help.

: lookfor str ¶

: lookfor -all str ¶

: [fcn, help1str] = lookfor (str) ¶

: [fcn, help1str] = lookfor ("-all", str) ¶

Поиск строки str в документации всех функций в текущем пути поиска функций.

По умолчанию, lookfor ищет str только в первом предложении строки справки для каждой найденной функции. Весь текст справки каждой функции можно найти, используя аргумент "-all". Все поиски нечувствительны к регистру.

Когда вызывается без выходных аргументов, lookfor выводит список соответствующих функций в терминал. В противном случае, выходной аргумент fcns содержит имена функций, а help1str содержит первое предложение из строки справки каждой функции.

Примечание для программистов: Способность lookfor правильно идентифицировать первое предложение текста справки зависит от формата справки функции. Все функции ядра Octave отформатированы правильно, но этого нельзя гарантировать для внешних пакетов и функций, предоставленных пользователем. Поэтому может потребоваться использование аргумента "-all" для поиска связанных функций, которые не являются частью Octave.

Скорость поиска значительно повышается при наличии кэшированного файла документации. Дополнительную информацию см. в doc_cache_create.

См. также: help, doc, which, path, doc_cache_create.

Чтобы узнать, что нового в текущей версии Octave, используйте функцию news.

: news ¶

: news package ¶

Отобразить текущий файл NEWS для Octave или установленного пакета.

При вызове без аргументов отображается файл NEWS для Octave.

При указании имени пакета package, отображается текущий файл NEWS для этого пакета.

См. также: ver, pkg.

: info () ¶

Отобразить контактную информацию для сообщества GNU Octave.

: warranty () ¶

Описать условия копирования и распространения Octave.

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

: val = info_file () ¶

: old_val = info_file (new_val) ¶

: info_file (new_val, "local") ¶

Запрос или установка внутренней переменной, определяющей имя файла справки Octave.

Значение по умолчанию — octave-home/share/info/octave.info, где octave-home — корневой каталог установки Octave. Значение по умолчанию может быть изменено переменной среды OCTAVE_INFO_FILE, или аргументом командной строки --info-file FNAME.

При вызове изнутри функции с параметром "local", переменная изменяется локально для функции и всех вызываемых ею подпрограмм. Исходное значение переменной восстанавливается при выходе из функции.

См. также: info_program, doc, help, makeinfo_program.

: val = info_program () ¶

: old_val = info_program (new_val) ¶

: info_program (new_val, "local") ¶

Запрос или установка внутренней переменной, определяющей имя программы info для запуска.

Значение по умолчанию — info. Значение по умолчанию может быть изменено переменной среды OCTAVE_INFO_PROGRAM, или аргументом командной строки --info-program NAME.

При вызове изнутри функции с параметром "local", переменная изменяется локально для функции и всех вызываемых ею подпрограмм. Исходное значение переменной восстанавливается при выходе из функции.

См. также: info_file, doc, help, makeinfo_program.

: val = makeinfo_program () ¶

: old_val = makeinfo_program (new_val) ¶

: makeinfo_program (new_val, "local") ¶

Запрос или установка внутренней переменной, определяющей имя программы, которую Octave запускает для форматирования текста справки, содержащего команды разметки Texinfo.

Значение по умолчанию — makeinfo.

При вызове изнутри функции с параметром "local", переменная изменяется локально для функции и всех вызываемых ею подпрограмм. Исходное значение переменной восстанавливается при выходе из функции.

См. также: texi_macros_file, info_file, info_program, doc, help.

: val = texi_macros_file () ¶

: old_val = texi_macros_file (new_val) ¶

: texi_macros_file (new_val, "local") ¶

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

Значение по умолчанию — octave-home/share/octave/version/etc/macros.texi, где octave-home — корневой каталог установки Octave, а version — номер версии Octave. Значение по умолчанию может быть переопределено переменной среды OCTAVE_TEXI_MACROS_FILE, или аргументом командной строки --texi-macros-file FNAME.

При вызове изнутри функции с опцией "local", переменная изменяется локально для функции и всех вызываемых подпрограмм. Исходное значение переменной восстанавливается при выходе из функции.

См. также: makeinfo_program.

: val = doc_cache_file () ¶

: old_val = doc_cache_file (new_val) ¶

: doc_cache_file (new_val, "local") ¶

Запрос или установка внутренней переменной, определяющей имя файла кэша документации Octave.

Файл кэша значительно улучшает производительность команды lookfor. Значение по умолчанию — octave-home/share/octave/version/etc/doc-cache, где octave-home — корневой каталог установки Octave, а version — номер версии Octave. Значение по умолчанию может быть переопределено переменной среды OCTAVE_DOC_CACHE_FILE, или аргументом командной строки --doc-cache-file FNAME.

При вызове изнутри функции с опцией "local", переменная изменяется локально для функции и всех вызываемых подпрограмм. Исходное значение переменной восстанавливается при выходе из функции.

См. также: doc_cache_create, lookfor, info_program, doc, help, makeinfo_program.

См. также: lookfor.

: val = built_in_docstrings_file () ¶

: old_val = built_in_docstrings_file (new_val) ¶

: built_in_docstrings_file (new_val, "local") ¶

Запрос или установка внутренней переменной, определяющей имя файла, содержащего строки документации для встроенных функций Octave.

Значение по умолчанию — octave-home/share/octave/version/etc/built-in-docstrings, где octave-home — корневой каталог установки Octave, а version — номер версии Octave. Значение по умолчанию может быть переопределено переменной среды OCTAVE_BUILT_IN_DOCSTRINGS_FILE, или аргументом командной строки --built-in-docstrings-file FNAME.

Примечание: Эта переменная используется только при инициализации Octave. Изменение её во время сеанса работы с Octave не повлияет на работу.

: val = suppress_verbose_help_message () ¶

: old_val = suppress_verbose_help_message (new_val) ¶

: suppress_verbose_help_message (new_val, "local") ¶

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

При вызове изнутри функции с опцией "local", переменная изменяется локально для функции и всех вызываемых подпрограмм. Исходное значение переменной восстанавливается при выходе из функции.

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

: doc_cache_create (out_file, directory) ¶

: doc_cache_create (out_file) ¶

: doc_cache_create () ¶

Генерация кэша документации для всех функций в directory.

Кэш документации создаётся для всех функций в directory, которое может быть одной строкой или массивом строк. Кэш используется для ускорения функции lookfor.

Кэш сохраняется в файле out_file, который по умолчанию равен doc-cache, если не указан.

Если каталог не указан (или это пустая матрица), создаётся кэш для встроенных функций, операторов и ключевых слов.

См. также: doc_cache_file, lookfor, path.

: [text, format] = get_help_text (name) ¶

Возвращает исходный текст справки функции name.

Исходный текст справки возвращается в text, а формат — в format. Формат — строка, которая может быть "texinfo", "html", или "plain text".

См. также: get_help_text_from_file.

: [text, format] = get_help_text_from_file (fname) ¶

Возвращает исходный текст справки из файла fname.

Исходный текст справки возвращается в text, а формат — в format. Формат — строка, которая может быть "texinfo", "html", или "plain text".

См. также: get_help_text.

: text = get_first_help_sentence (name) ¶

: text = get_first_help_sentence (name, max_len) ¶

: [text, status] = get_first_help_sentence (…) ¶

Возвращает первое предложение текста справки функции.

Первое предложение определяется как текст после объявления функции до первой точки (".") или первого появления двух последовательных переносов строки ("\n\n"). Текст усекается до максимальной длины max_len, которая по умолчанию равна 80. Если текст должен быть усечён, последние три символа текста заменяются на "..." для указания, что больше текста было доступно.

Необязательный выходной аргумент status возвращает статус, возвращаемый makeinfo. Если запрашивается только один выходной аргумент, и status не равен нулю, выводится сообщение об ошибке.

Например, первое предложение этого текста справки —

get_first_help_sentence ("get_first_help_sentence")
-| ans = Return the first sentence of a function's help text.