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 @@
Last Updated: October 20, 2017
+Last Updated: October 23, 2017
- 2.45 Check Network Peer (ping/ping6)+2.45 Check Network Peer (ping6) |
Command Syntax:
-ping [-c <count>] [-i <interval>] <ip-address> ping6 [-c <count>] [-i <interval>] <ip-address>
Synopsis. - Test the network communication with a remote peer. Example, + Test the network communication with a remote peer.
--nsh> ping 10.0.0.1 -PING 10.0.0.1 56 bytes of data -56 bytes from 10.0.0.1: icmp_seq=1 time=0 ms -56 bytes from 10.0.0.1: icmp_seq=2 time=0 ms -56 bytes from 10.0.0.1: icmp_seq=3 time=0 ms -56 bytes from 10.0.0.1: icmp_seq=4 time=0 ms -56 bytes from 10.0.0.1: icmp_seq=5 time=0 ms -56 bytes from 10.0.0.1: icmp_seq=6 time=0 ms -56 bytes from 10.0.0.1: icmp_seq=7 time=0 ms -56 bytes from 10.0.0.1: icmp_seq=8 time=0 ms -56 bytes from 10.0.0.1: icmp_seq=9 time=0 ms -56 bytes from 10.0.0.1: icmp_seq=10 time=0 ms -10 packets transmitted, 10 received, 0% packet loss, time 10190 ms -nsh> --
- ping6 differs from ping in that it uses IPv6 addressing.
+ ping6 differs from ping in that it uses IPv6 addressing.
- 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:
++ping [-c <count>] [-i <interval>] <ip-address> ++
+ Synopsis. + Test the network communication with a remote peer. Example, +
++nsh> ping 10.0.0.1 +PING 10.0.0.1 56 bytes of data +56 bytes from 10.0.0.1: icmp_seq=1 time=0 ms +56 bytes from 10.0.0.1: icmp_seq=2 time=0 ms +56 bytes from 10.0.0.1: icmp_seq=3 time=0 ms +56 bytes from 10.0.0.1: icmp_seq=4 time=0 ms +56 bytes from 10.0.0.1: icmp_seq=5 time=0 ms +56 bytes from 10.0.0.1: icmp_seq=6 time=0 ms +56 bytes from 10.0.0.1: icmp_seq=7 time=0 ms +56 bytes from 10.0.0.1: icmp_seq=8 time=0 ms +56 bytes from 10.0.0.1: icmp_seq=9 time=0 ms +56 bytes from 10.0.0.1: icmp_seq=10 time=0 ms +10 packets transmitted, 10 received, 0% packet loss, time 10190 ms +nsh> ++ +
+ 4.0 Configuration Settings |
- 3.1 Command Dependencies on Configuration Settings+4.1 Command Dependencies on Configuration Settings |
CONFIG_DISABLE_MOUNTPOINT && CONFIG_NFILE_DESCRIPTORS > 0 && CONFIG_FS_WRITABLE && CONFIG_NSH_LOGIN_PASSWDCONFIG_NSH_DISABLE_PASSWDpingCONFIG_NET && CONFIG_NET_ICMP &&
- CONFIG_NET_ICMP_SOCKET && !CONFIG_DISABLE_SIGNALSCONFIG_NSH_DISABLE_PINGping6CONFIG_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
+| Command | +Depends on Configuration | +
|---|---|
ping |
+ CONFIG_NET && CONFIG_NET_ICMP &&
+ CONFIG_NET_ICMP_SOCKET && CONFIG_SYSTEM_PING && !CONFIG_DISABLE_SIGNALS && !CONFIG_DISABLE_POLL |
+
+ 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 |
The NSH start-up sequence is very simple. @@ -4287,7 +4362,7 @@ set FOOBAR ABC_${FOO}_${BAR}
-nsh_initialize()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 |
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 |
Overview. @@ -4739,7 +4814,7 @@ context: -
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 |
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 |
- 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 |
passwdpingping6pingping6poweroffps