From de8f3ebedbcd5138bceddefebf72cff644a33a48 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Fri, 12 Jan 2018 17:59:13 -0600 Subject: [PATCH] Documentation: Update NSH documention to discuss the irqinfo command. --- Documentation/NuttShell.html | 217 +++++++++++++++++++++-------------- 1 file changed, 128 insertions(+), 89 deletions(-) diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index c23950484c..6095357a5c 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -8,7 +8,7 @@

NuttShell (NSH)

-

Last Updated: January 10, 2018

+

Last Updated: January 12, 2018

@@ -251,259 +251,265 @@
- 2.28 Send a signal to a task (kill) + 2.28 Show Interrupt Status (irqinfo)
- 2.29 Setup/teardown the Loop Device (losetup) + 2.29 Send a signal to a task (kill)
- 2.30 List to a File or Directory (ln) + 2.30 Setup/teardown the Loop Device (losetup)
- 2.31 List Directory Contents (ls) + 2.31 List to a File or Directory (ln)
- 2.32 Show information about installed OS modules (lsmod) + 2.32 List Directory Contents (ls)
- 2.33 Calculate MD5 (md5) + 2.33 Show information about installed OS modules (lsmod)
- 2.34 Access Memory (mb, mh, and mw) + 2.34 Calculate MD5 (md5)
- 2.35 Show Current Tasks and Threads (ps) + 2.35 Access Memory (mb, mh, and mw)
- 2.36 Create a Directory (mkdir) + 2.36 Show Current Tasks and Threads (ps)
- 2.37 Create a FAT File System (mkfatfs) + 2.37 Create a Directory (mkdir)
- 2.38 Create a FIFO (mkfifo) + 2.38 Create a FAT File System (mkfatfs)
- 2.39 Create a RAMDISK (mkrd) + 2.39 Create a FIFO (mkfifo)
- 2.40 Mount a File System (mount) + 2.40 Create a RAMDISK (mkrd)
- 2.41 Rename a File (mv) + 2.41 Mount a File System (mount)
- 2.42 Mount an NFS File System (nfsmount) + 2.42 Rename a File (mv)
- 2.43 Lookup a network address (nslookup) + 2.43 Mount an NFS File System (nfsmount)
- 2.44 Change a User's Password (passwd) + 2.44 Lookup a network address (nslookup)
- 2.45 Shut the system down (poweroff) + 2.45 Change a User's Password (passwd)
- 2.46 Send File Via TFTP (put) + 2.46 Shut the system down (poweroff)
- 2.47 Show Current Working Directory (pwd) + 2.47 Send File Via TFTP (put)
- 2.48 Show target of a link (readlink) + 2.48 Show Current Working Directory (pwd)
- 2.49 Reset and reboot the system (reboot) + 2.49 Show target of a link (readlink)
- 2.50 Remove a File (rm) + 2.50 Reset and reboot the system (reboot)
- 2.51 Remove a Directory (rmdir) + 2.51 Remove a File (rm)
- 2.52 Remove on OS Module (rmmod) + 2.52 Remove a Directory (rmdir)
- 2.53 Show routing table (route) + 2.53 Remove on OS Module (rmmod)
- 2.54 Set an Environment Variable (set) + 2.54 Show routing table (route)
- 2.55 Execute an NSH Script (sh) + 2.55 Set an Environment Variable (set)
- 2.56 Shut the system down (shutdown) + 2.56 Execute an NSH Script (sh)
- 2.57 Wait for Seconds (sleep) + 2.57 Shut the system down (shutdown)
- 2.58 Start the Telnet Daemon (telnetd) + 2.58 Wait for Seconds (sleep)
- 2.59 Time execution of another command (time) + 2.59 Start the Telnet Daemon (telnetd)
- 2.60 Set the Size of a File (truncate) + 2.60 Time execution of another command (time)
- 2.61 Unmount a File System (umount) + 2.61 Set the Size of a File (truncate)
- 2.62 Print system information (uname) + 2.62 Unmount a File System (umount)
- 2.63 Unset an Environment Variable (unset) + 2.63 Print system information (uname)
- 2.64 URL Decode (urldecode) + 2.64 Unset an Environment Variable (unset)
- 2.65 URL Encode (urlencode) + 2.65 URL Decode (urldecode)
- 2.66 Add a New User (useradd) + 2.66 URL Encode (urlencode)
- 2.67 Delete a user (userdel) + 2.67 Add a New User (useradd)
- 2.68 Wait for Microseconds (usleep) + 2.68 Delete a user (userdel)
- 2.69 Get File Via HTTP (wget) + 2.69 Wait for Microseconds (usleep)
- 2.70 Hexadecimal Dump of Memory (xd) + 2.70 Get File Via HTTP (wget) + + + +
+ + 2.71 Hexadecimal Dump of Memory (xd) @@ -1941,7 +1947,34 @@ mydriver 20404659 20404625 0 20404580 552 204047a8 0 + +
-

