diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index 36335e873e0..a51dd516b12 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -8,7 +8,7 @@

NuttShell (NSH)

-

Last Updated: October 20, 2017

+

Last Updated: October 23, 2017

@@ -353,7 +353,7 @@
- 2.45 Check Network Peer (ping/ping6) + 2.45 Check Network Peer (ping6) @@ -509,78 +509,97 @@ - 3.0 Configuration Settings + 3.0 Built-In Commands + + + +
+ + 3.1 Check Network Peer (ping) + + + + + + + 4.0 Configuration Settings
- 3.1 Command Dependencies on Configuration Settings + 4.1 Command Dependencies on Configuration Settings
- 3.2 NSH-Specific Configuration Settings + 4.2 Built-In Command Dependencies on Configuration Settings + + + +
+ + 4.3 NSH-Specific Configuration Settings - 4.0 Customizing the NuttShell + 5.0 Customizing the NuttShell
- 4.1 The NSH Library and NSH Initialization + 5.1 The NSH Library and NSH Initialization
- 4.2 NSH Commands + 5.2 NSH Commands
- 4.3 NSH "Built-In" Applications + 5.3 NSH "Built-In" Applications
- 4.4 Customizing NSH Initialization + 5.4 Customizing NSH Initialization - 5.0 Shell Login + 6.0 Shell Login
- 5.1 Enabling Shell Logins + 6.1 Enabling Shell Logins
- 5.2 Verification of Credentials + 6.2 Verification of Credentials
- 5.3 Password Files + 6.3 Password Files
- 5.4 Creating a Password File for a ROMFS File System + 6.4 Creating a Password File for a ROMFS File System @@ -2513,38 +2532,20 @@ passwd <username> <password>
-

2.45 Check Network Peer (ping/ping6)

+

2.45 Check Network Peer (ping6)

Command Syntax:

Synopsis. - Test the network communication with a remote peer. Example, + Test the network communication with a remote peer.

- -

- ping6 differs from ping in that it uses IPv6 addressing. + ping6 differs from ping in that it uses IPv6 addressing.

@@ -3263,7 +3264,61 @@ nsh>
+ +
-

3.0 Configuration Settings

+

3.0 Built-In Commands

+
+ +

+ In addition to the commands that are part of NSH listed in the previous section above, there can be additional, external built-in applications that can be added to NSH. + These are separately excecuble programs but will appear much like the commands that are a part of NSH. + The primary difference from the user's perspective is that help information about the built-in applications is not available directly from NSH. + Rather, you will need to execute the application with the -h option to get help about using the built-in applications. +

+ +

+ There are several built-in appliations in the apps/ repository. + No attempt is made here to enumerate all of them. + But a few of the more common, useful built-in applications are listed below. +

+ + + + + +
+

3.1 Check Network Peer (ping)

+
+ +

Command Syntax:

+ +

+ Synopsis. + Test the network communication with a remote peer. Example, +

+ + + + +
+

4.0 Configuration Settings

@@ -3287,7 +3342,7 @@ nsh>
-

3.1 Command Dependencies on Configuration Settings

+

4.1 Command Dependencies on Configuration Settings

@@ -3519,12 +3574,6 @@ nsh> !CONFIG_DISABLE_MOUNTPOINT && CONFIG_NFILE_DESCRIPTORS > 0 && CONFIG_FS_WRITABLE && CONFIG_NSH_LOGIN_PASSWD CONFIG_NSH_DISABLE_PASSWD - - ping - CONFIG_NET && CONFIG_NET_ICMP && - CONFIG_NET_ICMP_SOCKET && !CONFIG_DISABLE_SIGNALS - CONFIG_NSH_DISABLE_PING - ping6 CONFIG_NET && CONFIG_NET_ICMPv6 && @@ -3691,7 +3740,33 @@ nsh> + +
-

3.2 NSH-Specific Configuration Settings

+

4.2 Built-In Command Dependencies on Configuration Settings

+
+ +

+ All built-in applications require that support for NSH built-in applications has been enabled. + This support is enabled with CONFIG_BUILTIN=y and CONFIG_NSH_BUILTIN_APPS=y. +

