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

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

: diary

: diary on

: diary off

: diary filename

: [status, diaryfile] = diary

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

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

on

Начать запись сеанса в файл с именем diary в текущем рабочем каталоге.

off

Остановить запись сеанса в файл дневника.

filename

Записывать сеанс в файл с именем filename.

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

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

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