1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: A Sample Command Description</title>
<meta name="description" content="GNU Octave: A Sample Command Description">
<meta name="keywords" content="GNU Octave: A Sample Command Description">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Format-of-Descriptions.html#Format-of-Descriptions" rel="up" title="Format of Descriptions">
<link href="Getting-Started.html#Getting-Started" rel="next" title="Getting Started">
<link href="A-Sample-Function-Description.html#A-Sample-Function-Description" rel="prev" title="A Sample Function Description">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="A-Sample-Command-Description"></a>
<div class="header">
<p>
Previous: <a href="A-Sample-Function-Description.html#A-Sample-Function-Description" accesskey="p" rel="prev">A Sample Function Description</a>, Up: <a href="Format-of-Descriptions.html#Format-of-Descriptions" accesskey="u" rel="up">Format of Descriptions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="A-Sample-Command-Description-1"></a>
<h4 class="subsubsection">1.3.5.2 A Sample Command Description</h4>
<a name="index-command-descriptions"></a>
<p>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
<code>cd</code> command:
</p>
<dl>
<dt><a name="index-cd"></a>Command: <em></em> <strong>cd</strong> <em>dir</em></dt>
<dt><a name="index-chdir"></a>Command: <em></em> <strong>chdir</strong> <em>dir</em></dt>
<dd><p>Change the current working directory to <var>dir</var>. For example,
<kbd>cd ~/octave</kbd> changes the current working directory to
<samp>~/octave</samp>. If the directory does not exist, an error message is
printed and the working directory is not changed.
</p></dd></dl>
</body>
</html>
|
