diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index d547eb86bc7..df67f037e1d 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -119,319 +119,319 @@
- 2.5 Terminate a Loop (break) + 2.6 Terminate a Loop (break)
- 2.6 Concatenate Files (cat) + 2.7 Concatenate Files (cat)
- 2.7 Change Current Working Directory (cd) + 2.8 Change Current Working Directory (cd)
- 2.8 Compare Files (cmp) + 2.9 Compare Files (cmp)
- 2.9 Copy Files (cp) + 2.10 Copy Files (cp)
- 2.10 Show or set the date and time (date) + 2.11 Show or set the date and time (date)
- 2.11 Copy and Convert Files (dd) + 2.12 Copy and Convert Files (dd)
- 2.12 Delete a Routing Table Entry (delroute) + 2.13 Delete a Routing Table Entry (delroute)
- 2.13 Show volume status (df) + 2.14 Show volume status (df)
- 2.14 Extract Path to a File/Directory (dirname) + 2.15 Extract Path to a File/Directory (dirname)
- 2.14 Echo Strings and Variables (echo) + 2.16 Echo Strings and Variables (echo)
- 2.15 Execute User Code (exec) + 2.17 Execute User Code (exec)
- 2.16 Exit NSH (exit) + 2.18 Exit NSH (exit)
- 2.17 Show Memory Manager Status (free) + 2.19 Show Memory Manager Status (free)
- 2.18 Get File Via TFTP (get) + 2.20 Get File Via TFTP (get)
- 2.19 Show Usage Command Usage (help) + 2.21 Show Usage Command Usage (help)
- 2.20 Hexadecimal Dump of File or Device (hexdump) + 2.22 Hexadecimal Dump of File or Device (hexdump)
- 2.21 Manage Network Configuration (ifconfig) + 2.23 Manage Network Configuration (ifconfig)
- 2.22 Take a network down (ifdown) + 2.24 Take a network down (ifdown)
- 2.23 Bring a network up (ifup) + 2.25 Bring a network up (ifup)
- 2.24 Send a signal to a task (kill) + 2.26 Send a signal to a task (kill)
- 2.25 Setup/teardown the Loop Device (losetup) + 2.27 Setup/teardown the Loop Device (losetup)
- 2.26 List Directory Contents (ls) + 2.28 List Directory Contents (ls)
- 2.27 Calculate MD5 (md5) + 2.29 Calculate MD5 (md5)
- 2.28 Access Memory (mb, mh, and mw) + 2.30 Access Memory (mb, mh, and mw)
- 2.29 Show Current Tasks and Threads (ps) + 2.31 Show Current Tasks and Threads (ps)
- 2.30 Create a Directory (mkdir) + 2.32 Create a Directory (mkdir)
- 2.31 Create a FAT Filesystem (mkfatfs) + 2.33 Create a FAT Filesystem (mkfatfs)
- 2.32 Create a FIFO (mkfifo) + 2.34 Create a FIFO (mkfifo)
- 2.33 Create a RAMDISK (mkrd) + 2.35 Create a RAMDISK (mkrd)
- 2.34 Mount a File System (mount) + 2.36 Mount a File System (mount)
- 2.35 Rename a File (mv) + 2.37 Rename a File (mv)
- 2.36 Mount an NFS file system (nfsmount) + 2.38 Mount an NFS file system (nfsmount)
- 2.37 Lookup a network address (nslookup) + 2.39 Lookup a network address (nslookup)
- 2.38 Check Network Peer (ping/ping6) + 2.40 Check Network Peer (ping/ping6)
- 2.39 Shut the system down (poweroff) + 2.41 Shut the system down (poweroff)
- 2.40 Send File Via TFTP (put) + 2.42 Send File Via TFTP (put)
- 2.41 Show Current Working Directory (pwd) + 2.43 Show Current Working Directory (pwd)
- 2.42 Reset and reboot the system (reboot) + 2.44 Reset and reboot the system (reboot)
- 2.43 Remove a File (rm) + 2.45 Remove a File (rm)
- 2.44 Remove a Directory (rmdir) + 2.46 Remove a Directory (rmdir)
- 2.45 Set an Environment Variable (set) + 2.47 Set an Environment Variable (set)
- 2.46 Execute an NSH Script (sh) + 2.48 Execute an NSH Script (sh)
- 2.47 Shut the system down (shutdown) + 2.49 Shut the system down (shutdown)
- 2.48 Wait for Seconds (sleep) + 2.50 Wait for Seconds (sleep)
- 2.49 Unmount a File System (umount) + 2.51 Unmount a File System (umount)
- 2.50 Print system information (uname) + 2.52 Print system information (uname)
- 2.51 Unset an Environment Variable (unset) + 2.53 Unset an Environment Variable (unset)
- 2.52 URL Decode (urldecode) + 2.54 URL Decode (urldecode)
- 2.53 URL Encode (urlencode) + 2.55 URL Encode (urlencode)
- 2.54 Wait for Microseconds (usleep) + 2.56 Wait for Microseconds (usleep)
- 2.55 Get File Via HTTP (wget) + 2.57 Get File Via HTTP (wget)
- 2.56 Hexadecimal Dump of Memory (xd) + 2.58 Hexadecimal Dump of Memory (xd) @@ -1115,7 +1115,7 @@ basename <path> [<suffix>]
-