2.28 Send a signal to a task (kill)

+

2.28 Show Interrupt Status (irqinfo)

+
+ +

Command Syntax:

+ +

+ Synopsis. + Show the current count of interrupts taken on all attached interrupts. +

+

+ Example:. +

+ + + + +
+

2.29 Send a signal to a task (kill)

@@ -1983,7 +2016,7 @@ nsh>
-

2.29 Setup/teardown the Loop Device (losetup)

+

2.30 Setup/teardown the Loop Device (losetup)

@@ -2036,7 +2069,7 @@ losetup d <dev-path>
-

2.30 Link to a File or Directory (ln)

+

2.31 Link to a File or Directory (ln)

@@ -2061,7 +2094,7 @@ ln [-s] <target> <link>
-

2.31 List Directory Contents (ls)

+

2.32 List Directory Contents (ls)

@@ -2099,7 +2132,7 @@ ls [-lRs] <dir-path>
-

2.32 Show information about installed OS modules (lsmod)

+

2.33 Show information about installed OS modules (lsmod)

@@ -2132,7 +2165,7 @@ mydriver 20404659 20404625 0 20404580 552 204047a8 0
-

2.33 Calculate MD5 (md5)

+

2.34 Calculate MD5 (md5)

@@ -2149,7 +2182,7 @@ md5 [-f] <string or filepath>
-

2.34 Access Memory (mb, mh, and mw)

+

2.35 Access Memory (mb, mh, and mw)

@@ -2202,7 +2235,7 @@ nsh>
-

2.35 Show Current Tasks and Threads (ps)

+

2.36 Show Current Tasks and Threads (ps)

@@ -2236,7 +2269,7 @@ nsh> mount -t procfs /proc
-

2.36 Create a Directory (mkdir)

+

2.37 Create a Directory (mkdir)

@@ -2271,7 +2304,7 @@ nsh>
-

2.37 Create a FAT File System (mkfatfs)

+

2.38 Create a FAT File System (mkfatfs)

@@ -2296,7 +2329,7 @@ mkfatfs [-F <fatsize>] <block-driver>
-

2.38 Create a FIFO (mkfifo)

+

2.39 Create a FIFO (mkfifo)

@@ -2334,7 +2367,7 @@ nsh>
-

2.39 Create a RAMDISK (mkrd)

+

2.40 Create a RAMDISK (mkrd)

@@ -2385,7 +2418,7 @@ nsh>
-

2.40 Mount a File System (mount)

+

2.41 Mount a File System (mount)

@@ -2464,7 +2497,7 @@ nsh> mount
-

2.41 Rename a File (mv)

+

2.42 Rename a File (mv)

@@ -2482,7 +2515,7 @@ mv <old-path> <new-path>
-

2.42 Mount an NFS file system (nfsmount)

+

2.43 Mount an NFS file system (nfsmount)

@@ -2501,7 +2534,7 @@ nfsmount <server-address> <mount-point> <remote-path>
-

2.43 Lookup a network address (nslookup)

+

2.44 Lookup a network address (nslookup)

@@ -2518,7 +2551,7 @@ nslookup <host-name>
-

2.44 Change a User's Password (passwd)

+

2.45 Change a User's Password (passwd)

@@ -2535,7 +2568,7 @@ passwd <username> <password>
-

2.45 Shut the system down (poweroff)

+

2.46 Shut the system down (poweroff)

@@ -2557,7 +2590,7 @@ poweroff
-

2.46 Send File Via TFTP (put)

+

2.47 Send File Via TFTP (put)

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

2.47 Show Current Working Directory (pwd)

+

2.48 Show Current Working Directory (pwd)

@@ -2622,7 +2655,7 @@ nsh>
-

2.48 Show target of a link (readlink)

