Update NSH documentation.
This commit is contained in:
Gregory Nutt
parent
65698da12d
commit
cbf247e11b
@ -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: August 10, 2017</p>
|
||||
<p>Last Updated: August 11, 2017</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -407,97 +407,103 @@
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdset">2.54 Set an Environment Variable (set)</a>
|
||||
<a href="#cmdroute">2.54 Show routing table (route)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdsh">2.55 Execute an NSH Script (sh)</a>
|
||||
<a href="#cmdset">2.55 Set an Environment Variable (set)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdshutdown">2.56 Shut the system down (shutdown)</a>
|
||||
<a href="#cmdsh">2.56 Execute an NSH Script (sh)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdsleep">2.57 Wait for Seconds (sleep)</a>
|
||||
<a href="#cmdshutdown">2.57 Shut the system down (shutdown)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdtelnetd">2.58 Start the Telnet Daemon (telnetd)</a>
|
||||
<a href="#cmdsleep">2.58 Wait for Seconds (sleep)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdtime">2.59 Time execution of another command (time)</a>
|
||||
<a href="#cmdtelnetd">2.59 Start the Telnet Daemon (telnetd)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdunmount">2.60 Unmount a File System (umount)</a>
|
||||
<a href="#cmdtime">2.60 Time execution of another command (time)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmduname">2.61 Print system information (uname)</a>
|
||||
<a href="#cmdunmount">2.61 Unmount a File System (umount)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdunset">2.62 Unset an Environment Variable (unset)</a>
|
||||
<a href="#cmduname">2.62 Print system information (uname)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdurldec">2.63 URL Decode (urldecode)</a>
|
||||
<a href="#cmdunset">2.63 Unset an Environment Variable (unset)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdurlencode">2.64 URL Encode (urlencode)</a>
|
||||
<a href="#cmdurldec">2.64 URL Decode (urldecode)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmduseradd">2.65 Add a New User (useradd)</a>
|
||||
<a href="#cmdurlencode">2.65 URL Encode (urlencode)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmduserdel">2.66 Delete a user (userdel)</a>
|
||||
<a href="#cmduseradd">2.66 Add a New User (useradd)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdusleep">2.67 Wait for Microseconds (usleep)</a>
|
||||
<a href="#cmduserdel">2.67 Delete a user (userdel)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdwget">2.68 Get File Via HTTP (wget)</a>
|
||||
<a href="#cmdusleep">2.68 Wait for Microseconds (usleep)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdxd">2.69 Hexadecimal Dump of Memory (xd)</a>
|
||||
<a href="#cmdwget">2.69 Get File Via HTTP (wget)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><br></td>
|
||||
<td>
|
||||
<a href="#cmdxd">2.70 Hexadecimal Dump of Memory (xd)</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -2766,7 +2772,27 @@ nsh>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdset"><h2>2.54 Set an Environment Variable (set)</h2></a>
|
||||
<a name="cmdroute"><h2>2.54 Show routing table (route)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p><b>Command Syntax:</b></p>
|
||||
<ul><pre>
|
||||
route ipv4|ipv6
|
||||
</pre></ul>
|
||||
<p>
|
||||
<b>Synopsis</b>.
|
||||
Show the contents of routing table for IPv4 or IPv6.
|
||||
</p>
|
||||
<p>
|
||||
If only IPv4 or IPv6 is enabled, then the argument is optional but, if provided, must match the enabled internet protocol version.
|
||||
</p>
|
||||
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdset"><h2>2.55 Set an Environment Variable (set)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -2835,7 +2861,7 @@ nsh>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdsh"><h2>2.55 Execute an NSH Script (sh)</h2></a>
|
||||
<a name="cmdsh"><h2>2.56 Execute an NSH Script (sh)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -2853,7 +2879,7 @@ sh <script-path>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdshutdown"><h2>2.56 Shut the system down (shutdown)</h2></a>
|
||||
<a name="cmdshutdown"><h2>2.57 Shut the system down (shutdown)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -2874,7 +2900,7 @@ shutdown [--reboot]
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdsleep"><h2>2.57 Wait for Seconds (sleep)</h2></a>
|
||||
<a name="cmdsleep"><h2>2.58 Wait for Seconds (sleep)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -2891,7 +2917,7 @@ sleep <sec>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdtelnetd"><h2>2.58 Time Start the Telnet Daemon (telnetd)</h2></a>
|
||||
<a name="cmdtelnetd"><h2>2.59 Time Start the Telnet Daemon (telnetd)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -2917,7 +2943,7 @@ telnetd
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdtime"><h2>2.59 Time execution of another command (time)</h2></a>
|
||||
<a name="cmdtime"><h2>2.60 Time execution of another command (time)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -2975,7 +3001,7 @@ nsh>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdunmount"><h2>2.60 Unmount a File System (umount)</h2></a>
|
||||
<a name="cmdunmount"><h2>2.61 Unmount a File System (umount)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3005,7 +3031,7 @@ nsh>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmduname"><h2>2.61 Print system information (uname)</h2></a>
|
||||
<a name="cmduname"><h2>2.62 Print system information (uname)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3072,7 +3098,7 @@ uname [-a | -imnoprsv]
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdunset"><h2>2.62 Unset an Environment Variable (unset)</h2></a>
|
||||
<a name="cmdunset"><h2>2.63 Unset an Environment Variable (unset)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3098,7 +3124,7 @@ nsh>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdurldec"><h2>2.63 URL Decode (urldecode)</h2></a>
|
||||
<a name="cmdurldec"><h2>2.64 URL Decode (urldecode)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3115,7 +3141,7 @@ urldecode [-f] <string or filepath>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdurlencode"><h2>2.64 URL Encode (urlencode)</h2></a>
|
||||
<a name="cmdurlencode"><h2>2.65 URL Encode (urlencode)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3132,7 +3158,7 @@ urlencode [-f] <string or filepath>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmduseradd"><h2>2.65 Add a New User (useradd)</h2></a>
|
||||
<a name="cmduseradd"><h2>2.66 Add a New User (useradd)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3149,7 +3175,7 @@ useradd <username> <password>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmduserdel"><h2>2.66 Delete a user (userdel)</h2></a>
|
||||
<a name="cmduserdel"><h2>2.67 Delete a user (userdel)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3166,7 +3192,7 @@ userdel <username>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdusleep"><h2>2.67 Wait for Microseconds (usleep)</h2></a>
|
||||
<a name="cmdusleep"><h2>2.68 Wait for Microseconds (usleep)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3183,7 +3209,7 @@ usleep <usec>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdwget"><h2>2.68 Get File Via HTTP (wget)</h2></a>
|
||||
<a name="cmdwget"><h2>2.69 Get File Via HTTP (wget)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3210,7 +3236,7 @@ wget [-o <local-path>] <url>
|
||||
<table width ="100%">
|
||||
<tr bgcolor="#e4e4e4">
|
||||
<td>
|
||||
<a name="cmdxd"><h2>2.69 Hexadecimal Dump of Memory (xd)</h2></a>
|
||||
<a name="cmdxd"><h2>2.70 Hexadecimal Dump of Memory (xd)</h2></a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -3551,6 +3577,11 @@ nsh>
|
||||
<td><code>CONFIG_MODULE</code></td>
|
||||
<td><code>CONFIG_NSH_DISABLE_MODCMDS</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b><code>route</code></b></td>
|
||||
<td><code><code>CONFIG_FS_PROCFS</code> && <code>CONFIG_FS_PROCFS_EXCLUDE_NET</code> && !<code>CONFIG_FS_PROCFS_EXCLUDE_ROUTE</code> && <code>CONFIG_NET_ROUTE</code> && !<code>CONFIG_NSH_DISABLE_ROUTE</code> && (<code>CONFIG_NET_IPv4</code> || <code>CONFIG_NET_IPv6</code>)</code></td>
|
||||
<td><code>CONFIG_NSH_DISABLE_ROUTE</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b><code>set</code></b></td>
|
||||
<td>!<code>CONFIG_DISABLE_ENVIRON</code></td>
|
||||
@ -5467,6 +5498,7 @@ xxd -i romfs_img >nsh_romfsimg.h
|
||||
<li><a href="#cmdrmmod"><code>rmmod</code></a></li>
|
||||
<li><a href="#custinit">ROMFS, Modifying the ROMFS image</a></li>
|
||||
<li><a href="#passwdromfs">ROMFS, Password File</a></li>
|
||||
<li><a href="#cmdroute"><code>route</code></a></li>
|
||||
<li><a href="#cmdset"><code>set</code></a></li>
|
||||
<li><a href="#cmdsh"><code>sh</code></a></li>
|
||||
<li><a href="#cmdshutdown"><code>shutdown</code></a></li>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user