2.5 Terminate a Loop (break)

 +

2.6 Terminate a Loop (break)
@@ -1134,7 +1134,7 @@ break
-

2.6 Concatenate Files (cat)

 +

2.7 Concatenate Files (cat)
@@ -1152,7 +1152,7 @@ cat <path> [<path> [<path> -

2.7 Change Current Working Directory (cd)

 +

2.8 Change Current Working Directory (cd)

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

2.8 Compare Files (cmp)

 +

2.9 Compare Files (cmp)
@@ -1211,7 +1211,7 @@ cmp <path1> <path2>
-

2.9 Copy Files (cp)

 +

2.10 Copy Files (cp)
@@ -1229,7 +1229,7 @@ cp <source-path> <dest-path>
-

2.10 Show or set the date and time (date)

 +

2.11 Show or set the date and time (date)
@@ -1255,7 +1255,7 @@ data -s "Sep 1 11:30:00 2011"
-

2.11 Copy and Convert Files (dd)

 +

2.12 Copy and Convert Files (dd)
@@ -1313,7 +1313,7 @@ nsh> dd if=/dev/ram0 of=/dev/null
-

2.12 Delete a Routing Table Entry (delroute)

 +

2.13 Delete a Routing Table Entry (delroute)
@@ -1336,7 +1336,7 @@ nsh> delroute 1.1.1.1 2.2.2.2
-

2.13 Show Volument Status (df)

 +

2.14 Show Volument Status (df)
@@ -1368,7 +1368,7 @@ nsh>
-

2.14 Extract Path to a File/Directory (dirname)

 +

2.15 Extract Path to a File/Directory (dirname)
@@ -1385,7 +1385,7 @@ dirname <path>
-

2.14 Echo Strings and Variables (echo)

 +

2.16 Echo Strings and Variables (echo)
@@ -1403,7 +1403,7 @@ echo [<string|$name> [<string|$name>...]]
-

2.15 Execute User Code (exec)

 +

2.17 Execute User Code (exec)
@@ -1422,7 +1422,7 @@ exec <hex-address>
-

2.16 Exit NSH (exit)

 +

2.18 Exit NSH (exit)
@@ -1441,7 +1441,7 @@ exit
-

2.17 Show Memory Manager Status (free)

 +

2.19 Show Memory Manager Status (free)
@@ -1483,7 +1483,7 @@ nsh>
-

2.18 Get File Via TFTP (get)

 +

2.20 Get File Via TFTP (get)
@@ -1518,7 +1518,7 @@ get [-b|-n] [-f <local-path>] -h <ip-address> <remote-path>
-

2.19 Show Usage Command Usage (help)

 +

2.21 Show Usage Command Usage (help)
@@ -1550,7 +1550,7 @@ help [-v] [<cmd>]
-

2.20 Hexadecimal Dump of File or Device (hexdump)

 +

2.22 Hexadecimal Dump of File or Device (hexdump)
@@ -1574,7 +1574,7 @@ hexdump <file or device>
-

2.21 Manage Network Configuration (ifconfig)

 +

2.23 Manage Network Configuration (ifconfig)
@@ -1624,11 +1624,19 @@ ifconfig nic_name ip_address Other forms to be provided +

+NOTE: This commands depends upon having the procfs file system configured into the system. +The procfs file system must also have been mounted with a command like: +

+ +

-

2.22 Take a network down (ifdown)

 +

2.24 Take a network down (ifdown)
@@ -1651,7 +1659,7 @@ ifdown eth0
-

2.23 Bring a network up (ifup)

 +

2.25 Bring a network up (ifup)
@@ -1674,7 +1682,7 @@ ifup eth0
-

2.24 Send a signal to a task (kill)

 +

2.26 Send a signal to a task (kill)
@@ -1691,16 +1699,15 @@ nsh> mkfifo /dev/fifo nsh> cat /dev/fifo & cat [2:128] nsh> ps -PID PRI SCHD TYPE NP STATE NAME - 0 0 FIFO TASK READY Idle Task() - 1 128 FIFO TASK RUNNING init() - 2 128 FIFO PTHREAD WAITSEM (51ea50) +PID PRI POLICY TYPE NPX STATE EVENT SIGMASK COMMAND + 0 0 FIFO Kthread --- Ready 00000000 Idle Task + 1 128 RR Task --- Running 00000000 init + 2 128 FIFO pthread --- Waiting Semaphore 00000000 <pthread>(51ea50) nsh> kill -9 2 -nsh: cat: open failed: 4 nsh> ps -PID PRI SCHD TYPE NP STATE NAME - 0 0 FIFO TASK READY Idle Task() - 1 128 FIFO TASK RUNNING init() +PID PRI POLICY TYPE NPX STATE EVENT SIGMASK COMMAND + 0 0 FIFO Kthread --- Ready 00000000 Idle Task + 1 128 RR Task --- Running 00000000 init nsh>

@@ -1715,7 +1722,7 @@ nsh>
-

2.25 Setup/teardown the Loop Device (losetup)

 +

2.27 Setup/teardown the Loop Device (losetup)
@@ -1768,7 +1775,7 @@ losetup d <dev-path>
-

2.26 List Directory Contents (ls)

 +

2.28 List Directory Contents (ls)
@@ -1805,7 +1812,7 @@ ls [-lRs] <dir-path>
-

2.27 Calculate MD5 (md5)

 +

2.29 Calculate MD5 (md5)
@@ -1822,7 +1829,7 @@ md5 [-f] <string or filepath>
-

2.28 Access Memory (mb, mh, and mw)

 +

2.30 Access Memory (mb, mh, and mw)
@@ -1876,7 +1883,7 @@ nsh>
-

2.29 Show Current Tasks and Threads (ps)

 +

2.31 Show Current Tasks and Threads (ps)
@@ -1891,18 +1898,26 @@ ps 

     nsh> ps
-PID   PRI SCHD TYPE   NP STATE    NAME
-    0   0 FIFO TASK      READY    Idle Task()
-    1 128 RR   TASK      RUNNING  init()
-    2 128 FIFO TASK      WAITSEM  nsh_telnetmain()
-    3 100 RR   PTHREAD   WAITSEM  <pthread>(21)
+PID PRI POLICY   TYPE    NPX STATE    EVENT     SIGMASK  COMMAND
+  0   0 FIFO     Kthread --- Ready              00000000 Idle Task
+  1 128 RR       Task    --- Running            00000000 init
+  2 128 FIFO     Task    --- Waiting  Semaphore 00000000 nsh_telnetmain()
+  3 100 RR       pthread --- Waiting  Semaphore 00000000 <pthread>(21)
 nsh>
+

+NOTE: This commands depends upon having the procfs file system configured into the system. +The procfs file system must also have been mounted with a command like: +

+
    +nsh> mount -t procfs /proc
+
+

-

2.30 Create a Directory (mkdir)

 +

2.32 Create a Directory (mkdir)
@@ -1937,7 +1952,7 @@ nsh>
-

2.31 Create a FAT Filesystem (mkfatfs)

 +

2.33 Create a FAT Filesystem (mkfatfs)
@@ -1962,7 +1977,7 @@ mkfatfs [-F <fatsize>] <block-driver>
-

2.32 Create a FIFO (mkfifo)

 +

2.34 Create a FIFO (mkfifo)
@@ -2000,7 +2015,7 @@ nsh>
-

2.33 Create a RAMDISK (mkrd)

 +

2.35 Create a RAMDISK (mkrd)
@@ -2051,7 +2066,7 @@ nsh>
-

2.34 Mount a File System (mount)

 +

2.36 Mount a File System (mount)
@@ -2130,7 +2145,7 @@ nsh> mount
-

2.35 Rename a File (mv)

 +

2.37 Rename a File (mv)
@@ -2148,7 +2163,7 @@ mv <old-path> <new-path>
-

2.36 Mount an NFS file system (nfsmount)

 +

2.38 Mount an NFS file system (nfsmount)
@@ -2167,7 +2182,7 @@ nfsmount <server-address> <mount-point> <remote-path>
-

2.37 Lookup a network address (nslookup)

 +

2.39 Lookup a network address (nslookup)
@@ -2184,7 +2199,7 @@ nslookup <host-name>
-

2.38 Check Network Peer (ping/ping6)

 +

2.40 Check Network Peer (ping/ping6)
@@ -2221,7 +2236,7 @@ nsh>
-

2.39 Shut the system down (poweroff)

 +

2.41 Shut the system down (poweroff)
@@ -2243,7 +2258,7 @@ poweroff
-

2.40 Send File Via TFTP (put)

 +

2.42 Send File Via TFTP (put)
@@ -2278,7 +2293,7 @@ put [-b|-n] [-f <remote-path>] -h <ip-address> <local-path>
-

2.41 Show Current Working Directory (pwd)

 +

2.43 Show Current Working Directory (pwd)
@@ -2308,7 +2323,7 @@ nsh>
-

2.42 Reboot the system (reboot)

 +

2.44 Reboot the system (reboot)
@@ -2330,7 +2345,7 @@ reboot
-

2.43 Remove a File (rm)

 +

2.45 Remove a File (rm)
@@ -2364,7 +2379,7 @@ nsh>
-

2.44 Remove a Directory (rmdir)

 +

2.46 Remove a Directory (rmdir)
@@ -2399,7 +2414,7 @@ nsh>
-

2.45 Set an Environment Variable (set)

 +

2.47 Set an Environment Variable (set)
@@ -2425,7 +2440,7 @@ nsh>
-

2.46 Execute an NSH Script (sh)

 +

2.48 Execute an NSH Script (sh)
@@ -2444,7 +2459,7 @@ sh <script-path>
-

2.47 Shut the system down (shutdown)

 +

2.49 Shut the system down (shutdown)
@@ -2465,7 +2480,7 @@ shutdown [--reboot]
-

2.48 Wait for Seconds (sleep)

 +

2.50 Wait for Seconds (sleep)
@@ -2482,7 +2497,7 @@ sleep <sec>
-

2.49 Unmount a File System (umount)

 +

2.51 Unmount a File System (umount)
@@ -2512,7 +2527,7 @@ nsh>
-

2.50 Print system information (uname)

 +

2.52 Print system information (uname)
@@ -2579,7 +2594,7 @@ uname [-a | -imnoprsv]
-

2.51 Unset an Environment Variable (unset)

 +

2.53 Unset an Environment Variable (unset)
@@ -2605,7 +2620,7 @@ nsh>
-

2.52 URL Decode (urldecode)

 +

2.54 URL Decode (urldecode)
@@ -2622,7 +2637,7 @@ urldecode [-f] <string or filepath>
-

2.53 URL Encode (urlencode)

 +

2.55 URL Encode (urlencode)
@@ -2639,7 +2654,7 @@ urlencode [-f] <string or filepath>
-

2.54 Wait for Microseconds (usleep)

 +

2.56 Wait for Microseconds (usleep)
@@ -2656,7 +2671,7 @@ usleep <usec>
- 2.55 Get File Via HTTP (wget) + 2.57 Get File Via HTTP (wget)
@@ -2683,7 +2698,7 @@ wget [-o <local-path>] <url>
-

2.56 Hexadecimal Dump of Memory (xd)

 +

2.58 Hexadecimal Dump of Memory (xd)