+

2.49 Show target of a link (readlink)

@@ -2639,7 +2672,7 @@ readlink <link>
-

2.49 Reboot the system (reboot)

+

2.50 Reboot the system (reboot)

@@ -2660,7 +2693,7 @@ reboot
-

2.50 Remove a File (rm)

+

2.51 Remove a File (rm)

@@ -2694,7 +2727,7 @@ nsh>
-

2.51 Remove a Directory (rmdir)

+

2.52 Remove a Directory (rmdir)

@@ -2729,7 +2762,7 @@ nsh>
-

2.52 Remove on OS Module (rmmod)

+

2.53 Remove on OS Module (rmmod)

@@ -2757,7 +2790,7 @@ nsh>
-

2.53 Show routing table (route)

+

2.54 Show routing table (route)

@@ -2777,7 +2810,7 @@ route ipv4|ipv6
-

2.54 Set an Environment Variable (set)

+

2.55 Set an Environment Variable (set)

@@ -2846,7 +2879,7 @@ nsh>
-

2.55 Execute an NSH Script (sh)

+

2.56 Execute an NSH Script (sh)

@@ -2864,7 +2897,7 @@ sh <script-path>
-

2.56 Shut the system down (shutdown)

+

2.57 Shut the system down (shutdown)

@@ -2885,7 +2918,7 @@ shutdown [--reboot]
-

2.57 Wait for Seconds (sleep)

+

2.58 Wait for Seconds (sleep)

@@ -2902,7 +2935,7 @@ sleep <sec>
-

2.58 Time Start the Telnet Daemon (telnetd)

+

2.59 Time Start the Telnet Daemon (telnetd)

@@ -2928,7 +2961,7 @@ telnetd
-

2.59 Time execution of another command (time)

+

2.60 Time execution of another command (time)

@@ -2986,7 +3019,7 @@ nsh>
-

2.60 Set the Size of a File (truncate)

+

2.61 Set the Size of a File (truncate)

@@ -3014,7 +3047,7 @@ truncate -s <length> <file-path>
-

2.61 Unmount a File System (umount)

+

2.62 Unmount a File System (umount)

@@ -3044,7 +3077,7 @@ nsh>
-

2.62 Print system information (uname)

+

2.63 Print system information (uname)

@@ -3111,7 +3144,7 @@ uname [-a | -imnoprsv]
-

2.63 Unset an Environment Variable (unset)

+

2.64 Unset an Environment Variable (unset)

@@ -3137,7 +3170,7 @@ nsh>
-

2.64 URL Decode (urldecode)

+

2.65 URL Decode (urldecode)

@@ -3154,7 +3187,7 @@ urldecode [-f] <string or filepath>
-

2.65 URL Encode (urlencode)

+

2.66 URL Encode (urlencode)

@@ -3171,7 +3204,7 @@ urlencode [-f] <string or filepath>
-

2.66 Add a New User (useradd)

+

2.67 Add a New User (useradd)

@@ -3188,7 +3221,7 @@ useradd <username> <password>
-

2.67 Delete a user (userdel)

+

2.68 Delete a user (userdel)

@@ -3205,7 +3238,7 @@ userdel <username>
-

2.68 Wait for Microseconds (usleep)

+

2.69 Wait for Microseconds (usleep)

@@ -3222,7 +3255,7 @@ usleep <usec>
-

2.69 Get File Via HTTP (wget)

+

2.70 Get File Via HTTP (wget)

@@ -3249,7 +3282,7 @@ wget [-o <local-path>] <url>
-

2.70 Hexadecimal Dump of Memory (xd)

+

2.71 Hexadecimal Dump of Memory (xd)

@@ -3506,6 +3539,11 @@ nsh> CONFIG_MODULE CONFIG_NSH_DISABLE_MODCMDS + + irqinfo + !CONFIG_DISABLE_MOUNTPOINT && CONFIG_FS_PROCFS && CONFIG_SCHED_IRQMONITOR +
+ kill !CONFIG_DISABLE_SIGNALS @@ -5486,10 +5524,10 @@ xxd -i romfs_img >nsh_romfsimg.h
  • CONFIG_NSH_ROMFSMOUNTPT
  • CONFIG_NSH_ROMFSSECTSIZE
  • CONFIG_NSH_STRERROR
  • +
  • CONFIG_NSH_TELNET