From 8f6e28f194274bde92d11c6383167ddbcc496cb3 Mon Sep 17 00:00:00 2001 From: patacongo Date: Wed, 31 Oct 2012 17:53:28 +0000 Subject: Documentation update git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5282 42af7a65-404d-4744-a932-0658087f49c3 --- apps/examples/wgetjson/Kconfig | 2 +- apps/examples/wgetjson/wgetjson_main.c | 2 +- apps/nshlib/README.txt | 10 +- nuttx/Documentation/NuttShell.html | 299 ++++++++++++++++++++++++--------- 4 files changed, 230 insertions(+), 83 deletions(-) diff --git a/apps/examples/wgetjson/Kconfig b/apps/examples/wgetjson/Kconfig index 2e3b4b3eb..f7f4f236c 100644 --- a/apps/examples/wgetjson/Kconfig +++ b/apps/examples/wgetjson/Kconfig @@ -14,7 +14,7 @@ if EXAMPLES_WGETJSON config EXAMPLES_WGETJSON_MAXSIZE int "Max. JSON Buffer Size" - default 10240 + default 1024 config EXAMPLES_WGETJSON_URL string "wget URL" diff --git a/apps/examples/wgetjson/wgetjson_main.c b/apps/examples/wgetjson/wgetjson_main.c index 7f3096797..a137af438 100644 --- a/apps/examples/wgetjson/wgetjson_main.c +++ b/apps/examples/wgetjson/wgetjson_main.c @@ -58,7 +58,7 @@ ****************************************************************************/ #ifndef CONFIG_EXAMPLES_WGETJSON_MAXSIZE -# define CONFIG_EXAMPLES_WGETJSON_MAXSIZE 1024*10 +# define CONFIG_EXAMPLES_WGETJSON_MAXSIZE 1024 #endif #ifndef CONFIG_EXAMPLES_EXAMPLES_WGETJSON_URL diff --git a/apps/nshlib/README.txt b/apps/nshlib/README.txt index 043db2ae9..9f371678e 100644 --- a/apps/nshlib/README.txt +++ b/apps/nshlib/README.txt @@ -235,6 +235,10 @@ o test integer -gt integer | integer -le integer | integer -lt integer | integer -ne integer +o base64dec [-w] [-f] + +o base64dec [-w] [-f] + o cat [ [ ...]] This command copies and concatentates all of the files at @@ -257,10 +261,6 @@ o cd [|-|~|..] 'home' directory is '/'. 'cd ..' sets the current working directory to the parent directory. -o base64dec [-w] [-f] - -o base64dec [-w] [-f] - o cp Copy of the contents of the file at to the location @@ -874,6 +874,8 @@ Command Dependencies on Configuration Settings test !CONFIG_NSH_DISABLESCRIPT umount !CONFIG_DISABLE_MOUNTPOINT && CONFIG_NFILE_DESCRIPTORS > 0 && CONFIG_FS_READABLE unset !CONFIG_DISABLE_ENVIRON + urldecode CONFIG_NETUTILS_CODECS && CONFIG_CODECS_URLCODE + urlencode CONFIG_NETUTILS_CODECS && CONFIG_CODECS_URLCODE usleep !CONFIG_DISABLE_SIGNALS get CONFIG_NET && CONFIG_NET_TCP && CONFIG_NFILE_DESCRIPTORS > 0 xd --- diff --git a/nuttx/Documentation/NuttShell.html b/nuttx/Documentation/NuttShell.html index 78a565107..f8ef41fb9 100644 --- a/nuttx/Documentation/NuttShell.html +++ b/nuttx/Documentation/NuttShell.html @@ -8,7 +8,7 @@

NuttShell (NSH)

-

Last Updated: October 20, 2012

+

Last Updated: October 31, 2012

