From de45c3f60798104caa4d7c5e7afdecbae2f951a0 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Thu, 21 Nov 2019 12:25:50 -0600 Subject: [PATCH] Documentation/NuttShell.html: Update to include a description of the 'dmesg' command which was apparently never documented. --- Documentation/NuttShell.html | 272 ++++++++++++++++++++--------------- 1 file changed, 153 insertions(+), 119 deletions(-) diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index d794b2b8fa..c1a10cb4c8 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -178,355 +178,361 @@
- 2.17 Echo Strings and Variables (echo) + 2.17 Dump Buffered SYSLOG Ouput (dmesg)
- 2.18 Show Environment Variables (env) + 2.18 Echo Strings and Variables (echo)
- 2.19 Execute User Code (exec) + 2.19 Show Environment Variables (env)
- 2.20 Exit NSH (exit) + 2.20 Execute User Code (exec)
- 2.21 Set an Environment Variable (export) + 2.21 Exit NSH (exit)
- 2.22 Show Memory Manager Status (free) + 2.22 Set an Environment Variable (export)
- 2.23 Get File Via TFTP (get) + 2.23 Show Memory Manager Status (free)
- 2.24 Show Usage Command Usage (help) + 2.24 Get File Via TFTP (get)
- 2.25 Hexadecimal Dump of File or Device (hexdump) + 2.25 Show Usage Command Usage (help)
- 2.26 Manage Network Configuration (ifconfig) + 2.26 Hexadecimal Dump of File or Device (hexdump)
- 2.27 Take a network down (ifdown) + 2.27 Manage Network Configuration (ifconfig)
- 2.28 Bring a network up (ifup) + 2.28 Take a network down (ifdown)
- 2.29 Install an OS module (insmod) + 2.29 Bring a network up (ifup)
- 2.30 Show Interrupt Status (irqinfo) + 2.30 Install an OS module (insmod)
- 2.31 Send a signal to a task (kill) + 2.31 Show Interrupt Status (irqinfo)
- 2.32 Setup/teardown the Loop Device (losetup) + 2.32 Send a signal to a task (kill)
- 2.33 List to a File or Directory (ln) + 2.33 Setup/teardown the Loop Device (losetup)
- 2.34 List Directory Contents (ls) + 2.34 List to a File or Directory (ln)
- 2.35 Show information about installed OS modules (lsmod) + 2.35 List Directory Contents (ls)
- 2.36 Calculate MD5 (md5) + 2.36 Show information about installed OS modules (lsmod)
- 2.37 Access Memory (mb, mh, and mw) + 2.37 Calculate MD5 (md5)
- 2.38 Show Current Tasks and Threads (ps) + 2.38 Access Memory (mb, mh, and mw)
- 2.39 Create a Directory (mkdir) + 2.39 Show Current Tasks and Threads (ps)
- 2.40 Create a FAT File System (mkfatfs) + 2.40 Create a Directory (mkdir)
- 2.41 Create a FIFO (mkfifo) + 2.41 Create a FAT File System (mkfatfs)
- 2.42 Create a RAMDISK (mkrd) + 2.42 Create a FIFO (mkfifo)
- 2.43 Mount a File System (mount) + 2.43 Create a RAMDISK (mkrd)
- 2.44 Rename a File (mv) + 2.44 Mount a File System (mount)
- 2.45 Mount an NFS File System (nfsmount) + 2.45 Rename a File (mv)
- 2.46 Lookup a network address (nslookup) + 2.46 Mount an NFS File System (nfsmount)
- 2.47 Change a User's Password (passwd) + 2.47 Lookup a network address (nslookup)
- 2.48 Manage Power Management Subsystem (pmconfig) + 2.48 Change a User's Password (passwd)
- 2.49 Shut the system down (poweroff) + 2.49 Manage Power Management Subsystem (pmconfig)
- 2.50 Send File Via TFTP (put) + 2.50 Shut the system down (poweroff)
- 2.51 Show Current Working Directory (pwd) + 2.51 Send File Via TFTP (put)
- 2.52 Show target of a link (readlink) + 2.52 Show Current Working Directory (pwd)
- 2.53 Reset and reboot the system (reboot) + 2.53 Show target of a link (readlink)
- 2.54 Remove a File (rm) + 2.54 Reset and reboot the system (reboot)
- 2.55 Remove a Directory (rmdir) + 2.55 Remove a File (rm)
- 2.56 Remove on OS Module (rmmod) + 2.56 Remove a Directory (rmdir)
- 2.57 Show routing table (route) + 2.57 Remove on OS Module (rmmod)
- 2.58 Start/Stop the OpenAMP RPC Tunnel (rptun) + 2.58 Show routing table (route)
- 2.59 Set a Variable (set) + 2.59 Start/Stop the OpenAMP RPC Tunnel (rptun)
- 2.60 Execute an NSH Script (sh) + 2.60 Set a Variable (set)
- 2.61 Shut the system down (shutdown) + 2.61 Execute an NSH Script (sh)
- 2.62 Wait for Seconds (sleep) + 2.62 Shut the system down (shutdown)
- 2.63 Start the Telnet Daemon (telnetd) + 2.63 Wait for Seconds (sleep)
- 2.64 Time execution of another command (time) + 2.64 Start the Telnet Daemon (telnetd)
- 2.65 Set the Size of a File (truncate) + 2.65 Time execution of another command (time)
- 2.66 Unmount a File System (umount) + 2.66 Set the Size of a File (truncate)
- 2.67 Print system information (uname) + 2.67 Unmount a File System (umount)
- 2.68 Unset an Environment Variable (unset) + 2.68 Print system information (uname)
- 2.69 URL Decode (urldecode) + 2.69 Unset an Environment Variable (unset)
- 2.70 URL Encode (urlencode) + 2.70 URL Decode (urldecode)
- 2.71 Add a New User (useradd) + 2.71 URL Encode (urlencode)
- 2.72 Delete a user (userdel) + 2.72 Add a New User (useradd)
- 2.73 Wait for Microseconds (usleep) + 2.73 Delete a user (userdel)
- 2.74 Get File Via HTTP (wget) + 2.74 Wait for Microseconds (usleep)
- 2.75 Hexadecimal Dump of Memory (xd) + 2.75 Get File Via HTTP (wget) + + + +
+ + 2.76 Hexadecimal Dump of Memory (xd) @@ -1664,10 +1670,32 @@ dirname <path> the final directory or file name.

