summaryrefslogtreecommitdiffstats
path: root/shell/general_commands.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2016-11-08 21:33:20 +1100
committerChris Johns <chrisj@rtems.org>2016-11-08 21:33:20 +1100
commitbf61a8b14e57ef56e8f5e190e9bdd0ba5db16a6f (patch)
treecca300e6dd29b3539aac4946e4316515ac89ebe8 /shell/general_commands.rst
parentwaf: Get a copy of the optional packages. (diff)
downloadrtems-docs-bf61a8b14e57ef56e8f5e190e9bdd0ba5db16a6f.tar.bz2
shell: Update commands to use descriptions.
Diffstat (limited to 'shell/general_commands.rst')
-rw-r--r--shell/general_commands.rst1466
1 files changed, 714 insertions, 752 deletions
diff --git a/shell/general_commands.rst b/shell/general_commands.rst
index 88d8324..7b0ad5c 100644
--- a/shell/general_commands.rst
+++ b/shell/general_commands.rst
@@ -55,84 +55,86 @@ 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.
+.. raw:: latex
+
+ \clearpage
+
.. _help:
help - Print command help
-------------------------
.. index:: help
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- help misc
-
-**DESCRIPTION:**
-
-This command prints the command help. Help without arguments prints a list of
-topics and help with a topic prints the help for that topic.
-
-**EXIT STATUS:**
-
-This command returns 0.
-
-**NOTES:**
-
-The help print will break the output up based on the environment variable
-SHELL_LINES. If this environment variable is not set the default is 16
-lines. If set the number of lines is set to that the value. If the shell lines
-is set 0 there will be no break.
-
-**EXAMPLES:**
-
-The following is an example of how to use ``alias``:
-
-.. code-block:: shell
-
- SHLL [/] $ help
- help: ('r' repeat last cmd - 'e' edit last cmd)
- TOPIC? The topics are
- mem, misc, files, help, rtems, network, monitor
- SHLL [/] $ help misc
- help: list for the topic 'misc'
- alias - alias old new
- time - time command [arguments...]
- joel - joel [args] SCRIPT
- date - date [YYYY-MM-DD HH:MM:SS]
- echo - echo [args]
- sleep - sleep seconds [nanoseconds]
- id - show uid, gid, euid, and egid
- tty - show ttyname
- whoami - show current user
- logoff - logoff from the system
- setenv - setenv [var] [string]
- getenv - getenv [var]
- unsetenv - unsetenv [var]
- umask - umask [new_umask]
- Press any key to continue...
- rtc - real time clock read and set
- SHLL [/] $ setenv SHELL_ENV 0
- SHLL [/] $ help misc
- help: list for the topic 'misc'
- alias - alias old new
- time - time command [arguments...]
- joel - joel [args] SCRIPT
- date - date [YYYY-MM-DD HH:MM:SS]
- echo - echo [args]
- sleep - sleep seconds [nanoseconds]
- id - show uid, gid, euid, and egid
- tty - show ttyname
- whoami - show current user
- logoff - logoff from the system
- setenv - setenv [var] [string]
- getenv - getenv [var]
- unsetenv - unsetenv [var]
- umask - umask [new_umask]
- rtc - real time clock read and set
-
-**CONFIGURATION:**
-
-This command has no configuration.
+SYNOPSYS:
+ .. code-block:: shell
+
+ help misc
+
+DESCRIPTION:
+ This command prints the command help. Help without arguments prints a list
+ of topics and help with a topic prints the help for that topic.
+
+EXIT STATUS:
+ This command returns 0.
+
+NOTES:
+ The help print will break the output up based on the environment variable
+ SHELL_LINES. If this environment variable is not set the default is 16
+ lines. If set the number of lines is set to that the value. If the shell
+ lines is set 0 there will be no break.
+
+EXAMPLES:
+ The following is an example of how to use ``alias``:
+
+ .. code-block:: shell
+
+ SHLL [/] $ help
+ help: ('r' repeat last cmd - 'e' edit last cmd)
+ TOPIC? The topics are
+ mem, misc, files, help, rtems, network, monitor
+ SHLL [/] $ help misc
+ help: list for the topic 'misc'
+ alias - alias old new
+ time - time command [arguments...]
+ joel - joel [args] SCRIPT
+ date - date [YYYY-MM-DD HH:MM:SS]
+ echo - echo [args]
+ sleep - sleep seconds [nanoseconds]
+ id - show uid, gid, euid, and egid
+ tty - show ttyname
+ whoami - show current user
+ logoff - logoff from the system
+ setenv - setenv [var] [string]
+ getenv - getenv [var]
+ unsetenv - unsetenv [var]
+ umask - umask [new_umask]
+ Press any key to continue...
+ rtc - real time clock read and set
+ SHLL [/] $ setenv SHELL_ENV 0
+ SHLL [/] $ help misc
+ help: list for the topic 'misc'
+ alias - alias old new
+ time - time command [arguments...]
+ joel - joel [args] SCRIPT
+ date - date [YYYY-MM-DD HH:MM:SS]
+ echo - echo [args]
+ sleep - sleep seconds [nanoseconds]
+ id - show uid, gid, euid, and egid
+ tty - show ttyname
+ whoami - show current user
+ logoff - logoff from the system
+ setenv - setenv [var] [string]
+ getenv - getenv [var]
+ unsetenv - unsetenv [var]
+ umask - umask [new_umask]
+ rtc - real time clock read and set
+
+CONFIGURATION:
+ This command has no configuration.
+
+.. raw:: latex
+
+ \clearpage
.. _alias:
@@ -140,70 +142,68 @@ alias - add alias for an existing command
-----------------------------------------
.. index:: alias
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- alias oldCommand newCommand
-
-**DESCRIPTION:**
+SYNOPSYS:
+ .. code-block:: shell
-This command adds an alternate name for an existing command to the command set.
+ alias oldCommand newCommand
-**EXIT STATUS:**
+DESCRIPTION:
+ This command adds an alternate name for an existing command to the command
+ set.
-This command returns 0 on success and non-zero if an error is encountered.
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-**NOTES:**
+NOTES:
+ None.
-None.
+EXAMPLES:
+ The following is an example of how to use ``alias``:
-**EXAMPLES:**
+ .. code-block:: shell
-The following is an example of how to use ``alias``:
-
-.. code-block:: shell
-
- SHLL [/] $ me
- shell:me command not found
- SHLL [/] $ alias whoami me
- SHLL [/] $ me
- rtems
- SHLL [/] $ whoami
- rtems
-
-**CONFIGURATION:**
+ SHLL [/] $ me
+ shell:me command not found
+ SHLL [/] $ alias whoami me
+ SHLL [/] $ me
+ rtems
+ SHLL [/] $ whoami
+ rtems
.. index:: CONFIGURE_SHELL_NO_COMMAND_ALIAS
.. index:: CONFIGURE_SHELL_COMMAND_ALIAS
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_ALIAS`` to have this
-command included.
-
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_ALIAS`` when all shell commands have been
-configured.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_ALIAS`` to have this
+ command included.
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_ALIAS`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_alias
-The ``alias`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``alias`` is implemented by a C language function which has the
+ following prototype:
-.. code-block:: c
+ .. code-block:: c
- int rtems_shell_rtems_main_alias(
- int argc,
- char **argv
- );
+ int rtems_shell_rtems_main_alias(
+ int argc,
+ char **argv
+ );
-The configuration structure for the ``alias`` has the following prototype:
+ The configuration structure for the ``alias`` has the following prototype:
-.. code-block:: c
+ .. code-block:: c
- extern rtems_shell_cmd_t rtems_shell_ALIAS_Command;
+ extern rtems_shell_cmd_t rtems_shell_ALIAS_Command;
+
+.. raw:: latex
+
+ \clearpage
.. _cmdls:
@@ -211,54 +211,51 @@ cmdls - List commands
---------------------
.. index:: cmdls
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- cmdls COMMAND...
-
-**DESCRIPTION:**
+SYNOPSYS:
+ .. code-block:: shell
-This command lists the visible commands of the command set.
+ cmdls COMMAND...
-**EXIT STATUS:**
+DESCRIPTION:
+ This command lists the visible commands of the command set.
-This command returns 0 on success and non-zero if an error is encountered.
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-**NOTES:**
+NOTES:
+ The current user must have read permission to list a command.
-The current user must have read permission to list a command.
+EXAMPLES:
+ The following is an example of how to use ``cmdls``:
-**EXAMPLES:**
+ .. code-block:: shell
-The following is an example of how to use ``cmdls``:
-
-.. code-block:: shell
-
- SHLL [/] # cmdls help shutdown
- r-xr-xr-x 0 0 help
- r-x------ 0 0 shutdown
-
-**CONFIGURATION:**
+ SHLL [/] # cmdls help shutdown
+ r-xr-xr-x 0 0 help
+ r-x------ 0 0 shutdown
.. index:: CONFIGURE_SHELL_NO_COMMAND_CMDLS
.. index:: CONFIGURE_SHELL_COMMAND_CMDLS
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_CMDLS`` to have this
-command included.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_CMDLS`` to have this
+ command included.
+
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_CMDLS`` when all shell commands have been
+ configured.
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_CMDLS`` when all shell commands have been
-configured.
+PROGRAMMING INFORMATION:
+ The configuration structure for the ``cmdls`` has the following prototype:
-**PROGRAMMING INFORMATION:**
+ .. code-block:: c
-The configuration structure for the ``cmdls`` has the following prototype:
+ extern rtems_shell_cmd_t rtems_shell_CMDLS_Command;
-.. code-block:: c
+.. raw:: latex
- extern rtems_shell_cmd_t rtems_shell_CMDLS_Command;
+ \clearpage
.. _cmdchown:
@@ -266,57 +263,55 @@ cmdchown - Change user or owner of commands
-------------------------------------------
.. index:: cmdchown
-**SYNOPSYS:**
+SYNOPSYS:
+ .. code-block:: shell
-.. code-block:: shell
+ cmdchown [OWNER][:[GROUP]] COMMAND...
- cmdchown [OWNER][:[GROUP]] COMMAND...
+DESCRIPTION:
+ This command changes the user or owner of a command.
-**DESCRIPTION:**
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-This command changes the user or owner of a command.
+NOTES:
+ The current user must have an UID of zero or be the command owner to change
+ the owner or group.
-**EXIT STATUS:**
+EXAMPLES:
+ The following is an example of how to use ``cmdchown``:
-This command returns 0 on success and non-zero if an error is encountered.
+ .. code-block:: shell
-**NOTES:**
-
-The current user must have an UID of zero or be the command owner to change the
-owner or group.
-
-**EXAMPLES:**
-
-The following is an example of how to use ``cmdchown``:
-
-.. code-block:: shell
-
- [/] # cmdls help
- r-xr-xr-x 0 0 help
- [/] # cmdchown 1:1 help
- [/] # cmdls help
- r--r--r-- 1 1 help
-
-**CONFIGURATION:**
+ [/] # cmdls help
+ r-xr-xr-x 0 0 help
+ [/] # cmdchown 1:1 help
+ [/] # cmdls help
+ r--r--r-- 1 1 help
.. index:: CONFIGURE_SHELL_NO_COMMAND_CMDCHOWN
.. index:: CONFIGURE_SHELL_COMMAND_CMDCHOWN
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_CMDCHOWN`` to have this
-command included.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_CMDCHOWN`` to have
+ this command included.
+
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_CMDCHOWN`` when all shell commands have been
+ configured.
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_CMDCHOWN`` when all shell commands have been
-configured.
+PROGRAMMING INFORMATION:
+ The configuration structure for the ``cmdchown`` has the following
+ prototype:
-**PROGRAMMING INFORMATION:**
+ .. code-block:: c
-The configuration structure for the ``cmdchown`` has the following prototype:
+ extern rtems_shell_cmd_t rtems_shell_CMDCHOWN_Command;
-.. code-block:: c
+.. raw:: latex
- extern rtems_shell_cmd_t rtems_shell_CMDCHOWN_Command;
+ \clearpage
.. _cmdchmod:
@@ -324,57 +319,55 @@ cmdchmod - Change mode of commands
----------------------------------
.. index:: cmdchmod
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- cmdchmod OCTAL-MODE COMMAND...
+SYNOPSYS:
+ .. code-block:: shell
-**DESCRIPTION:**
+ cmdchmod OCTAL-MODE COMMAND...
-This command changes the mode of a command.
+DESCRIPTION:
+ This command changes the mode of a command.
-**EXIT STATUS:**
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-This command returns 0 on success and non-zero if an error is encountered.
+NOTES:
+ The current user must have an UID of zero or be the command owner to change
+ the mode.
-**NOTES:**
+EXAMPLES:
+ The following is an example of how to use ``cmdchmod``:
-The current user must have an UID of zero or be the command owner to change the
-mode.
+ .. code-block:: shell
-**EXAMPLES:**
-
-The following is an example of how to use ``cmdchmod``:
-
-.. code-block:: shell
-
- [/] # cmdls help
- r-xr-xr-x 0 0 help
- [/] # cmdchmod 544 help
- [/] # cmdls help
- r-xr--r-- 0 0 help
-
-**CONFIGURATION:**
+ [/] # cmdls help
+ r-xr-xr-x 0 0 help
+ [/] # cmdchmod 544 help
+ [/] # cmdls help
+ r-xr--r-- 0 0 help
.. index:: CONFIGURE_SHELL_NO_COMMAND_CMDCHMOD
.. index:: CONFIGURE_SHELL_COMMAND_CMDCHMOD
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_CMDCHMOD`` to have this
-command included.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_CMDCHMOD`` to have
+ this command included.
+
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_CMDCHMOD`` when all shell commands have been
+ configured.
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_CMDCHMOD`` when all shell commands have been
-configured.
+PROGRAMMING INFORMATION:
+ The configuration structure for the ``cmdchmod`` has the following
+ prototype:
-**PROGRAMMING INFORMATION:**
+ .. code-block:: c
-The configuration structure for the ``cmdchmod`` has the following prototype:
+ extern rtems_shell_cmd_t rtems_shell_CMDCHMOD_Command;
-.. code-block:: c
+.. raw:: latex
- extern rtems_shell_cmd_t rtems_shell_CMDCHMOD_Command;
+ \clearpage
.. _date:
@@ -382,74 +375,71 @@ date - print or set current date and time
-----------------------------------------
.. index:: date
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- date
- date DATE TIME
-
-**DESCRIPTION:**
-
-This command operates one of two modes. When invoked with no arguments, it
-prints the current date and time. When invoked with both ``date`` and ``time``
-arguments, it sets the current time.
+SYNOPSYS:
+ .. code-block:: shell
-The ``date`` is specified in ``YYYY-MM-DD`` format.
-The ``time`` is specified in ``HH:MM:SS`` format.
+ date
+ date DATE TIME
-**EXIT STATUS:**
+DESCRIPTION:
+ This command operates one of two modes. When invoked with no arguments, it
+ prints the current date and time. When invoked with both ``date`` and
+ ``time`` arguments, it sets the current time.
-This command returns 0 on success and non-zero if an error is encountered.
+ The ``date`` is specified in ``YYYY-MM-DD`` format.
+ The ``time`` is specified in ``HH:MM:SS`` format.
-**NOTES:**
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-None.
+NOTES:
+ None.
-**EXAMPLES:**
+EXAMPLES:
+ The following is an example of how to use ``date``:
-The following is an example of how to use ``date``:
+ .. code-block:: shell
-.. code-block:: shell
-
- SHLL [/] $ date
- Fri Jan 1 00:00:09 1988
- SHLL [/] $ date 2008-02-29 06:45:32
- SHLL [/] $ date
- Fri Feb 29 06:45:35 2008
-
-**CONFIGURATION:**
+ SHLL [/] $ date
+ Fri Jan 1 00:00:09 1988
+ SHLL [/] $ date 2008-02-29 06:45:32
+ SHLL [/] $ date
+ Fri Feb 29 06:45:35 2008
.. index:: CONFIGURE_SHELL_NO_COMMAND_DATE
.. index:: CONFIGURE_SHELL_COMMAND_DATE
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_DATE`` to have this command
-included.
-
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_DATE`` when all shell commands have been
-configured.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_DATE`` to have this
+ command included.
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_DATE`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_date
-The ``date`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``date`` is implemented by a C language function which has the
+ following prototype:
+
+ .. code-block:: c
+
+ int rtems_shell_rtems_main_date(
+ int argc,
+ char **argv
+ );
-.. code-block:: c
+ The configuration structure for the ``date`` has the following prototype:
- int rtems_shell_rtems_main_date(
- int argc,
- char **argv
- );
+ .. code-block:: c
-The configuration structure for the ``date`` has the following prototype:
+ extern rtems_shell_cmd_t rtems_shell_DATE_Command;
-.. code-block:: c
+.. raw:: latex
- extern rtems_shell_cmd_t rtems_shell_DATE_Command;
+ \clearpage
.. _echo:
@@ -457,113 +447,110 @@ echo - produce message in a shell script
----------------------------------------
.. index:: echo
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- echo [-n | -e] args ...
-
-**DESCRIPTION:**
-
-Echo prints its arguments on the standard output, separated by spaces. Unless
-the *-n* option is present, a newline is output following the arguments. The
-*-e* option causes echo to treat the escape sequences specially, as described
-in the following paragraph. The *-e* option is the default, and is provided
-solely for compatibility with other systems. Only one of the options *-n* and
-*-e* may be given.
+SYNOPSYS:
+ .. code-block:: shell
-If any of the following sequences of characters is encountered during output,
-the sequence is not output. Instead, the specified action is performed:
+ echo [-n | -e] args ...
-*\b*
- A backspace character is output.
+DESCRIPTION:
+ Echo prints its arguments on the standard output, separated by spaces.
+ Unless the *-n* option is present, a newline is output following the
+ arguments. The *-e* option causes echo to treat the escape sequences
+ specially, as described in the following paragraph. The *-e* option is the
+ default, and is provided solely for compatibility with other systems. Only
+ one of the options *-n* and *-e* may be given.
-*\c*
- Subsequent output is suppressed. This is normally used at the end of the
- last argument to suppress the trailing newline that echo would otherwise
- output.
+ If any of the following sequences of characters is encountered during
+ output, the sequence is not output. Instead, the specified action is
+ performed:
-*\f*
- Output a form feed.
+ *\b*
+ A backspace character is output.
-*\n*
- Output a newline character.
+ *\c*
+ Subsequent output is suppressed. This is normally used at the end of
+ the last argument to suppress the trailing newline that echo would
+ otherwise output.
-*\r*
- Output a carriage return.
+ *\f*
+ Output a form feed.
-*\t*
- Output a (horizontal) tab character.
+ *\n*
+ Output a newline character.
-*\v*
- Output a vertical tab.
+ *\r*
+ Output a carriage return.
-*\0digits*
- Output the character whose value is given by zero to three digits. If
- there are zero digits, a nul character is output.
+ *\t*
+ Output a (horizontal) tab character.
-*\\*
- Output a backslash.
+ *\v*
+ Output a vertical tab.
-**EXIT STATUS:**
+ *\0digits*
+ Output the character whose value is given by zero to three digits. If
+ there are zero digits, a nul character is output.
-This command returns 0 on success and non-zero if an error is encountered.
+ *\\*
+ Output a backslash.
-**NOTES:**
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-The octal character escape mechanism (\0digits) differs from the C language
-mechanism.
+NOTES:
+ The octal character escape mechanism (\0digits) differs from the C language
+ mechanism.
-There is no way to force ``echo`` to treat its arguments literally, rather than
-interpreting them as options and escape sequences.
+ There is no way to force ``echo`` to treat its arguments literally, rather
+ than interpreting them as options and escape sequences.
-**EXAMPLES:**
+EXAMPLES:
+ The following is an example of how to use ``echo``:
-The following is an example of how to use ``echo``:
+ .. code-block:: shell
-.. code-block:: shell
-
- SHLL [/] $ echo a b c
- a b c
- SHLL [/] $ echo
-
-**CONFIGURATION:**
+ SHLL [/] $ echo a b c
+ a b c
+ SHLL [/] $ echo
.. index:: CONFIGURE_SHELL_NO_COMMAND_ECHO
.. index:: CONFIGURE_SHELL_COMMAND_ECHO
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_ECHO`` to have this command
-included.
-
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_ECHO`` when all shell commands have been
-configured.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_ECHO`` to have this
+ command included.
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_ECHO`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_echo
-The ``echo`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``echo`` is implemented by a C language function which has the
+ following prototype:
-.. code-block:: c
+ .. code-block:: c
- int rtems_shell_rtems_main_echo(
- int argc,
- char **argv
- );
+ int rtems_shell_rtems_main_echo(
+ int argc,
+ char **argv
+ );
-The configuration structure for the ``echo`` has the following prototype:
+ The configuration structure for the ``echo`` has the following prototype:
-.. code-block:: c
+ .. code-block:: c
- extern rtems_shell_cmd_t rtems_shell_ECHO_Command;
+ extern rtems_shell_cmd_t rtems_shell_ECHO_Command;
-**ORIGIN:**
+ORIGIN:
+ The implementation and portions of the documentation for this command are
+ from NetBSD 4.0.
-The implementation and portions of the documentation for this command are from
-NetBSD 4.0.
+.. raw:: latex
+
+ \clearpage
.. _sleep:
@@ -571,76 +558,74 @@ sleep - delay for a specified amount of time
--------------------------------------------
.. index:: sleep
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- sleep seconds
- sleep seconds nanoseconds
-
-**DESCRIPTION:**
-
-This command causes the task executing the shell to block for the specified
-number of ``seconds`` and ``nanoseconds``.
-
-**EXIT STATUS:**
+SYNOPSYS:
+ .. code-block:: shell
-This command returns 0 on success and non-zero if an error is encountered.
+ sleep seconds
+ sleep seconds nanoseconds
-**NOTES:**
+DESCRIPTION:
+ This command causes the task executing the shell to block for the specified
+ number of ``seconds`` and ``nanoseconds``.
-This command is implemented using the ``nanosleep()`` method.
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-The command line interface is similar to the ``sleep`` command found on POSIX
-systems but the addition of the ``nanoseconds`` parameter allows fine grained
-delays in shell scripts without adding another command such as ``usleep``.
+NOTES:
+ This command is implemented using the ``nanosleep()`` method.
-**EXAMPLES:**
+ The command line interface is similar to the ``sleep`` command found on
+ POSIX systems but the addition of the ``nanoseconds`` parameter allows fine
+ grained delays in shell scripts without adding another command such as
+ ``usleep``.
-The following is an example of how to use ``sleep``:
+EXAMPLES:
+ The following is an example of how to use ``sleep``:
-.. code-block:: shell
+ .. code-block:: shell
- SHLL [/] $ sleep 10
- SHLL [/] $ sleep 0 5000000
+ SHLL [/] $ sleep 10
+ SHLL [/] $ sleep 0 5000000
-It is not clear from the above but there is a ten second pause after executing
-the first command before the prompt is printed. The second command completes
-very quickly from a human perspective and there is no noticeable delay in the
-prompt being printed.
-
-**CONFIGURATION:**
+ It is not clear from the above but there is a ten second pause after
+ executing the first command before the prompt is printed. The second
+ command completes very quickly from a human perspective and there is no
+ noticeable delay in the prompt being printed.
.. index:: CONFIGURE_SHELL_NO_COMMAND_SLEEP
.. index:: CONFIGURE_SHELL_COMMAND_SLEEP
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_SLEEP`` to have this
-command included.
-
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_SLEEP`` when all shell commands have been
-configured.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_SLEEP`` to have this
+ command included.
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_SLEEP`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_sleep
-The ``sleep`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``sleep`` is implemented by a C language function which has the
+ following prototype:
+
+ .. code-block:: c
-.. code-block:: c
+ int rtems_shell_rtems_main_sleep(
+ int argc,
+ char **argv
+ );
- int rtems_shell_rtems_main_sleep(
- int argc,
- char **argv
- );
+ The configuration structure for the ``sleep`` has the following prototype:
-The configuration structure for the ``sleep`` has the following prototype:
+ .. code-block:: c
-.. code-block:: c
+ extern rtems_shell_cmd_t rtems_shell_SLEEP_Command;
- extern rtems_shell_cmd_t rtems_shell_SLEEP_Command;
+.. raw:: latex
+
+ \clearpage
.. _id:
@@ -648,76 +633,73 @@ id - show uid gid euid and egid
-------------------------------
.. index:: id
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- id
-
-**DESCRIPTION:**
-
-This command prints the user identity. This includes the user id (uid), group
-id (gid), effective user id (euid), and effective group id (egid).
-
-**EXIT STATUS:**
+SYNOPSYS:
+ .. code-block:: shell
-This command returns 0 on success and non-zero if an error is encountered.
+ id
-**NOTES:**
+DESCRIPTION:
+ This command prints the user identity. This includes the user id (uid),
+ group id (gid), effective user id (euid), and effective group id (egid).
-Remember there is only one POSIX process in a single processor RTEMS
-application. Each thread may have its own user identity and that identity is
-used by the filesystem to enforce permissions.
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-**EXAMPLES:**
+NOTES:
+ Remember there is only one POSIX process in a single processor RTEMS
+ application. Each thread may have its own user identity and that identity
+ is used by the filesystem to enforce permissions.
-The first example of the ``id`` command is from a session logged
-in as the normal user ``rtems``:
+EXAMPLES:
+ The first example of the ``id`` command is from a session logged
+ in as the normal user ``rtems``:
-.. code-block:: shell
+ .. code-block:: shell
- SHLL [/] # id
- uid=1(rtems),gid=1(rtems),euid=1(rtems),egid=1(rtems)
+ SHLL [/] # id
+ uid=1(rtems),gid=1(rtems),euid=1(rtems),egid=1(rtems)
-The second example of the ``id`` command is from a session logged in as the
-``root`` user:
+ The second example of the ``id`` command is from a session logged in as the
+ ``root`` user:
-.. code-block:: shell
+ .. code-block:: shell
- SHLL [/] # id
- uid=0(root),gid=0(root),euid=0(root),egid=0(root)
-
-**CONFIGURATION:**
+ SHLL [/] # id
+ uid=0(root),gid=0(root),euid=0(root),egid=0(root)
.. index:: CONFIGURE_SHELL_NO_COMMAND_ID
.. index:: CONFIGURE_SHELL_COMMAND_ID
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_ID`` to have this command
-included.
-
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_ID`` when all shell commands have been configured.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_ID`` to have this
+ command included.
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_ID`` when all shell commands have been configured.
.. index:: rtems_shell_rtems_main_id
-The ``id`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``id`` is implemented by a C language function which has the following
+ prototype:
+
+ .. code-block:: c
+
+ int rtems_shell_rtems_main_id(
+ int argc,
+ char **argv
+ );
-.. code-block:: c
+ The configuration structure for the ``id`` has the following prototype:
- int rtems_shell_rtems_main_id(
- int argc,
- char **argv
- );
+ .. code-block:: c
-The configuration structure for the ``id`` has the following prototype:
+ extern rtems_shell_cmd_t rtems_shell_ID_Command;
-.. code-block:: c
+.. raw:: latex
- extern rtems_shell_cmd_t rtems_shell_ID_Command;
+ \clearpage
.. _tty:
@@ -725,65 +707,63 @@ tty - show ttyname
------------------
.. index:: tty
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- tty
-
-**DESCRIPTION:**
-
-This command prints the file name of the device connected to standard input.
+SYNOPSYS:
+ .. code-block:: shell
-**EXIT STATUS:**
+ tty
-This command returns 0 on success and non-zero if an error is encountered.
+DESCRIPTION:
+ This command prints the file name of the device connected to standard
+ input.
-**NOTES:**
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-NONE
+NOTES:
+ NONE
-**EXAMPLES:**
+EXAMPLES:
+ The following is an example of how to use ``tty``:
-The following is an example of how to use ``tty``:
+ .. code-block:: shell
-.. code-block:: shell
-
- SHLL [/] $ tty
- /dev/console
-
-**CONFIGURATION:**
+ SHLL [/] $ tty
+ /dev/console
.. index:: CONFIGURE_SHELL_NO_COMMAND_TTY
.. index:: CONFIGURE_SHELL_COMMAND_TTY
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_TTY`` to have this command
-included.
-
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_TTY`` when all shell commands have been
-configured.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_TTY`` to have this
+ command included.
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_TTY`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_tty
-The ``tty`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``tty`` is implemented by a C language function which has the following
+ prototype:
+
+ .. code-block:: c
+
+ int rtems_shell_rtems_main_tty(
+ int argc,
+ char **argv
+ );
-.. code-block:: c
+ The configuration structure for the ``tty`` has the following prototype:
- int rtems_shell_rtems_main_tty(
- int argc,
- char **argv
- );
+ .. code-block:: c
-The configuration structure for the ``tty`` has the following prototype:
+ extern rtems_shell_cmd_t rtems_shell_TTY_Command;
-.. code-block:: c
+.. raw:: latex
- extern rtems_shell_cmd_t rtems_shell_TTY_Command;
+ \clearpage
.. _whoami:
@@ -791,66 +771,64 @@ whoami - print effective user id
--------------------------------
.. index:: whoami
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- whoami
-
-**DESCRIPTION:**
-
-This command displays the user name associated with the current effective user
-id.
+SYNOPSYS:
+ .. code-block:: shell
-**EXIT STATUS:**
+ whoami
-This command always succeeds.
+DESCRIPTION:
+ This command displays the user name associated with the current effective
+ user
+ id.
-**NOTES:**
+EXIT STATUS:
+ This command always succeeds.
-None.
+NOTES:
+ None.
-**EXAMPLES:**
+EXAMPLES:
+ The following is an example of how to use ``whoami``:
-The following is an example of how to use ``whoami``:
+ .. code-block:: shell
-.. code-block:: shell
-
- SHLL [/] $ whoami
- rtems
-
-**CONFIGURATION:**
+ SHLL [/] $ whoami
+ rtems
.. index:: CONFIGURE_SHELL_NO_COMMAND_WHOAMI
.. index:: CONFIGURE_SHELL_COMMAND_WHOAMI
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_WHOAMI`` to have this
-command included.
-
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_WHOAMI`` when all shell commands have been
-configured.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_WHOAMI`` to have this
+ command included.
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_WHOAMI`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_whoami
-The ``whoami`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``whoami`` is implemented by a C language function which has the
+ following prototype:
+
+ .. code-block:: c
+
+ int rtems_shell_rtems_main_whoami(
+ int argc,
+ char **argv
+ );
-.. code-block:: c
+ The configuration structure for the ``whoami`` has the following prototype:
- int rtems_shell_rtems_main_whoami(
- int argc,
- char **argv
- );
+ .. code-block:: c
-The configuration structure for the ``whoami`` has the following prototype:
+ extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command;
-.. code-block:: c
+.. raw:: latex
- extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command;
+ \clearpage
.. _getenv:
@@ -858,66 +836,64 @@ getenv - print environment variable
-----------------------------------
.. index:: getenv
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- getenv variable
-
-**DESCRIPTION:**
-
-This command is used to display the value of a ``variable`` in the set of
-environment variables.
+SYNOPSYS:
+ .. code-block:: shell
-**EXIT STATUS:**
+ getenv variable
-This command will return 1 and print a diagnostic message if a failure occurs.
+DESCRIPTION:
+ This command is used to display the value of a ``variable`` in the set of
+ environment variables.
-**NOTES:**
+EXIT STATUS:
+ This command will return 1 and print a diagnostic message if a failure
+ occurs.
-The entire RTEMS application shares a single set of environment variables.
+NOTES:
+ The entire RTEMS application shares a single set of environment variables.
-**EXAMPLES:**
+EXAMPLES:
+ The following is an example of how to use ``getenv``:
-The following is an example of how to use ``getenv``:
+ .. code-block:: shell
-.. code-block:: shell
-
- SHLL [/] $ getenv BASEPATH
- /mnt/hda1
-
-**CONFIGURATION:**
+ SHLL [/] $ getenv BASEPATH
+ /mnt/hda1
.. index:: CONFIGURE_SHELL_NO_COMMAND_GETENV
.. index:: CONFIGURE_SHELL_COMMAND_GETENV
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_GETENV`` to have this
-command included.
-
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_GETENV`` when all shell commands have been
-configured.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_GETENV`` to have this
+ command included.
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_GETENV`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_getenv
-The ``getenv`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``getenv`` is implemented by a C language function which has the
+ following prototype:
+
+ .. code-block:: c
+
+ int rtems_shell_rtems_main_getenv(
+ int argc,
+ char **argv
+ );
-.. code-block:: c
+ The configuration structure for the ``getenv`` has the following prototype:
- int rtems_shell_rtems_main_getenv(
- int argc,
- char **argv
- );
+ .. code-block:: c
-The configuration structure for the ``getenv`` has the following prototype:
+ extern rtems_shell_cmd_t rtems_shell_GETENV_Command;
-.. code-block:: c
+.. raw:: latex
- extern rtems_shell_cmd_t rtems_shell_GETENV_Command;
+ \clearpage
.. _setenv:
@@ -925,67 +901,65 @@ setenv - set environment variable
---------------------------------
.. index:: setenv
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- setenv variable [value]
-
-**DESCRIPTION:**
-
-This command is used to add a new ``variable`` to the set of environment
-variables or to modify the variable of an already existing ``variable``. If
-the ``value`` is not provided, the ``variable`` will be set to the empty
-string.
+SYNOPSYS:
+ .. code-block:: shell
-**EXIT STATUS:**
+ setenv variable [value]
-This command will return 1 and print a diagnostic message if a failure occurs.
+DESCRIPTION:
+ This command is used to add a new ``variable`` to the set of environment
+ variables or to modify the variable of an already existing ``variable``.
+ If the ``value`` is not provided, the ``variable`` will be set to the empty
+ string.
-**NOTES:**
+EXIT STATUS:
+ This command will return 1 and print a diagnostic message if a failure
+ occurs.
-The entire RTEMS application shares a single set of environment variables.
+NOTES:
+ The entire RTEMS application shares a single set of environment variables.
-**EXAMPLES:**
+EXAMPLES:
+ The following is an example of how to use ``setenv``:
-The following is an example of how to use ``setenv``:
+ .. code-block:: shell
-.. code-block:: shell
-
- SHLL [/] $ setenv BASEPATH /mnt/hda1
-
-**CONFIGURATION:**
+ SHLL [/] $ setenv BASEPATH /mnt/hda1
.. index:: CONFIGURE_SHELL_NO_COMMAND_SETENV
.. index:: CONFIGURE_SHELL_COMMAND_SETENV
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_SETENV`` to have this
-command included.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_SETENV`` to have this
+ command included.
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_SETENV`` when all shell commands have been
-configured.
-
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_SETENV`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_setenv
-The ``setenv`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``setenv`` is implemented by a C language function which has the
+ following prototype:
+
+ .. code-block:: c
-.. code-block:: c
+ int rtems_shell_rtems_main_setenv(
+ int argc,
+ char **argv
+ );
- int rtems_shell_rtems_main_setenv(
- int argc,
- char **argv
- );
+ The configuration structure for the ``setenv`` has the following prototype:
-The configuration structure for the ``setenv`` has the following prototype:
+ .. code-block:: c
-.. code-block:: c
+ extern rtems_shell_cmd_t rtems_shell_SETENV_Command;
- extern rtems_shell_cmd_t rtems_shell_SETENV_Command;
+.. raw:: latex
+
+ \clearpage
.. _unsetenv:
@@ -993,64 +967,63 @@ unsetenv - unset environment variable
-------------------------------------
.. index:: unsetenv
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- unsetenv variable
-
-**DESCRIPTION:**
+SYNOPSYS:
+ .. code-block:: shell
-This command is remove to a ``variable`` from the set of environment variables.
+ unsetenv variable
-**EXIT STATUS:**
+DESCRIPTION:
+ This command is remove to a ``variable`` from the set of environment
+ variables.
-This command will return 1 and print a diagnostic message if a failure occurs.
+EXIT STATUS:
+ This command will return 1 and print a diagnostic message if a failure
+ occurs.
-**NOTES:**
+NOTES:
+ The entire RTEMS application shares a single set of environment variables.
-The entire RTEMS application shares a single set of environment variables.
+EXAMPLES:
+ The following is an example of how to use ``unsetenv``:
-**EXAMPLES:**
+ .. code-block:: shell
-The following is an example of how to use ``unsetenv``:
-
-.. code-block:: shell
-
- SHLL [/] $ unsetenv BASEPATH
-
-**CONFIGURATION:**
+ SHLL [/] $ unsetenv BASEPATH
.. index:: CONFIGURE_SHELL_NO_COMMAND_UNSETENV
.. index:: CONFIGURE_SHELL_COMMAND_UNSETENV
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_UNSETENV`` to have this
-command included.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_UNSETENV`` to have
+ this command included.
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_UNSETENV`` when all shell commands have been
-configured.
-
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_UNSETENV`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_unsetenv
-The ``unsetenv`` is implemented by a C language function which has the
-following prototype:
+PROGRAMMING INFORMATION:
+ The ``unsetenv`` is implemented by a C language function which has the
+ following prototype:
+
+ .. code-block:: c
-.. code-block:: c
+ int rtems_shell_rtems_main_unsetenv(
+ int argc,
+ char **argv
+ );
- int rtems_shell_rtems_main_unsetenv(
- int argc,
- char **argv
- );
+ The configuration structure for the ``unsetenv`` has the following prototype:
-The configuration structure for the ``unsetenv`` has the following prototype:
+ .. code-block:: c
-.. code-block:: c
+ extern rtems_shell_cmd_t rtems_shell_UNSETENV_Command;
- extern rtems_shell_cmd_t rtems_shell_UNSETENV_Command;
+.. raw:: latex
+
+ \clearpage
.. _time:
@@ -1058,65 +1031,62 @@ time - time command execution
-----------------------------
.. index:: time
-**SYNOPSYS:**
-
-.. code-block:: c
-
- time command [argument ...]
-
-**DESCRIPTION:**
+SYNOPSYS:
+ .. code-block:: c
-The time command executes and times a command. After the command finishes,
-time writes the total time elapsed. Times are reported in seconds.
+ time command [argument ...]
-**EXIT STATUS:**
+DESCRIPTION:
+ The time command executes and times a command. After the command finishes,
+ time writes the total time elapsed. Times are reported in seconds.
-This command returns 0 on success and non-zero if an error is encountered.
+EXIT STATUS:
+ This command returns 0 on success and non-zero if an error is encountered.
-**NOTES:**
+NOTES:
+ None.
-None.
+EXAMPLES:
+ The following is an example of how to use ``time``:
-**EXAMPLES:**
+ .. code-block:: shell
-The following is an example of how to use ``time``:
-
-.. code-block:: shell
-
- SHLL [/] $ time cp -r /nfs/directory /c
-
-**CONFIGURATION:**
+ SHLL [/] $ time cp -r /nfs/directory /c
.. index:: CONFIGURE_SHELL_NO_COMMAND_TIME
.. index:: CONFIGURE_SHELL_COMMAND_TIME
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_TIME`` to have this command
-included.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_TIME`` to have this
+ command included.
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_TIME`` when all shell commands have been
-configured.
-
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_TIME`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_time
-The ``time`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``time`` is implemented by a C language function which has the
+ following prototype:
+
+ .. code-block:: c
-.. code-block:: c
+ int rtems_shell_rtems_main_time(
+ int argc,
+ char **argv
+ );
- int rtems_shell_rtems_main_time(
- int argc,
- char **argv
- );
+ The configuration structure for the ``time`` has the following prototype:
-The configuration structure for the ``time`` has the following prototype:
+ .. code-block:: c
-.. code-block:: c
+ extern rtems_shell_cmd_t rtems_shell_TIME_Command;
- extern rtems_shell_cmd_t rtems_shell_TIME_Command;
+.. raw:: latex
+
+ \clearpage
.. _logoff:
@@ -1124,68 +1094,65 @@ logoff - logoff from the system
-------------------------------
.. index:: logoff
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- logoff
-
-**DESCRIPTION:**
+SYNOPSYS:
+ .. code-block:: shell
-This command logs the user out of the shell.
+ logoff
-**EXIT STATUS:**
+DESCRIPTION:
+ This command logs the user out of the shell.
-This command does not return.
+EXIT STATUS:
+ This command does not return.
-**NOTES:**
+NOTES:
+ The system behavior when the shell is exited depends upon how the shell was
+ initiated. The typical behavior is that a login prompt will be displayed
+ for the next login attempt or that the connection will be dropped by the
+ RTEMS system.
-The system behavior when the shell is exited depends upon how the shell was
-initiated. The typical behavior is that a login prompt will be displayed for
-the next login attempt or that the connection will be dropped by the RTEMS
-system.
+EXAMPLES:
+ The following is an example of how to use ``logoff``:
-**EXAMPLES:**
+ .. code-block:: shell
-The following is an example of how to use ``logoff``:
-
-.. code-block:: shell
-
- SHLL [/] $ logoff
- logoff from the system...
-
-**CONFIGURATION:**
+ SHLL [/] $ logoff
+ logoff from the system...
.. index:: CONFIGURE_SHELL_NO_COMMAND_LOGOFF
.. index:: CONFIGURE_SHELL_COMMAND_LOGOFF
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_LOGOFF`` to have this
-command included.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_LOGOFF`` to have this
+ command included.
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_LOGOFF`` when all shell commands have been
-configured.
-
-**PROGRAMMING INFORMATION:**
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_LOGOFF`` when all shell commands have been
+ configured.
.. index:: rtems_shell_rtems_main_logoff
-The ``logoff`` is implemented by a C language function which has the following
-prototype:
+PROGRAMMING INFORMATION:
+ The ``logoff`` is implemented by a C language function which has the
+ following prototype:
+
+ .. code-block:: c
-.. code-block:: c
+ int rtems_shell_rtems_main_logoff(
+ int argc,
+ char **argv
+ );
- int rtems_shell_rtems_main_logoff(
- int argc,
- char **argv
- );
+ The configuration structure for the ``logoff`` has the following prototype:
-The configuration structure for the ``logoff`` has the following prototype:
+ .. code-block:: c
-.. code-block:: c
+ extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command;
- extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command;
+.. raw:: latex
+
+ \clearpage
.. _rtc:
@@ -1193,24 +1160,26 @@ rtc - RTC driver configuration
------------------------------
.. index:: rtc
-**SYNOPSYS:**
-
-.. code-block:: shell
+SYNOPSYS:
+ .. code-block:: shell
- rtc
-
-**CONFIGURATION:**
+ rtc
.. index:: CONFIGURE_SHELL_NO_COMMAND_RTC
.. index:: CONFIGURE_SHELL_COMMAND_RTC
-This command is included in the default shell command set. When building a
-custom command set, define ``CONFIGURE_SHELL_COMMAND_RTC`` to have this command
-included.
+CONFIGURATION:
+ This command is included in the default shell command set. When building a
+ custom command set, define ``CONFIGURE_SHELL_COMMAND_RTC`` to have this
+ command included.
+
+ This command can be excluded from the shell command set by defining
+ ``CONFIGURE_SHELL_NO_COMMAND_RTC`` when all shell commands have been
+ configured.
-This command can be excluded from the shell command set by defining
-``CONFIGURE_SHELL_NO_COMMAND_RTC`` when all shell commands have been
-configured.
+.. raw:: latex
+
+ \clearpage
.. _exit:
@@ -1218,39 +1187,32 @@ exit - exit the shell
---------------------
.. index:: exit
-**SYNOPSYS:**
-
-.. code-block:: shell
-
- exit
-
-**DESCRIPTION:**
-
-This command causes the shell interpreter to ``exit``.
-
-**EXIT STATUS:**
-
-This command does not return.
-
-**NOTES:**
+SYNOPSYS:
+ .. code-block:: shell
-In contrast to `logoff - logoff from the system`, this command is built into
-the shell interpreter loop.
+ exit
-**EXAMPLES:**
+DESCRIPTION:
+ This command causes the shell interpreter to ``exit``.
-The following is an example of how to use ``exit``:
+EXIT STATUS:
+ This command does not return.
-.. code-block:: shell
+NOTES:
+ In contrast to `logoff - logoff from the system`, this command is built
+ into the shell interpreter loop.
- SHLL [/] $ exit
- Shell exiting
+EXAMPLES:
+ The following is an example of how to use ``exit``:
-**CONFIGURATION:**
+ .. code-block:: shell
-This command is always present and cannot be disabled.
+ SHLL [/] $ exit
+ Shell exiting
-**PROGRAMMING INFORMATION:**
+CONFIGURATION:
+ This command is always present and cannot be disabled.
-The ``exit`` is implemented directly in the shell interpreter. There is no C
-routine associated with it.
+PROGRAMMING INFORMATION:
+ The ``exit`` is implemented directly in the shell interpreter. There is no
+ C routine associated with it.