@@ -89,229 +89,259 @@
- 2.2 Concatenate Files (cat) + 2.2 Base64 Decode (base64dec)
- 2.3 Change Current Working Directory (cd) + 2.3 Base64 Encode (base64enc)
- 2.4 Copy Files (cp) + 2.4 Concatenate Files (cat)
- 2.5 Show or set the date and time (date) + 2.5 Change Current Working Directory (cd)
- 2.6 Copy and Convert Files (dd) + 2.6 Copy Files (cp)
- 2.7 Show volume status (df) + 2.7 Show or set the date and time (date)
- 2.8 Echo Strings and Variables (echo) + 2.8 Copy and Convert Files (dd)
- 2.9 Execute User Code (exec) + 2.9 Show volume status (df)
- 2.10 Exit NSH (exit) + 2.10 Echo Strings and Variables (echo)
- 2.11 Show Memory Manager Status (free) + 2.11 Execute User Code (exec)
- 2.12 Get File Via TFTP (get) + 2.12 Exit NSH (exit)
- 2.13 Show Usage Command Usage (help) + 2.13 Show Memory Manager Status (free)
- 2.14 Show Network Configuration (ifconfig) + 2.14 Get File Via TFTP (get)
- 2.15 Send a signal to a task (kill) + 2.15 Show Usage Command Usage (help)
- 2.16 Setup/teardown the Loop Device (losetup) + 2.16 Show Network Configuration (ifconfig)
- 2.17 List Directory Contents (ls) + 2.17 Send a signal to a task (kill)
- 2.18 Access Memory (mb, mh, and mw) + 2.18 Setup/teardown the Loop Device (losetup)
- 2.19 Show Current Tasks and Threads (ps) + 2.19 List Directory Contents (ls)
- 2.20 Create a Directory (mkdir) + 2.20 Calculate MD5 (md5)
- 2.21 Create a FAT Filesystem (mkfatfs) + 2.21 Access Memory (mb, mh, and mw)
- 2.22 Create a FIFO (mkfifo) + 2.22 Show Current Tasks and Threads (ps)
- 2.23 Create a RAMDISK (mkrd) + 2.23 Create a Directory (mkdir)
- 2.24 Mount a File System (mount) + 2.24 Create a FAT Filesystem (mkfatfs)
- 2.25 Rename a File (mv) + 2.25 Create a FIFO (mkfifo)
- 2.26 Mount an NFS file system (nfsmount) + 2.26 Create a RAMDISK (mkrd)
- 2.27 Check Network Peer (ping) + 2.27 Mount a File System (mount)
- 2.28 Send File Via TFTP (put) + 2.28 Rename a File (mv)
- 2.29 Show Current Working Directory (pwd) + 2.29 Mount an NFS file system (nfsmount)
- 2.30 Remove a File (rm) + 2.30 Check Network Peer (ping)
- 2.31 Remove a Directory (rmdir) + 2.31 Send File Via TFTP (put)
- 2.32 Set an Environment Variable (set) + 2.32 Show Current Working Directory (pwd)
- 2.33 Execute an NSH Script (sh) + 2.33 Remove a File (rm)
- 2.34 Wait for Seconds (sleep) + 2.34 Remove a Directory (rmdir)
- 2.35 Unmount a File System (umount) + 2.35 Set an Environment Variable (set)
- 2.36 Unset an Environment Variable (unset) + 2.36 Execute an NSH Script (sh)
- 2.37 Wait for Microseconds (usleep) + 2.37 Wait for Seconds (sleep)
- 2.38 Get File Via HTTP (wget) + 2.38 Unmount a File System (umount)
- 2.39 Hexadecimal Dump (xd) + 2.39 Unset an Environment Variable (unset) + + + +
+ + 2.40 URL Decode (urldecode) + + + +
+ + 2.41 URL Encode (urlencode) + + + +
+ + 2.42 Wait for Microseconds (usleep) + + + +
+ + 2.43 Get File Via HTTP (wget) + + + +
+ + 2.44 Hexadecimal Dump (xd) @@ -750,7 +780,41 @@ test <expression> + +
-

2.2 Concatenate Files (cat)

 +

2.2 Base64 Decode (base64dec)

 +
+ +

Command Syntax:

+
    +base64dec [-w] [-f] <string or filepath>
+
+

+ Synopsis. + To be provided. +

+ + + + + +
+

2.3 Base64 Encode (base64enc)

 +
+ +

Command Syntax:

+
    +base64enc [-w] [-f] <string or filepath>
+
+

+ Synopsis. + To be provided. +

+ + + +
+

