diff options
Diffstat (limited to 'nuttx/Documentation/NuttShell.html')
-rw-r--r-- | nuttx/Documentation/NuttShell.html | 178 |
1 files changed, 135 insertions, 43 deletions
diff --git a/nuttx/Documentation/NuttShell.html b/nuttx/Documentation/NuttShell.html index c689cbb468..e9d363dc97 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: September 3, 2008</p> + <p>Last Updated: September 5, 2008</p> </td> </tr> </table> @@ -113,127 +113,139 @@ <tr> <td><br></td> <td> - <a href="#cmdexit">2.7 Exit NSH (exit)</a> + <a href="#cmdget">2.7 Get File Via TFTP (get)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdhelp">2.8 Show Usage Command Usage (help)</a> + <a href="#cmdexit">2.8 Exit NSH (exit)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdifconfig">2.9 Show Network Configuration (ifconfig)</a> + <a href="#cmdhelp">2.9 Show Usage Command Usage (help)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdls">2.10 List Directory Contents (ls)</a> + <a href="#cmdifconfig">2.10 Show Network Configuration (ifconfig)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdmbhw">2.11 Access Memory (mb, mh, and mw)</a> + <a href="#cmdls">2.11 List Directory Contents (ls)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdmem">2.12 Show Memory Manager Status (mem)</a> + <a href="#cmdmbhw">2.12 Access Memory (mb, mh, and mw)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdps">2.13 Show Current Tasks and Threads (ps)</a> + <a href="#cmdmem">2.13 Show Memory Manager Status (mem)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdmkdir">2.14 Create a Directory (mkdir)</a> + <a href="#cmdps">2.14 Show Current Tasks and Threads (ps)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdmkfatfs">2.15 Create a FAT Filesystem (mkfatfs)</a> + <a href="#cmdmkdir">2.15 Create a Directory (mkdir)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdmkfifo">2.16 Create a FIFO (mkfifo)</a> + <a href="#cmdmkfatfs">2.16 Create a FAT Filesystem (mkfatfs)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdmount">2.17 Mount a File System (mount)</a> + <a href="#cmdmkfifo">2.17 Create a FIFO (mkfifo)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdping">2.18 Check Network Peer (ping)</a> + <a href="#cmdmount">2.18 Mount a File System (mount)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdpwd">2.19 Show Current Working Directory (pwd)</a> + <a href="#cmdping">2.19 Check Network Peer (ping)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdrm">2.20 Remove a File (rm)</a> + <a href="#cmdput">2.20 Send File Via TFTP (put)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdrmdir">2.21 Remove a Directory (rmdir)</a> + <a href="#cmdpwd">2.21 Show Current Working Directory (pwd)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdset">2.22 Set an Environment Variable (set)</a> + <a href="#cmdrm">2.22 Remove a File (rm)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdsh">2.23 Execute an NSH Script (sh)</a> + <a href="#cmdrmdir">2.23 Remove a Directory (rmdir)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdsleep">2.24 Wait for Seconds (sleep)</a> + <a href="#cmdset">2.24 Set an Environment Variable (set)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdunmount">2.25 Unmount a File System (umount)</a> + <a href="#cmdsh">2.25 Execute an NSH Script (sh)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdunset">2.26 Unset an Environment Variable (unset)</a> + <a href="#cmdsleep">2.26 Wait for Seconds (sleep)</a> </td> </tr> <tr> <td><br></td> <td> - <a href="#cmdusleep">2.27 Wait for Microseconds (usleep)</a> + <a href="#cmdunmount">2.27 Unmount a File System (umount)</a> + </td> +</tr> +<tr> + <td><br></td> + <td> + <a href="#cmdunset">2.28 Unset an Environment Variable (unset)</a> + </td> +</tr> +<tr> + <td><br></td> + <td> + <a href="#cmdusleep">2.29 Wait for Microseconds (usleep)</a> </td> </tr> <tr> @@ -621,7 +633,42 @@ exec <hex-address> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdexit"><h2>2.7 Exit NSH (exit)</h2></a> + <a name="cmdget"><h2>2.7 Get File Via TFTP (get)</h2></a> + </td> + </tr> +</table> + +<a <p><b>Command Syntax:</b></p> +<ul><pre> +get [-b|-n] [-f <local-path>] -h <ip-address> <remote-path> +</pre></ul> +<p> + <b>Synopsis</b>. + Copy the file at <code><remote-address></code> from the host whose IP address is + identified by <code><ip-address></code>. +</p> +<p><b>Other options:</b></p> +<ul><table> + <tr> + <td><b><code>-f <local-path></code></b></td> + <td> + The file will be saved relative to the current working directory + unless <code><local-path></code> is provided. + </td> + </tr> + <tr> + <td><b><code>-b|-n</code></b></td> + <td> + Selects either binary ("octect") or test ("netascii") transfer + mode. Default: text. + </td> + </tr> +</table></ul> + +<table width ="100%"> + <tr bgcolor="#e4e4e4"> + <td> + <a name="cmdexit"><h2>2.8 Exit NSH (exit)</h2></a> </td> </tr> </table> @@ -640,7 +687,7 @@ exit <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdhelp"><h2>2.8 Show Usage Command Usage (help)</h2></a> + <a name="cmdhelp"><h2>2.9 Show Usage Command Usage (help)</h2></a> </td> </tr> </table> @@ -657,7 +704,7 @@ help <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdifconfig"><h2>2.9 Show Network Configuration (ifconfig)</h2></a> + <a name="cmdifconfig"><h2>2.10 Show Network Configuration (ifconfig)</h2></a> </td> </tr> </table> @@ -683,7 +730,7 @@ eth0 HWaddr 00:18:11:80:10:06 <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdls"><h2>2.10 List Directory Contents (ls)</h2></a> + <a name="cmdls"><h2>2.11 List Directory Contents (ls)</h2></a> </td> </tr> </table> @@ -720,7 +767,7 @@ ls [-lRs] <dir-path> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdmbhw"><h2>2.11 Access Memory (mb, mh, and mw)</h2></a> + <a name="cmdmbhw"><h2>2.12 Access Memory (mb, mh, and mw)</h2></a> </td> </tr> </table> @@ -774,7 +821,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdmem"><h2>2.12 Show Memory Manager Status (mem)</h2></a> + <a name="cmdmem"><h2>2.13 Show Memory Manager Status (mem)</h2></a> </td> </tr> </table> @@ -823,7 +870,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdps"><h2>2.13 Show Current Tasks and Threads (ps)</h2></a> + <a name="cmdps"><h2>2.14 Show Current Tasks and Threads (ps)</h2></a> </td> </tr> </table> @@ -849,7 +896,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdmkdir"><h2>2.14 Create a Directory (mkdir)</h2></a> + <a name="cmdmkdir"><h2>2.15 Create a Directory (mkdir)</h2></a> </td> </tr> </table> @@ -884,7 +931,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdmkfatfs"><h2>2.15 Create a FAT Filesystem (mkfatfs)</h2></a> + <a name="cmdmkfatfs"><h2>2.16 Create a FAT Filesystem (mkfatfs)</h2></a> </td> </tr> </table> @@ -904,7 +951,7 @@ mkfatfs <path> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdmkfifo"><h2>2.16 Create a FIFO (mkfifo)</h2></a> + <a name="cmdmkfifo"><h2>2.17 Create a FIFO (mkfifo)</h2></a> </td> </tr> </table> @@ -942,7 +989,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdmount"><h2>2.17 Mount a File System (mount)</h2></a> + <a name="cmdmount"><h2>2.18 Mount a File System (mount)</h2></a> </td> </tr> </table> @@ -1009,7 +1056,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdping"><h2>2.18 Check Network Peer (ping)</h2></a> + <a name="cmdping"><h2>2.19 Check Network Peer (ping)</h2></a> </td> </tr> </table> @@ -1042,7 +1089,42 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdpwd"><h2>2.19 Show Current Working Directory (pwd)</h2></a> + <a name="cmdput"><h2>2.20 Send File Via TFTP (put)</h2></a> + </td> + </tr> +</table> + +<a <p><b>Command Syntax:</b></p> +<ul><pre> +put [-b|-n] [-f <remote-path>] -h <ip-address> <local-path> +</pre></ul> +<p> + <b>Synopsis</b>. + Copy the file at <code><local-address></code> to the host whose IP address is + identified by <code><ip-address></code>. +</p> +<p><b>Other options:</b></p> +<ul><table> + <tr> + <td><b><code>-f <remote-path></code></b></td> + <td> + The file will be saved relative with the same name on the host + unless <code><remote-path></code> is provided. + </td> + </tr> + <tr> + <td><b><code>-b|-n</code></b></td> + <td> + Selects either binary ("octect") or test ("netascii") transfer + mode. Default: text. + </td> + </tr> +</table></ul> + +<table width ="100%"> + <tr bgcolor="#e4e4e4"> + <td> + <a name="cmdpwd"><h2>2.21 Show Current Working Directory (pwd)</h2></a> </td> </tr> </table> @@ -1072,7 +1154,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdrm"><h2>2.20 Remove a File (rm)</h2></a> + <a name="cmdrm"><h2>2.22 Remove a File (rm)</h2></a> </td> </tr> </table> @@ -1106,7 +1188,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdrmdir"><h2>2.21 Remove a Directory (rmdir)</h2></a> + <a name="cmdrmdir"><h2>2.23 Remove a Directory (rmdir)</h2></a> </td> </tr> </table> @@ -1141,7 +1223,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdset"><h2>2.22 Set an Environment Variable (set)</h2></a> + <a name="cmdset"><h2>2.24 Set an Environment Variable (set)</h2></a> </td> </tr> </table> @@ -1167,7 +1249,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdsh"><h2>2.23 Execute an NSH Script (sh)</h2></a> + <a name="cmdsh"><h2>2.25 Execute an NSH Script (sh)</h2></a> </td> </tr> </table> @@ -1185,7 +1267,7 @@ sh <script-path> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdsleep"><h2>2.24 Wait for Seconds (sleep)</h2></a> + <a name="cmdsleep"><h2>2.26 Wait for Seconds (sleep)</h2></a> </td> </tr> </table> @@ -1202,7 +1284,7 @@ sleep <sec> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdunmount"><h2>2.25 Unmount a File System (umount)</h2></a> + <a name="cmdunmount"><h2>2.27 Unmount a File System (umount)</h2></a> </td> </tr> </table> @@ -1232,7 +1314,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdunset"><h2>2.26 Unset an Environment Variable (unset)</h2></a> + <a name="cmdunset"><h2>2.28 Unset an Environment Variable (unset)</h2></a> </td> </tr> </table> @@ -1258,7 +1340,7 @@ nsh> <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <a name="cmdusleep"><h2>2.27 Wait for Microseconds (usleep)</h2></a> + <a name="cmdusleep"><h2>2.29 Wait for Microseconds (usleep)</h2></a> </td> </tr> </table> @@ -1332,6 +1414,10 @@ usleep <usec> <td><br></td> </tr> <tr> + <td><b><code>get</code></b></td> + <td><code>CONFIG_NET</code> && <code>CONFIG_NET_UDP</code> && <code>CONFIG_NFILE_DESCRIPTORS</code> > 0</td> + </tr> + <tr> <td><b><code>help</code></b></td> <td><br></td> </tr> @@ -1376,6 +1462,10 @@ usleep <usec> <td><br></td> </tr> <tr> + <td><b><code>put</code></b></td> + <td><code>CONFIG_NET</code> && <code>CONFIG_NET_UDP</code> && <code>CONFIG_NFILE_DESCRIPTORS</code> > 0</td> + </tr> + <tr> <td><b><code>pwd</code></b></td> <td>!<code>CONFIG_DISABLE_ENVIRON</code> && <code>CONFIG_NFILE_DESCRIPTORS</code> > 0</td> </tr> @@ -1602,6 +1692,7 @@ usleep <usec> <li><a href="#environvars">Environment Variables</a></li> <li><a href="#cmdexec"><code>exec</code></a></li> <li><a href="#cmdexit"><code>exit</code></a></li> + <li><a href="#cmdget"><code>get</code></a></li> </ul></td> <td></ul> <li><a href="#frontend">Greeting</a></li> @@ -1623,6 +1714,7 @@ usleep <usec> <li><a href="#cmdping"><code>ping</code></a></li> <li><a href="#frontend">Prompt</a></li> <li><a href="#cmdps"><code>ps</code></a></li> + <li><a href="#cmdput"><code>put</code></a></li> <li><a href="#cmdpwd"><code>pwd</code></a></li> <li><a href="#environvars"><code>PWD</code></a></li> <li><a href="#cmdoverview">Re-directed commands</a></li> |