summaryrefslogtreecommitdiff
path: root/nuttx/Documentation/NuttShell.html
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-11-09 14:54:29 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-11-09 14:54:29 +0000
commit42a56e78dda5561d301ec2e61a0bac17e7342525 (patch)
tree5dec10051ddb12ddf1d6d7f02c69d09ad2a27895 /nuttx/Documentation/NuttShell.html
parent2b35c03044dc6acfe720522f943ee07df1b65897 (diff)
downloadpx4-nuttx-42a56e78dda5561d301ec2e61a0bac17e7342525.tar.gz
px4-nuttx-42a56e78dda5561d301ec2e61a0bac17e7342525.tar.bz2
px4-nuttx-42a56e78dda5561d301ec2e61a0bac17e7342525.zip
Several patches from Petteri Aimonen (mostly NxWidgets)
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5324 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'nuttx/Documentation/NuttShell.html')
-rw-r--r--nuttx/Documentation/NuttShell.html164
1 files changed, 100 insertions, 64 deletions
diff --git a/nuttx/Documentation/NuttShell.html b/nuttx/Documentation/NuttShell.html
index 31546a100..1b14f96f6 100644
--- a/nuttx/Documentation/NuttShell.html
+++ b/nuttx/Documentation/NuttShell.html
@@ -8,7 +8,7 @@
<tr align="center" bgcolor="#e4e4e4">
<td>
<h1><big><font color="#3c34ec"><i>NuttShell (NSH)</i></font></big></h1>
- <p>Last Updated: November 4, 2012</p>
+ <p>Last Updated: November 9, 2012</p>
</td>
</tr>
</table>
@@ -173,187 +173,193 @@
<tr>
<td><br></td>
<td>
- <a href="#cmdifconfig">2.16 Manage Network Configuration (ifconfig)</a>
+ <a href="#cmdhexdump">2.16 Hexadecimal Dump of File or Device (hexdump)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdifdown">2.17 Take a network down (ifdown)</a>
+ <a href="#cmdifconfig">2.17 Manage Network Configuration (ifconfig)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdifup">2.18 Bring a network up (ifup)</a>
+ <a href="#cmdifdown">2.18 Take a network down (ifdown)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdkill">2.19 Send a signal to a task (kill)</a>
+ <a href="#cmdifup">2.19 Bring a network up (ifup)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdlosetup">2.20 Setup/teardown the Loop Device (losetup)</a>
+ <a href="#cmdkill">2.20 Send a signal to a task (kill)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdls">2.21 List Directory Contents (ls)</a>
+ <a href="#cmdlosetup">2.21 Setup/teardown the Loop Device (losetup)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdmd5">2.22 Calculate MD5 (md5)</a>
+ <a href="#cmdls">2.22 List Directory Contents (ls)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdmbhw">2.23 Access Memory (mb, mh, and mw)</a>
+ <a href="#cmdmd5">2.23 Calculate MD5 (md5)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdps">2.24 Show Current Tasks and Threads (ps)</a>
+ <a href="#cmdmbhw">2.24 Access Memory (mb, mh, and mw)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdmkdir">2.25 Create a Directory (mkdir)</a>
+ <a href="#cmdps">2.25 Show Current Tasks and Threads (ps)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdmkfatfs">2.26 Create a FAT Filesystem (mkfatfs)</a>
+ <a href="#cmdmkdir">2.26 Create a Directory (mkdir)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdmkfifo">2.27 Create a FIFO (mkfifo)</a>
+ <a href="#cmdmkfatfs">2.27 Create a FAT Filesystem (mkfatfs)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdmkrd">2.28 Create a RAMDISK (mkrd)</a>
+ <a href="#cmdmkfifo">2.28 Create a FIFO (mkfifo)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdmount">2.29 Mount a File System (mount)</a>
+ <a href="#cmdmkrd">2.29 Create a RAMDISK (mkrd)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdmv">2.30 Rename a File (mv)</a>
+ <a href="#cmdmount">2.30 Mount a File System (mount)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdnfsmount">2.31 Mount an NFS file system (nfsmount)</a>
+ <a href="#cmdmv">2.31 Rename a File (mv)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdping">2.32 Check Network Peer (ping)</a>
+ <a href="#cmdnfsmount">2.32 Mount an NFS file system (nfsmount)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdput">2.33 Send File Via TFTP (put)</a>
+ <a href="#cmdping">2.33 Check Network Peer (ping)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdpwd">2.34 Show Current Working Directory (pwd)</a>
+ <a href="#cmdput">2.34 Send File Via TFTP (put)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdrm">2.35 Remove a File (rm)</a>
+ <a href="#cmdpwd">2.35 Show Current Working Directory (pwd)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdrmdir">2.36 Remove a Directory (rmdir)</a>
+ <a href="#cmdrm">2.36 Remove a File (rm)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdset">2.37 Set an Environment Variable (set)</a>
+ <a href="#cmdrmdir">2.37 Remove a Directory (rmdir)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdsh">2.38 Execute an NSH Script (sh)</a>
+ <a href="#cmdset">2.38 Set an Environment Variable (set)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdsleep">2.39 Wait for Seconds (sleep)</a>
+ <a href="#cmdsh">2.39 Execute an NSH Script (sh)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdunmount">2.40 Unmount a File System (umount)</a>
+ <a href="#cmdsleep">2.40 Wait for Seconds (sleep)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdunset">2.41 Unset an Environment Variable (unset)</a>
+ <a href="#cmdunmount">2.41 Unmount a File System (umount)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdurldec">2.42 URL Decode (urldecode)</a>
+ <a href="#cmdunset">2.42 Unset an Environment Variable (unset)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdurlencode">2.43 URL Encode (urlencode)</a>
+ <a href="#cmdurldec">2.43 URL Decode (urldecode)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdusleep">2.44 Wait for Microseconds (usleep)</a>
+ <a href="#cmdurlencode">2.44 URL Encode (urlencode)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdwget">2.45 Get File Via HTTP (wget)</a>
+ <a href="#cmdusleep">2.45 Wait for Microseconds (usleep)</a>
</td>
</tr>
<tr>
<td><br></td>
<td>
- <a href="#cmdxd">2.46 Hexadecimal Dump (xd)</a>
+ <a href="#cmdwget">2.46 Get File Via HTTP (wget)</a>
+ </td>
+</tr>
+<tr>
+ <td><br></td>
+ <td>
+ <a href="#cmdxd">2.47 Hexadecimal Dump of Memory (xd)</a>
</td>
</tr>
<tr>
@@ -1182,7 +1188,31 @@ help [-v] [&lt;cmd&gt;]
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdifconfig"><h2>2.16 Manage Network Configuration (ifconfig)</h2></a>
+ <a name="cmdhexdump"><h2>2.16 Hexadecimal Dump of File or Device (hexdump)</h2></a>
+ </td>
+ </tr>
+</table>
+
+<p><b>Command Syntax:</b></p>
+<ul><pre>
+hexdump &lt;file or device&gt;
+</pre></ul>
+<p>
+ <b>Synopsis</b>.
+ Dump data in hexadecimal format from a file or character device.
+</p>
+
+<tr>
+ <td><br></td>
+ <td>
+ <a href="#"></a>
+ </td>
+</tr>
+
+<table width ="100%">
+ <tr bgcolor="#e4e4e4">
+ <td>
+ <a name="cmdifconfig"><h2>2.17 Manage Network Configuration (ifconfig)</h2></a>
</td>
</tr>
</table>
@@ -1236,7 +1266,7 @@ ifconfig nic_name ip_address
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdifdown"><h2>2.17 Take a network down (ifdown)</h2></a>
+ <a name="cmdifdown"><h2>2.18 Take a network down (ifdown)</h2></a>
</td>
</tr>
</table>
@@ -1259,7 +1289,7 @@ ifdown eth0
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdifup"><h2>2.18 Bring a network up (ifup)</h2></a>
+ <a name="cmdifup"><h2>2.19 Bring a network up (ifup)</h2></a>
</td>
</tr>
</table>
@@ -1282,7 +1312,7 @@ ifup eth0
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdkill"><h2>2.19 Send a signal to a task (kill)</h2></a>
+ <a name="cmdkill"><h2>2.20 Send a signal to a task (kill)</h2></a>
</td>
</tr>
</table>
@@ -1323,7 +1353,7 @@ nsh&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdlosetup"><h2>2.20 Setup/teardown the Loop Device (losetup)</h2></a>
+ <a name="cmdlosetup"><h2>2.21 Setup/teardown the Loop Device (losetup)</h2></a>
</td>
</tr>
</table>
@@ -1376,7 +1406,7 @@ losetup d &lt;dev-path&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdls"><h2>2.21 List Directory Contents (ls)</h2></a>
+ <a name="cmdls"><h2>2.22 List Directory Contents (ls)</h2></a>
</td>
</tr>
</table>
@@ -1413,7 +1443,7 @@ ls [-lRs] &lt;dir-path&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdmd5"><h2>2.22 Calculate MD5 (md5)</h2></a>
+ <a name="cmdmd5"><h2>2.23 Calculate MD5 (md5)</h2></a>
</td>
</tr>
</table>
@@ -1430,7 +1460,7 @@ md5 [-f] &lt;string or filepath&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdmbhw"><h2>2.23 Access Memory (mb, mh, and mw)</h2></a>
+ <a name="cmdmbhw"><h2>2.24 Access Memory (mb, mh, and mw)</h2></a>
</td>
</tr>
</table>
@@ -1484,7 +1514,7 @@ nsh&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdps"><h2>2.24 Show Current Tasks and Threads (ps)</h2></a>
+ <a name="cmdps"><h2>2.25 Show Current Tasks and Threads (ps)</h2></a>
</td>
</tr>
</table>
@@ -1510,7 +1540,7 @@ nsh&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdmkdir"><h2>2.25 Create a Directory (mkdir)</h2></a>
+ <a name="cmdmkdir"><h2>2.26 Create a Directory (mkdir)</h2></a>
</td>
</tr>
</table>
@@ -1545,7 +1575,7 @@ nsh>
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdmkfatfs"><h2>2.26 Create a FAT Filesystem (mkfatfs)</h2></a>
+ <a name="cmdmkfatfs"><h2>2.27 Create a FAT Filesystem (mkfatfs)</h2></a>
</td>
</tr>
</table>
@@ -1565,7 +1595,7 @@ mkfatfs &lt;path&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdmkfifo"><h2>2.27 Create a FIFO (mkfifo)</h2></a>
+ <a name="cmdmkfifo"><h2>2.28 Create a FIFO (mkfifo)</h2></a>
</td>
</tr>
</table>
@@ -1603,7 +1633,7 @@ nsh>
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdmkrd"><h2>2.28 Create a RAMDISK (mkrd)</h2></a>
+ <a name="cmdmkrd"><h2>2.29 Create a RAMDISK (mkrd)</h2></a>
</td>
</tr>
</table>
@@ -1654,7 +1684,7 @@ nsh&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdmount"><h2>2.29 Mount a File System (mount)</h2></a>
+ <a name="cmdmount"><h2>2.30 Mount a File System (mount)</h2></a>
</td>
</tr>
</table>
@@ -1733,7 +1763,7 @@ nsh> mount
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdmv"><h2>2.30 Rename a File (mv)</h2></a>
+ <a name="cmdmv"><h2>2.31 Rename a File (mv)</h2></a>
</td>
</tr>
</table>
@@ -1751,7 +1781,7 @@ mv &lt;old-path&gt; &lt;new-path&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdnfsmount"><h2>2.31 Mount an NFS file system (nfsmount)</h2></a>
+ <a name="cmdnfsmount"><h2>2.32 Mount an NFS file system (nfsmount)</h2></a>
</td>
</tr>
</table>
@@ -1770,7 +1800,7 @@ nfsmount &lt;server-address&gt; &lt;mount-point&gt; &lt;remote-path&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdping"><h2>2.32 Check Network Peer (ping)</h2></a>
+ <a name="cmdping"><h2>2.33 Check Network Peer (ping)</h2></a>
</td>
</tr>
</table>
@@ -1803,7 +1833,7 @@ nsh&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdput"><h2>2.33 Send File Via TFTP (put)</h2></a>
+ <a name="cmdput"><h2>2.34 Send File Via TFTP (put)</h2></a>
</td>
</tr>
</table>
@@ -1838,7 +1868,7 @@ put [-b|-n] [-f &lt;remote-path&gt;] -h &lt;ip-address&gt; &lt;local-path&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdpwd"><h2>2.34 Show Current Working Directory (pwd)</h2></a>
+ <a name="cmdpwd"><h2>2.35 Show Current Working Directory (pwd)</h2></a>
</td>
</tr>
</table>
@@ -1868,7 +1898,7 @@ nsh&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdrm"><h2>2.35 Remove a File (rm)</h2></a>
+ <a name="cmdrm"><h2>2.36 Remove a File (rm)</h2></a>
</td>
</tr>
</table>
@@ -1902,7 +1932,7 @@ nsh>
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdrmdir"><h2>2.36 Remove a Directory (rmdir)</h2></a>
+ <a name="cmdrmdir"><h2>2.37 Remove a Directory (rmdir)</h2></a>
</td>
</tr>
</table>
@@ -1937,7 +1967,7 @@ nsh>
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdset"><h2>2.37 Set an Environment Variable (set)</h2></a>
+ <a name="cmdset"><h2>2.38 Set an Environment Variable (set)</h2></a>
</td>
</tr>
</table>
@@ -1963,7 +1993,7 @@ nsh&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdsh"><h2>2.38 Execute an NSH Script (sh)</h2></a>
+ <a name="cmdsh"><h2>2.39 Execute an NSH Script (sh)</h2></a>
</td>
</tr>
</table>
@@ -1981,7 +2011,7 @@ sh &lt;script-path&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdsleep"><h2>2.39 Wait for Seconds (sleep)</h2></a>
+ <a name="cmdsleep"><h2>2.40 Wait for Seconds (sleep)</h2></a>
</td>
</tr>
</table>
@@ -1998,7 +2028,7 @@ sleep &lt;sec&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdunmount"><h2>2.40 Unmount a File System (umount)</h2></a>
+ <a name="cmdunmount"><h2>2.41 Unmount a File System (umount)</h2></a>
</td>
</tr>
</table>
@@ -2028,7 +2058,7 @@ nsh>
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdunset"><h2>2.41 Unset an Environment Variable (unset)</h2></a>
+ <a name="cmdunset"><h2>2.42 Unset an Environment Variable (unset)</h2></a>
</td>
</tr>
</table>
@@ -2054,7 +2084,7 @@ nsh&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdurldec"><h2>2.42 URL Decode (urldecode)</h2></a>
+ <a name="cmdurldec"><h2>2.43 URL Decode (urldecode)</h2></a>
</td>
</tr>
</table>
@@ -2071,7 +2101,7 @@ urldecode [-f] &lt;string or filepath&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdurlencode"><h2>2.43 URL Encode (urlencode)</h2></a>
+ <a name="cmdurlencode"><h2>2.44 URL Encode (urlencode)</h2></a>
</td>
</tr>
</table>
@@ -2088,7 +2118,7 @@ urlencode [-f] &lt;string or filepath&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdusleep"><h2>2.44 Wait for Microseconds (usleep)</h2></a>
+ <a name="cmdusleep"><h2>2.45 Wait for Microseconds (usleep)</h2></a>
</td>
</tr>
</table>
@@ -2105,7 +2135,7 @@ usleep &lt;usec&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdwget">2.45 Get File Via HTTP (wget)</a>
+ <a name="cmdwget">2.46 Get File Via HTTP (wget)</a>
</td>
</tr>
</table>
@@ -2132,7 +2162,7 @@ wget [-o &lt;local-path&gt;] &lt;url&gt;
<table width ="100%">
<tr bgcolor="#e4e4e4">
<td>
- <a name="cmdxd"><h2>2.46 Hexadecimal dump (xd)</h2></a>
+ <a name="cmdxd"><h2>2.47 Hexadecimal Dump of Memory (xd)</h2></a>
</td>
</tr>
</table>
@@ -2272,6 +2302,11 @@ nsh>
<td><code>CONFIG_NSH_DISABLE_HELP</code></td>
</tr>
<tr>
+ <td><b><code>hexdump</code></b></td>
+ <td><code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0</td>
+ <td><code>CONFIG_NSH_DISABLE_HEXDUMP</code></td>
+ </tr>
+ <tr>
<td><b><code>ifconfig</code></b></td>
<td><code>CONFIG_NET</code></td>
<td><code>CONFIG_NSH_DISABLE_IFCONFIG</code></td>
@@ -3795,14 +3830,15 @@ mount -t vfat /dev/ram1 /tmp
<li><a href="#cmdexec"><code>exec</code></a></li>
<li><a href="#custapps"><code>exec_namedapp()</code></a></li>
<li><a href="#cmdexit"><code>exit</code></a></li>
+ <li><a href="#cmdfree"><code>free</code></a></li>
</ul></td>
<td></ul>
- <li><a href="#cmdfree"><code>free</code></a></li>
<li><a href="#custoncmds"><code>g_cmdmap</code></a></li>
<li><a href="#custinit"><code>genromfs</code></a></li>
<li><a href="#cmdget"><code>get</code></a></li>
<li><a href="#frontend">Greeting</a></li>
<li><a href="#cmdhelp"><code>help</code></a></li>
+ <li><a href="#cmdhexdump"><code>hexdump</code></a></li>
<li><a href="#conditional"><code>if-then[-else]-fi</code></a></li>
<li><a href="#cmdifconfig"><code>ifconfig</code></a></li>
<li><a href="#cmdifdown"><code>ifdown</code></a></li>