1.3.5.2 Пример описания команды

Команды — это функции, которые могут быть вызваны без скобок вокруг аргументов. Описания команд имеют формат, аналогичный описаниям функций. Например, вот описание команды Octave diary:

diary

diary on

diary off

diary filename

[status, diaryfile] = diary

Записывает список всех команд и результатов, которые они производят, перемешивая их так, как они отображаются на терминале.

Допустимые параметры:

on: Начать запись сессии в файл с именем diary в текущем рабочем каталоге.
off: Остановить запись сессии в файл журнала.
filename: Записать сессию в файл с именем filename.

Без входных или выходных аргументов, diary переключает текущее состояние журнала.

Если запрашиваются выходные аргументы, diary игнорирует входные данные и возвращает текущий статус. Булево значение status указывает, включена ли запись, а diaryfile — имя файла, в котором хранится сессия.

См. также: history, evalc.

© 1996–2022 The Octave Project Developers
Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions.
https://docs.octave.org/v5.2.0/A-Sample-Command-Description.html