2.4 Concatenate Files (cat)
@@ -768,7 +832,7 @@ cat <path> [<path> [<path> -

2.3 Change Current Working Directory (cd)

 +

2.5 Change Current Working Directory (cd)

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

2.4 Copy Files (cp)

 +

2.6 Copy Files (cp)
@@ -828,7 +892,7 @@ cp <source-path> <dest-path>
-

2.5 Show or set the date and time (date)

 +

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

2.6 Copy and Convert Files (dd)

 +

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

2.7 Show Volument Status (df)

 +

2.9 Show Volument Status (df)
@@ -941,7 +1005,7 @@ nsh>
-

2.8 Echo Strings and Variables (echo)

 +

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

2.9 Execute User Code (exec)

 +

2.11 Execute User Code (exec)
@@ -978,7 +1042,7 @@ exec <hex-address>
-

2.10 Exit NSH (exit)

 +

2.12 Exit NSH (exit)
@@ -997,7 +1061,7 @@ exit
-

2.11 Show Memory Manager Status (free)

 +

2.13 Show Memory Manager Status (free)
@@ -1039,7 +1103,7 @@ nsh>
-

2.12 Get File Via TFTP (get)

 +

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

2.13 Show Usage Command Usage (help)

 +

2.15 Show Usage Command Usage (help)
@@ -1106,7 +1170,7 @@ help [-v] [<cmd>]
-

2.14 Show Network Configuration (ifconfig)

 +

2.16 Show Network Configuration (ifconfig)
@@ -1157,7 +1221,7 @@ ifconfig nic_name ip_address
-

2.15 Send a signal to a task (kill)

 +

2.17 Send a signal to a task (kill)
@@ -1198,7 +1262,7 @@ nsh>
-

2.16 Setup/teardown the Loop Device (losetup)

 +

2.18 Setup/teardown the Loop Device (losetup)
@@ -1251,7 +1315,7 @@ losetup d <dev-path>
-

2.17 List Directory Contents (ls)

 +

2.19 List Directory Contents (ls)
@@ -1288,7 +1352,24 @@ ls [-lRs] <dir-path> + +
-

2.18 Access Memory (mb, mh, and mw)

 +

2.20 Calculate MD5 (md5)

 +
+ +

Command Syntax:

+
    +md5 [-f] <string or filepath>
+
+

+ Synopsis. + To be provided. +

+ + + +
+

2.21 Access Memory (mb, mh, and mw)
@@ -1342,7 +1423,7 @@ nsh>
-

2.19 Show Current Tasks and Threads (ps)

 +

2.22 Show Current Tasks and Threads (ps)
@@ -1368,7 +1449,7 @@ nsh>
-

2.20 Create a Directory (mkdir)

 +

2.23 Create a Directory (mkdir)
@@ -1403,7 +1484,7 @@ nsh>
-

2.21 Create a FAT Filesystem (mkfatfs)

 +

2.24 Create a FAT Filesystem (mkfatfs)
@@ -1423,7 +1504,7 @@ mkfatfs <path>
-

2.22 Create a FIFO (mkfifo)

 +

2.25 Create a FIFO (mkfifo)
@@ -1461,7 +1542,7 @@ nsh>
-

2.23 Create a RAMDISK (mkrd)

 +

2.26 Create a RAMDISK (mkrd)
@@ -1512,7 +1593,7 @@ nsh>
-

2.24 Mount a File System (mount)

 +

2.27 Mount a File System (mount)
@@ -1591,7 +1672,7 @@ nsh> mount
-

2.25 Rename a File (mv)

 +

2.28 Rename a File (mv)
@@ -1609,7 +1690,7 @@ mv <old-path> <new-path>
-

2.26 Mount an NFS file system (nfsmount)

 +

2.29 Mount an NFS file system (nfsmount)
@@ -1628,7 +1709,7 @@ nfsmount <server-address> <mount-point> <remote-path>
-

2.27 Check Network Peer (ping)

 +

2.30 Check Network Peer (ping)
@@ -1661,7 +1742,7 @@ nsh>
-

2.28 Send File Via TFTP (put)

 +

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

2.29 Show Current Working Directory (pwd)

 +

2.32 Show Current Working Directory (pwd)
@@ -1726,7 +1807,7 @@ nsh>
-

2.30 Remove a File (rm)

 +

2.33 Remove a File (rm)
@@ -1760,7 +1841,7 @@ nsh>
-

2.31 Remove a Directory (rmdir)

 +

2.34 Remove a Directory (rmdir)
@@ -1795,7 +1876,7 @@ nsh>
-

2.32 Set an Environment Variable (set)

 +

2.35 Set an Environment Variable (set)
@@ -1821,7 +1902,7 @@ nsh>
-

2.33 Execute an NSH Script (sh)

 +

2.36 Execute an NSH Script (sh)
@@ -1839,7 +1920,7 @@ sh <script-path>
-

2.34 Wait for Seconds (sleep)

 +

2.37 Wait for Seconds (sleep)
@@ -1856,7 +1937,7 @@ sleep <sec>
-

2.35 Unmount a File System (umount)

 +

2.38 Unmount a File System (umount)
@@ -1886,7 +1967,7 @@ nsh>
-

2.36 Unset an Environment Variable (unset)

 +

2.39 Unset an Environment Variable (unset)
@@ -1912,7 +1993,41 @@ nsh> + +
-

2.37 Wait for Microseconds (usleep)

 +

2.40 URL Decode (urldecode)

 +
+ +

Command Syntax:

+
    +urldecode [-f] <string or filepath>
+
+

+ Synopsis. + To be provided. +

+ + + + + +
+

2.41 URL Encode (urlencode)

 +
+ +

Command Syntax:

+
    +urlencode [-f] <string or filepath>
+
+

+ Synopsis. + To be provided. +

+ + + +
+

2.42 Wait for Microseconds (usleep)
@@ -1929,7 +2044,7 @@ usleep <usec>
- 2.37 Get File Via HTTP (wget) + 2.43 Get File Via HTTP (wget)
@@ -1956,7 +2071,7 @@ wget [-o <local-path>] <url>
-

2.38 Hexadecimal dump (xd)

 +

2.44 Hexadecimal dump (xd)
@@ -2024,6 +2139,16 @@ nsh> !CONFIG_NSH_DISABLESCRIPT CONFIG_NSH_DISABLE_TEST + + base64dec + CONFIG_NETUTILS_CODECS && CONFIG_CODECS_BASE64 + CONFIG_NSH_DISABLE_BASE64DEC + + + base64enc + CONFIG_NETUTILS_CODECS && CONFIG_CODECS_BASE64 + CONFIG_NSH_DISABLE_BASE64ENC + cat CONFIG_NFILE_DESCRIPTORS > 0 @@ -2105,6 +2230,11 @@ nsh> CONFIG_NFILE_DESCRIPTORS > 0 CONFIG_NSH_DISABLE_LS + + md5 + CONFIG_NETUTILS_CODECS && CONFIG_CODECS_HASH_MD5 + CONFIG_NSH_DISABLE_MD5 + mb,mh,mw
@@ -2212,6 +2342,16 @@ nsh> !CONFIG_DISABLE_ENVIRON CONFIG_NSH_DISABLE_UNSET + + urldecode + !CONFIG_NETUTILS_CODECS && CONFIG_CODECS_URLCODE + CONFIG_NSH_DISABLE_URLDECODE + + + urlencode + !CONFIG_NETUTILS_CODECS && CONFIG_CODECS_URLCODE + CONFIG_NSH_DISABLE_URLENCODE + usleep !CONFIG_DISABLE_SIGNALS @@ -3517,6 +3657,8 @@ mount -t vfat /dev/ram1 /tmp
  • binfs
  • Built-In applications
  • Built-in variables
    • +
  • base64dec
    • +
  • base64enc
  • cat
  • cd
  • Command summaries
    • @@ -3597,6 +3739,7 @@ mount -t vfat /dev/ram1 /tmp
  • losetup
  • ls
  • mb
    • +
  • md5
  • mh
  • mw
  • mkdir
    • @@ -3652,6 +3795,8 @@ mount -t vfat /dev/ram1 /tmp
  • unset
  • up_cxxinitialize()
  • up_nsh.c
    • +
  • urldecode
    • +
  • urlencode
  • usleep
  • waitpid()
  • wget
    • -- cgit v1.2.3