Changeset df77336 in rtems-docs


Ignore:
Timestamp:
Jan 22, 2016, 11:14:42 PM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
fabe6d0
Parents:
ed3794e
git-author:
Chris Johns <chrisj@…> (01/22/16 23:14:42)
git-committer:
Amar Takhar <verm@…> (05/03/16 00:51:25)
Message:

Add links from the command list to the commands.

Location:
shell
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • shell/file_and_directory.rst

    red3794e rdf77336  
    77The RTEMS shell has the following file and directory commands:
    88
    9 - ``blksync`` - sync the block driver
    10 
    11 - ``cat`` - display file contents
    12 
    13 - ``cd`` - alias for chdir
    14 
    15 - ``chdir`` - change the current directory
    16 
    17 - ``chmod`` - change permissions of a file
    18 
    19 - ``chroot`` - change the root directory
    20 
    21 - ``cp`` - copy files
    22 
    23 - ``dd`` - format disks
    24 
    25 - ``debugrfs`` - debug RFS file system
    26 
    27 - ``df`` - display file system disk space usage
    28 
    29 - ``dir`` - alias for ls
    30 
    31 - ``fdisk`` - format disks
    32 
    33 - ``hexdump`` - format disks
    34 
    35 - ``ln`` - make links
    36 
    37 - ``ls`` - list files in the directory
    38 
    39 - ``md5`` - display file system disk space usage
    40 
    41 - ``mkdir`` - create a directory
    42 
    43 - ``mkdos`` - DOSFS disk format
    44 
    45 - ``mknod`` - make device special file
    46 
    47 - ``mkrfs`` - format RFS file system
    48 
    49 - ``mount`` - mount disk
    50 
    51 - ``mv`` - move files
    52 
    53 - ``pwd`` - print work directory
    54 
    55 - ``rmdir`` - remove empty directories
    56 
    57 - ``rm`` - remove files
    58 
    59 - ``umask`` - Set file mode creation mask
    60 
    61 - ``unmount`` - unmount disk
     9- blksync_ - sync the block driver
     10
     11- cat_ - display file contents
     12
     13- cd_ - alias for chdir
     14
     15- chdir_ - change the current directory
     16
     17- chmod_ - change permissions of a file
     18
     19- chroot_ - change the root directory
     20
     21- cp_ - copy files
     22
     23- dd_ - convert and copy a file
     24
     25- debugrfs_ - debug RFS file system
     26
     27- df_ - display file system disk space usage
     28
     29- dir_ - alias for ls_
     30
     31- fdisk_ - format disks
     32
     33- hexdump_ - format disks
     34
     35- ln_ - make links
     36
     37- ls_ - list files in the directory
     38
     39- md5_ - display file system disk space usage
     40
     41- mkdir_ - create a directory
     42
     43- mkdos_ - DOSFS disk format
     44
     45- mknod_ - make device special file
     46
     47- mkrfs_ - format RFS file system
     48
     49- mount_ - mount disk
     50
     51- mv_ - move files
     52
     53- pwd_ - print work directory
     54
     55- rmdir_ - remove empty directories
     56
     57- rm_ - remove files
     58
     59- umask_ - Set file mode creation mask
     60
     61- unmount_ - unmount disk
    6262
    6363Commands
     
    6767is dedicated to each of the commands and describes the behavior and
    6868configuration of that command as well as providing an example usage.
     69
     70.. _blksync:
    6971
    7072blksync - sync the block driver
     
    133135    extern rtems_shell_cmd_t rtems_shell_BLKSYNC_Command;
    134136
     137.. _cat:
     138
    135139cat - display file contents
    136140---------------------------
     
    198202
    199203    extern rtems_shell_cmd_t rtems_shell_CAT_Command;
     204
     205.. _cd:
    200206
    201207cd - alias for chdir
     
    273279    extern rtems_shell_cmd_t rtems_shell_CD_Command;
    274280
     281.. _chdir:
    275282
    276283chdir - change the current directory
     
    342349
    343350    extern rtems_shell_cmd_t rtems_shell_CHDIR_Command;
     351
     352.. _chmod:
    344353
    345354chmod - change permissions of a file
     
    436445    extern rtems_shell_cmd_t rtems_shell_CHMOD_Command;
    437446
     447.. _chroot:
     448
    438449chroot - change the root directory
    439450----------------------------------
     
    510521
    511522    extern rtems_shell_cmd_t rtems_shell_CHROOT_Command;
     523
     524.. _cp:
    512525
    513526cp - copy files
     
    688701NetBSD 4.0.
    689702
     703.. _dd:
     704
    690705dd - convert and copy a file
    691706----------------------------
     
    939954    extern rtems_shell_cmd_t rtems_shell_DD_Command;
    940955
     956.. _debugrfs:
     957
    941958debugrfs - debug RFS file system
    942959--------------------------------
     
    10401057
    10411058    extern rtems_shell_cmd_t rtems_shell_DEBUGRFS_Command;
     1059
     1060.. _df:
    10421061
    10431062df - display file system disk space usage
     
    11091128
    11101129    extern rtems_shell_cmd_t rtems_shell_DF_Command;
     1130
     1131.. _dir:
    11111132
    11121133dir - alias for ls
     
    11831204    extern rtems_shell_cmd_t rtems_shell_DIR_Command;
    11841205
     1206.. _fdisk:
     1207
    11851208fdisk - format disk
    11861209-------------------
     
    12051228``CONFIGURE_SHELL_NO_COMMAND_FDISK`` when all shell commands have been
    12061229configured.
     1230
     1231.. _hexdump:
    12071232
    12081233hexdump - ascii/dec/hex/octal dump
     
    14611486    extern rtems_shell_cmd_t rtems_shell_HEXDUMP_Command;
    14621487
     1488.. _ln:
     1489
    14631490ln - make links
    14641491---------------
     
    15781605The implementation and portions of the documentation for this command are from
    15791606NetBSD 4.0.
     1607
     1608.. _ls:
    15801609
    15811610ls - list files in the directory
     
    16551684    extern rtems_shell_cmd_t rtems_shell_LS_Command;
    16561685
     1686.. _md5:
     1687
    16571688md5 - compute the Md5 hash of a file or list of files
    16581689-----------------------------------------------------
     
    17191750
    17201751    extern rtems_shell_cmd_t rtems_shell_MD5_Command;
     1752
     1753.. _mkdir:
    17211754
    17221755mkdir - create a directory
     
    18001833    extern rtems_shell_cmd_t rtems_shell_MKDIR_Command;
    18011834
    1802 mldos - DOSFS file system format
     1835.. _mkdos:
     1836
     1837mkdos - DOSFS file system format
    18031838--------------------------------
    1804 .. index:: pwd
     1839.. index:: mkdos
    18051840
    18061841**SYNOPSYS:**
     
    18681903
    18691904    extern rtems_shell_cmd_t rtems_shell_MKDOS_Command;
     1905
     1906.. _mknod:
    18701907
    18711908mknod - make device special file
     
    19972034NetBSD 4.0.
    19982035
     2036.. _mkrfs:
     2037
    19992038mkrfs - format RFS file system
    20002039------------------------------
     
    20922131
    20932132    extern rtems_shell_cmd_t rtems_shell_MKRFS_Command;
     2133
     2134.. _mount:
    20942135
    20952136mount - mount disk
     
    22202261    extern rtems_shell_cmd_t rtems_shell_MOUNT_Command;
    22212262
     2263.. _mv:
     2264
    22222265mv - move files
    22232266---------------
     
    23282371NetBSD 4.0.
    23292372
     2373.. _pwd:
     2374
    23302375pwd - print work directory
    23312376--------------------------
     
    23962441    extern rtems_shell_cmd_t rtems_shell_PWD_Command;
    23972442
     2443.. _rmdir:
     2444
    23982445rmdir - remove empty directories
    23992446--------------------------------
     
    24632510
    24642511    extern rtems_shell_cmd_t rtems_shell_RMDIR_Command;
     2512
     2513.. _rm:
    24652514
    24662515rm - remove files
     
    25402589    extern rtems_shell_cmd_t rtems_shell_RM_Command;
    25412590
     2591.. _umask:
     2592
    25422593umask - set file mode creation mask
    25432594-----------------------------------
     
    26092660    extern rtems_shell_cmd_t rtems_shell_UMASK_Command;
    26102661
     2662.. _unmount:
     2663
    26112664unmount - unmount disk
    26122665----------------------
  • shell/general_commands.rst

    red3794e rdf77336  
     1.. COMMENT: COPYRIGHT (c) 1988-2008.
     2.. COMMENT: On-Line Applications Research Corporation (OAR).
     3.. COMMENT: All rights reserved.
     4
    15General Commands
    26################
     
    711The RTEMS shell has the following general commands:
    812
    9 - ``help`` - Print command help
    10 
    11 - ``alias`` - Add alias for an existing command
    12 
    13 - ``cmdls`` - List commands
    14 
    15 - ``cmdchown`` - Change user or owner of commands
    16 
    17 - ``cmdchmod`` - Change mode of commands
    18 
    19 - ``date`` - Print or set current date and time
    20 
    21 - ``echo`` - Produce message in a shell script
    22 
    23 - ``sleep`` - Delay for a specified amount of time
    24 
    25 - ``id`` - show uid gid euid and egid
    26 
    27 - ``tty`` - show ttyname
    28 
    29 - ``whoami`` - print effective user id
    30 
    31 - ``getenv`` - print environment variable
    32 
    33 - ``setenv`` - set environment variable
    34 
    35 - ``unsetenv`` - unset environment variable
    36 
    37 - ``time`` - time command execution
    38 
    39 - ``logoff`` - logoff from the system
    40 
    41 - ``rtc`` - RTC driver configuration
    42 
    43 - ``exit`` - alias for logoff command
     13- help_ - Print command help
     14
     15- alias_ - Add alias for an existing command
     16
     17- cmdls_ - List commands
     18
     19- cmdchown_ - Change user or owner of commands
     20
     21- cmdchmod_ - Change mode of commands
     22
     23- date_ - Print or set current date and time
     24
     25- echo_ - Produce message in a shell script
     26
     27- sleep_ - Delay for a specified amount of time
     28
     29- id_ - show uid gid euid and egid
     30
     31- tty_ - show ttyname
     32
     33- whoami_ - print effective user id
     34
     35- getenv_ - print environment variable
     36
     37- setenv_ - set environment variable
     38
     39- unsetenv_ - unset environment variable
     40
     41- time_ - time command execution
     42
     43- logoff_ - logoff from the system
     44
     45- rtc_ - RTC driver configuration
     46
     47- exit_ - alias for logoff command
    4448
    4549Commands
     
    4953to each of the commands and describes the behavior and configuration of that
    5054command as well as providing an example usage.
     55
     56.. _help:
    5157
    5258help - Print command help
     
    127133This command has no configuration.
    128134
     135.. _alias:
     136
    129137alias - add alias for an existing command
    130138-----------------------------------------
     
    196204    extern rtems_shell_cmd_t rtems_shell_ALIAS_Command;
    197205
     206.. _cmdls:
     207
    198208cmdls - List commands
    199209---------------------
     
    248258
    249259    extern rtems_shell_cmd_t rtems_shell_CMDLS_Command;
     260
     261.. _cmdchown:
    250262
    251263cmdchown - Change user or owner of commands
     
    305317    extern rtems_shell_cmd_t rtems_shell_CMDCHOWN_Command;
    306318
     319.. _cmdchmod:
     320
    307321cmdchmod - Change mode of commands
    308322----------------------------------
     
    361375    extern rtems_shell_cmd_t rtems_shell_CMDCHMOD_Command;
    362376
     377.. _date:
     378
    363379date - print or set current date and time
    364380-----------------------------------------
     
    433449
    434450    extern rtems_shell_cmd_t rtems_shell_DATE_Command;
     451
     452.. _echo:
    435453
    436454echo - produce message in a shell script
     
    546564NetBSD 4.0.
    547565
     566.. _sleep:
     567
    548568sleep - delay for a specified amount of time
    549569--------------------------------------------
     
    621641    extern rtems_shell_cmd_t rtems_shell_SLEEP_Command;
    622642
     643.. _id:
     644
    623645id - show uid gid euid and egid
    624646-------------------------------
     
    696718    extern rtems_shell_cmd_t rtems_shell_ID_Command;
    697719
     720.. _tty:
     721
    698722tty - show ttyname
    699723------------------
     
    760784    extern rtems_shell_cmd_t rtems_shell_TTY_Command;
    761785
     786.. _whoami:
     787
    762788whoami - print effective user id
    763789--------------------------------
     
    825851    extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command;
    826852
     853.. _getenv:
     854
    827855getenv - print environment variable
    828856-----------------------------------
     
    890918    extern rtems_shell_cmd_t rtems_shell_GETENV_Command;
    891919
     920.. _setenv:
     921
    892922setenv - set environment variable
    893923---------------------------------
     
    956986    extern rtems_shell_cmd_t rtems_shell_SETENV_Command;
    957987
     988.. _unsetenv:
     989
    958990unsetenv - unset environment variable
    959991-------------------------------------
     
    10191051    extern rtems_shell_cmd_t rtems_shell_UNSETENV_Command;
    10201052
     1053.. _time:
     1054
    10211055time - time command execution
    10221056-----------------------------
     
    10831117    extern rtems_shell_cmd_t rtems_shell_TIME_Command;
    10841118
     1119.. _logoff:
     1120
    10851121logoff - logoff from the system
    10861122-------------------------------
     
    11501186    extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command;
    11511187
     1188.. _rtc:
     1189
    11521190rtc - RTC driver configuration
    11531191------------------------------
     
    11731211configured.
    11741212
     1213.. _exit:
     1214
    11751215exit - exit the shell
    11761216---------------------
Note: See TracChangeset for help on using the changeset viewer.