+ + +
-

2.17 Echo Strings and Variables (echo)

 +

2.17 Dump Buffered SYSLOG Ouput (dmesg)

 +
+ +

Command Syntax:

+ +

+ Synopsis. + This command can be used to dump (and clear) the content of any buffered syslog output messages. + This command is only available if CONFIG_RAMLOG_SYSLOG is enabled. + In that case, syslog output will be collected in an in-memory, circular buffer. + Entering the dmesg command will dump the content of that in-memory, circular buffer to the NSH console output. + dmesg has the side effect of clearing the buffered data so that entering dmesg again will show only newly buffered data. +

+ + + +
+

2.18 Echo Strings and Variables (echo)
@@ -1688,7 +1716,7 @@ echo [-n] [<string|$name> [<string|$name>...]]
-

2.18 Show Environment Variables (env)

 +

2.19 Show Environment Variables (env)
@@ -1723,7 +1751,7 @@ nsh>
-

2.19 Execute User Code (exec)

 +

2.20 Execute User Code (exec)
@@ -1742,7 +1770,7 @@ exec <hex-address>
-

2.20 Exit NSH (exit)

 +

2.21 Exit NSH (exit)
@@ -1761,7 +1789,7 @@ exit
-

2.21 Set an Environment Variable (export)

 +

2.22 Set an Environment Variable (export)
@@ -1820,7 +1848,7 @@ dog=poop
-

2.22 Show Memory Manager Status (free)

 +

2.23 Show Memory Manager Status (free)
@@ -1862,7 +1890,7 @@ nsh>
-

2.23 Get File Via TFTP (get)

 +

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

2.24 Show Usage Command Usage (help)

 +

2.25 Show Usage Command Usage (help)
@@ -1929,7 +1957,7 @@ help [-v] [<cmd>]
-

2.25 Hexadecimal Dump of File or Device (hexdump)

 +

2.26 Hexadecimal Dump of File or Device (hexdump)
@@ -1959,7 +1987,7 @@ The skip and count options are only available if -

2.26 Manage Network Configuration (ifconfig)

 +

2.27 Manage Network Configuration (ifconfig)

 @@ -2021,7 +2049,7 @@ nsh> mount -t procfs /proc
-

2.27 Take a network down (ifdown)

 +

2.28 Take a network down (ifdown)
@@ -2044,7 +2072,7 @@ ifdown eth0
-

2.28 Bring a network up (ifup)

 +

