Changeset dc1c4308 in rtems


Ignore:
Timestamp:
Feb 21, 2008, 11:56:30 PM (12 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.9, master
Children:
3f4dce3
Parents:
ea08043
Message:

2008-02-21 Joel Sherrill <joel.sherrill@…>

  • shell/file.t, shell/general.t, shell/memory.t, shell/network.t, shell/rtems.t: More descriptions and examples added.
Location:
doc
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    rea08043 rdc1c4308  
     12008-02-21      Joel Sherrill <joel.sherrill@oarcorp.com>
     2
     3        * shell/file.t, shell/general.t, shell/memory.t, shell/network.t,
     4        shell/rtems.t: More descriptions and examples added.
     5
    162008-02-21      Joel Sherrill <joel.sherrill@oarcorp.com>
    27
  • doc/shell/file.t

    rea08043 rdc1c4308  
    5353@subheading DESCRIPTION:
    5454
    55 This command XXX
    56 
    57 @subheading EXIT STATUS:
    58 
    59 This command returns 0 on success and non-zero if an error is encountered.
    60 
    61 @subheading NOTES:
    62 
    63 NONE
    64 
    65 @subheading EXAMPLES:
    66 
    67 The following is an example of how to use umask:
    68 
    69 @example
    70 EXAMPLE_TBD
     55This command sets the user file creation mask to @code{new_umask}.  The
     56argument @code{new_umask} may be octal, hexadecimal, or decimal.
     57
     58@subheading EXIT STATUS:
     59
     60This command returns 0 on success and non-zero if an error is encountered.
     61
     62@subheading NOTES:
     63
     64This command does not currently support symbolic mode masks.
     65
     66@subheading EXAMPLES:
     67
     68The following is an example of how to use @code{umask}:
     69
     70@example
     71SHLL [/] $ umask
     72022
     73SHLL [/] $ umask 0666
     740666
     75SHLL [/] $ umask
     760666
    7177@end example
    7278
     
    8995@findex rtems_shell_rtems_main_umask
    9096
    91 The @code{COMMAND} is implemented by a C language function
     97The @code{umask} is implemented by a C language function
    9298which has the following prototype:
    9399
     
    99105@end example
    100106
    101 The configuration structure for the @code{COMMAND} has the
     107The configuration structure for the @code{umask} has the
    102108following prototype:
    103109
     
    227233@subheading EXAMPLES:
    228234
    229 The following is an example of how to use cp:
     235The following is an example of how to use @code{cp}:
    230236
    231237@example
     
    251257@findex rtems_shell_rtems_main_cp
    252258
    253 The @code{COMMAND} is implemented by a C language function
     259The @code{cp} is implemented by a C language function
    254260which has the following prototype:
    255261
     
    261267@end example
    262268
    263 The configuration structure for the @code{COMMAND} has the
     269The configuration structure for the @code{cp} has the
    264270following prototype:
    265271
     
    289295@subheading DESCRIPTION:
    290296
    291 This command XXX
     297This command prints the fully qualified filename of the current
     298working directory.
    292299
    293300@subheading EXIT STATUS:
     
    301308@subheading EXAMPLES:
    302309
    303 The following is an example of how to use pwd:
    304 
    305 @example
    306 EXAMPLE_TBD
     310The following is an example of how to use @code{pwd}:
     311
     312@example
     313SHLL [/] $ pwd
     314/
     315SHLL [/] $ cd dev
     316SHLL [/dev] $ pwd
     317/dev
    307318@end example
    308319
     
    325336@findex rtems_shell_rtems_main_pwd
    326337
    327 The @code{COMMAND} is implemented by a C language function
     338The @code{pwd} is implemented by a C language function
    328339which has the following prototype:
    329340
     
    335346@end example
    336347
    337 The configuration structure for the @code{COMMAND} has the
     348The configuration structure for the @code{pwd} has the
    338349following prototype:
    339350
     
    358369@subheading DESCRIPTION:
    359370
    360 This command XXX
     371This command displays the contents of the specified directory.  If
     372no arguments are given, then it displays the contents of the current
     373working directory.
    361374
    362375@subheading EXIT STATUS:
     
    370383@subheading EXAMPLES:
    371384
    372 The following is an example of how to use ls:
    373 
    374 @example
    375 EXAMPLE_TBD
     385The following is an example of how to use @code{ls}:
     386
     387@example
     388SHLL [/] $ ls
     389drwxr-xr-x   1   root   root         536 Jan 01 00:00 dev/
     390drwxr-xr-x   1   root   root        1072 Jan 01 00:00 etc/
     3912 files 1608 bytes occupied
     392SHLL [/] $ ls etc
     393-rw-r--r--   1   root   root         102 Jan 01 00:00 passwd
     394-rw-r--r--   1   root   root          42 Jan 01 00:00 group
     395-rw-r--r--   1   root   root          30 Jan 01 00:00 issue
     396-rw-r--r--   1   root   root          28 Jan 01 00:00 issue.net
     3974 files 202 bytes occupied
     398SHLL [/] $ ls dev etc
     399-rwxr-xr-x   1  rtems   root           0 Jan 01 00:00 console
     400-rwxr-xr-x   1   root   root           0 Jan 01 00:00 console_b
    376401@end example
    377402
     
    394419@findex rtems_shell_rtems_main_ls
    395420
    396 The @code{COMMAND} is implemented by a C language function
     421The @code{ls} is implemented by a C language function
    397422which has the following prototype:
    398423
     
    404429@end example
    405430
    406 The configuration structure for the @code{COMMAND} has the
     431The configuration structure for the @code{ls} has the
    407432following prototype:
    408433
     
    427452@subheading DESCRIPTION:
    428453
    429 This command XXX
     454This command is used to change the current working directory to
     455the specified directory.  If no arguments are given, the current
     456working directory will be changed to @code{/}.
    430457
    431458@subheading EXIT STATUS:
     
    439466@subheading EXAMPLES:
    440467
    441 The following is an example of how to use chdir:
    442 
    443 @example
    444 EXAMPLE_TBD
     468The following is an example of how to use @code{chdir}:
     469
     470@example
     471SHLL [/] $ pwd
     472/
     473SHLL [/] $ chdir etc
     474SHLL [/etc] $ pwd
     475/etc
    445476@end example
    446477
     
    463494@findex rtems_shell_rtems_main_chdir
    464495
    465 The @code{COMMAND} is implemented by a C language function
     496The @code{chdir} is implemented by a C language function
    466497which has the following prototype:
    467498
     
    473504@end example
    474505
    475 The configuration structure for the @code{COMMAND} has the
     506The configuration structure for the @code{chdir} has the
    476507following prototype:
    477508
     
    491522
    492523@example
    493 mkdir  dir
    494 @end example
    495 
    496 @subheading DESCRIPTION:
    497 
    498 This command XXX
    499 
    500 @subheading EXIT STATUS:
    501 
    502 This command returns 0 on success and non-zero if an error is encountered.
    503 
    504 @subheading NOTES:
    505 
    506 NONE
    507 
    508 @subheading EXAMPLES:
    509 
    510 The following is an example of how to use mkdir:
    511 
    512 @example
    513 EXAMPLE_TBD
     524mkdir  dir [dir1 .. dirN]
     525@end example
     526
     527@subheading DESCRIPTION:
     528
     529This command creates the set of directories in the order they
     530are specified on the command line.  If an error is encountered
     531making one of the directories, the command will continue to
     532attempt to create the remaining directories on the command line.
     533
     534@subheading EXIT STATUS:
     535
     536This command returns 0 on success and non-zero if an error is encountered.
     537
     538@subheading NOTES:
     539
     540If this command is invoked with no arguments, nothing occurs.
     541
     542The user must have sufficient permissions to create the directory.
     543For the @code{fileio} test provided with RTEMS, this means the user
     544must login as @code{root} not @code{rtems}.
     545
     546@subheading EXAMPLES:
     547
     548The following is an example of how to use @code{mkdir}:
     549
     550@example
     551SHLL [/] # ls
     552drwxr-xr-x   1   root   root         536 Jan 01 00:00 dev/
     553drwxr-xr-x   1   root   root        1072 Jan 01 00:00 etc/
     5542 files 1608 bytes occupied
     555SHLL [/] # mkdir joel
     556SHLL [/] # ls joel
     5570 files 0 bytes occupied
     558SHLL [/] # cp etc/passwd joel
     559SHLL [/] # ls joel
     560-rw-r--r--   1   root   root         102 Jan 01 00:02 passwd
     5611 files 102 bytes occupied
    514562@end example
    515563
     
    532580@findex rtems_shell_rtems_main_mkdir
    533581
    534 The @code{COMMAND} is implemented by a C language function
     582The @code{mkdir} is implemented by a C language function
    535583which has the following prototype:
    536584
     
    542590@end example
    543591
    544 The configuration structure for the @code{COMMAND} has the
     592The configuration structure for the @code{mkdir} has the
    545593following prototype:
    546594
     
    577625@subheading EXAMPLES:
    578626
    579 The following is an example of how to use rmdir:
     627The following is an example of how to use @code{rmdir}:
    580628
    581629@example
     
    601649@findex rtems_shell_rtems_main_rmdir
    602650
    603 The @code{COMMAND} is implemented by a C language function
     651The @code{rmdir} is implemented by a C language function
    604652which has the following prototype:
    605653
     
    611659@end example
    612660
    613 The configuration structure for the @code{COMMAND} has the
     661The configuration structure for the @code{rmdir} has the
    614662following prototype:
    615663
     
    646694@subheading EXAMPLES:
    647695
    648 The following is an example of how to use chroot:
     696The following is an example of how to use @code{chroot}:
    649697
    650698@example
     
    670718@findex rtems_shell_rtems_main_chroot
    671719
    672 The @code{COMMAND} is implemented by a C language function
     720The @code{chroot} is implemented by a C language function
    673721which has the following prototype:
    674722
     
    680728@end example
    681729
    682 The configuration structure for the @code{COMMAND} has the
     730The configuration structure for the @code{chroot} has the
    683731following prototype:
    684732
     
    715763@subheading EXAMPLES:
    716764
    717 The following is an example of how to use chmod:
     765The following is an example of how to use @code{chmod}:
    718766
    719767@example
     
    739787@findex rtems_shell_rtems_main_chmod
    740788
    741 The @code{COMMAND} is implemented by a C language function
     789The @code{chmod} is implemented by a C language function
    742790which has the following prototype:
    743791
     
    749797@end example
    750798
    751 The configuration structure for the @code{COMMAND} has the
     799The configuration structure for the @code{chmod} has the
    752800following prototype:
    753801
     
    784832@subheading EXAMPLES:
    785833
    786 The following is an example of how to use cat:
     834The following is an example of how to use @code{cat}:
    787835
    788836@example
     
    808856@findex rtems_shell_rtems_main_cat
    809857
    810 The @code{COMMAND} is implemented by a C language function
     858The @code{cat} is implemented by a C language function
    811859which has the following prototype:
    812860
     
    818866@end example
    819867
    820 The configuration structure for the @code{COMMAND} has the
     868The configuration structure for the @code{cat} has the
    821869following prototype:
    822870
     
    853901@subheading EXAMPLES:
    854902
    855 The following is an example of how to use rm:
     903The following is an example of how to use @code{rm}:
    856904
    857905@example
     
    877925@findex rtems_shell_rtems_main_rm
    878926
    879 The @code{COMMAND} is implemented by a C language function
     927The @code{rm} is implemented by a C language function
    880928which has the following prototype:
    881929
     
    887935@end example
    888936
    889 The configuration structure for the @code{COMMAND} has the
     937The configuration structure for the @code{rm} has the
    890938following prototype:
    891939
     
    10051053@findex rtems_shell_rtems_main_mount
    10061054
    1007 The @code{COMMAND} is implemented by a C language function
     1055The @code{mount} is implemented by a C language function
    10081056which has the following prototype:
    10091057
     
    10151063@end example
    10161064
    1017 The configuration structure for the @code{COMMAND} has the
     1065The configuration structure for the @code{mount} has the
    10181066following prototype:
    10191067
     
    10501098@subheading EXAMPLES:
    10511099
    1052 The following is an example of how to use mount:
     1100The following is an example of how to use @code{mount}:
    10531101
    10541102@example
     
    10741122@findex rtems_shell_rtems_main_unmount
    10751123
    1076 The @code{COMMAND} is implemented by a C language function
     1124The @code{unmount} is implemented by a C language function
    10771125which has the following prototype:
    10781126
     
    10841132@end example
    10851133
    1086 The configuration structure for the @code{COMMAND} has the
     1134The configuration structure for the @code{unmount} has the
    10871135following prototype:
    10881136
     
    11191167@subheading EXAMPLES:
    11201168
    1121 The following is an example of how to use blksync:
     1169The following is an example of how to use @code{blksync}:
    11221170
    11231171@example
     
    11431191@findex rtems_shell_rtems_main_blksync
    11441192
    1145 The @code{COMMAND} is implemented by a C language function
     1193The @code{blksync} is implemented by a C language function
    11461194which has the following prototype:
    11471195
     
    11531201@end example
    11541202
    1155 The configuration structure for the @code{COMMAND} has the
     1203The configuration structure for the @code{blksync} has the
    11561204following prototype:
    11571205
     
    11881236@subheading EXAMPLES:
    11891237
    1190 The following is an example of how to use dir:
     1238The following is an example of how to use @code{dir}:
    11911239
    11921240@example
     
    12121260@findex rtems_shell_rtems_main_dir
    12131261
    1214 The @code{COMMAND} is implemented by a C language function
     1262The @code{dir} is implemented by a C language function
    12151263which has the following prototype:
    12161264
     
    12221270@end example
    12231271
    1224 The configuration structure for the @code{COMMAND} has the
     1272The configuration structure for the @code{dir} has the
    12251273following prototype:
    12261274
     
    12571305@subheading EXAMPLES:
    12581306
    1259 The following is an example of how to use cd:
     1307The following is an example of how to use @code{cd}:
    12601308
    12611309@example
     
    12811329@findex rtems_shell_rtems_main_cd
    12821330
    1283 The @code{COMMAND} is implemented by a C language function
     1331The @code{cd} is implemented by a C language function
    12841332which has the following prototype:
    12851333
     
    12911339@end example
    12921340
    1293 The configuration structure for the @code{COMMAND} has the
     1341The configuration structure for the @code{cd} has the
    12941342following prototype:
    12951343
  • doc/shell/general.t

    rea08043 rdc1c4308  
    4343@subheading DESCRIPTION:
    4444
    45 This command XXX
    46 
    47 @subheading EXIT STATUS:
    48 
    49 This command returns 0 on success and non-zero if an error is encountered.
    50 
    51 @subheading NOTES:
    52 
    53 NONE
    54 
    55 @subheading EXAMPLES:
    56 
    57 The following is an example of how to use alias:
    58 
    59 @example
    60 EXAMPLE_TBD
     45This command adds an alternate name for an existing command to
     46the command set.
     47
     48@subheading EXIT STATUS:
     49
     50This command returns 0 on success and non-zero if an error is encountered.
     51
     52@subheading NOTES:
     53
     54NONE
     55
     56@subheading EXAMPLES:
     57
     58The following is an example of how to use @code{alias}:
     59
     60@example
     61SHLL [/] $ me
     62shell:me command not found
     63SHLL [/] $ alias whoami me
     64SHLL [/] $ me
     65rtems
     66SHLL [/] $ whoami
     67rtems
    6168@end example
    6269
     
    7986@findex rtems_shell_rtems_main_alias
    8087
    81 The @code{COMMAND} is implemented by a C language function
     88The @code{alias} is implemented by a C language function
    8289which has the following prototype:
    8390
     
    8996@end example
    9097
    91 The configuration structure for the @code{COMMAND} has the
     98The configuration structure for the @code{alias} has the
    9299following prototype:
    93100
     
    124131@subheading EXAMPLES:
    125132
    126 The following is an example of how to use date:
     133The following is an example of how to use @code{date}:
    127134
    128135@example
     
    148155@findex rtems_shell_rtems_main_date
    149156
    150 The @code{COMMAND} is implemented by a C language function
     157The @code{date} is implemented by a C language function
    151158which has the following prototype:
    152159
     
    158165@end example
    159166
    160 The configuration structure for the @code{COMMAND} has the
     167The configuration structure for the @code{date} has the
    161168following prototype:
    162169
     
    193200@subheading EXAMPLES:
    194201
    195 The following is an example of how to use id:
     202The following is an example of how to use @code{id}:
    196203
    197204@example
     
    217224@findex rtems_shell_rtems_main_id
    218225
    219 The @code{COMMAND} is implemented by a C language function
     226The @code{id} is implemented by a C language function
    220227which has the following prototype:
    221228
     
    227234@end example
    228235
    229 The configuration structure for the @code{COMMAND} has the
     236The configuration structure for the @code{id} has the
    230237following prototype:
    231238
     
    262269@subheading EXAMPLES:
    263270
    264 The following is an example of how to use tty:
     271The following is an example of how to use @code{tty}:
    265272
    266273@example
     
    286293@findex rtems_shell_rtems_main_tty
    287294
    288 The @code{COMMAND} is implemented by a C language function
     295The @code{tty} is implemented by a C language function
    289296which has the following prototype:
    290297
     
    296303@end example
    297304
    298 The configuration structure for the @code{COMMAND} has the
     305The configuration structure for the @code{tty} has the
    299306following prototype:
    300307
     
    331338@subheading EXAMPLES:
    332339
    333 The following is an example of how to use whoami:
     340The following is an example of how to use @code{whoami}:
    334341
    335342@example
     
    355362@findex rtems_shell_rtems_main_whoami
    356363
    357 The @code{COMMAND} is implemented by a C language function
     364The @code{whoami} is implemented by a C language function
    358365which has the following prototype:
    359366
     
    365372@end example
    366373
    367 The configuration structure for the @code{COMMAND} has the
     374The configuration structure for the @code{whoami} has the
    368375following prototype:
    369376
     
    400407@subheading EXAMPLES:
    401408
    402 The following is an example of how to use logoff:
     409The following is an example of how to use @code{logoff}:
    403410
    404411@example
     
    424431@findex rtems_shell_rtems_main_logoff
    425432
    426 The @code{COMMAND} is implemented by a C language function
     433The @code{logoff} is implemented by a C language function
    427434which has the following prototype:
    428435
     
    434441@end example
    435442
    436 The configuration structure for the @code{COMMAND} has the
     443The configuration structure for the @code{logoff} has the
    437444following prototype:
    438445
     
    469476@subheading EXAMPLES:
    470477
    471 The following is an example of how to use exit:
     478The following is an example of how to use @code{exit}:
    472479
    473480@example
     
    493500@findex rtems_shell_rtems_main_exit
    494501
    495 The @code{COMMAND} is implemented by a C language function
     502The @code{exit} is implemented by a C language function
    496503which has the following prototype:
    497504
     
    503510@end example
    504511
    505 The configuration structure for the @code{COMMAND} has the
     512The configuration structure for the @code{exit} has the
    506513following prototype:
    507514
  • doc/shell/memory.t

    rea08043 rdc1c4308  
    5454@subheading EXAMPLES:
    5555
    56 The following is an example of how to use mdump:
     56The following is an example of how to use @code{mdump}:
    5757
    5858@example
     
    7878@findex rtems_shell_rtems_main_mdump
    7979
    80 The @code{COMMAND} is implemented by a C language function
     80The @code{mdump} is implemented by a C language function
    8181which has the following prototype:
    8282
     
    8888@end example
    8989
    90 The configuration structure for the @code{COMMAND} has the
     90The configuration structure for the @code{mdump} has the
    9191following prototype:
    9292
     
    123123@subheading EXAMPLES:
    124124
    125 The following is an example of how to use wdump:
     125The following is an example of how to use @code{wdump}:
    126126
    127127@example
     
    147147@findex rtems_shell_rtems_main_wdump
    148148
    149 The @code{COMMAND} is implemented by a C language function
     149The @code{wdump} is implemented by a C language function
    150150which has the following prototype:
    151151
     
    157157@end example
    158158
    159 The configuration structure for the @code{COMMAND} has the
     159The configuration structure for the @code{wdump} has the
    160160following prototype:
    161161
     
    192192@subheading EXAMPLES:
    193193
    194 The following is an example of how to use medit:
     194The following is an example of how to use @code{medit}:
    195195
    196196@example
     
    216216@findex rtems_shell_rtems_main_medit
    217217
    218 The @code{COMMAND} is implemented by a C language function
     218The @code{medit} is implemented by a C language function
    219219which has the following prototype:
    220220
     
    226226@end example
    227227
    228 The configuration structure for the @code{COMMAND} has the
     228The configuration structure for the @code{medit} has the
    229229following prototype:
    230230
     
    261261@subheading EXAMPLES:
    262262
    263 The following is an example of how to use mfill:
     263The following is an example of how to use @code{mfill}:
    264264
    265265@example
     
    285285@findex rtems_shell_rtems_main_mfill
    286286
    287 The @code{COMMAND} is implemented by a C language function
     287The @code{mfill} is implemented by a C language function
    288288which has the following prototype:
    289289
     
    295295@end example
    296296
    297 The configuration structure for the @code{COMMAND} has the
     297The configuration structure for the @code{mfill} has the
    298298following prototype:
    299299
     
    330330@subheading EXAMPLES:
    331331
    332 The following is an example of how to use mmove:
     332The following is an example of how to use @code{mmove}:
    333333
    334334@example
     
    354354@findex rtems_shell_rtems_main_mmove
    355355
    356 The @code{COMMAND} is implemented by a C language function
     356The @code{mmove} is implemented by a C language function
    357357which has the following prototype:
    358358
     
    364364@end example
    365365
    366 The configuration structure for the @code{COMMAND} has the
     366The configuration structure for the @code{mmove} has the
    367367following prototype:
    368368
     
    399399@subheading EXAMPLES:
    400400
    401 The following is an example of how to use malloc:
     401The following is an example of how to use @code{malloc}:
    402402
    403403@example
     
    423423@findex rtems_shell_rtems_main_malloc
    424424
    425 The @code{COMMAND} is implemented by a C language function
     425The @code{malloc} is implemented by a C language function
    426426which has the following prototype:
    427427
     
    433433@end example
    434434
    435 The configuration structure for the @code{COMMAND} has the
     435The configuration structure for the @code{malloc} has the
    436436following prototype:
    437437
  • doc/shell/network.t

    rea08043 rdc1c4308  
    5151@subheading EXAMPLES:
    5252
    53 The following is an example of how to use netstats:
     53The following is an example of how to use @code{netstats}:
    5454
    5555@example
     
    7575@findex rtems_shell_rtems_main_netstats
    7676
    77 The @code{COMMAND} is implemented by a C language function
     77The @code{netstats} is implemented by a C language function
    7878which has the following prototype:
    7979
     
    8585@end example
    8686
    87 The configuration structure for the @code{COMMAND} has the
     87The configuration structure for the @code{netstats} has the
    8888following prototype:
    8989
     
    120120@subheading EXAMPLES:
    121121
    122 The following is an example of how to use ifconfig:
     122The following is an example of how to use @code{ifconfig}:
    123123
    124124@example
     
    144144@findex rtems_shell_rtems_main_ifconfig
    145145
    146 The @code{COMMAND} is implemented by a C language function
     146The @code{ifconfig} is implemented by a C language function
    147147which has the following prototype:
    148148
     
    154154@end example
    155155
    156 The configuration structure for the @code{COMMAND} has the
     156The configuration structure for the @code{ifconfig} has the
    157157following prototype:
    158158
     
    189189@subheading EXAMPLES:
    190190
    191 The following is an example of how to use route:
     191The following is an example of how to use @code{route}:
    192192
    193193@example
     
    213213@findex rtems_shell_rtems_main_route
    214214
    215 The @code{COMMAND} is implemented by a C language function
     215The @code{route} is implemented by a C language function
    216216which has the following prototype:
    217217
     
    223223@end example
    224224
    225 The configuration structure for the @code{COMMAND} has the
     225The configuration structure for the @code{route} has the
    226226following prototype:
    227227
  • doc/shell/rtems.t

    rea08043 rdc1c4308  
    6363@subheading EXAMPLES:
    6464
    65 The following is an example of how to use cpuuse:
     65The following is an example of how to use @code{cpuuse}:
    6666
    6767@example
     
    8787@findex rtems_shell_rtems_main_cpuuse
    8888
    89 The @code{COMMAND} is implemented by a C language function
     89The @code{cpuuse} is implemented by a C language function
    9090which has the following prototype:
    9191
     
    9797@end example
    9898
    99 The configuration structure for the @code{COMMAND} has the
     99The configuration structure for the @code{cpuuse} has the
    100100following prototype:
    101101
     
    132132@subheading EXAMPLES:
    133133
    134 The following is an example of how to use stackuse:
     134The following is an example of how to use @code{stackuse}:
    135135
    136136@example
     
    156156@findex rtems_shell_rtems_main_stackuse
    157157
    158 The @code{COMMAND} is implemented by a C language function
     158The @code{stackuse} is implemented by a C language function
    159159which has the following prototype:
    160160
     
    166166@end example
    167167
    168 The configuration structure for the @code{COMMAND} has the
     168The configuration structure for the @code{stackuse} has the
    169169following prototype:
    170170
     
    201201@subheading EXAMPLES:
    202202
    203 The following is an example of how to use perioduse:
     203The following is an example of how to use @code{perioduse}:
    204204
    205205@example
     
    225225@findex rtems_shell_rtems_main_perioduse
    226226
    227 The @code{COMMAND} is implemented by a C language function
     227The @code{perioduse} is implemented by a C language function
    228228which has the following prototype:
    229229
     
    235235@end example
    236236
    237 The configuration structure for the @code{COMMAND} has the
     237The configuration structure for the @code{perioduse} has the
    238238following prototype:
    239239
     
    270270@subheading EXAMPLES:
    271271
    272 The following is an example of how to use wkspace:
     272The following is an example of how to use @code{wkspace}:
    273273
    274274@example
     
    294294@findex rtems_shell_rtems_main_wkspace
    295295
    296 The @code{COMMAND} is implemented by a C language function
     296The @code{wkspace} is implemented by a C language function
    297297which has the following prototype:
    298298
     
    304304@end example
    305305
    306 The configuration structure for the @code{COMMAND} has the
     306The configuration structure for the @code{wkspace} has the
    307307following prototype:
    308308
     
    339339@subheading EXAMPLES:
    340340
    341 The following is an example of how to use config:
     341The following is an example of how to use @code{config}:
    342342
    343343@example
     
    363363@findex rtems_shell_rtems_main_config
    364364
    365 The @code{COMMAND} is implemented by a C language function
     365The @code{config} is implemented by a C language function
    366366which has the following prototype:
    367367
     
    373373@end example
    374374
    375 The configuration structure for the @code{COMMAND} has the
     375The configuration structure for the @code{config} has the
    376376following prototype:
    377377
     
    408408@subheading EXAMPLES:
    409409
    410 The following is an example of how to use itask:
     410The following is an example of how to use @code{itask}:
    411411
    412412@example
     
    432432@findex rtems_shell_rtems_main_itask
    433433
    434 The @code{COMMAND} is implemented by a C language function
     434The @code{itask} is implemented by a C language function
    435435which has the following prototype:
    436436
     
    442442@end example
    443443
    444 The configuration structure for the @code{COMMAND} has the
     444The configuration structure for the @code{itask} has the
    445445following prototype:
    446446
     
    477477@subheading EXAMPLES:
    478478
    479 The following is an example of how to use extension:
     479The following is an example of how to use @code{extension}:
    480480
    481481@example
     
    501501@findex rtems_shell_rtems_main_extension
    502502
    503 The @code{COMMAND} is implemented by a C language function
     503The @code{extension} is implemented by a C language function
    504504which has the following prototype:
    505505
     
    511511@end example
    512512
    513 The configuration structure for the @code{COMMAND} has the
     513The configuration structure for the @code{extension} has the
    514514following prototype:
    515515
     
    546546@subheading EXAMPLES:
    547547
    548 The following is an example of how to use task:
     548The following is an example of how to use @code{task}:
    549549
    550550@example
     
    570570@findex rtems_shell_rtems_main_task
    571571
    572 The @code{COMMAND} is implemented by a C language function
     572The @code{task} is implemented by a C language function
    573573which has the following prototype:
    574574
     
    580580@end example
    581581
    582 The configuration structure for the @code{COMMAND} has the
     582The configuration structure for the @code{task} has the
    583583following prototype:
    584584
     
    615615@subheading EXAMPLES:
    616616
    617 The following is an example of how to use queue:
     617The following is an example of how to use @code{queue}:
    618618
    619619@example
     
    639639@findex rtems_shell_rtems_main_queue
    640640
    641 The @code{COMMAND} is implemented by a C language function
     641The @code{queue} is implemented by a C language function
    642642which has the following prototype:
    643643
     
    649649@end example
    650650
    651 The configuration structure for the @code{COMMAND} has the
     651The configuration structure for the @code{queue} has the
    652652following prototype:
    653653
     
    684684@subheading EXAMPLES:
    685685
    686 The following is an example of how to use sema:
     686The following is an example of how to use @code{sema}:
    687687
    688688@example
     
    708708@findex rtems_shell_rtems_main_sema
    709709
    710 The @code{COMMAND} is implemented by a C language function
     710The @code{sema} is implemented by a C language function
    711711which has the following prototype:
    712712
     
    718718@end example
    719719
    720 The configuration structure for the @code{COMMAND} has the
     720The configuration structure for the @code{sema} has the
    721721following prototype:
    722722
     
    753753@subheading EXAMPLES:
    754754
    755 The following is an example of how to use region:
     755The following is an example of how to use @code{region}:
    756756
    757757@example
     
    777777@findex rtems_shell_rtems_main_region
    778778
    779 The @code{COMMAND} is implemented by a C language function
     779The @code{region} is implemented by a C language function
    780780which has the following prototype:
    781781
     
    787787@end example
    788788
    789 The configuration structure for the @code{COMMAND} has the
     789The configuration structure for the @code{region} has the
    790790following prototype:
    791791
     
    822822@subheading EXAMPLES:
    823823
    824 The following is an example of how to use part:
     824The following is an example of how to use @code{part}:
    825825
    826826@example
     
    846846@findex rtems_shell_rtems_main_part
    847847
    848 The @code{COMMAND} is implemented by a C language function
     848The @code{part} is implemented by a C language function
    849849which has the following prototype:
    850850
     
    856856@end example
    857857
    858 The configuration structure for the @code{COMMAND} has the
     858The configuration structure for the @code{part} has the
    859859following prototype:
    860860
     
    891891@subheading EXAMPLES:
    892892
    893 The following is an example of how to use object:
     893The following is an example of how to use @code{object}:
    894894
    895895@example
     
    915915@findex rtems_shell_rtems_main_object
    916916
    917 The @code{COMMAND} is implemented by a C language function
     917The @code{object} is implemented by a C language function
    918918which has the following prototype:
    919919
     
    925925@end example
    926926
    927 The configuration structure for the @code{COMMAND} has the
     927The configuration structure for the @code{object} has the
    928928following prototype:
    929929
     
    960960@subheading EXAMPLES:
    961961
    962 The following is an example of how to use driver:
     962The following is an example of how to use @code{driver}:
    963963
    964964@example
     
    984984@findex rtems_shell_rtems_main_driver
    985985
    986 The @code{COMMAND} is implemented by a C language function
     986The @code{driver} is implemented by a C language function
    987987which has the following prototype:
    988988
     
    994994@end example
    995995
    996 The configuration structure for the @code{COMMAND} has the
     996The configuration structure for the @code{driver} has the
    997997following prototype:
    998998
     
    10291029@subheading EXAMPLES:
    10301030
    1031 The following is an example of how to use dname:
     1031The following is an example of how to use @code{dname}:
    10321032
    10331033@example
     
    10531053@findex rtems_shell_rtems_main_dname
    10541054
    1055 The @code{COMMAND} is implemented by a C language function
     1055The @code{dname} is implemented by a C language function
    10561056which has the following prototype:
    10571057
     
    10631063@end example
    10641064
    1065 The configuration structure for the @code{COMMAND} has the
     1065The configuration structure for the @code{dname} has the
    10661066following prototype:
    10671067
Note: See TracChangeset for help on using the changeset viewer.