rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-25 06:23:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

shell: Fix code-block warnings.

Browse Source
This commit is contained in:
Chris Johns 2016-10-29 04:56:11 +11:00
parent 53d00e6a43
commit 2592441410
5 changed files with 293 additions and 294 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

222
shell/file_and_directory.rst
View File

@ -81,7 +81,7 @@ blksync - sync the block driver
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
blksync driver blksync driver
@ -103,7 +103,7 @@ None.
The following is an example of how to use ``blksync``: The following is an example of how to use ``blksync``:
.. code:: c .. code-block:: c
blksync /dev/hda1 blksync /dev/hda1
@ -127,7 +127,7 @@ configured.
The ``blksync`` is implemented by a C language function The ``blksync`` is implemented by a C language function
which has the following prototype: which has the following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_blksync( int rtems_shell_rtems_main_blksync(
int argc, int argc,
@ -136,7 +136,7 @@ which has the following prototype:
The configuration structure for the ``blksync`` has the following prototype: The configuration structure for the ``blksync`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_BLKSYNC_Command; extern rtems_shell_cmd_t rtems_shell_BLKSYNC_Command;
@ -148,7 +148,7 @@ cat - display file contents
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
cat file1 [file2 .. fileN] cat file1 [file2 .. fileN]
@ -168,7 +168,7 @@ It is possible to read the input from a device file using ``cat``.
The following is an example of how to use ``cat``: The following is an example of how to use ``cat``:
.. code:: shell .. code-block:: shell
SHLL [/] # cat /etc/passwd SHLL [/] # cat /etc/passwd
root:*:0:0:root::/:/bin/sh root:*:0:0:root::/:/bin/sh
@ -195,7 +195,7 @@ configured.
The ``cat`` is implemented by a C language function which has the following The ``cat`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_cat( int rtems_shell_rtems_main_cat(
int argc, int argc,
@ -204,7 +204,7 @@ prototype:
The configuration structure for the ``cat`` has the following prototype: The configuration structure for the ``cat`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CAT_Command; extern rtems_shell_cmd_t rtems_shell_CAT_Command;
@ -216,7 +216,7 @@ cd - alias for chdir
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
cd directory cd directory
@ -237,7 +237,7 @@ None.
The following is an example of how to use ``cd``: The following is an example of how to use ``cd``:
.. code:: shell .. code-block:: shell
SHLL [/] $ cd etc SHLL [/] $ cd etc
SHLL [/etc] $ cd / SHLL [/etc] $ cd /
@ -271,7 +271,7 @@ This command can be excluded from the shell command set by defining
The ``cd`` is implemented by a C language function which has the following The ``cd`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_cd( int rtems_shell_rtems_main_cd(
int argc, int argc,
@ -280,7 +280,7 @@ prototype:
The configuration structure for the ``cd`` has the following prototype: The configuration structure for the ``cd`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CD_Command; extern rtems_shell_cmd_t rtems_shell_CD_Command;
@ -292,7 +292,7 @@ chdir - change the current directory
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
chdir [dir] chdir [dir]
@ -314,7 +314,7 @@ None.
The following is an example of how to use ``chdir``: The following is an example of how to use ``chdir``:
.. code:: shell .. code-block:: shell
SHLL [/] $ pwd SHLL [/] $ pwd
/ /
@ -342,7 +342,7 @@ configured.
The ``chdir`` is implemented by a C language function which has the following The ``chdir`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_chdir( int rtems_shell_rtems_main_chdir(
int argc, int argc,
@ -351,7 +351,7 @@ prototype:
The configuration structure for the ``chdir`` has the following prototype: The configuration structure for the ``chdir`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CHDIR_Command; extern rtems_shell_cmd_t rtems_shell_CHDIR_Command;
@ -363,7 +363,7 @@ chmod - change permissions of a file
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
chmod permissions file1 [file2...] chmod permissions file1 [file2...]
@ -386,7 +386,7 @@ the permissions.
The following is an example of how to use ``chmod``: The following is an example of how to use ``chmod``:
.. code:: shell .. code-block:: shell
SHLL [/] # cd etc SHLL [/] # cd etc
SHLL [/etc] # ls SHLL [/etc] # ls
@ -437,7 +437,7 @@ configured.
The ``chmod`` is implemented by a C language function which has the following The ``chmod`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_chmod( int rtems_shell_rtems_main_chmod(
int argc, int argc,
@ -446,7 +446,7 @@ prototype:
The configuration structure for the ``chmod`` has the following prototype: The configuration structure for the ``chmod`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CHMOD_Command; extern rtems_shell_cmd_t rtems_shell_CHMOD_Command;
@ -458,7 +458,7 @@ chroot - change the root directory
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
chroot [dir] chroot [dir]
@ -481,7 +481,7 @@ None.
The following is an example of how to use ``chroot`` and the impact it has on The following is an example of how to use ``chroot`` and the impact it has on
the environment for subsequent command invocations: the environment for subsequent command invocations:
.. code:: c .. code-block:: shell
SHLL [/] $ cat passwd SHLL [/] $ cat passwd
cat: passwd: No such file or directory cat: passwd: No such file or directory
@ -514,7 +514,7 @@ configured.
The ``chroot`` is implemented by a C language function which has the following The ``chroot`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_chroot( int rtems_shell_rtems_main_chroot(
int argc, int argc,
@ -523,7 +523,7 @@ prototype:
The configuration structure for the ``chroot`` has the following prototype: The configuration structure for the ``chroot`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CHROOT_Command; extern rtems_shell_cmd_t rtems_shell_CHROOT_Command;
@ -535,7 +535,7 @@ cp - copy files
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
cp [-R [-H | -L | -P]] [-f | -i] [-pv] src target cp [-R [-H | -L | -P]] [-f | -i] [-pv] src target
cp [-R [-H | -L] ] [-f | -i] [-NpPv] source_file ... target_directory cp [-R [-H | -L] ] [-f | -i] [-NpPv] source_file ... target_directory
@ -634,7 +634,7 @@ NONE
The following is an example of how to use ``cp`` to copy a file to a new name The following is an example of how to use ``cp`` to copy a file to a new name
in the current directory: in the current directory:
.. code:: shell .. code-block:: shell
SHLL [/] # cat joel SHLL [/] # cat joel
cat: joel: No such file or directory cat: joel: No such file or directory
@ -653,7 +653,7 @@ The following is an example of how to use ``cp`` to
copy one or more files to a destination directory and copy one or more files to a destination directory and
use the same ``basename`` in the destination directory: use the same ``basename`` in the destination directory:
.. code:: shell .. code-block:: shell
SHLL [/] # mkdir tmp SHLL [/] # mkdir tmp
SHLL [/] # ls tmp SHLL [/] # ls tmp
@ -688,7 +688,7 @@ This command can be excluded from the shell command set by defining
The ``cp`` command is implemented by a C language function which The ``cp`` command is implemented by a C language function which
has the following prototype: has the following prototype:
.. code:: c .. code-block:: c
int rtems_shell_main_cp( int rtems_shell_main_cp(
int argc, int argc,
@ -697,7 +697,7 @@ has the following prototype:
The configuration structure for the ``cp`` has the following prototype: The configuration structure for the ``cp`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CP_Command; extern rtems_shell_cmd_t rtems_shell_CP_Command;
@ -714,7 +714,7 @@ dd - convert and copy a file
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
dd [operands ...] dd [operands ...]
@ -922,7 +922,7 @@ NONE
The following is an example of how to use ``dd``: The following is an example of how to use ``dd``:
.. code:: shell .. code-block:: shell
SHLL [/] $ dd if=/nfs/boot-image of=/dev/hda1 SHLL [/] $ dd if=/nfs/boot-image of=/dev/hda1
@ -946,7 +946,7 @@ configured.
The ``dd`` command is implemented by a C language function which has the The ``dd`` command is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_dd( int rtems_shell_rtems_main_dd(
int argc, int argc,
@ -955,7 +955,7 @@ following prototype:
The configuration structure for the ``dd`` has the following prototype: The configuration structure for the ``dd`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_DD_Command; extern rtems_shell_cmd_t rtems_shell_DD_Command;
@ -967,7 +967,7 @@ debugrfs - debug RFS file system
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
debugrfs [-hl] path command [options] debugrfs [-hl] path command [options]
@ -1026,7 +1026,7 @@ NONE
The following is an example of how to use ``debugrfs``: The following is an example of how to use ``debugrfs``:
.. code:: shell .. code-block:: shell
SHLL [/] $ debugrfs /c data SHLL [/] $ debugrfs /c data
@ -1050,7 +1050,7 @@ configured.
The ``debugrfs`` command is implemented by a C language function which The ``debugrfs`` command is implemented by a C language function which
has the following prototype: has the following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_debugrfs( int rtems_shell_rtems_main_debugrfs(
int argc, int argc,
@ -1059,7 +1059,7 @@ has the following prototype:
The configuration structure for ``debugrfs`` has the following prototype: The configuration structure for ``debugrfs`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_DEBUGRFS_Command; extern rtems_shell_cmd_t rtems_shell_DEBUGRFS_Command;
@ -1071,7 +1071,7 @@ df - display file system disk space usage
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
df [-h] [-B block_size] df [-h] [-B block_size]
@ -1091,7 +1091,7 @@ NONE
The following is an example of how to use ``df``: The following is an example of how to use ``df``:
.. code:: c .. code-block:: shell
SHLL [/] $ df -B 4K SHLL [/] $ df -B 4K
Filesystem 4K-blocks Used Available Use% Mounted on Filesystem 4K-blocks Used Available Use% Mounted on
@ -1122,7 +1122,7 @@ This command can be excluded from the shell command set by defining
The ``df`` is implemented by a C language function which has the following The ``df`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_main_df( int rtems_shell_main_df(
int argc, int argc,
@ -1131,7 +1131,7 @@ prototype:
The configuration structure for the ``df`` has the following prototype: The configuration structure for the ``df`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_DF_Command; extern rtems_shell_cmd_t rtems_shell_DF_Command;
@ -1143,7 +1143,7 @@ dir - alias for ls
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
dir [dir] dir [dir]
@ -1164,7 +1164,7 @@ NONE
The following is an example of how to use ``dir``: The following is an example of how to use ``dir``:
.. code:: shell .. code-block:: shell
SHLL [/] $ dir SHLL [/] $ dir
drwxr-xr-x 1 root root 536 Jan 01 00:00 dev/ drwxr-xr-x 1 root root 536 Jan 01 00:00 dev/
@ -1197,7 +1197,7 @@ configured.
The ``dir`` is implemented by a C language function The ``dir`` is implemented by a C language function
which has the following prototype: which has the following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_dir( int rtems_shell_rtems_main_dir(
int argc, int argc,
@ -1206,7 +1206,7 @@ which has the following prototype:
The configuration structure for the ``dir`` has the following prototype: The configuration structure for the ``dir`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_DIR_Command; extern rtems_shell_cmd_t rtems_shell_DIR_Command;
@ -1218,7 +1218,7 @@ fdisk - format disk
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
fdisk fdisk
@ -1243,7 +1243,7 @@ hexdump - ascii/dec/hex/octal dump
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
hexdump [-bcCdovx] [-e format_string] [-f format_file] [-n length] [-s skip] file ... hexdump [-bcCdovx] [-e format_string] [-f format_file] [-n length] [-s skip] file ...
@ -1455,7 +1455,7 @@ NONE
The following is an example of how to use ``hexdump``: The following is an example of how to use ``hexdump``:
.. code:: shell .. code-block:: shell
SHLL [/] $ hexdump -C -n 512 /dev/hda1 SHLL [/] $ hexdump -C -n 512 /dev/hda1
@ -1479,7 +1479,7 @@ been configured.
The ``hexdump`` command is implemented by a C language function which has the The ``hexdump`` command is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_hexdump( int rtems_shell_rtems_main_hexdump(
int argc, int argc,
@ -1488,7 +1488,7 @@ following prototype:
The configuration structure for the ``hexdump`` has the following prototype: The configuration structure for the ``hexdump`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_HEXDUMP_Command; extern rtems_shell_cmd_t rtems_shell_HEXDUMP_Command;
@ -1500,7 +1500,7 @@ ln - make links
**SYNOPSYS:** **SYNOPSYS:**
.. code:: c .. code-block:: c
ln [-fhinsv] source_file [target_file] ln [-fhinsv] source_file [target_file]
ln [-fhinsv] source_file ... target_dir ln [-fhinsv] source_file ... target_dir
@ -1571,7 +1571,7 @@ None.
**EXAMPLES:** **EXAMPLES:**
.. code:: shell .. code-block:: shell
SHLL [/] ln -s /dev/console /dev/con1 SHLL [/] ln -s /dev/console /dev/con1
@ -1594,7 +1594,7 @@ This command can be excluded from the shell command set by defining
The ``ln`` command is implemented by a C language function which has the The ``ln`` command is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_ln( int rtems_shell_rtems_main_ln(
int argc, int argc,
@ -1603,7 +1603,7 @@ following prototype:
The configuration structure for the ``ln`` has the following prototype: The configuration structure for the ``ln`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_LN_Command; extern rtems_shell_cmd_t rtems_shell_LN_Command;
@ -1620,7 +1620,7 @@ ls - list files in the directory
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
ls [dir] ls [dir]
@ -1642,7 +1642,7 @@ POSIX ls(1). It only displays the contents of entire directories.
The following is an example of how to use ``ls``: The following is an example of how to use ``ls``:
.. code:: shell .. code-block:: shell
SHLL [/] $ ls SHLL [/] $ ls
drwxr-xr-x 1 root root 536 Jan 01 00:00 dev/ drwxr-xr-x 1 root root 536 Jan 01 00:00 dev/
@ -1677,7 +1677,7 @@ This command can be excluded from the shell command set by defining
The ``ls`` is implemented by a C language function which has the following The ``ls`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_ls( int rtems_shell_rtems_main_ls(
int argc, int argc,
@ -1686,7 +1686,7 @@ prototype:
The configuration structure for the ``ls`` has the following prototype: The configuration structure for the ``ls`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_LS_Command; extern rtems_shell_cmd_t rtems_shell_LS_Command;
@ -1698,7 +1698,7 @@ md5 - compute the Md5 hash of a file or list of files
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
md5 <files> md5 <files>
@ -1719,7 +1719,7 @@ None.
The following is an example of how to use ``md5``: The following is an example of how to use ``md5``:
.. code:: shell .. code-block:: shell
SHLL [/] $ md5 shell-init SHLL [/] $ md5 shell-init
MD5 (shell-init) = 43b4d2e71b47db79eae679a2efeacf31 MD5 (shell-init) = 43b4d2e71b47db79eae679a2efeacf31
@ -1744,7 +1744,7 @@ configured.
The ``md5`` is implemented by a C language function which has the following The ``md5`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_main_md5( int rtems_shell_main_md5(
int argc, int argc,
@ -1753,7 +1753,7 @@ prototype:
The configuration structure for the ``md5`` has the following prototype: The configuration structure for the ``md5`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MD5_Command; extern rtems_shell_cmd_t rtems_shell_MD5_Command;
@ -1765,7 +1765,7 @@ mkdir - create a directory
**SYNOPSYS:** **SYNOPSYS:**
.. code:: c .. code-block:: c
mkdir dir [dir1 .. dirN] mkdir dir [dir1 .. dirN]
@ -1792,7 +1792,7 @@ not ``rtems``.
The following is an example of how to use ``mkdir``: The following is an example of how to use ``mkdir``:
.. code:: shell .. code-block:: shell
SHLL [/] # ls SHLL [/] # ls
drwxr-xr-x 1 root root 536 Jan 01 00:00 dev/ drwxr-xr-x 1 root root 536 Jan 01 00:00 dev/
@ -1826,7 +1826,7 @@ configured.
The ``mkdir`` is implemented by a C language function which has the following The ``mkdir`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_mkdir( int rtems_shell_rtems_main_mkdir(
int argc, int argc,
@ -1835,7 +1835,7 @@ prototype:
The configuration structure for the ``mkdir`` has the following prototype: The configuration structure for the ``mkdir`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MKDIR_Command; extern rtems_shell_cmd_t rtems_shell_MKDIR_Command;
@ -1847,7 +1847,7 @@ mkdos - DOSFS file system format
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
mkdos [-V label] [-s sectors/cluster] [-r size] [-v] path mkdos [-V label] [-s sectors/cluster] [-r size] [-v] path
@ -1879,7 +1879,7 @@ None.
The following is an example of how to use ``mkdos``: The following is an example of how to use ``mkdos``:
.. code:: shell .. code-block:: shell
SHLL [/] $ mkdos /dev/rda1 SHLL [/] $ mkdos /dev/rda1
@ -1903,7 +1903,7 @@ configured.
The ``mkdos`` is implemented by a C language function which has the following The ``mkdos`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_mkdos( int rtems_shell_rtems_main_mkdos(
int argc, int argc,
@ -1912,7 +1912,7 @@ prototype:
The configuration structure for the ``mkdos`` has the following prototype: The configuration structure for the ``mkdos`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MKDOS_Command; extern rtems_shell_cmd_t rtems_shell_MKDOS_Command;
@ -1924,7 +1924,7 @@ mknod - make device special file
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
mknod [-rR] [-F fmt] [-g gid] [-m mode] [-u uid] name [c | b] [driver | major] minor mknod [-rR] [-F fmt] [-g gid] [-m mode] [-u uid] name [c | b] [driver | major] minor
mknod [-rR] [-F fmt] [-g gid] [-m mode] [-u uid] name [c | b] major unit subunit mknod [-rR] [-F fmt] [-g gid] [-m mode] [-u uid] name [c | b] major unit subunit
@ -2004,7 +2004,7 @@ None.
**EXAMPLES:** **EXAMPLES:**
.. code:: shell .. code-block:: shell
SHLL [/] mknod c 3 0 /dev/ttyS10 SHLL [/] mknod c 3 0 /dev/ttyS10
@ -2028,7 +2028,7 @@ configured.
The ``mknod`` command is implemented by a C language function which has the The ``mknod`` command is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_mknod( int rtems_shell_rtems_main_mknod(
int argc, int argc,
@ -2037,7 +2037,7 @@ following prototype:
The configuration structure for the ``mknod`` has the following prototype: The configuration structure for the ``mknod`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MKNOD_Command; extern rtems_shell_cmd_t rtems_shell_MKNOD_Command;
@ -2054,7 +2054,7 @@ mkrfs - format RFS file system
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
mkrfs [-vsbiIo] device mkrfs [-vsbiIo] device
@ -2107,7 +2107,7 @@ None.
The following is an example of how to use ``mkrfs``: The following is an example of how to use ``mkrfs``:
.. code:: shell .. code-block:: shell
SHLL [/] $ mkrfs /dev/fdda SHLL [/] $ mkrfs /dev/fdda
@ -2131,7 +2131,7 @@ configured.
The ``mkrfs`` command is implemented by a C language function which has the The ``mkrfs`` command is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_mkrfs( int rtems_shell_rtems_main_mkrfs(
int argc, int argc,
@ -2140,7 +2140,7 @@ following prototype:
The configuration structure for ``mkrfs`` has the following prototype: The configuration structure for ``mkrfs`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MKRFS_Command; extern rtems_shell_cmd_t rtems_shell_MKRFS_Command;
@ -2152,7 +2152,7 @@ mount - mount disk
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
mount [-t fstype] [-r] [-L] device path mount [-t fstype] [-r] [-L] device path
@ -2193,24 +2193,24 @@ provided.
Mount the Flash Disk driver to the '/fd' mount point: Mount the Flash Disk driver to the '/fd' mount point:
.. code:: shell .. code-block:: shell
SHLL [/] $ mount -t msdos /dev/flashdisk0 /fd SHLL [/] $ mount -t msdos /dev/flashdisk0 /fd
Mount the NFS file system exported path 'bar' by host 'foo': Mount the NFS file system exported path 'bar' by host 'foo':
.. code:: shell .. code-block:: shell
$ mount -t nfs foo:/bar /nfs $ mount -t nfs foo:/bar /nfs
Mount the TFTP file system on '/tftp': Mount the TFTP file system on '/tftp':
.. code:: shell .. code-block:: shell
$ mount -t tftp /tftp $ mount -t tftp /tftp
To access the TFTP files on server '10.10.10.10': To access the TFTP files on server '10.10.10.10':
.. code:: shell .. code-block:: shell
$ cat /tftp/10.10.10.10/test.txt $ cat /tftp/10.10.10.10/test.txt
@ -2243,7 +2243,7 @@ support for that file-system. The file-system mount command defines are:
An example configuration is: An example configuration is:
.. code:: c .. code-block:: c
#define CONFIGURE_SHELL_MOUNT_MSDOS #define CONFIGURE_SHELL_MOUNT_MSDOS
#ifdef RTEMS_NETWORKING #ifdef RTEMS_NETWORKING
@ -2260,7 +2260,7 @@ An example configuration is:
The ``mount`` is implemented by a C language function which has the following The ``mount`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_mount( int rtems_shell_rtems_main_mount(
int argc, int argc,
@ -2269,7 +2269,7 @@ prototype:
The configuration structure for the ``mount`` has the following prototype: The configuration structure for the ``mount`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MOUNT_Command; extern rtems_shell_cmd_t rtems_shell_MOUNT_Command;
@ -2281,7 +2281,7 @@ mv - move files
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
mv [-fiv] source_file target_file mv [-fiv] source_file target_file
mv [-fiv] source_file... target_file mv [-fiv] source_file... target_file
@ -2326,7 +2326,7 @@ Should the *rename* call fail because source and target are on different file
systems, ``mv`` will remove the destination file, copy the source file to the systems, ``mv`` will remove the destination file, copy the source file to the
destination, and then remove the source. The effect is roughly equivalent to: destination, and then remove the source. The effect is roughly equivalent to:
.. code:: shell .. code-block:: shell
rm -f destination_path && \ rm -f destination_path && \
cp -PRp source_file destination_path && \ cp -PRp source_file destination_path && \
@ -2342,7 +2342,7 @@ None.
**EXAMPLES:** **EXAMPLES:**
.. code:: shell .. code-block:: shell
SHLL [/] mv /dev/console /dev/con1 SHLL [/] mv /dev/console /dev/con1
@ -2365,7 +2365,7 @@ This command can be excluded from the shell command set by defining
The ``mv`` command is implemented by a C language function which has the The ``mv`` command is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_main_mv( int rtems_shell_main_mv(
int argc, int argc,
@ -2374,7 +2374,7 @@ following prototype:
The configuration structure for the ``mv`` has the following prototype: The configuration structure for the ``mv`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MV_Command; extern rtems_shell_cmd_t rtems_shell_MV_Command;
@ -2391,7 +2391,7 @@ pwd - print work directory
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
pwd pwd
@ -2412,7 +2412,7 @@ None.
The following is an example of how to use ``pwd``: The following is an example of how to use ``pwd``:
.. code:: shell .. code-block:: shell
SHLL [/] $ pwd SHLL [/] $ pwd
/ /
@ -2440,7 +2440,7 @@ configured.
The ``pwd`` is implemented by a C language function which has the following The ``pwd`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_pwd( int rtems_shell_rtems_main_pwd(
int argc, int argc,
@ -2449,7 +2449,7 @@ prototype:
The configuration structure for the ``pwd`` has the following prototype: The configuration structure for the ``pwd`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_PWD_Command; extern rtems_shell_cmd_t rtems_shell_PWD_Command;
@ -2461,7 +2461,7 @@ rmdir - remove empty directories
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
rmdir [dir1 .. dirN] rmdir [dir1 .. dirN]
@ -2483,7 +2483,7 @@ reasons that call may fail apply to this command.
The following is an example of how to use ``rmdir``: The following is an example of how to use ``rmdir``:
.. code:: shell .. code-block:: shell
SHLL [/] # mkdir joeldir SHLL [/] # mkdir joeldir
SHLL [/] # rmdir joeldir SHLL [/] # rmdir joeldir
@ -2510,7 +2510,7 @@ configured.
The ``rmdir`` is implemented by a C language function which has the following The ``rmdir`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_rmdir( int rtems_shell_rtems_main_rmdir(
int argc, int argc,
@ -2519,7 +2519,7 @@ prototype:
The configuration structure for the ``rmdir`` has the following prototype: The configuration structure for the ``rmdir`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_RMDIR_Command; extern rtems_shell_cmd_t rtems_shell_RMDIR_Command;
@ -2531,7 +2531,7 @@ rm - remove files
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
rm file1 [file2 ... fileN] rm file1 [file2 ... fileN]
@ -2558,7 +2558,7 @@ None.
The following is an example of how to use ``rm``: The following is an example of how to use ``rm``:
.. code:: c .. code-block:: shell
SHLL [/] # cp /etc/passwd tmpfile SHLL [/] # cp /etc/passwd tmpfile
SHLL [/] # cat tmpfile SHLL [/] # cat tmpfile
@ -2588,7 +2588,7 @@ This command can be excluded from the shell command set by defining
The ``rm`` is implemented by a C language function which has the following The ``rm`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_main_rm( int rtems_shell_main_rm(
int argc, int argc,
@ -2597,7 +2597,7 @@ prototype:
The configuration structure for the ``rm`` has the The configuration structure for the ``rm`` has the
following prototype: following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_RM_Command; extern rtems_shell_cmd_t rtems_shell_RM_Command;
@ -2609,7 +2609,7 @@ umask - set file mode creation mask
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
umask [new_umask] umask [new_umask]
@ -2630,7 +2630,7 @@ This command does not currently support symbolic mode masks.
The following is an example of how to use ``umask``: The following is an example of how to use ``umask``:
.. code:: shell .. code-block:: shell
SHLL [/] $ umask SHLL [/] $ umask
022 022
@ -2659,7 +2659,7 @@ configured.
The ``umask`` is implemented by a C language function which has the following The ``umask`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_umask( int rtems_shell_rtems_main_umask(
int argc, int argc,
@ -2668,7 +2668,7 @@ prototype:
The configuration structure for the ``umask`` has the following prototype: The configuration structure for the ``umask`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_UMASK_Command; extern rtems_shell_cmd_t rtems_shell_UMASK_Command;
@ -2680,7 +2680,7 @@ unmount - unmount disk
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
unmount path unmount path
@ -2700,7 +2700,7 @@ TBD - Surely there must be some warnings to go here.
The following is an example of how to use ``unmount``: The following is an example of how to use ``unmount``:
.. code:: shell .. code-block:: shell
EXAMPLE_TBD EXAMPLE_TBD
@ -2724,7 +2724,7 @@ configured.
The ``unmount`` is implemented by a C language function which has the following The ``unmount`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_unmount( int rtems_shell_rtems_main_unmount(
int argc, int argc,
@ -2733,6 +2733,6 @@ prototype:
The configuration structure for the ``unmount`` has the following prototype: The configuration structure for the ``unmount`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_UNMOUNT_Command; extern rtems_shell_cmd_t rtems_shell_UNMOUNT_Command;

126
shell/general_commands.rst
View File

@ -63,7 +63,7 @@ help - Print command help
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
help misc help misc
@ -87,7 +87,7 @@ is set 0 there will be no break.
The following is an example of how to use ``alias``: The following is an example of how to use ``alias``:
.. code:: shell .. code-block:: shell
SHLL [/] $ help SHLL [/] $ help
help: ('r' repeat last cmd - 'e' edit last cmd) help: ('r' repeat last cmd - 'e' edit last cmd)
@ -142,7 +142,7 @@ alias - add alias for an existing command
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
alias oldCommand newCommand alias oldCommand newCommand
@ -162,7 +162,7 @@ None.
The following is an example of how to use ``alias``: The following is an example of how to use ``alias``:
.. code:: shell .. code-block:: shell
SHLL [/] $ me SHLL [/] $ me
shell:me command not found shell:me command not found
@ -192,7 +192,7 @@ configured.
The ``alias`` is implemented by a C language function which has the following The ``alias`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_alias( int rtems_shell_rtems_main_alias(
int argc, int argc,
@ -201,7 +201,7 @@ prototype:
The configuration structure for the ``alias`` has the following prototype: The configuration structure for the ``alias`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_ALIAS_Command; extern rtems_shell_cmd_t rtems_shell_ALIAS_Command;
@ -213,7 +213,7 @@ cmdls - List commands
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
cmdls COMMAND... cmdls COMMAND...
@ -233,7 +233,7 @@ The current user must have read permission to list a command.
The following is an example of how to use ``cmdls``: The following is an example of how to use ``cmdls``:
.. code:: shell .. code-block:: shell
SHLL [/] # cmdls help shutdown SHLL [/] # cmdls help shutdown
r-xr-xr-x 0 0 help r-xr-xr-x 0 0 help
@ -256,7 +256,7 @@ configured.
The configuration structure for the ``cmdls`` has the following prototype: The configuration structure for the ``cmdls`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CMDLS_Command; extern rtems_shell_cmd_t rtems_shell_CMDLS_Command;
@ -268,7 +268,7 @@ cmdchown - Change user or owner of commands
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
cmdchown [OWNER][:[GROUP]] COMMAND... cmdchown [OWNER][:[GROUP]] COMMAND...
@ -289,7 +289,7 @@ owner or group.
The following is an example of how to use ``cmdchown``: The following is an example of how to use ``cmdchown``:
.. code:: shell .. code-block:: shell
[/] # cmdls help [/] # cmdls help
r-xr-xr-x 0 0 help r-xr-xr-x 0 0 help
@ -314,7 +314,7 @@ configured.
The configuration structure for the ``cmdchown`` has the following prototype: The configuration structure for the ``cmdchown`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CMDCHOWN_Command; extern rtems_shell_cmd_t rtems_shell_CMDCHOWN_Command;
@ -326,7 +326,7 @@ cmdchmod - Change mode of commands
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
cmdchmod OCTAL-MODE COMMAND... cmdchmod OCTAL-MODE COMMAND...
@ -347,7 +347,7 @@ mode.
The following is an example of how to use ``cmdchmod``: The following is an example of how to use ``cmdchmod``:
.. code:: shell .. code-block:: shell
[/] # cmdls help [/] # cmdls help
r-xr-xr-x 0 0 help r-xr-xr-x 0 0 help
@ -372,7 +372,7 @@ configured.
The configuration structure for the ``cmdchmod`` has the following prototype: The configuration structure for the ``cmdchmod`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CMDCHMOD_Command; extern rtems_shell_cmd_t rtems_shell_CMDCHMOD_Command;
@ -384,7 +384,7 @@ date - print or set current date and time
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
date date
date DATE TIME date DATE TIME
@ -410,7 +410,7 @@ None.
The following is an example of how to use ``date``: The following is an example of how to use ``date``:
.. code:: shell .. code-block:: shell
SHLL [/] $ date SHLL [/] $ date
Fri Jan 1 00:00:09 1988 Fri Jan 1 00:00:09 1988
@ -438,7 +438,7 @@ configured.
The ``date`` is implemented by a C language function which has the following The ``date`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_date( int rtems_shell_rtems_main_date(
int argc, int argc,
@ -447,7 +447,7 @@ prototype:
The configuration structure for the ``date`` has the following prototype: The configuration structure for the ``date`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_DATE_Command; extern rtems_shell_cmd_t rtems_shell_DATE_Command;
@ -459,7 +459,7 @@ echo - produce message in a shell script
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
echo [-n | -e] args ... echo [-n | -e] args ...
@ -521,7 +521,7 @@ interpreting them as options and escape sequences.
The following is an example of how to use ``echo``: The following is an example of how to use ``echo``:
.. code:: shell .. code-block:: shell
SHLL [/] $ echo a b c SHLL [/] $ echo a b c
a b c a b c
@ -547,7 +547,7 @@ configured.
The ``echo`` is implemented by a C language function which has the following The ``echo`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_echo( int rtems_shell_rtems_main_echo(
int argc, int argc,
@ -556,7 +556,7 @@ prototype:
The configuration structure for the ``echo`` has the following prototype: The configuration structure for the ``echo`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_ECHO_Command; extern rtems_shell_cmd_t rtems_shell_ECHO_Command;
@ -573,7 +573,7 @@ sleep - delay for a specified amount of time
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
sleep seconds sleep seconds
sleep seconds nanoseconds sleep seconds nanoseconds
@ -599,7 +599,7 @@ delays in shell scripts without adding another command such as ``usleep``.
The following is an example of how to use ``sleep``: The following is an example of how to use ``sleep``:
.. code:: shell .. code-block:: shell
SHLL [/] $ sleep 10 SHLL [/] $ sleep 10
SHLL [/] $ sleep 0 5000000 SHLL [/] $ sleep 0 5000000
@ -629,7 +629,7 @@ configured.
The ``sleep`` is implemented by a C language function which has the following The ``sleep`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_sleep( int rtems_shell_rtems_main_sleep(
int argc, int argc,
@ -638,7 +638,7 @@ prototype:
The configuration structure for the ``sleep`` has the following prototype: The configuration structure for the ``sleep`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_SLEEP_Command; extern rtems_shell_cmd_t rtems_shell_SLEEP_Command;
@ -650,7 +650,7 @@ id - show uid gid euid and egid
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
id id
@ -674,7 +674,7 @@ used by the filesystem to enforce permissions.
The first example of the ``id`` command is from a session logged The first example of the ``id`` command is from a session logged
in as the normal user ``rtems``: in as the normal user ``rtems``:
.. code:: shell .. code-block:: shell
SHLL [/] # id SHLL [/] # id
uid=1(rtems),gid=1(rtems),euid=1(rtems),egid=1(rtems) uid=1(rtems),gid=1(rtems),euid=1(rtems),egid=1(rtems)
@ -682,7 +682,7 @@ in as the normal user ``rtems``:
The second example of the ``id`` command is from a session logged in as the The second example of the ``id`` command is from a session logged in as the
``root`` user: ``root`` user:
.. code:: shell .. code-block:: shell
SHLL [/] # id SHLL [/] # id
uid=0(root),gid=0(root),euid=0(root),egid=0(root) uid=0(root),gid=0(root),euid=0(root),egid=0(root)
@ -706,7 +706,7 @@ This command can be excluded from the shell command set by defining
The ``id`` is implemented by a C language function which has the following The ``id`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_id( int rtems_shell_rtems_main_id(
int argc, int argc,
@ -715,7 +715,7 @@ prototype:
The configuration structure for the ``id`` has the following prototype: The configuration structure for the ``id`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_ID_Command; extern rtems_shell_cmd_t rtems_shell_ID_Command;
@ -727,7 +727,7 @@ tty - show ttyname
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
tty tty
@ -747,7 +747,7 @@ NONE
The following is an example of how to use ``tty``: The following is an example of how to use ``tty``:
.. code:: shell .. code-block:: shell
SHLL [/] $ tty SHLL [/] $ tty
/dev/console /dev/console
@ -772,7 +772,7 @@ configured.
The ``tty`` is implemented by a C language function which has the following The ``tty`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_tty( int rtems_shell_rtems_main_tty(
int argc, int argc,
@ -781,7 +781,7 @@ prototype:
The configuration structure for the ``tty`` has the following prototype: The configuration structure for the ``tty`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_TTY_Command; extern rtems_shell_cmd_t rtems_shell_TTY_Command;
@ -793,7 +793,7 @@ whoami - print effective user id
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
whoami whoami
@ -814,7 +814,7 @@ None.
The following is an example of how to use ``whoami``: The following is an example of how to use ``whoami``:
.. code:: shell .. code-block:: shell
SHLL [/] $ whoami SHLL [/] $ whoami
rtems rtems
@ -839,7 +839,7 @@ configured.
The ``whoami`` is implemented by a C language function which has the following The ``whoami`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_whoami( int rtems_shell_rtems_main_whoami(
int argc, int argc,
@ -848,7 +848,7 @@ prototype:
The configuration structure for the ``whoami`` has the following prototype: The configuration structure for the ``whoami`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command; extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command;
@ -860,7 +860,7 @@ getenv - print environment variable
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
getenv variable getenv variable
@ -881,7 +881,7 @@ The entire RTEMS application shares a single set of environment variables.
The following is an example of how to use ``getenv``: The following is an example of how to use ``getenv``:
.. code:: shell .. code-block:: shell
SHLL [/] $ getenv BASEPATH SHLL [/] $ getenv BASEPATH
/mnt/hda1 /mnt/hda1
@ -906,7 +906,7 @@ configured.
The ``getenv`` is implemented by a C language function which has the following The ``getenv`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_getenv( int rtems_shell_rtems_main_getenv(
int argc, int argc,
@ -915,7 +915,7 @@ prototype:
The configuration structure for the ``getenv`` has the following prototype: The configuration structure for the ``getenv`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_GETENV_Command; extern rtems_shell_cmd_t rtems_shell_GETENV_Command;
@ -927,7 +927,7 @@ setenv - set environment variable
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
setenv variable [value] setenv variable [value]
@ -950,7 +950,7 @@ The entire RTEMS application shares a single set of environment variables.
The following is an example of how to use ``setenv``: The following is an example of how to use ``setenv``:
.. code:: shell .. code-block:: shell
SHLL [/] $ setenv BASEPATH /mnt/hda1 SHLL [/] $ setenv BASEPATH /mnt/hda1
@ -974,7 +974,7 @@ configured.
The ``setenv`` is implemented by a C language function which has the following The ``setenv`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_setenv( int rtems_shell_rtems_main_setenv(
int argc, int argc,
@ -983,7 +983,7 @@ prototype:
The configuration structure for the ``setenv`` has the following prototype: The configuration structure for the ``setenv`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_SETENV_Command; extern rtems_shell_cmd_t rtems_shell_SETENV_Command;
@ -995,7 +995,7 @@ unsetenv - unset environment variable
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
unsetenv variable unsetenv variable
@ -1015,7 +1015,7 @@ The entire RTEMS application shares a single set of environment variables.
The following is an example of how to use ``unsetenv``: The following is an example of how to use ``unsetenv``:
.. code:: shell .. code-block:: shell
SHLL [/] $ unsetenv BASEPATH SHLL [/] $ unsetenv BASEPATH
@ -1039,7 +1039,7 @@ configured.
The ``unsetenv`` is implemented by a C language function which has the The ``unsetenv`` is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_unsetenv( int rtems_shell_rtems_main_unsetenv(
int argc, int argc,
@ -1048,7 +1048,7 @@ following prototype:
The configuration structure for the ``unsetenv`` has the following prototype: The configuration structure for the ``unsetenv`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_UNSETENV_Command; extern rtems_shell_cmd_t rtems_shell_UNSETENV_Command;
@ -1060,7 +1060,7 @@ time - time command execution
**SYNOPSYS:** **SYNOPSYS:**
.. code:: c .. code-block:: c
time command [argument ...] time command [argument ...]
@ -1081,7 +1081,7 @@ None.
The following is an example of how to use ``time``: The following is an example of how to use ``time``:
.. code:: shell .. code-block:: shell
SHLL [/] $ time cp -r /nfs/directory /c SHLL [/] $ time cp -r /nfs/directory /c
@ -1105,7 +1105,7 @@ configured.
The ``time`` is implemented by a C language function which has the following The ``time`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_time( int rtems_shell_rtems_main_time(
int argc, int argc,
@ -1114,7 +1114,7 @@ prototype:
The configuration structure for the ``time`` has the following prototype: The configuration structure for the ``time`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_TIME_Command; extern rtems_shell_cmd_t rtems_shell_TIME_Command;
@ -1126,7 +1126,7 @@ logoff - logoff from the system
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
logoff logoff
@ -1149,7 +1149,7 @@ system.
The following is an example of how to use ``logoff``: The following is an example of how to use ``logoff``:
.. code:: shell .. code-block:: shell
SHLL [/] $ logoff SHLL [/] $ logoff
logoff from the system... logoff from the system...
@ -1174,7 +1174,7 @@ configured.
The ``logoff`` is implemented by a C language function which has the following The ``logoff`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_logoff( int rtems_shell_rtems_main_logoff(
int argc, int argc,
@ -1183,7 +1183,7 @@ prototype:
The configuration structure for the ``logoff`` has the following prototype: The configuration structure for the ``logoff`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command; extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command;
@ -1195,7 +1195,7 @@ rtc - RTC driver configuration
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
rtc rtc
@ -1220,7 +1220,7 @@ exit - exit the shell
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
exit exit
@ -1241,7 +1241,7 @@ the shell interpreter loop.
The following is an example of how to use ``exit``: The following is an example of how to use ``exit``:
.. code:: shell .. code-block:: shell
SHLL [/] $ exit SHLL [/] $ exit
Shell exiting Shell exiting

56
shell/memory_commands.rst
View File

@ -42,7 +42,7 @@ mdump - display contents of memory
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
mdump [address [length [size]]] mdump [address [length [size]]]
@ -73,7 +73,7 @@ program fault.
The following is an example of how to use ``mdump``: The following is an example of how to use ``mdump``:
.. code:: shell .. code-block:: shell
SHLL [/] $ mdump 0x10000 32 SHLL [/] $ mdump 0x10000 32
0x0001000000 00 00 00 00 00 00 00-00 00 00 00 00 00 00 00 ................ 0x0001000000 00 00 00 00 00 00 00-00 00 00 00 00 00 00 00 ................
@ -105,7 +105,7 @@ configured.
The ``mdump`` is implemented by a C language function which has the following The ``mdump`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_mdump( int rtems_shell_rtems_main_mdump(
int argc, int argc,
@ -114,7 +114,7 @@ prototype:
The configuration structure for the ``mdump`` has the following prototype: The configuration structure for the ``mdump`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MDUMP_Command; extern rtems_shell_cmd_t rtems_shell_MDUMP_Command;
@ -126,7 +126,7 @@ wdump - display contents of memory (word)
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
wdump [address [length]] wdump [address [length]]
@ -155,7 +155,7 @@ program fault.
The following is an example of how to use ``wdump``: The following is an example of how to use ``wdump``:
.. code:: shell .. code-block:: shell
SHLL [/] $ wdump 0x02010000 32 SHLL [/] $ wdump 0x02010000 32
0x02010000 0201 08D8 0201 08C0-0201 08AC 0201 0874 ...............t 0x02010000 0201 08D8 0201 08C0-0201 08AC 0201 0874 ...............t
@ -181,7 +181,7 @@ configured.
The ``wdump`` is implemented by a C language function which has the following The ``wdump`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_wdump( int rtems_shell_rtems_main_wdump(
int argc, int argc,
@ -190,7 +190,7 @@ prototype:
The configuration structure for the ``wdump`` has the following prototype: The configuration structure for the ``wdump`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_WDUMP_Command; extern rtems_shell_cmd_t rtems_shell_WDUMP_Command;
@ -202,7 +202,7 @@ ldump - display contents of memory (longword)
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
ldump [address [length]] ldump [address [length]]
@ -231,7 +231,7 @@ program fault.
The following is an example of how to use ``ldump``: The following is an example of how to use ``ldump``:
.. code:: shell .. code-block:: shell
SHLL [/] $ ldump 0x02010000 32 SHLL [/] $ ldump 0x02010000 32
0x02010000 020108D8 020108C0-020108AC 02010874 ...............t 0x02010000 020108D8 020108C0-020108AC 02010874 ...............t
@ -257,7 +257,7 @@ configured.
The ``ldump`` is implemented by a C language function which has the following The ``ldump`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_ldump( int rtems_shell_rtems_main_ldump(
int argc, int argc,
@ -266,7 +266,7 @@ prototype:
The configuration structure for the ``ldump`` has the following prototype: The configuration structure for the ``ldump`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_LDUMP_Command; extern rtems_shell_cmd_t rtems_shell_LDUMP_Command;
@ -278,7 +278,7 @@ medit - modify contents of memory
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
medit address value1 [value2 ... valueN] medit address value1 [value2 ... valueN]
@ -301,7 +301,7 @@ program fault.
The following is an example of how to use ``medit``: The following is an example of how to use ``medit``:
.. code:: shell .. code-block:: shell
SHLL [/] $ mdump 0x02000000 32 SHLL [/] $ mdump 0x02000000 32
0x02000000 A1 48 00 00 29 00 80 33-81 C5 22 BC A6 10 21 00 .H..)..3.."...!. 0x02000000 A1 48 00 00 29 00 80 33-81 C5 22 BC A6 10 21 00 .H..)..3.."...!.
@ -331,7 +331,7 @@ configured.
The ``medit`` is implemented by a C language function which has the following The ``medit`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_medit( int rtems_shell_rtems_main_medit(
int argc, int argc,
@ -340,7 +340,7 @@ prototype:
The configuration structure for the ``medit`` has the following prototype: The configuration structure for the ``medit`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MEDIT_Command; extern rtems_shell_cmd_t rtems_shell_MEDIT_Command;
@ -352,7 +352,7 @@ mfill - file memory with pattern
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
mfill address length value mfill address length value
@ -382,7 +382,7 @@ pattern used as a guard by the Stack Checker. On the first context switch
after the pattern is overwritten by the ``mfill`` command, the Stack Checker after the pattern is overwritten by the ``mfill`` command, the Stack Checker
detect the pattern has been corrupted and generates a fatal error. detect the pattern has been corrupted and generates a fatal error.
.. code:: shell .. code-block:: shell
SHLL [/] $ mdump 0x23d89a0 16 SHLL [/] $ mdump 0x23d89a0 16
0x023D89A0 A5 A5 A5 A5 A5 A5 A5 A5-FE ED F0 0D 0B AD 0D 06 ................ 0x023D89A0 A5 A5 A5 A5 A5 A5 A5 A5-FE ED F0 0D 0B AD 0D 06 ................
@ -411,7 +411,7 @@ configured.
The ``mfill`` is implemented by a C language function which has the following The ``mfill`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_mfill( int rtems_shell_rtems_main_mfill(
int argc, int argc,
@ -421,7 +421,7 @@ prototype:
The configuration structure for the ``mfill`` has the The configuration structure for the ``mfill`` has the
following prototype: following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MFILL_Command; extern rtems_shell_cmd_t rtems_shell_MFILL_Command;
@ -433,7 +433,7 @@ mmove - move contents of memory
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
mmove dst src length mmove dst src length
@ -454,7 +454,7 @@ NONE
The following is an example of how to use ``mmove``: The following is an example of how to use ``mmove``:
.. code:: shell .. code-block:: shell
SHLL [/] $ mdump 0x023d99a0 16 SHLL [/] $ mdump 0x023d99a0 16
0x023D99A0 A5 A5 A5 A5 A5 A5 A5 A5-A5 A5 A5 A5 A5 A5 A5 A5 ................ 0x023D99A0 A5 A5 A5 A5 A5 A5 A5 A5-A5 A5 A5 A5 A5 A5 A5 A5 ................
@ -484,7 +484,7 @@ configured.
The ``mmove`` is implemented by a C language function which has the following The ``mmove`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_mmove( int rtems_shell_rtems_main_mmove(
int argc, int argc,
@ -493,7 +493,7 @@ prototype:
The configuration structure for the ``mmove`` has the following prototype: The configuration structure for the ``mmove`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MMOVE_Command; extern rtems_shell_cmd_t rtems_shell_MMOVE_Command;
@ -505,7 +505,7 @@ malloc - obtain information on C program heap
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
malloc [walk] malloc [walk]
@ -564,7 +564,7 @@ NONE
The following is an example of how to use the ``malloc`` command. The following is an example of how to use the ``malloc`` command.
.. code:: shell .. code-block:: shell
SHLL [/] $ malloc SHLL [/] $ malloc
C Program Heap and RTEMS Workspace are the same. C Program Heap and RTEMS Workspace are the same.
@ -625,7 +625,7 @@ configured.
The ``malloc`` is implemented by a C language function The ``malloc`` is implemented by a C language function
which has the following prototype: which has the following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_malloc( int rtems_shell_rtems_main_malloc(
int argc, int argc,
@ -634,6 +634,6 @@ which has the following prototype:
The configuration structure for the ``malloc`` has the following prototype: The configuration structure for the ``malloc`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_MALLOC_Command; extern rtems_shell_cmd_t rtems_shell_MALLOC_Command;

47
shell/network_commands.rst
View File

@ -35,7 +35,7 @@ netstats - obtain network statistics
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
netstats [-Aimfpcut] netstats [-Aimfpcut]
@ -82,7 +82,7 @@ NONE
The following is an example of using the ``netstats`` command to print the IP The following is an example of using the ``netstats`` command to print the IP
routing table: routing table:
.. code:: shell .. code-block:: shell
[/] $ netstats -i [/] $ netstats -i
Destination Gateway/Mask/Hw Flags Refs Use Expire Interface Destination Gateway/Mask/Hw Flags Refs Use Expire Interface
@ -95,7 +95,7 @@ routing table:
The following is an example of using the ``netstats`` command to print the MBUF The following is an example of using the ``netstats`` command to print the MBUF
statistics: statistics:
.. code:: shell .. code-block:: shell
[/] $ netstats -m [/] $ netstats -m
************ MBUF STATISTICS ************ ************ MBUF STATISTICS ************
@ -109,7 +109,7 @@ statistics:
The following is an example of using the ``netstats`` command to print the The following is an example of using the ``netstats`` command to print the
print the interface statistics: print the interface statistics:
.. code:: shell .. code-block:: shell
[/] $ netstats -f [/] $ netstats -f
************ INTERFACE STATISTICS ************ ************ INTERFACE STATISTICS ************
@ -127,7 +127,7 @@ print the interface statistics:
The following is an example of using the ``netstats`` command to print the The following is an example of using the ``netstats`` command to print the
print IP statistics: print IP statistics:
.. code:: shell .. code-block:: shell
[/] $ netstats -p [/] $ netstats -p
************ IP Statistics ************ ************ IP Statistics ************
@ -139,7 +139,7 @@ print IP statistics:
The following is an example of using the ``netstats`` command to print the ICMP The following is an example of using the ``netstats`` command to print the ICMP
statistics: statistics:
.. code:: shell .. code-block:: shell
[/] $ netstats -c [/] $ netstats -c
************ ICMP Statistics ************ ************ ICMP Statistics ************
@ -150,7 +150,7 @@ statistics:
The following is an example of using the ``netstats`` command to print the UDP The following is an example of using the ``netstats`` command to print the UDP
statistics: statistics:
.. code:: shell .. code-block:: shell
[/] $ netstats -u [/] $ netstats -u
************ UDP Statistics ************ ************ UDP Statistics ************
@ -158,7 +158,7 @@ statistics:
The following is an example of using the ``netstats`` command to print the TCP The following is an example of using the ``netstats`` command to print the TCP
statistics: statistics:
.. code:: shell .. code-block:: shell
[/] $ netstats -t [/] $ netstats -t
************ TCP Statistics ************ ************ TCP Statistics ************
@ -199,7 +199,7 @@ configured.
The ``netstats`` is implemented by a C language function The ``netstats`` is implemented by a C language function
which has the following prototype: which has the following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_netstats( int rtems_shell_rtems_main_netstats(
int argc, int argc,
@ -208,7 +208,7 @@ which has the following prototype:
The configuration structure for the ``netstats`` has the following prototype: The configuration structure for the ``netstats`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_NETSTATS_Command; extern rtems_shell_cmd_t rtems_shell_NETSTATS_Command;
@ -220,7 +220,7 @@ ifconfig - configure a network interface
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
ifconfig ifconfig
ifconfig interface ifconfig interface
@ -245,7 +245,7 @@ complicated. More example usages would be a welcome submission.
The following is an example of how to use ``ifconfig``: The following is an example of how to use ``ifconfig``:
.. code:: shell .. code-block:: shell
************ INTERFACE STATISTICS ************ ************ INTERFACE STATISTICS ************
***** eth1 ***** ***** eth1 *****
@ -279,7 +279,7 @@ configured.
The ``ifconfig`` is implemented by a C language function which has the The ``ifconfig`` is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_ifconfig( int rtems_shell_rtems_main_ifconfig(
int argc, int argc,
@ -288,7 +288,7 @@ following prototype:
The configuration structure for the ``ifconfig`` has the following prototype: The configuration structure for the ``ifconfig`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_IFCONFIG_Command; extern rtems_shell_cmd_t rtems_shell_IFCONFIG_Command;
@ -300,7 +300,7 @@ route - show or manipulate the ip routing table
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
route [subcommand] [args] route [subcommand] [args]
@ -313,7 +313,7 @@ provided to describe the route.
Command templates include the following: Command templates include the following:
.. code:: shell .. code-block:: shell
route [add|del] -net IP_ADDRESS gw GATEWAY_ADDRESS [netmask MASK] route [add|del] -net IP_ADDRESS gw GATEWAY_ADDRESS [netmask MASK]
route [add|del] -host IP_ADDRESS gw GATEWAY_ADDRES [netmask MASK] route [add|del] -host IP_ADDRESS gw GATEWAY_ADDRES [netmask MASK]
@ -334,7 +334,7 @@ complicated. More example usages would be a welcome submission.
The following is an example of how to use ``route`` to display, add, and delete The following is an example of how to use ``route`` to display, add, and delete
a new route: a new route:
.. code:: c .. code-block:: shell
[/] $ route [/] $ route
Destination Gateway/Mask/Hw Flags Refs Use Expire Interface Destination Gateway/Mask/Hw Flags Refs Use Expire Interface
@ -381,7 +381,7 @@ configured.
The ``route`` is implemented by a C language function which has the following The ``route`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_route( int rtems_shell_rtems_main_route(
int argc, int argc,
@ -390,7 +390,7 @@ prototype:
The configuration structure for the ``route`` has the following prototype: The configuration structure for the ``route`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_ROUTE_Command; extern rtems_shell_cmd_t rtems_shell_ROUTE_Command;
@ -402,7 +402,7 @@ ping - ping a host or IP address
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
ping [-AaDdfnoQqRrv] [-c count] [-G sweepmaxsize] [-g sweepminsize] ping [-AaDdfnoQqRrv] [-c count] [-G sweepmaxsize] [-g sweepminsize]
[-h sweepincrsize] [-i wait] [-l preload] [-M mask | time] [-m ttl] [-h sweepincrsize] [-i wait] [-l preload] [-M mask | time] [-m ttl]
@ -601,7 +601,7 @@ are open.
The following is an example of how to use ``oing`` to ping: The following is an example of how to use ``oing`` to ping:
.. code:: shell .. code-block:: shell
[/] # ping 10.10.10.1 [/] # ping 10.10.10.1
PING 10.10.10.1 (10.10.10.1): 56 data bytes PING 10.10.10.1 (10.10.10.1): 56 data bytes
@ -640,7 +640,7 @@ configured.
The ``ping`` is implemented by a C language function which has the following The ``ping`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_ping( int rtems_shell_rtems_main_ping(
int argc, int argc,
@ -649,7 +649,6 @@ prototype:
The configuration structure for the ``ping`` has the following prototype: The configuration structure for the ``ping`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_PING_Command; extern rtems_shell_cmd_t rtems_shell_PING_Command;

136
shell/rtems_specific_commands.rst
View File

@ -64,7 +64,7 @@ shutdown - Shutdown the system
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
shutdown shutdown
@ -82,7 +82,7 @@ This command does not return.
The following is an example of how to use ``shutdown``: The following is an example of how to use ``shutdown``:
.. code:: shell .. code-block:: shell
SHLL [/] $ shutdown SHLL [/] $ shutdown
System shutting down at user request System shutting down at user request
@ -106,7 +106,7 @@ configured.
The configuration structure for the ``shutdown`` has the following prototype: The configuration structure for the ``shutdown`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command; extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command;
@ -118,7 +118,7 @@ cpuuse - print or reset per thread cpu usage
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
cpuuse [-r] cpuuse [-r]
@ -144,7 +144,7 @@ reported is limited by the clock tick quantum.
The following is an example of how to use ``cpuuse``: The following is an example of how to use ``cpuuse``:
.. code:: shell .. code-block:: shell
SHLL [/] $ cpuuse SHLL [/] $ cpuuse
CPU Usage by thread CPU Usage by thread
@ -190,7 +190,7 @@ configured.
The ``cpuuse`` is implemented by a C language function which has the following The ``cpuuse`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_cpuuse( int rtems_shell_rtems_main_cpuuse(
int argc, int argc,
@ -199,7 +199,7 @@ prototype:
The configuration structure for the ``cpuuse`` has the following prototype: The configuration structure for the ``cpuuse`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command; extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
@ -211,7 +211,7 @@ stackuse - print per thread stack usage
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
stackuse stackuse
@ -235,7 +235,7 @@ report.
The following is an example of how to use ``stackuse``: The following is an example of how to use ``stackuse``:
.. code:: shell .. code-block:: shell
SHLL [/] $ stackuse SHLL [/] $ stackuse
Stack usage by thread Stack usage by thread
@ -265,7 +265,7 @@ configured.
The ``stackuse`` is implemented by a C language function which has the The ``stackuse`` is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_stackuse( int rtems_shell_rtems_main_stackuse(
int argc, int argc,
@ -274,7 +274,7 @@ following prototype:
The configuration structure for the ``stackuse`` has the following prototype: The configuration structure for the ``stackuse`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command; extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
@ -286,7 +286,7 @@ perioduse - print or reset per period usage
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
perioduse [-r] perioduse [-r]
@ -313,7 +313,7 @@ reported is limited by the clock tick quantum.
The following is an example of how to use ``perioduse``: The following is an example of how to use ``perioduse``:
.. code:: shell .. code-block:: shell
SHLL [/] $ perioduse SHLL [/] $ perioduse
Period information by period Period information by period
@ -360,7 +360,7 @@ configured.
The ``perioduse`` is implemented by a C language function The ``perioduse`` is implemented by a C language function
which has the following prototype: which has the following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_perioduse( int rtems_shell_rtems_main_perioduse(
int argc, int argc,
@ -369,7 +369,7 @@ which has the following prototype:
The configuration structure for the ``perioduse`` has the following prototype: The configuration structure for the ``perioduse`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command; extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
@ -381,7 +381,7 @@ profreport - print a profiling report
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
profreport profreport
@ -403,7 +403,7 @@ information.
The following is an example of how to use ``profreport``: The following is an example of how to use ``profreport``:
.. code:: shell .. code-block:: shell
SHLL [/] $ profreport SHLL [/] $ profreport
<ProfilingReport name="Shell"> <ProfilingReport name="Shell">
@ -473,7 +473,7 @@ configured.
The configuration structure for the ``profreport`` has the following prototype: The configuration structure for the ``profreport`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_PROFREPORT_Command; extern rtems_shell_cmd_t rtems_shell_PROFREPORT_Command;
@ -485,7 +485,7 @@ wkspace - display information on executive workspace
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
wkspace wkspace
@ -518,7 +518,7 @@ NONE
The following is an example of how to use ``wkspace``: The following is an example of how to use ``wkspace``:
.. code:: shell .. code-block:: shell
SHLL [/] $ wkspace SHLL [/] $ wkspace
Number of free blocks: 1 Number of free blocks: 1
@ -548,7 +548,7 @@ configured.
The ``wkspace`` is implemented by a C language function which has the following The ``wkspace`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_wkspace( int rtems_shell_rtems_main_wkspace(
int argc, int argc,
@ -557,7 +557,7 @@ prototype:
The configuration structure for the ``wkspace`` has the following prototype: The configuration structure for the ``wkspace`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command; extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
@ -569,7 +569,7 @@ config - show the system configuration.
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
config config
@ -591,7 +591,7 @@ appreciated.
The following is an example of how to use ``config``: The following is an example of how to use ``config``:
.. code:: shell .. code-block:: shell
SHLL [/] $ config SHLL [/] $ config
INITIAL (startup) Configuration Info INITIAL (startup) Configuration Info
@ -621,7 +621,7 @@ configured.
The ``config`` is implemented by a C language function which has the following The ``config`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_config( int rtems_shell_rtems_main_config(
int argc, int argc,
@ -630,7 +630,7 @@ prototype:
The configuration structure for the ``config`` has the following prototype: The configuration structure for the ``config`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_CONFIG_Command; extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
@ -642,7 +642,7 @@ itask - list init tasks for the system
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
itask itask
@ -665,7 +665,7 @@ appreciated.
The following is an example of how to use ``itask``: The following is an example of how to use ``itask``:
.. code:: shell .. code-block:: shell
SHLL [/] $ itask SHLL [/] $ itask
# NAME ENTRY ARGUMENT PRIO MODES ATTRIBUTES STACK SIZE # NAME ENTRY ARGUMENT PRIO MODES ATTRIBUTES STACK SIZE
@ -692,7 +692,7 @@ configured.
The ``itask`` is implemented by a C language function which has the following The ``itask`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_itask( int rtems_shell_rtems_main_itask(
int argc, int argc,
@ -701,7 +701,7 @@ prototype:
The configuration structure for the ``itask`` has the following prototype: The configuration structure for the ``itask`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_ITASK_Command; extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
@ -713,7 +713,7 @@ extension - display information about extensions
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
extension [id [id ...]] extension [id [id ...]]
@ -738,7 +738,7 @@ NONE
The following is an example of using the ``extension`` command The following is an example of using the ``extension`` command
on a system with no user extensions. on a system with no user extensions.
.. code:: shell .. code-block:: shell
SHLL [/] $ extension SHLL [/] $ extension
ID NAME ID NAME
@ -764,7 +764,7 @@ configured.
The ``extension`` is implemented by a C language function which has the The ``extension`` is implemented by a C language function which has the
following prototype: following prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_extension( int rtems_shell_rtems_main_extension(
int argc, int argc,
@ -773,7 +773,7 @@ following prototype:
The configuration structure for the ``extension`` has the following prototype: The configuration structure for the ``extension`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command; extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
@ -785,7 +785,7 @@ task - display information about tasks
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
task [id [id ...]] task [id [id ...]]
@ -810,7 +810,7 @@ NONE
The following is an example of how to use the ``task`` on an application with The following is an example of how to use the ``task`` on an application with
just two Classic API tasks: just two Classic API tasks:
.. code:: shell .. code-block:: shell
SHLL [/] $ task SHLL [/] $ task
ID NAME PRIO STAT MODES EVENTS WAITID WAITARG NOTES ID NAME PRIO STAT MODES EVENTS WAITID WAITARG NOTES
@ -838,7 +838,7 @@ configured.
The ``task`` is implemented by a C language function which has the following The ``task`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: shell .. code-block:: shell
int rtems_shell_rtems_main_task( int rtems_shell_rtems_main_task(
int argc, int argc,
@ -847,7 +847,7 @@ prototype:
The configuration structure for the ``task`` has the following prototype: The configuration structure for the ``task`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_TASK_Command; extern rtems_shell_cmd_t rtems_shell_TASK_Command;
@ -859,7 +859,7 @@ queue - display information about message queues
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
queue [id [id ... ]] queue [id [id ... ]]
@ -884,7 +884,7 @@ NONE
The following is an example of using the ``queue`` command on a system with no The following is an example of using the ``queue`` command on a system with no
Classic API Message Queues. Classic API Message Queues.
.. code:: shell .. code-block:: shell
SHLL [/] $ queue SHLL [/] $ queue
ID NAME ATTRIBUTES PEND MAXPEND MAXSIZE ID NAME ATTRIBUTES PEND MAXPEND MAXSIZE
@ -910,7 +910,7 @@ configured.
The ``queue`` is implemented by a C language function which has the following The ``queue`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_queue( int rtems_shell_rtems_main_queue(
int argc, int argc,
@ -919,7 +919,7 @@ prototype:
The configuration structure for the ``queue`` has the following prototype: The configuration structure for the ``queue`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_QUEUE_Command; extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
@ -931,7 +931,7 @@ sema - display information about semaphores
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
sema [id [id ... ]] sema [id [id ... ]]
@ -955,7 +955,7 @@ NONE
The following is an example of how to use ``sema``: The following is an example of how to use ``sema``:
.. code:: shell .. code-block:: shell
SHLL [/] $ sema SHLL [/] $ sema
ID NAME ATTR PRICEIL CURR_CNT HOLDID ID NAME ATTR PRICEIL CURR_CNT HOLDID
@ -989,7 +989,7 @@ configured.
The ``sema`` is implemented by a C language function which has the following The ``sema`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_sema( int rtems_shell_rtems_main_sema(
int argc, int argc,
@ -998,7 +998,7 @@ prototype:
The configuration structure for the ``sema`` has the following prototype: The configuration structure for the ``sema`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_SEMA_Command; extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
@ -1010,7 +1010,7 @@ region - display information about regions
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
region [id [id ... ]] region [id [id ... ]]
@ -1035,7 +1035,7 @@ NONE
The following is an example of using the ``region`` command on a system with no The following is an example of using the ``region`` command on a system with no
user extensions. user extensions.
.. code:: shell .. code-block:: shell
SHLL [/] $ region SHLL [/] $ region
ID NAME ATTR STARTADDR LENGTH PAGE_SIZE USED_BLOCKS ID NAME ATTR STARTADDR LENGTH PAGE_SIZE USED_BLOCKS
@ -1061,7 +1061,7 @@ configured.
The ``region`` is implemented by a C language function which has the following The ``region`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_region( int rtems_shell_rtems_main_region(
int argc, int argc,
@ -1070,7 +1070,7 @@ prototype:
The configuration structure for the ``region`` has the following prototype: The configuration structure for the ``region`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_REGION_Command; extern rtems_shell_cmd_t rtems_shell_REGION_Command;
@ -1082,7 +1082,7 @@ part - display information about partitions
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
part [id [id ... ]] part [id [id ... ]]
@ -1107,7 +1107,7 @@ NONE
The following is an example of using the ``part`` command on a system with no The following is an example of using the ``part`` command on a system with no
user extensions. user extensions.
.. code:: shell .. code-block:: shell
SHLL [/] $ part SHLL [/] $ part
ID NAME ATTR STARTADDR LENGTH BUF_SIZE USED_BLOCKS ID NAME ATTR STARTADDR LENGTH BUF_SIZE USED_BLOCKS
@ -1133,7 +1133,7 @@ configured.
The ``part`` is implemented by a C language function which has the following The ``part`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_part( int rtems_shell_rtems_main_part(
int argc, int argc,
@ -1142,7 +1142,7 @@ prototype:
The configuration structure for the ``part`` has the following prototype: The configuration structure for the ``part`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_PART_Command; extern rtems_shell_cmd_t rtems_shell_PART_Command;
@ -1154,7 +1154,7 @@ object - display information about RTEMS objects
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
object [id [id ...]] object [id [id ...]]
@ -1175,7 +1175,7 @@ NONE
The following is an example of how to use ``object``: The following is an example of how to use ``object``:
.. code:: shell .. code-block:: shell
SHLL [/] $ object 0a010001 1a010002 SHLL [/] $ object 0a010001 1a010002
ID NAME PRIO STAT MODES EVENTS WAITID WAITARG NOTES ID NAME PRIO STAT MODES EVENTS WAITID WAITARG NOTES
@ -1205,7 +1205,7 @@ configured.
The ``object`` is implemented by a C language function which has the following The ``object`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_object( int rtems_shell_rtems_main_object(
int argc, int argc,
@ -1215,7 +1215,7 @@ prototype:
The configuration structure for the ``object`` has the The configuration structure for the ``object`` has the
following prototype: following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_OBJECT_Command; extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
@ -1227,7 +1227,7 @@ driver - display the RTEMS device driver table
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
driver [major [major ...]] driver [major [major ...]]
@ -1251,7 +1251,7 @@ NONE
The following is an example of how to use ``driver``: The following is an example of how to use ``driver``:
.. code:: shell .. code-block:: shell
SHLL [/] $ driver SHLL [/] $ driver
Major Entry points Major Entry points
@ -1284,7 +1284,7 @@ configured.
The ``driver`` is implemented by a C language function which has the following The ``driver`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_driver( int rtems_shell_rtems_main_driver(
int argc, int argc,
@ -1293,7 +1293,7 @@ prototype:
The configuration structure for the ``driver`` has the following prototype: The configuration structure for the ``driver`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_DRIVER_Command; extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
@ -1305,7 +1305,7 @@ dname - displays information about named drivers
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
dname dname
@ -1325,7 +1325,7 @@ NONE
The following is an example of how to use ``dname``: The following is an example of how to use ``dname``:
.. code:: shell .. code-block:: shell
EXAMPLE_TBD EXAMPLE_TBD
@ -1349,7 +1349,7 @@ configured.
The ``dname`` is implemented by a C language function which has the following The ``dname`` is implemented by a C language function which has the following
prototype: prototype:
.. code:: c .. code-block:: c
int rtems_shell_rtems_main_dname( int rtems_shell_rtems_main_dname(
int argc, int argc,
@ -1358,7 +1358,7 @@ prototype:
The configuration structure for the ``dname`` has the following prototype: The configuration structure for the ``dname`` has the following prototype:
.. code:: c .. code-block:: c
extern rtems_shell_cmd_t rtems_shell_DNAME_Command; extern rtems_shell_cmd_t rtems_shell_DNAME_Command;
@ -1370,7 +1370,7 @@ pthread - display information about POSIX threads
**SYNOPSYS:** **SYNOPSYS:**
.. code:: shell .. code-block:: shell
pthread [id [id ...]] pthread [id [id ...]]
@ -1395,7 +1395,7 @@ This command is only available when the POSIX API is configured.
The following is an example of how to use the ``task`` on an application with The following is an example of how to use the ``task`` on an application with
four POSIX threads: four POSIX threads:
.. code:: shell .. code-block:: shell
SHLL [/] $ pthread SHLL [/] $ pthread
ID NAME PRI STATE MODES EVENTS WAITID WAITARG NOTES ID NAME PRI STATE MODES EVENTS WAITID WAITARG NOTES