summaryrefslogtreecommitdiffstats
path: root/shell/general_commands.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2016-01-23 10:14:42 +1100
committerAmar Takhar <verm@darkbeer.org>2016-05-02 20:51:25 -0400
commitdf773360c902958c0b1b62512dcccd483020f645 (patch)
tree2472696febe4cead99cb1465acd1a0cb7e3d84f0 /shell/general_commands.rst
parented3794ea3926f3e8ee801eae908bb7557cb30637 (diff)
downloadrtems-docs-df773360c902958c0b1b62512dcccd483020f645.tar.bz2
Add links from the command list to the commands.
Diffstat (limited to 'shell/general_commands.rst')
-rw-r--r--shell/general_commands.rst76
1 files changed, 58 insertions, 18 deletions
diff --git a/shell/general_commands.rst b/shell/general_commands.rst
index 98f7e02..b236cb3 100644
--- a/shell/general_commands.rst
+++ b/shell/general_commands.rst
@@ -1,3 +1,7 @@
+.. COMMENT: COPYRIGHT (c) 1988-2008.
+.. COMMENT: On-Line Applications Research Corporation (OAR).
+.. COMMENT: All rights reserved.
+
General Commands
################
@@ -6,41 +10,41 @@ Introduction
The RTEMS shell has the following general commands:
-- ``help`` - Print command help
+- help_ - Print command help
-- ``alias`` - Add alias for an existing command
+- alias_ - Add alias for an existing command
-- ``cmdls`` - List commands
+- cmdls_ - List commands
-- ``cmdchown`` - Change user or owner of commands
+- cmdchown_ - Change user or owner of commands
-- ``cmdchmod`` - Change mode of commands
+- cmdchmod_ - Change mode of commands
-- ``date`` - Print or set current date and time
+- date_ - Print or set current date and time
-- ``echo`` - Produce message in a shell script
+- echo_ - Produce message in a shell script
-- ``sleep`` - Delay for a specified amount of time
+- sleep_ - Delay for a specified amount of time
-- ``id`` - show uid gid euid and egid
+- id_ - show uid gid euid and egid
-- ``tty`` - show ttyname
+- tty_ - show ttyname
-- ``whoami`` - print effective user id
+- whoami_ - print effective user id
-- ``getenv`` - print environment variable
+- getenv_ - print environment variable
-- ``setenv`` - set environment variable
+- setenv_ - set environment variable
-- ``unsetenv`` - unset environment variable
+- unsetenv_ - unset environment variable
-- ``time`` - time command execution
+- time_ - time command execution
-- ``logoff`` - logoff from the system
+- logoff_ - logoff from the system
-- ``rtc`` - RTC driver configuration
+- rtc_ - RTC driver configuration
-- ``exit`` - alias for logoff command
+- exit_ - alias for logoff command
Commands
========
@@ -49,6 +53,8 @@ This section details the General Commands available. A subsection is dedicated
to each of the commands and describes the behavior and configuration of that
command as well as providing an example usage.
+.. _help:
+
help - Print command help
-------------------------
.. index:: help
@@ -126,6 +132,8 @@ The following is an example of how to use ``alias``:
This command has no configuration.
+.. _alias:
+
alias - add alias for an existing command
-----------------------------------------
.. index:: alias
@@ -195,6 +203,8 @@ The configuration structure for the ``alias`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_ALIAS_Command;
+.. _cmdls:
+
cmdls - List commands
---------------------
.. index:: cmdls
@@ -248,6 +258,8 @@ The configuration structure for the ``cmdls`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_CMDLS_Command;
+.. _cmdchown:
+
cmdchown - Change user or owner of commands
-------------------------------------------
.. index:: cmdchown
@@ -304,6 +316,8 @@ The configuration structure for the ``cmdchown`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_CMDCHOWN_Command;
+.. _cmdchmod:
+
cmdchmod - Change mode of commands
----------------------------------
.. index:: cmdchmod
@@ -360,6 +374,8 @@ The configuration structure for the ``cmdchmod`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_CMDCHMOD_Command;
+.. _date:
+
date - print or set current date and time
-----------------------------------------
.. index:: date
@@ -433,6 +449,8 @@ The configuration structure for the ``date`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_DATE_Command;
+.. _echo:
+
echo - produce message in a shell script
----------------------------------------
.. index:: echo
@@ -545,6 +563,8 @@ The configuration structure for the ``echo`` has the following prototype:
The implementation and portions of the documentation for this command are from
NetBSD 4.0.
+.. _sleep:
+
sleep - delay for a specified amount of time
--------------------------------------------
.. index:: sleep
@@ -620,6 +640,8 @@ The configuration structure for the ``sleep`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_SLEEP_Command;
+.. _id:
+
id - show uid gid euid and egid
-------------------------------
.. index:: id
@@ -695,6 +717,8 @@ The configuration structure for the ``id`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_ID_Command;
+.. _tty:
+
tty - show ttyname
------------------
.. index:: tty
@@ -759,6 +783,8 @@ The configuration structure for the ``tty`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_TTY_Command;
+.. _whoami:
+
whoami - print effective user id
--------------------------------
.. index:: whoami
@@ -824,6 +850,8 @@ The configuration structure for the ``whoami`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command;
+.. _getenv:
+
getenv - print environment variable
-----------------------------------
.. index:: getenv
@@ -889,6 +917,8 @@ The configuration structure for the ``getenv`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_GETENV_Command;
+.. _setenv:
+
setenv - set environment variable
---------------------------------
.. index:: setenv
@@ -955,6 +985,8 @@ The configuration structure for the ``setenv`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_SETENV_Command;
+.. _unsetenv:
+
unsetenv - unset environment variable
-------------------------------------
.. index:: unsetenv
@@ -1018,6 +1050,8 @@ The configuration structure for the ``unsetenv`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_UNSETENV_Command;
+.. _time:
+
time - time command execution
-----------------------------
.. index:: time
@@ -1082,6 +1116,8 @@ The configuration structure for the ``time`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_TIME_Command;
+.. _logoff:
+
logoff - logoff from the system
-------------------------------
.. index:: logoff
@@ -1149,6 +1185,8 @@ The configuration structure for the ``logoff`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command;
+.. _rtc:
+
rtc - RTC driver configuration
------------------------------
.. index:: rtc
@@ -1172,6 +1210,8 @@ This command can be excluded from the shell command set by defining
``CONFIGURE_SHELL_NO_COMMAND_RTC`` when all shell commands have been
configured.
+.. _exit:
+
exit - exit the shell
---------------------
.. index:: exit