From 91625b0597f5396c5ca310f8f0d8700742ceb723 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Mon, 13 Jul 2015 11:20:14 -0600 Subject: [PATCH] Update NSH documentation --- Documentation/NuttShell.html | 111 ++++++++++++++++++++++------------- 1 file changed, 70 insertions(+), 41 deletions(-) diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index f567b8b076..01e98a9169 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -8,7 +8,7 @@

NuttShell (NSH)

-

Last Updated: July 4, 2015

+

Last Updated: July 13, 2015

@@ -305,115 +305,121 @@
- 2.37 Check Network Peer (ping/ping6) + 2.37 Lookup a network address (nslookup)
- 2.38 Shut the system down (poweroff) + 2.38 Check Network Peer (ping/ping6)
- 2.39 Send File Via TFTP (put) + 2.39 Shut the system down (poweroff)
- 2.40 Show Current Working Directory (pwd) + 2.40 Send File Via TFTP (put)
- 2.41 Reset and reboot the system (reboot) + 2.41 Show Current Working Directory (pwd)
- 2.42 Remove a File (rm) + 2.42 Reset and reboot the system (reboot)
- 2.43 Remove a Directory (rmdir) + 2.43 Remove a File (rm)
- 2.44 Set an Environment Variable (set) + 2.44 Remove a Directory (rmdir)
- 2.45 Execute an NSH Script (sh) + 2.45 Set an Environment Variable (set)
- 2.46 Shut the system down (shutdown) + 2.46 Execute an NSH Script (sh)
- 2.47 Wait for Seconds (sleep) + 2.47 Shut the system down (shutdown)
- 2.48 Unmount a File System (umount) + 2.48 Wait for Seconds (sleep)
- 2.49 Print system information (uname) + 2.49 Unmount a File System (umount)
- 2.50 Unset an Environment Variable (unset) + 2.50 Print system information (uname)
- 2.51 URL Decode (urldecode) + 2.51 Unset an Environment Variable (unset)
- 2.52 URL Encode (urlencode) + 2.52 URL Decode (urldecode)
- 2.53 Wait for Microseconds (usleep) + 2.53 URL Encode (urlencode)
- 2.54 Get File Via HTTP (wget) + 2.54 Wait for Microseconds (usleep)
- 2.55 Hexadecimal Dump of Memory (xd) + 2.55 Get File Via HTTP (wget) + + + +
+ + 2.56 Hexadecimal Dump of Memory (xd) @@ -2115,7 +2121,24 @@ nfsmount <server-address> <mount-point> <remote-path> + +
-

2.37 Check Network Peer (ping/ping6)

+

2.37 Lookup a network address (nslookup)

+
+ +

Command Syntax:

+ +

+ Synopsis. + Lookup and print the IP address associated with <host-name>. +

+ + + +
+

2.38 Check Network Peer (ping/ping6)

@@ -2152,7 +2175,7 @@ nsh>
-

2.38 Shut the system down (poweroff)

+

2.39 Shut the system down (poweroff)

@@ -2174,7 +2197,7 @@ poweroff
-

2.39 Send File Via TFTP (put)

+

2.40 Send File Via TFTP (put)

@@ -2209,7 +2232,7 @@ put [-b|-n] [-f <remote-path>] -h <ip-address> <local-path>
-

2.40 Show Current Working Directory (pwd)

+

2.41 Show Current Working Directory (pwd)

@@ -2239,7 +2262,7 @@ nsh>
-

2.41 Reboot the system (reboot)

+

2.42 Reboot the system (reboot)

@@ -2261,7 +2284,7 @@ reboot
-

2.42 Remove a File (rm)

+

2.43 Remove a File (rm)

@@ -2295,7 +2318,7 @@ nsh>
-

2.43 Remove a Directory (rmdir)

+

2.44 Remove a Directory (rmdir)

@@ -2330,7 +2353,7 @@ nsh>
-

2.44 Set an Environment Variable (set)

+

2.45 Set an Environment Variable (set)

@@ -2356,7 +2379,7 @@ nsh>
-

2.45 Execute an NSH Script (sh)

+

2.46 Execute an NSH Script (sh)

@@ -2375,7 +2398,7 @@ sh <script-path>
-

2.46 Shut the system down (shutdown)

+

2.47 Shut the system down (shutdown)

@@ -2396,7 +2419,7 @@ shutdown [--reboot]
-

2.47 Wait for Seconds (sleep)

+

2.48 Wait for Seconds (sleep)

@@ -2413,7 +2436,7 @@ sleep <sec>
-

2.48 Unmount a File System (umount)

+

2.49 Unmount a File System (umount)

@@ -2443,7 +2466,7 @@ nsh>
-

2.49 Print system information (uname)

+

2.50 Print system information (uname)

@@ -2510,7 +2533,7 @@ uname [-a | -imnoprsv]
-

2.50 Unset an Environment Variable (unset)

+

2.51 Unset an Environment Variable (unset)

@@ -2536,7 +2559,7 @@ nsh>
-

2.51 URL Decode (urldecode)

+

2.52 URL Decode (urldecode)

@@ -2553,7 +2576,7 @@ urldecode [-f] <string or filepath>
-

2.52 URL Encode (urlencode)

+

2.53 URL Encode (urlencode)

@@ -2570,7 +2593,7 @@ urlencode [-f] <string or filepath>
-

2.53 Wait for Microseconds (usleep)

+

2.54 Wait for Microseconds (usleep)

@@ -2587,7 +2610,7 @@ usleep <usec>
- 2.54 Get File Via HTTP (wget) + 2.55 Get File Via HTTP (wget)
@@ -2614,7 +2637,7 @@ wget [-o <local-path>] <url>
-

2.55 Hexadecimal Dump of Memory (xd)

+

2.56 Hexadecimal Dump of Memory (xd)

@@ -2857,6 +2880,11 @@ nsh> !CONFIG_DISABLE_MOUNTPOINT && CONFIG_NFILE_DESCRIPTORS > 0 && CONFIG_NET && CONFIG_NFS CONFIG_NSH_DISABLE_NFSMOUNT + + nslookup + CONFIG_LIBC_NETDB && CONFIG_NETDB_DNSCLIENT + CONFIG_NSH_DISABLE_NSLOOKUP + ping CONFIG_NET && CONFIG_NET_ICMP && @@ -4371,10 +4399,10 @@ mount -t vfat /dev/ram1 /tmp
  • CONFIG_NSH_NOMAC
  • CONFIG_NSH_READLINE
  • CONFIG_NSH_ROMFSDEVNO
  • +
  • CONFIG_NSH_ROMFSETC