2.29 Bring a network up (ifup)
@@ -2067,7 +2095,7 @@ ifup eth0
-

2.29 Install an OS module (insmod)

 +

2.30 Install an OS module (insmod)
@@ -2110,7 +2138,7 @@ mydriver 20404659 20404625 0 20404580 552 204047a8 0
-

2.30 Show Interrupt Status (irqinfo)

 +

2.31 Show Interrupt Status (irqinfo)
@@ -2137,7 +2165,7 @@ IRQ HANDLER ARGUMENT COUNT RATE
-

2.31 Send a signal to a task (kill)

 +

2.32 Send a signal to a task (kill)
@@ -2184,7 +2212,7 @@ nsh>
-

2.32 Setup/teardown the Loop Device (losetup)

 +

2.33 Setup/teardown the Loop Device (losetup)
@@ -2237,7 +2265,7 @@ losetup d <dev-path>
-

2.33 Link to a File or Directory (ln)

 +

2.34 Link to a File or Directory (ln)
@@ -2262,7 +2290,7 @@ ln [-s] <target> <link>
-

2.34 List Directory Contents (ls)

 +

2.35 List Directory Contents (ls)
@@ -2300,7 +2328,7 @@ ls [-lRs] <dir-path>
-

2.35 Show information about installed OS modules (lsmod)

 +

2.36 Show information about installed OS modules (lsmod)
@@ -2333,7 +2361,7 @@ mydriver 20404659 20404625 0 20404580 552 204047a8 0
-

2.36 Calculate MD5 (md5)

 +

2.37 Calculate MD5 (md5)
@@ -2350,7 +2378,7 @@ md5 [-f] <string or filepath>
-

2.37 Access Memory (mb, mh, and mw)

 +

2.38 Access Memory (mb, mh, and mw)
@@ -2403,7 +2431,7 @@ nsh>
-

2.38 Show Current Tasks and Threads (ps)

 +

2.39 Show Current Tasks and Threads (ps)
@@ -2437,7 +2465,7 @@ nsh> mount -t procfs /proc
-

2.39 Create a Directory (mkdir)

 +

2.40 Create a Directory (mkdir)
@@ -2472,7 +2500,7 @@ nsh>
-

2.40 Create a FAT File System (mkfatfs)

 +

2.41 Create a FAT File System (mkfatfs)
@@ -2504,7 +2532,7 @@ mkfatfs [-F <fatsize>] [-r <rootdirentries>] <block-driver>
-

2.41 Create a FIFO (mkfifo)

 +

2.42 Create a FIFO (mkfifo)
@@ -2542,7 +2570,7 @@ nsh>
-

2.42 Create a RAMDISK (mkrd)

 +

2.43 Create a RAMDISK (mkrd)
@@ -2593,7 +2621,7 @@ nsh>
-

2.43 Mount a File System (mount)

 +

2.44 Mount a File System (mount)
@@ -2672,7 +2700,7 @@ nsh> mount
-

2.44 Rename a File (mv)

 +

2.45 Rename a File (mv)
@@ -2690,7 +2718,7 @@ mv <old-path> <new-path>
-

2.45 Mount an NFS file system (nfsmount)

 +

2.46 Mount an NFS file system (nfsmount)
@@ -2709,7 +2737,7 @@ nfsmount <server-address> <mount-point> <remote-path>
-

2.46 Lookup a network address (nslookup)

 +

2.47 Lookup a network address (nslookup)
@@ -2726,7 +2754,7 @@ nslookup <host-name>
-

2.47 Change a User's Password (passwd)

 +

2.48 Change a User's Password (passwd)
@@ -2743,7 +2771,7 @@ passwd <username> <password>
-

2.48 Manage Power Management Subsystem (pmconfig)

 +

2.49 Manage Power Management Subsystem (pmconfig)
@@ -2760,7 +2788,7 @@ pmconfig [stay|relax] [normal|idle|standby|sleep]
-

2.49 Shut the system down (poweroff)

 +

2.50 Shut the system down (poweroff)
@@ -2784,7 +2812,7 @@ poweroff [<n>]
-

2.50 Send File Via TFTP (put)

 +

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

2.51 Show Current Working Directory (pwd)

 +

2.52 Show Current Working Directory (pwd)
@@ -2849,7 +2877,7 @@ nsh>
-

2.52 Show target of a link (readlink)

 +

2.53 Show target of a link (readlink)
@@ -2866,7 +2894,7 @@ readlink <link>
-

2.53 Reboot the system (reboot)

 +

