diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index be74af7062..ee752faa73 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -8,7 +8,7 @@

NuttShell (NSH)

-

Last Updated: January 22, 2016

+

Last Updated: February 8, 2016

@@ -101,379 +101,385 @@
- 2.3 Base64 Decode (base64dec) + 2.3 Access the ARP table (arp)
- 2.4 Base64 Encode (base64enc) + 2.4 Base64 Decode (base64dec)
- 2.5 Extract Base File/Directory Name (basename) + 2.5 Base64 Encode (base64enc)
- 2.6 Terminate a Loop (break) + 2.6 Extract Base File/Directory Name (basename)
- 2.7 Concatenate Files (cat) + 2.7 Terminate a Loop (break)
- 2.8 Change Current Working Directory (cd) + 2.8 Concatenate Files (cat)
- 2.9 Compare Files (cmp) + 2.9 Change Current Working Directory (cd)
- 2.10 Copy Files (cp) + 2.10 Compare Files (cmp)
- 2.11 Show or set the date and time (date) + 2.11 Copy Files (cp)
- 2.12 Copy and Convert Files (dd) + 2.12 Show or set the date and time (date)
- 2.13 Delete a Routing Table Entry (delroute) + 2.13 Copy and Convert Files (dd)
- 2.14 Show volume status (df) + 2.14 Delete a Routing Table Entry (delroute)
- 2.15 Extract Path to a File/Directory (dirname) + 2.15 Show volume status (df)
- 2.16 Echo Strings and Variables (echo) + 2.16 Extract Path to a File/Directory (dirname)
- 2.17 Execute User Code (exec) + 2.17 Echo Strings and Variables (echo)
- 2.18 Exit NSH (exit) + 2.18 Execute User Code (exec)
- 2.19 Show Memory Manager Status (free) + 2.19 Exit NSH (exit)
- 2.20 Get File Via TFTP (get) + 2.20 Show Memory Manager Status (free)
- 2.21 Show Usage Command Usage (help) + 2.21 Get File Via TFTP (get)
- 2.22 Hexadecimal Dump of File or Device (hexdump) + 2.22 Show Usage Command Usage (help)
- 2.23 Manage Network Configuration (ifconfig) + 2.23 Hexadecimal Dump of File or Device (hexdump)
- 2.24 Take a network down (ifdown) + 2.24 Manage Network Configuration (ifconfig)
- 2.25 Bring a network up (ifup) + 2.25 Take a network down (ifdown)
- 2.26 Install an OS module (insmod) + 2.26 Bring a network up (ifup)
- 2.27 Send a signal to a task (kill) + 2.27 Install an OS module (insmod)
- 2.28 Setup/teardown the Loop Device (losetup) + 2.28 Send a signal to a task (kill)
- 2.29 List Directory Contents (ls) + 2.29 Setup/teardown the Loop Device (losetup)
- 2.30 Show information about installed OS modules (lsmod) + 2.30 List Directory Contents (ls)
- 2.31 Calculate MD5 (md5) + 2.31 Show information about installed OS modules (lsmod)
- 2.32 Access Memory (mb, mh, and mw) + 2.32 Calculate MD5 (md5)
- 2.33 Show Current Tasks and Threads (ps) + 2.33 Access Memory (mb, mh, and mw)
- 2.34 Create a Directory (mkdir) + 2.34 Show Current Tasks and Threads (ps)
- 2.35 Create a FAT Filesystem (mkfatfs) + 2.35 Create a Directory (mkdir)
- 2.36 Create a FIFO (mkfifo) + 2.36 Create a FAT Filesystem (mkfatfs)
- 2.37 Create a RAMDISK (mkrd) + 2.37 Create a FIFO (mkfifo)
- 2.38 Mount a File System (mount) + 2.38 Create a RAMDISK (mkrd)
- 2.39 Rename a File (mv) + 2.39 Mount a File System (mount)
- 2.40 Mount an NFS file system (nfsmount) + 2.40 Rename a File (mv)
- 2.41 Lookup a network address (nslookup) + 2.41 Mount an NFS file system (nfsmount)
- 2.42 Change a User's Password (passwd) + 2.42 Lookup a network address (nslookup)
- 2.43 Check Network Peer (ping/ping6) + 2.43 Change a User's Password (passwd)
- 2.44 Shut the system down (poweroff) + 2.44 Check Network Peer (ping/ping6)
- 2.45 Send File Via TFTP (put) + 2.45 Shut the system down (poweroff)
- 2.46 Show Current Working Directory (pwd) + 2.46 Send File Via TFTP (put)
- 2.47 Reset and reboot the system (reboot) + 2.47 Show Current Working Directory (pwd)
- 2.48 Remove a File (rm) + 2.48 Reset and reboot the system (reboot)
- 2.49 Remove a Directory (rmdir) + 2.49 Remove a File (rm)
- 2.50 Remove on OS Module (rmmod) + 2.50 Remove a Directory (rmdir)
- 2.51 Set an Environment Variable (set) + 2.51 Remove on OS Module (rmmod)
- 2.52 Execute an NSH Script (sh) + 2.52 Set an Environment Variable (set)
- 2.53 Shut the system down (shutdown) + 2.53 Execute an NSH Script (sh)
- 2.54 Wait for Seconds (sleep) + 2.54 Shut the system down (shutdown)
- 2.55 Time execution of another command (time) + 2.55 Wait for Seconds (sleep)
- 2.56 Unmount a File System (umount) + 2.56 Time execution of another command (time)
- 2.57 Print system information (uname) + 2.57 Unmount a File System (umount)
- 2.58 Unset an Environment Variable (unset) + 2.58 Print system information (uname)
- 2.59 URL Decode (urldecode) + 2.59 Unset an Environment Variable (unset)
- 2.60 URL Encode (urlencode) + 2.60 URL Decode (urldecode)
- 2.61 Add a New User (useradd) + 2.61 URL Encode (urlencode)
- 2.62 Delete a user (userdel) + 2.62 Add a New User (useradd)
- 2.63 Wait for Microseconds (usleep) + 2.63 Delete a user (userdel)
- 2.64 Get File Via HTTP (wget) + 2.64 Wait for Microseconds (usleep)
- 2.65 Hexadecimal Dump of Memory (xd) + 2.65 Get File Via HTTP (wget) + + + +
+ + 2.66 Hexadecimal Dump of Memory (xd) @@ -1135,7 +1141,49 @@ nsh> addroute 1.1.1.1 2.2.2.2 3.3.3.3 + +
-

