Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > b38d2da330d1936e5ab1307c039c4941 > files > 91

octave-doc-3.6.4-3.mga4.noarch.rpm

<html lang="en">
<head>
<title>A Sample Command Description - GNU Octave</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Octave">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Format-of-Descriptions.html#Format-of-Descriptions" title="Format of Descriptions">
<link rel="prev" href="A-Sample-Function-Description.html#A-Sample-Function-Description" title="A Sample Function Description">
<link rel="next" href="A-Sample-Variable-Description.html#A-Sample-Variable-Description" title="A Sample Variable Description">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="A-Sample-Command-Description"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="A-Sample-Variable-Description.html#A-Sample-Variable-Description">A Sample Variable Description</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="A-Sample-Function-Description.html#A-Sample-Function-Description">A Sample Function Description</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Format-of-Descriptions.html#Format-of-Descriptions">Format of Descriptions</a>
<hr>
</div>

<h5 class="subsubsection">1.3.5.2 A Sample Command Description</h5>

<p><a name="index-command-descriptions-24"></a>
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:

<div class="defun">
&mdash; Command:  <b>cd</b><var> dir<a name="index-cd-25"></a></var><br>
&mdash; Command:  <b>chdir</b><var> dir<a name="index-chdir-26"></a></var><br>
<blockquote><p>Change the current working directory to <var>dir</var>.  For example,
<kbd>cd ~/octave</kbd> changes the current working directory to
<samp><span class="file">~/octave</span></samp>.  If the directory does not exist, an error message is
printed and the working directory is not changed. 
</p></blockquote></div>

   </body></html>