summaryrefslogtreecommitdiffstats
path: root/shell
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
parented3794ea3926f3e8ee801eae908bb7557cb30637 (diff)
downloadrtems-docs-df773360c902958c0b1b62512dcccd483020f645.tar.bz2
Add links from the command list to the commands.
Diffstat (limited to 'shell')
-rw-r--r--shell/file_and_directory.rst111
-rw-r--r--shell/general_commands.rst76
2 files changed, 140 insertions, 47 deletions
diff --git a/shell/file_and_directory.rst b/shell/file_and_directory.rst
index 05e2952..abf656e 100644
--- a/shell/file_and_directory.rst
+++ b/shell/file_and_directory.rst
@@ -6,59 +6,59 @@ Introduction
The RTEMS shell has the following file and directory commands:
-- ``blksync`` - sync the block driver
+- blksync_ - sync the block driver
-- ``cat`` - display file contents
+- cat_ - display file contents
-- ``cd`` - alias for chdir
+- cd_ - alias for chdir
-- ``chdir`` - change the current directory
+- chdir_ - change the current directory
-- ``chmod`` - change permissions of a file
+- chmod_ - change permissions of a file
-- ``chroot`` - change the root directory
+- chroot_ - change the root directory
-- ``cp`` - copy files
+- cp_ - copy files
-- ``dd`` - format disks
+- dd_ - convert and copy a file
-- ``debugrfs`` - debug RFS file system
+- debugrfs_ - debug RFS file system
-- ``df`` - display file system disk space usage
+- df_ - display file system disk space usage
-- ``dir`` - alias for ls
+- dir_ - alias for ls_
-- ``fdisk`` - format disks
+- fdisk_ - format disks
-- ``hexdump`` - format disks
+- hexdump_ - format disks
-- ``ln`` - make links
+- ln_ - make links
-- ``ls`` - list files in the directory
+- ls_ - list files in the directory
-- ``md5`` - display file system disk space usage
+- md5_ - display file system disk space usage
-- ``mkdir`` - create a directory
+- mkdir_ - create a directory
-- ``mkdos`` - DOSFS disk format
+- mkdos_ - DOSFS disk format
-- ``mknod`` - make device special file
+- mknod_ - make device special file
-- ``mkrfs`` - format RFS file system
+- mkrfs_ - format RFS file system
-- ``mount`` - mount disk
+- mount_ - mount disk
-- ``mv`` - move files
+- mv_ - move files
-- ``pwd`` - print work directory
+- pwd_ - print work directory
-- ``rmdir`` - remove empty directories
+- rmdir_ - remove empty directories
-- ``rm`` - remove files
+- rm_ - remove files
-- ``umask`` - Set file mode creation mask
+- umask_ - Set file mode creation mask
-- ``unmount`` - unmount disk
+- unmount_ - unmount disk
Commands
========
@@ -67,6 +67,8 @@ This section details the File and Directory 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.
+.. _blksync:
+
blksync - sync the block driver
-------------------------------
.. index:: blksync
@@ -132,6 +134,8 @@ The configuration structure for the ``blksync`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_BLKSYNC_Command;
+.. _cat:
+
cat - display file contents
---------------------------
.. index:: cat
@@ -198,6 +202,8 @@ The configuration structure for the ``cat`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_CAT_Command;
+.. _cd:
+
cd - alias for chdir
--------------------
.. index:: cd
@@ -272,6 +278,7 @@ The configuration structure for the ``cd`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_CD_Command;
+.. _chdir:
chdir - change the current directory
------------------------------------
@@ -342,6 +349,8 @@ The configuration structure for the ``chdir`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_CHDIR_Command;
+.. _chmod:
+
chmod - change permissions of a file
------------------------------------
.. index:: chmod
@@ -435,6 +444,8 @@ The configuration structure for the ``chmod`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_CHMOD_Command;
+.. _chroot:
+
chroot - change the root directory
----------------------------------
.. index:: chroot
@@ -510,6 +521,8 @@ The configuration structure for the ``chroot`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_CHROOT_Command;
+.. _cp:
+
cp - copy files
---------------
.. index:: cp
@@ -687,6 +700,8 @@ The configuration structure for the ``cp`` has the following prototype:
The implementation and portions of the documentation for this command are from
NetBSD 4.0.
+.. _dd:
+
dd - convert and copy a file
----------------------------
.. index:: dd
@@ -938,6 +953,8 @@ The configuration structure for the ``dd`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_DD_Command;
+.. _debugrfs:
+
debugrfs - debug RFS file system
--------------------------------
.. index:: debugrfs
@@ -1040,6 +1057,8 @@ The configuration structure for ``debugrfs`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_DEBUGRFS_Command;
+.. _df:
+
df - display file system disk space usage
-----------------------------------------
.. index:: df
@@ -1109,6 +1128,8 @@ The configuration structure for the ``df`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_DF_Command;
+.. _dir:
+
dir - alias for ls
------------------
.. index:: dir
@@ -1182,6 +1203,8 @@ The configuration structure for the ``dir`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_DIR_Command;
+.. _fdisk:
+
fdisk - format disk
-------------------
.. index:: fdisk
@@ -1205,6 +1228,8 @@ This command can be excluded from the shell command set by defining
``CONFIGURE_SHELL_NO_COMMAND_FDISK`` when all shell commands have been
configured.
+.. _hexdump:
+
hexdump - ascii/dec/hex/octal dump
----------------------------------
.. index:: hexdump
@@ -1460,6 +1485,8 @@ The configuration structure for the ``hexdump`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_HEXDUMP_Command;
+.. _ln:
+
ln - make links
---------------
.. index:: ln
@@ -1578,6 +1605,8 @@ The configuration structure for the ``ln`` has the following prototype:
The implementation and portions of the documentation for this command are from
NetBSD 4.0.
+.. _ls:
+
ls - list files in the directory
--------------------------------
.. index:: ls
@@ -1654,6 +1683,8 @@ The configuration structure for the ``ls`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_LS_Command;
+.. _md5:
+
md5 - compute the Md5 hash of a file or list of files
-----------------------------------------------------
.. index:: md5
@@ -1719,6 +1750,8 @@ The configuration structure for the ``md5`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_MD5_Command;
+.. _mkdir:
+
mkdir - create a directory
--------------------------
.. index:: mkdir
@@ -1799,9 +1832,11 @@ The configuration structure for the ``mkdir`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_MKDIR_Command;
-mldos - DOSFS file system format
+.. _mkdos:
+
+mkdos - DOSFS file system format
--------------------------------
-.. index:: pwd
+.. index:: mkdos
**SYNOPSYS:**
@@ -1868,6 +1903,8 @@ The configuration structure for the ``mkdos`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_MKDOS_Command;
+.. _mknod:
+
mknod - make device special file
--------------------------------
.. index:: mknod
@@ -1996,6 +2033,8 @@ The configuration structure for the ``mknod`` has the following prototype:
The implementation and portions of the documentation for this command are from
NetBSD 4.0.
+.. _mkrfs:
+
mkrfs - format RFS file system
------------------------------
.. index:: mkrfs
@@ -2092,6 +2131,8 @@ The configuration structure for ``mkrfs`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_MKRFS_Command;
+.. _mount:
+
mount - mount disk
------------------
.. index:: mount
@@ -2219,6 +2260,8 @@ The configuration structure for the ``mount`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_MOUNT_Command;
+.. _mv:
+
mv - move files
---------------
.. index:: mv
@@ -2327,6 +2370,8 @@ The configuration structure for the ``mv`` has the following prototype:
The implementation and portions of the documentation for this command are from
NetBSD 4.0.
+.. _pwd:
+
pwd - print work directory
--------------------------
.. index:: pwd
@@ -2395,6 +2440,8 @@ The configuration structure for the ``pwd`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_PWD_Command;
+.. _rmdir:
+
rmdir - remove empty directories
--------------------------------
.. index:: rmdir
@@ -2463,6 +2510,8 @@ The configuration structure for the ``rmdir`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_RMDIR_Command;
+.. _rm:
+
rm - remove files
-----------------
.. index:: rm
@@ -2539,6 +2588,8 @@ following prototype:
extern rtems_shell_cmd_t rtems_shell_RM_Command;
+.. _umask:
+
umask - set file mode creation mask
-----------------------------------
.. index:: umask
@@ -2608,6 +2659,8 @@ The configuration structure for the ``umask`` has the following prototype:
extern rtems_shell_cmd_t rtems_shell_UMASK_Command;
+.. _unmount:
+
unmount - unmount disk
----------------------
.. index:: unmount
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