2.3 Base64 Decode (base64dec)

+

2.3 Access the ARP table (arp)

+
+ +

Command Syntax:

+ +

+ Synopsis. + Access the OS ARP table. +

+ +

+ Example: +

+ + + + +
+

2.4 Base64 Decode (base64dec)

@@ -1152,7 +1200,7 @@ base64dec [-w] [-f] <string or filepath>
-

2.4 Base64 Encode (base64enc)

+

2.5 Base64 Encode (base64enc)

@@ -1169,7 +1217,7 @@ base64enc [-w] [-f] <string or filepath>
-

2.5 Extract Base File/Directory Name (basename)

+

2.6 Extract Base File/Directory Name (basename)

@@ -1186,7 +1234,7 @@ basename <path> [<suffix>]
-

2.6 Terminate a Loop (break)

+

2.7 Terminate a Loop (break)

@@ -1205,7 +1253,7 @@ break
-

2.7 Concatenate Files (cat)

+

2.8 Concatenate Files (cat)

@@ -1223,7 +1271,7 @@ cat <path> [<path> [<path> -

2.8 Change Current Working Directory (cd)

+

2.9 Change Current Working Directory (cd)

@@ -1265,7 +1313,7 @@ cd [<dir-path>|-|~|..]
-

2.9 Compare Files (cmp)

+

2.10 Compare Files (cmp)

@@ -1282,7 +1330,7 @@ cmp <path1> <path2>
-

2.10 Copy Files (cp)

+

2.11 Copy Files (cp)

@@ -1300,7 +1348,7 @@ cp <source-path> <dest-path>
-

2.11 Show or set the date and time (date)

+

2.12 Show or set the date and time (date)

@@ -1326,7 +1374,7 @@ data -s "Sep 1 11:30:00 2011"
-

2.12 Copy and Convert Files (dd)

+

2.13 Copy and Convert Files (dd)

@@ -1384,7 +1432,7 @@ nsh> dd if=/dev/ram0 of=/dev/null
-

2.13 Delete a Routing Table Entry (delroute)

+

2.14 Delete a Routing Table Entry (delroute)

@@ -1407,7 +1455,7 @@ nsh> delroute 1.1.1.1 2.2.2.2
-

2.14 Show Volument Status (df)

+

2.15 Show Volume Status (df)

@@ -1439,7 +1487,7 @@ nsh>
-

2.15 Extract Path to a File/Directory (dirname)

+

2.16 Extract Path to a File/Directory (dirname)

@@ -1456,7 +1504,7 @@ dirname <path>
-

2.16 Echo Strings and Variables (echo)

+

2.17 Echo Strings and Variables (echo)

@@ -1474,7 +1522,7 @@ echo [<string|$name> [<string|$name>...]]
-

2.17 Execute User Code (exec)

+

2.18 Execute User Code (exec)

@@ -1493,7 +1541,7 @@ exec <hex-address>
-

2.18 Exit NSH (exit)

+

2.19 Exit NSH (exit)

@@ -1512,7 +1560,7 @@ exit
-

2.19 Show Memory Manager Status (free)

+

2.20 Show Memory Manager Status (free)

@@ -1554,7 +1602,7 @@ nsh>
-

2.20 Get File Via TFTP (get)

+

2.21 Get File Via TFTP (get)

@@ -1589,7 +1637,7 @@ get [-b|-n] [-f <local-path>] -h <ip-address> <remote-path>
-

2.21 Show Usage Command Usage (help)

+

2.22 Show Usage Command Usage (help)

@@ -1621,7 +1669,7 @@ help [-v] [<cmd>]
-

2.22 Hexadecimal Dump of File or Device (hexdump)

+

2.23 Hexadecimal Dump of File or Device (hexdump)

@@ -1645,7 +1693,7 @@ hexdump <file or device>
-

2.23 Manage Network Configuration (ifconfig)

+

2.24 Manage Network Configuration (ifconfig)

@@ -1707,7 +1755,7 @@ nsh> mount -t procfs /proc
-

2.24 Take a network down (ifdown)

+

2.25 Take a network down (ifdown)

@@ -1730,7 +1778,7 @@ ifdown eth0
-

2.25 Bring a network up (ifup)

+

2.26 Bring a network up (ifup)

@@ -1753,7 +1801,7 @@ ifup eth0
-

2.26 Install an OS module (insmod)

+

2.27 Install an OS module (insmod)

@@ -1796,7 +1844,7 @@ mydriver 20404659 20404625 0 20404580 552 204047a8 0
-

2.27 Send a signal to a task (kill)

+

2.28 Send a signal to a task (kill)

@@ -1838,7 +1886,7 @@ nsh>
-

2.28 Setup/teardown the Loop Device (losetup)

+

2.29 Setup/teardown the Loop Device (losetup)

@@ -1891,7 +1939,7 @@ losetup d <dev-path>
-

2.29 List Directory Contents (ls)

+

2.30 List Directory Contents (ls)

@@ -1929,7 +1977,7 @@ ls [-lRs] <dir-path>
-

2.30 Show information about installed OS modules (lsmod)

+

2.31 Show information about installed OS modules (lsmod)

@@ -1962,7 +2010,7 @@ mydriver 20404659 20404625 0 20404580 552 204047a8 0
-

2.31 Calculate MD5 (md5)

+

2.32 Calculate MD5 (md5)

@@ -1979,7 +2027,7 @@ md5 [-f] <string or filepath>
-

2.32 Access Memory (mb, mh, and mw)

+

2.33 Access Memory (mb, mh, and mw)

@@ -2033,7 +2081,7 @@ nsh>
-

2.33 Show Current Tasks and Threads (ps)

+

2.34 Show Current Tasks and Threads (ps)

@@ -2067,7 +2115,7 @@ nsh> mount -t procfs /proc
-

2.34 Create a Directory (mkdir)

+

2.35 Create a Directory (mkdir)

@@ -2102,7 +2150,7 @@ nsh>
-

2.35 Create a FAT Filesystem (mkfatfs)

+

2.36 Create a FAT Filesystem (mkfatfs)

@@ -2127,7 +2175,7 @@ mkfatfs [-F <fatsize>] <block-driver>
-

2.36 Create a FIFO (mkfifo)

+

2.37 Create a FIFO (mkfifo)

@@ -2165,7 +2213,7 @@ nsh>
-

2.37 Create a RAMDISK (mkrd)

+

2.38 Create a RAMDISK (mkrd)

@@ -2216,7 +2264,7 @@ nsh>
-

2.38 Mount a File System (mount)

+

2.39 Mount a File System (mount)

@@ -2295,7 +2343,7 @@ nsh> mount
-

2.39 Rename a File (mv)

+

2.40 Rename a File (mv)

@@ -2313,7 +2361,7 @@ mv <old-path> <new-path>
-

2.40 Mount an NFS file system (nfsmount)

+

2.41 Mount an NFS file system (nfsmount)

@@ -2332,7 +2380,7 @@ nfsmount <server-address> <mount-point> <remote-path>
-

2.41 Lookup a network address (nslookup)

+

2.42 Lookup a network address (nslookup)

@@ -2349,7 +2397,7 @@ nslookup <host-name>
-

2.42 Change a User's Password (passwd)

+

2.43 Change a User's Password (passwd)

@@ -2366,7 +2414,7 @@ passwd <username> <password>
-

2.43 Check Network Peer (ping/ping6)

+

2.44 Check Network Peer (ping/ping6)

@@ -2403,7 +2451,7 @@ nsh>
-

2.44 Shut the system down (poweroff)

+

2.45 Shut the system down (poweroff)

@@ -2425,7 +2473,7 @@ poweroff
-

2.45 Send File Via TFTP (put)

+

2.46 Send File Via TFTP (put)

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

2.46 Show Current Working Directory (pwd)

+

2.47 Show Current Working Directory (pwd)

@@ -2490,7 +2538,7 @@ nsh>
-

2.47 Reboot the system (reboot)

+

2.48 Reboot the system (reboot)

@@ -2512,7 +2560,7 @@ reboot
-

2.48 Remove a File (rm)

+

2.49 Remove a File (rm)

@@ -2546,7 +2594,7 @@ nsh>
-

2.49 Remove a Directory (rmdir)

+

2.50 Remove a Directory (rmdir)

@@ -2581,7 +2629,7 @@ nsh>
-

2.50 Remove on OS Module (rmmod)

+

2.51 Remove on OS Module (rmmod)

@@ -2609,7 +2657,7 @@ nsh>
-

2.51 Set an Environment Variable (set)

+

2.52 Set an Environment Variable (set)

@@ -2635,7 +2683,7 @@ nsh>
-

2.52 Execute an NSH Script (sh)

+

2.53 Execute an NSH Script (sh)

@@ -2654,7 +2702,7 @@ sh <script-path>
-

2.53 Shut the system down (shutdown)

+

2.54 Shut the system down (shutdown)

@@ -2675,7 +2723,7 @@ shutdown [--reboot]
-

2.54 Wait for Seconds (sleep)

+

2.55 Wait for Seconds (sleep)

@@ -2692,7 +2740,7 @@ sleep <sec>
-

2.55 Time execution of another command (time)

+

2.56 Time execution of another command (time)

@@ -2751,7 +2799,7 @@ nsh>
-

2.56 Unmount a File System (umount)

+

2.57 Unmount a File System (umount)

@@ -2781,7 +2829,7 @@ nsh>
-

2.57 Print system information (uname)

+

2.58 Print system information (uname)

@@ -2848,7 +2896,7 @@ uname [-a | -imnoprsv]
-

2.58 Unset an Environment Variable (unset)

+

2.59 Unset an Environment Variable (unset)

@@ -2874,7 +2922,7 @@ nsh>
-

2.59 URL Decode (urldecode)

+

2.60 URL Decode (urldecode)

@@ -2891,7 +2939,7 @@ urldecode [-f] <string or filepath>
-

2.60 URL Encode (urlencode)

+

2.61 URL Encode (urlencode)

@@ -2908,7 +2956,7 @@ urlencode [-f] <string or filepath>
-

2.61 Add a New User (useradd)

+

2.62 Add a New User (useradd)

@@ -2925,7 +2973,7 @@ useradd <username> <password>
-

2.62 Delete a user (userdel)

+

2.63 Delete a user (userdel)

@@ -2942,7 +2990,7 @@ userdel <username>
-

2.63 Wait for Microseconds (usleep)

+

2.64 Wait for Microseconds (usleep)

@@ -2959,7 +3007,7 @@ usleep <usec>
-

2.64 Get File Via HTTP (wget)

+

2.65 Get File Via HTTP (wget)

@@ -2986,7 +3034,7 @@ wget [-o <local-path>] <url>
-

2.65 Hexadecimal Dump of Memory (xd)

+

2.66 Hexadecimal Dump of Memory (xd)

@@ -3059,6 +3107,11 @@ nsh> CONFIG_NET && CONFIG_NET_ROUTE CONFIG_NSH_DISABLE_ADDROUTE + + arp + CONFIG_NET && CONFIG_NET_ARP + CONFIG_NSH_DISABLE_ARP + base64dec CONFIG_NETUTILS_CODECS && CONFIG_CODECS_BASE64 @@ -5066,6 +5119,7 @@ xxd -i romfs_img >nsh_romfsimg.h
  • [
  • Adding NSH commands
  • addroute
  • +
  • arp
  • Autogenerated header files
  • Background commands
  • Background command priority