+ +

Table. Built-In Command Dependencies on Configuration Settings

+ + + + + + + + + +
CommandDepends on Configuration
pingCONFIG_NET && CONFIG_NET_ICMP && + CONFIG_NET_ICMP_SOCKET && CONFIG_SYSTEM_PING && !CONFIG_DISABLE_SIGNALS && !CONFIG_DISABLE_POLL
+ + + +
+

4.3 NSH-Specific Configuration Settings

@@ -4226,7 +4301,7 @@ set FOOBAR ABC_${FOO}_${BAR}
-

4.0 Customizing the NuttShell

+

5.0 Customizing the NuttShell

@@ -4241,7 +4316,7 @@ set FOOBAR ABC_${FOO}_${BAR}
-

4.1 The NSH Library and NSH Initialization

+

5.1 The NSH Library and NSH Initialization

@@ -4255,7 +4330,7 @@ set FOOBAR ABC_${FOO}_${BAR} That initialization performed by that example is discussed in the following paragraphs.

-

4.1.1 NSH Initialization sequence

+

5.1.1 NSH Initialization sequence

The NSH start-up sequence is very simple. @@ -4287,7 +4362,7 @@ set FOOBAR ABC_${FOO}_${BAR}

-

4.1.2 nsh_initialize()

+

5.1.2 nsh_initialize()

The NSH initialization function, nsh_initialize(), be found in apps/nshlib/nsh_init.c. @@ -4386,7 +4461,7 @@ mount -t vfat /dev/ram1 /tmp
-

4.2 NSH Commands

+

5.2 NSH Commands

@@ -4407,7 +4482,7 @@ nsh> help You can see the specific command dependencies in the table above.

-

4.2.1 Adding New NSH Commands

+

5.2.1 Adding New NSH Commands

New commands can be added to the NSH very easily. @@ -4504,7 +4579,7 @@ struct cmdmap_s
-

4.3 NSH "Built-In" Applications

+

5.3 NSH "Built-In" Applications

@@ -4541,7 +4616,7 @@ Builtin Apps: Note that no detailed help information beyond the name of the built-in application is provided.

-

4.3.1 Built-In Applications

+

5.3.1 Built-In Applications

Overview. @@ -4739,7 +4814,7 @@ context: -

4.3.2 Synchronous Built-In Applications

+

5.3.2 Synchronous Built-In Applications

By default, built-in commands started from the NSH command line will run asynchronously with NSH. @@ -4759,7 +4834,7 @@ CONFIG_SCHED_WAITPID=y
-

4.4 Customizing NSH Initialization

+

5.4 Customizing NSH Initialization

@@ -4792,7 +4867,7 @@ CONFIG_SCHED_WAITPID=y

-

4.4.1 NuttShell Start up Scripts

+

5.4.1 NuttShell Start up Scripts

First of all you should look at NSH Start-Up Script paragraph. @@ -4988,7 +5063,7 @@ mount -t vfat /dev/ram1 /tmp
-

5.0 Shell Login

+

6.0 Shell Login

@@ -4996,7 +5071,7 @@ mount -t vfat /dev/ram1 /tmp
-

5.1 Enabling Shell Logins

+

6.1 Enabling Shell Logins

@@ -5046,7 +5121,7 @@ CONFIG_NSH_LOGIN_FAILCOUNT=3
-

5.2 Verification of Credentials

+

6.2 Verification of Credentials

@@ -5110,7 +5185,7 @@ CONFIG_NSH_LOGIN_PASSWD=y
-

5.3 Password Files

+

6.3 Password Files

@@ -5178,7 +5253,7 @@ CONFIG_FSUTILS_PASSWD_KEY4=0x9abcdef0
-

5.4 Creating a Password File for a ROMFS File System

+

6.4 Creating a Password File for a ROMFS File System

@@ -5480,8 +5555,8 @@ xxd -i romfs_img >nsh_romfsimg.h

  • passwd
  • Password File
  • Password File, ROMFS
  • -
  • ping
  • -
  • ping6
  • +
  • ping
  • +
  • ping6
  • poweroff
  • Prompt
  • ps