You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by pk...@apache.org on 2023/10/23 11:54:06 UTC
[nuttx] branch master updated: Documentation: format the NSH command list
This is an automated email from the ASF dual-hosted git repository.
pkarashchenko pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new c87a967806 Documentation: format the NSH command list
c87a967806 is described below
commit c87a9678068ba064d0e88db117198302557b2060
Author: raiden00pl <ra...@railab.me>
AuthorDate: Mon Oct 23 13:19:06 2023 +0200
Documentation: format the NSH command list
command names will be more visible and look nicer
---
Documentation/applications/nsh/commands.rst | 312 ++++++++++++++--------------
1 file changed, 156 insertions(+), 156 deletions(-)
diff --git a/Documentation/applications/nsh/commands.rst b/Documentation/applications/nsh/commands.rst
index b8f28ab9be..5770b7297e 100644
--- a/Documentation/applications/nsh/commands.rst
+++ b/Documentation/applications/nsh/commands.rst
@@ -4,8 +4,8 @@ Commands
.. _cmdtest:
-Evaluate Expression (test)
-**************************
+``test`` Evaluate Expression
+*****************************
**Command Syntax:**
@@ -42,8 +42,8 @@ the conditional command following the ``if`` in the
.. _cmdaddroute:
-Add a Routing Table Entry (addroute)
-************************************
+``addroute`` Add a Routing Table Entry
+**************************************
**Command Syntax:**
@@ -77,8 +77,8 @@ default gateway.
.. _cmdarp:
-Access the ARP table (arp)
-**************************
+``arp`` Access the ARP table
+****************************
**Command syntax**::
@@ -110,8 +110,8 @@ Access the ARP table (arp)
.. _cmdbase64dec:
-Base64 Decode (base64dec)
-*************************
+``base64dec`` Base64 Decode
+***************************
**Command Syntax**::
@@ -121,8 +121,8 @@ Base64 Decode (base64dec)
.. _cmdbase64enc:
-Base64 Encode (base64enc)
-*************************
+``base64enc`` Base64 Encode
+***************************
**Command Syntax**::
@@ -132,8 +132,8 @@ Base64 Encode (base64enc)
.. _cmdbasename:
-Extract Base File/Directory Name (basename)
-*******************************************
+``basename`` Extract Base File/Directory Name
+*********************************************
**Command Syntax**::
@@ -145,8 +145,8 @@ trailing ``<suffix>``.
.. _cmdbreak:
-Terminate a Loop (break)
-************************
+``break`` Terminate a Loop
+**************************
**Command Syntax**::
@@ -162,8 +162,8 @@ immediately following the ``done`` token.
.. _cmdcat:
-Concatenate Files (cat)
-***********************
+``cat`` Concatenate Files
+*************************
**Command Syntax**::
@@ -175,8 +175,8 @@ output is redirected).
.. _cmdcd:
-Change Current Working Directory (cd)
-*************************************
+``cd`` Change Current Working Directory
+***************************************
**Command Syntax**::
@@ -200,8 +200,8 @@ Also sets the previous working directory environment variable
.. _cmdcmp:
-Compare Files (cmp)
-*******************
+``cmp`` Compare Files
+*********************
**Command Syntax**::
@@ -213,8 +213,8 @@ indication only if the files differ.
.. _cmdcp:
-Copy Files (cp)
-***************
+``cp`` Copy Files
+*****************
**Command Syntax**::
@@ -226,8 +226,8 @@ Copy Files (cp)
.. _cmddate:
-Show or set the date and time (date)
-************************************
+``date`` Show or set the date and time
+**************************************
**Command Syntax**::
@@ -263,8 +263,8 @@ To change the system clock manually, type ``date -s MMM DD HH:MM:SS YYYY``.
.. _cmddd:
-Copy and Convert Files (dd)
-***************************
+``dd`` Copy and Convert Files
+*****************************
**Command Syntax**::
@@ -306,8 +306,8 @@ bucket::
.. _cmddelroute:
-Delete a Routing Table Entry (delroute)
-***************************************
+``delroute`` Delete a Routing Table Entry
+*****************************************
**Command Syntax**::
@@ -330,8 +330,8 @@ which is equivalent to::
.. _cmddf:
-Show Volume Status (df)
-***********************
+``df`` Show Volume Status
+*************************
**Command Syntax**::
@@ -357,8 +357,8 @@ readable* format.
.. _cmddirname:
-Extract Path to a File/Directory (dirname)
-******************************************
+``dirname`` Extract Path to a File/Directory
+********************************************
**Command Syntax**::
@@ -369,8 +369,8 @@ Extract Path to a File/Directory (dirname)
.. _cmddmesg:
-Dump Buffered SYSLOG Output (dmesg)
-***********************************
+``dmesg`` Dump Buffered SYSLOG Output
+*************************************
**Command Syntax**::
@@ -387,8 +387,8 @@ that entering ``dmesg`` again will show only newly buffered data.
.. _cmdecho:
-Echo Strings and Variables (echo)
-*********************************
+``echo`` Echo Strings and Variables
+***********************************
**Command Syntax**::
@@ -402,8 +402,8 @@ The ``-n`` option suppresses the trailing newline character.
.. _cmdenv:
-Show Environment Variables (env)
-********************************
+``env`` Show Environment Variables
+**********************************
**Command Syntax**::
@@ -431,8 +431,8 @@ environment. Example::
.. _cmdexec:
-Execute User Code (exec)
-************************
+``exec`` Execute User Code
+**************************
**Command Syntax**::
@@ -444,8 +444,8 @@ executed in background via ``exec <hex-address> &``.
.. _cmdexit:
-Exit NSH (exit)
-***************
+``exit`` Exit NSH
+*****************
**Command Syntax**::
@@ -458,8 +458,8 @@ telnet front-end, ``exit`` terminates the telnet session.
.. _cmdexport:
-Set an Environment Variable (export)
-************************************
+``export`` Set an Environment Variable
+**************************************
**Command Syntax**::
@@ -505,8 +505,8 @@ The ``export`` command is not supported by NSH unless both
.. _cmdfree:
-Show Memory Manager Status (free)
-*********************************
+``free`` Show Memory Manager Status
+***********************************
**Command Syntax**::
@@ -534,8 +534,8 @@ nfree This is the number of free chunks
.. _cmdget:
-Get File Via TFTP (get)
-***********************
+``get`` Get File Via TFTP
+*************************
**Command Syntax**::
@@ -554,8 +554,8 @@ whose IP address is identified by ``<ip-address>``.
.. _cmdhelp:
-Show Usage Command Usage (help)
-*******************************
+``help`` Show Usage Command Usage
+*********************************
**Command Syntax**::
@@ -573,8 +573,8 @@ console.
.. _cmdhexdump:
-Hexadecimal Dump of File or Device (hexdump)
-********************************************
+``hexdump`` Hexadecimal Dump of File or Device
+**********************************************
**Command Syntax**::
@@ -594,8 +594,8 @@ configuration.
.. _cmdifconfig:
-Manage Network Configuration (ifconfig)
-***************************************
+``ifconfig`` Manage Network Configuration
+*****************************************
**Command Syntax**::
@@ -636,8 +636,8 @@ supported:
.. _cmdifdown:
-Take a network down (ifdown)
-****************************
+``ifdown`` Take a network down
+******************************
**Command Syntax**::
@@ -652,8 +652,8 @@ Take a network down (ifdown)
.. _cmdifup:
-Bring a network up (ifup)
-*************************
+``ifup`` Bring a network up
+***************************
**Command Syntax**::
@@ -668,8 +668,8 @@ Bring a network up (ifup)
.. _cmdinsmod:
-Install an OS module (insmod)
-*****************************
+``insmod`` Install an OS module
+*******************************
**Command Syntax**::
@@ -706,8 +706,8 @@ module <module-name>.
.. _cmdirqinfo:
-Show Interrupt Status (irqinfo)
-*******************************
+``irqinfo`` Show Interrupt Status
+*********************************
**Command Syntax**::
@@ -726,8 +726,8 @@ attached interrupts.
.. _cmdcritmon:
-Show Critical Monitor Status (critmon)
-**************************************
+``critmon`` Show Critical Monitor Status
+****************************************
**Command Syntax**::
@@ -761,8 +761,8 @@ The output of the ``critmon`` command displays the following columns:
.. _cmdkill:
-Send a signal to a task (kill)
-******************************
+``kill`` Send a signal to a task
+********************************
**Command Syntax**::
@@ -805,8 +805,8 @@ Send a signal to a task (kill)
.. _cmdlosetup:
-Setup/teardown the Loop Device (losetup)
-****************************************
+``losetup`` Setup/teardown the Loop Device
+******************************************
**Command Syntax 1**::
@@ -850,8 +850,8 @@ on the loop-mounted file::
.. _cmdln:
-Link to a File or Directory (ln)
-********************************
+``ln`` Link to a File or Directory
+**********************************
**Command Syntax**::
@@ -871,8 +871,8 @@ implementation is simplified for use with NuttX in these ways:
.. _cmdls:
-List Directory Contents (ls)
-****************************
+``ls`` List Directory Contents
+******************************
**Command Syntax**::
@@ -892,8 +892,8 @@ no other file system object.
.. _cmdlsmod:
-Show information about installed OS modules (lsmod)
-***************************************************
+``lsmod`` Show information about installed OS modules
+*****************************************************
**Command Syntax**::
@@ -925,8 +925,8 @@ modules. This information includes:
.. _cmdmd5:
-Calculate MD5 (md5)
-*******************
+``md5`` Calculate MD5
+*********************
**Command Syntax**::
@@ -936,8 +936,8 @@ Calculate MD5 (md5)
.. _cmdmx:
-Access Memory (mb, mh, and mw)
-******************************
+``mb``, ``mh``, ``and`` ``mw`` Access Memory
+********************************************
**Command Syntax**::
@@ -975,8 +975,8 @@ accesses (mh), or 32-bit access (mw). In each case,
.. _cmdps:
-Show Current Tasks and Threads (ps)
-***********************************
+``ps`` Show Current Tasks and Threads
+*************************************
**Command Syntax**::
@@ -1001,8 +1001,8 @@ have been mounted with a command like::
.. _cmdmkdir:
-Create a Directory (mkdir)
-**************************
+``mkdir`` Create a Directory
+****************************
**Command Syntax**::
@@ -1030,8 +1030,8 @@ directories in the *pseudo* file system.
.. _cmdmkfatfs:
-Create a FAT File System (mkfatfs)
-**********************************
+``mkfatfs`` Create a FAT File System
+************************************
**Command Syntax**
@@ -1061,8 +1061,8 @@ and must have been created by some call to ``register_blockdriver()``
.. _cmdmkfifo:
-Create a FIFO (mkfifo)
-**********************
+``mkfifo`` Create a FIFO
+************************
**Command Syntax**::
@@ -1095,8 +1095,8 @@ driver. NSH provides this command to access the
.. _cmdmkrd:
-Create a RAMDISK (mkrd)
-***********************
+``mkrd`` Create a RAMDISK
+*************************
**Command Syntax**::
@@ -1140,8 +1140,8 @@ Once the ramdisk has been created, it may be formatted using the
.. _cmdmount:
-Mount a File System (mount)
-***************************
+``mount`` Mount a File System
+*****************************
**Command Syntax**::
@@ -1214,8 +1214,8 @@ Using ``mount`` to enumerate mounts::
.. _cmdmv:
-Rename a File (mv)
-******************
+``mv`` Rename a File
+********************
**Command Syntax**::
@@ -1227,8 +1227,8 @@ system.
.. _cmdnfsmount:
-Mount an NFS file system (nfsmount)
-***********************************
+``nfsmount`` Mount an NFS file system
+*************************************
**Command Syntax**::
@@ -1240,8 +1240,8 @@ address of the remote server.
.. _cmdnslookup:
-Lookup a network address (nslookup)
-***********************************
+``nslookup`` Lookup a network address
+*************************************
**Command Syntax**::
@@ -1252,8 +1252,8 @@ Lookup a network address (nslookup)
.. _cmdpasswd:
-Change a User's Password (passwd)
-*********************************
+``passwd`` Change a User's Password
+***********************************
**Command Syntax**::
@@ -1264,8 +1264,8 @@ Change a User's Password (passwd)
.. _cmdpmconfig:
-Manage Power Management Subsystem (pmconfig)
-********************************************
+``pmconfig`` Manage Power Management Subsystem
+**********************************************
**Command Syntax**::
@@ -1275,8 +1275,8 @@ Manage Power Management Subsystem (pmconfig)
.. _cmdpoweroff:
-Shut the system down (poweroff)
-*******************************
+``poweroff`` Shut the system down
+*********************************
**Command Syntax**::
@@ -1292,8 +1292,8 @@ is redundant.
.. _cmdput:
-Send File Via TFTP (put)
-************************
+``put`` Send File Via TFTP
+**************************
**Command Syntax**::
@@ -1313,8 +1313,8 @@ whose IP address is identified by ``<ip-address>``.
.. _cmdpwd:
-Show Current Working Directory (pwd)
-************************************
+``pwd`` Show Current Working Directory
+**************************************
**Command Syntax**::
@@ -1335,8 +1335,8 @@ Same as ``echo $PWD``::
.. _cmdreadlink:
-Show target of a link (readlink)
-********************************
+``readlink`` Show target of a link
+**********************************
**Command Syntax**::
@@ -1347,8 +1347,8 @@ Show target of a link (readlink)
.. _cmdreboot:
-Reboot the system (reboot)
-**************************
+``reboot`` Reboot the system
+****************************
**Command Syntax**::
@@ -1364,8 +1364,8 @@ redundant.
.. _cmdrm:
-Remove a File (rm)
-******************
+``rm`` Remove a File
+********************
**Command Syntax**::
@@ -1393,8 +1393,8 @@ names in the *pseudo* file system.
.. _cmdrmdir:
-Remove a Directory (rmdir)
-**************************
+``rmdir`` Remove a Directory
+****************************
**Command Syntax**::
@@ -1423,8 +1423,8 @@ file system.
.. _cmdrmmod:
-Remove on OS Module (rmmod)
-***************************
+``rmmod`` Remove on OS Module
+*****************************
**Command Syntax**::
@@ -1446,8 +1446,8 @@ busy.
.. _cmdroute:
-Show routing table (route)
-**************************
+``route`` Show routing table
+****************************
**Command Syntax**::
@@ -1461,8 +1461,8 @@ version.
.. _cmdrptun:
-Start/Stop the OpenAMP RPC Tunnel (rptun)
-*****************************************
+``rptun`` Start/Stop the OpenAMP RPC Tunnel
+*******************************************
**Command Syntax**::
@@ -1472,8 +1472,8 @@ Start/Stop the OpenAMP RPC Tunnel (rptun)
.. _cmdset:
-Set a Variable (set)
-********************
+``set`` Set a Variable
+**********************
**Command Syntax**::
@@ -1550,8 +1550,8 @@ script commands and set foobar to foovalue::
.. _cmdsh:
-Execute an NSH Script (sh)
-**************************
+``sh`` Execute an NSH Script
+****************************
**Command Syntax**::
@@ -1562,8 +1562,8 @@ to by ``<script-path>``.
.. _cmdshutdown:
-Shut the system down (shutdown)
-*******************************
+``shutdown`` Shut the system down
+*********************************
**Command Syntax**::
@@ -1579,8 +1579,8 @@ NOTE: The ``shutdown`` command duplicates the behavior of the
.. _cmdsleep:
-Wait for Seconds (sleep)
-************************
+``sleep`` Wait for Seconds
+**************************
**Command Syntax**::
@@ -1590,8 +1590,8 @@ Wait for Seconds (sleep)
.. _cmdtelnetd:
-Time Start the Telnet Daemon (telnetd)
-**************************************
+``telnetd`` Time Start the Telnet Daemon
+****************************************
**Command Syntax**::
@@ -1615,8 +1615,8 @@ network is initialized, it will fail.
.. _cmdtime:
-Time execution of another command (time)
-****************************************
+``time`` Time execution of another command
+******************************************
**Command Syntax**::
@@ -1671,8 +1671,8 @@ command is run in background with the sleep command::
.. _cmdtruncate:
-Set the Size of a File (truncate)
-*********************************
+``truncate`` Set the Size of a File
+***********************************
**Command Syntax**::
@@ -1690,8 +1690,8 @@ reads as zero bytes.
.. _cmdumount:
-Unmount a File System (umount)
-******************************
+``umount`` Unmount a File System
+********************************
**Command Syntax**::
@@ -1714,8 +1714,8 @@ mounted using :ref:`mount <cmdmount>` command.
.. _cmduname:
-Print system information (uname)
-********************************
+``uname`` Print system information
+**********************************
**Command Syntax**::
@@ -1738,8 +1738,8 @@ output is the same as -s.
.. _cmdunset:
-Unset an Environment Variable (unset)
-*************************************
+``unset`` Unset an Environment Variable
+***************************************
**Command Syntax**:
@@ -1758,8 +1758,8 @@ and the group-wide environment variables. For example::
.. _cmdurldecode:
-URL Decode (urldecode)
-**********************
+``urldecode`` URL Decode
+************************
**Command Syntax**::
@@ -1769,8 +1769,8 @@ URL Decode (urldecode)
.. _cmdurlencode:
-URL Encode (urlencode)
-**********************
+``urlencode`` URL Encode
+************************
**Command Syntax**::
@@ -1780,8 +1780,8 @@ URL Encode (urlencode)
.. _cmduseradd:
-Add a New User (useradd)
-************************
+``useradd`` Add a New User
+**************************
**Command Syntax**::
@@ -1791,8 +1791,8 @@ Add a New User (useradd)
.. _cmduserdel:
-Delete a user (userdel)
-***********************
+``userdel`` Delete a user
+*************************
**Command Syntax**::
@@ -1802,8 +1802,8 @@ Delete a user (userdel)
.. _cmdusleep:
-Wait for Microseconds (usleep)
-******************************
+``usleep`` Wait for Microseconds
+********************************
**Command Syntax**::
@@ -1813,8 +1813,8 @@ Wait for Microseconds (usleep)
.. _cmdwget:
-Get File Via HTTP (wget)
-************************
+``wget`` Get File Via HTTP
+**************************
**Command Syntax**
@@ -1833,8 +1833,8 @@ directory.
.. _cmdxd:
-Hexadecimal Dump of Memory (xd)
-*******************************
+``xd`` Hexadecimal Dump of Memory
+*********************************
**Command Syntax**::
@@ -1871,8 +1871,8 @@ common, useful built-in applications are listed below.
.. _cmdping:
-Check Network Peer (ping/ping6)
-*******************************
+``ping`` and ``ping6`` Check Network Peer
+*****************************************
**Command Syntax**::