2.54 Reboot the system (reboot)
@@ -2888,7 +2916,7 @@ reboot [<n>]
-

2.54 Remove a File (rm)

 +

2.55 Remove a File (rm)
@@ -2922,7 +2950,7 @@ nsh>
-

2.55 Remove a Directory (rmdir)

 +

2.56 Remove a Directory (rmdir)
@@ -2957,7 +2985,7 @@ nsh>
-

2.56 Remove on OS Module (rmmod)

 +

2.57 Remove on OS Module (rmmod)
@@ -2985,7 +3013,7 @@ nsh>
-

2.57 Show routing table (route)

 +

2.58 Show routing table (route)
@@ -3006,7 +3034,7 @@ route ipv4|ipv6 -

2.58 Start/Stop the OpenAMP RPC Tunnel (rptun)

 +

2.59 Start/Stop the OpenAMP RPC Tunnel (rptun)

 @@ -3023,7 +3051,7 @@ rptun start|stop <dev-path>
-

2.59 Set a Variable (set)

 +

2.60 Set a Variable (set)
@@ -3112,7 +3140,7 @@ foovalue
-

2.60 Execute an NSH Script (sh)

 +

2.61 Execute an NSH Script (sh)
@@ -3130,7 +3158,7 @@ sh <script-path>
-

2.61 Shut the system down (shutdown)

 +

2.62 Shut the system down (shutdown)
@@ -3151,7 +3179,7 @@ shutdown [--reboot]
-

2.62 Wait for Seconds (sleep)

 +

2.63 Wait for Seconds (sleep)
@@ -3168,7 +3196,7 @@ sleep <sec>
-

2.63 Time Start the Telnet Daemon (telnetd)

 +

2.64 Time Start the Telnet Daemon (telnetd)
@@ -3194,7 +3222,7 @@ telnetd
-

2.64 Time execution of another command (time)

 +

2.65 Time execution of another command (time)
@@ -3252,7 +3280,7 @@ nsh>
-

2.65 Set the Size of a File (truncate)

 +

2.66 Set the Size of a File (truncate)
@@ -3280,7 +3308,7 @@ truncate -s <length> <file-path>
-

2.66 Unmount a File System (umount)

 +

2.67 Unmount a File System (umount)
@@ -3310,7 +3338,7 @@ nsh>
-

2.67 Print system information (uname)

 +

2.68 Print system information (uname)
@@ -3377,7 +3405,7 @@ uname [-a | -imnoprsv]
-

2.68 Unset an Environment Variable (unset)

 +

2.69 Unset an Environment Variable (unset)
@@ -3403,7 +3431,7 @@ nsh>
-

2.69 URL Decode (urldecode)

 +

2.70 URL Decode (urldecode)
@@ -3420,7 +3448,7 @@ urldecode [-f] <string or filepath>
-

2.70 URL Encode (urlencode)

 +

2.71 URL Encode (urlencode)
@@ -3437,7 +3465,7 @@ urlencode [-f] <string or filepath>
-

2.71 Add a New User (useradd)

 +

2.72 Add a New User (useradd)
@@ -3454,7 +3482,7 @@ useradd <username> <password>
-

2.72 Delete a user (userdel)

 +

2.73 Delete a user (userdel)
@@ -3471,7 +3499,7 @@ userdel <username>
-

2.73 Wait for Microseconds (usleep)

 +

2.74 Wait for Microseconds (usleep)
@@ -3488,7 +3516,7 @@ usleep <usec>
-

2.74 Get File Via HTTP (wget)

 +

2.75 Get File Via HTTP (wget)
@@ -3515,7 +3543,7 @@ wget [-o <local-path>] <url>
-

2.75 Hexadecimal Dump of Memory (xd)

 +

2.76 Hexadecimal Dump of Memory (xd)
@@ -3716,6 +3744,11 @@ nsh>   CONFIG_NSH_DISABLE_DIRNAME + + dmesg + CONFIG_RAMLOG_SYSLOG + CONFIG_NSH_DISABLE_DMESG + echo
@@ -5864,6 +5897,7 @@ xxd -i romfs_img >nsh_romfsimg.h
  • dirname
  • do
  • done
    • +
  • dmesg
  • echo
  • env
  • Environment Variables
    • @@ -5907,10 +5941,10 @@ xxd -i romfs_img >nsh_romfsimg.h
  • nfsmount
  • nice
  • NSH library (nshlib)
    • -
  • NSH library (nshlib), initialization