A Sample Command Description

Next: A Sample Variable Description, Previous: A Sample Function Description, Up: Format of Descriptions

1.3.5.2 A Sample Command Description

Command descriptions have a format similar to function descriptions, except that the word `Function' is replaced by `Command'. Commands are functions that may be called without surrounding their arguments in parentheses. For example, here is the description for Octave's cd command:

— Command: cd dir
— Command: chdir dir

Change the current working directory to dir. For example, cd ~/octave changes the current working directory to ~/octave. If the directory does not exist, an error message is printed and the working directory is not changed.