Mirrors_Framework/rtems
1
0
Fork 0
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2026-09-20 11:27:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* shell/file.t, shell/general.t, shell/memory.t, shell/network.t,
	shell/rtems.t: More descriptions and examples added.
This commit is contained in:
Joel Sherrill
2008-02-21 23:56:30 +00:00
parent ea0804303b
commit dc1c4308d6
6 changed files with 215 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/ChangeLog
+5
View File
@@ -1,3 +1,8 @@
2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com>
* shell/file.t, shell/general.t, shell/memory.t, shell/network.t,
shell/rtems.t: More descriptions and examples added.
2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com>
* shell/file.t, shell/general.t, shell/memory.t, shell/network.t,
doc/shell/file.t
+108 -60
View File
File diff suppressed because it is too large Load Diff
doc/shell/general.t
+30 -23
View File
@@ -42,7 +42,8 @@ alias oldCommand newCommand
@subheading DESCRIPTION:
This command XXX
This command adds an alternate name for an existing command to
the command set.
@subheading EXIT STATUS:
@@ -54,10 +55,16 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use alias:
The following is an example of how to use @code{alias}:
@example
EXAMPLE_TBD
SHLL [/] $ me
shell:me command not found
SHLL [/] $ alias whoami me
SHLL [/] $ me
rtems
SHLL [/] $ whoami
rtems
@end example
@subheading CONFIGURATION:
@@ -78,7 +85,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_alias
The @code{COMMAND} is implemented by a C language function
The @code{alias} is implemented by a C language function
which has the following prototype:
@example
@@ -88,7 +95,7 @@ int rtems_shell_rtems_main_alias(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{alias} has the
following prototype:
@example
@@ -123,7 +130,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use date:
The following is an example of how to use @code{date}:
@example
EXAMPLE_TBD
@@ -147,7 +154,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_date
The @code{COMMAND} is implemented by a C language function
The @code{date} is implemented by a C language function
which has the following prototype:
@example
@@ -157,7 +164,7 @@ int rtems_shell_rtems_main_date(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{date} has the
following prototype:
@example
@@ -192,7 +199,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use id:
The following is an example of how to use @code{id}:
@example
EXAMPLE_TBD
@@ -216,7 +223,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_id
The @code{COMMAND} is implemented by a C language function
The @code{id} is implemented by a C language function
which has the following prototype:
@example
@@ -226,7 +233,7 @@ int rtems_shell_rtems_main_id(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{id} has the
following prototype:
@example
@@ -261,7 +268,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use tty:
The following is an example of how to use @code{tty}:
@example
EXAMPLE_TBD
@@ -285,7 +292,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_tty
The @code{COMMAND} is implemented by a C language function
The @code{tty} is implemented by a C language function
which has the following prototype:
@example
@@ -295,7 +302,7 @@ int rtems_shell_rtems_main_tty(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{tty} has the
following prototype:
@example
@@ -330,7 +337,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use whoami:
The following is an example of how to use @code{whoami}:
@example
EXAMPLE_TBD
@@ -354,7 +361,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_whoami
The @code{COMMAND} is implemented by a C language function
The @code{whoami} is implemented by a C language function
which has the following prototype:
@example
@@ -364,7 +371,7 @@ int rtems_shell_rtems_main_whoami(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{whoami} has the
following prototype:
@example
@@ -399,7 +406,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use logoff:
The following is an example of how to use @code{logoff}:
@example
EXAMPLE_TBD
@@ -423,7 +430,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_logoff
The @code{COMMAND} is implemented by a C language function
The @code{logoff} is implemented by a C language function
which has the following prototype:
@example
@@ -433,7 +440,7 @@ int rtems_shell_rtems_main_logoff(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{logoff} has the
following prototype:
@example
@@ -468,7 +475,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use exit:
The following is an example of how to use @code{exit}:
@example
EXAMPLE_TBD
@@ -492,7 +499,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_exit
The @code{COMMAND} is implemented by a C language function
The @code{exit} is implemented by a C language function
which has the following prototype:
@example
@@ -502,7 +509,7 @@ int rtems_shell_rtems_main_exit(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{exit} has the
following prototype:
@example
doc/shell/memory.t
+18 -18
View File
@@ -53,7 +53,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use mdump:
The following is an example of how to use @code{mdump}:
@example
EXAMPLE_TBD
@@ -77,7 +77,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_mdump
The @code{COMMAND} is implemented by a C language function
The @code{mdump} is implemented by a C language function
which has the following prototype:
@example
@@ -87,7 +87,7 @@ int rtems_shell_rtems_main_mdump(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{mdump} has the
following prototype:
@example
@@ -122,7 +122,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use wdump:
The following is an example of how to use @code{wdump}:
@example
EXAMPLE_TBD
@@ -146,7 +146,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_wdump
The @code{COMMAND} is implemented by a C language function
The @code{wdump} is implemented by a C language function
which has the following prototype:
@example
@@ -156,7 +156,7 @@ int rtems_shell_rtems_main_wdump(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{wdump} has the
following prototype:
@example
@@ -191,7 +191,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use medit:
The following is an example of how to use @code{medit}:
@example
EXAMPLE_TBD
@@ -215,7 +215,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_medit
The @code{COMMAND} is implemented by a C language function
The @code{medit} is implemented by a C language function
which has the following prototype:
@example
@@ -225,7 +225,7 @@ int rtems_shell_rtems_main_medit(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{medit} has the
following prototype:
@example
@@ -260,7 +260,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use mfill:
The following is an example of how to use @code{mfill}:
@example
EXAMPLE_TBD
@@ -284,7 +284,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_mfill
The @code{COMMAND} is implemented by a C language function
The @code{mfill} is implemented by a C language function
which has the following prototype:
@example
@@ -294,7 +294,7 @@ int rtems_shell_rtems_main_mfill(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{mfill} has the
following prototype:
@example
@@ -329,7 +329,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use mmove:
The following is an example of how to use @code{mmove}:
@example
EXAMPLE_TBD
@@ -353,7 +353,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_mmove
The @code{COMMAND} is implemented by a C language function
The @code{mmove} is implemented by a C language function
which has the following prototype:
@example
@@ -363,7 +363,7 @@ int rtems_shell_rtems_main_mmove(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{mmove} has the
following prototype:
@example
@@ -398,7 +398,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use malloc:
The following is an example of how to use @code{malloc}:
@example
EXAMPLE_TBD
@@ -422,7 +422,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_malloc
The @code{COMMAND} is implemented by a C language function
The @code{malloc} is implemented by a C language function
which has the following prototype:
@example
@@ -432,7 +432,7 @@ int rtems_shell_rtems_main_malloc(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{malloc} has the
following prototype:
@example
doc/shell/network.t
+9 -9
View File
@@ -50,7 +50,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use netstats:
The following is an example of how to use @code{netstats}:
@example
EXAMPLE_TBD
@@ -74,7 +74,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_netstats
The @code{COMMAND} is implemented by a C language function
The @code{netstats} is implemented by a C language function
which has the following prototype:
@example
@@ -84,7 +84,7 @@ int rtems_shell_rtems_main_netstats(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{netstats} has the
following prototype:
@example
@@ -119,7 +119,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use ifconfig:
The following is an example of how to use @code{ifconfig}:
@example
EXAMPLE_TBD
@@ -143,7 +143,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_ifconfig
The @code{COMMAND} is implemented by a C language function
The @code{ifconfig} is implemented by a C language function
which has the following prototype:
@example
@@ -153,7 +153,7 @@ int rtems_shell_rtems_main_ifconfig(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{ifconfig} has the
following prototype:
@example
@@ -188,7 +188,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use route:
The following is an example of how to use @code{route}:
@example
EXAMPLE_TBD
@@ -212,7 +212,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_route
The @code{COMMAND} is implemented by a C language function
The @code{route} is implemented by a C language function
which has the following prototype:
@example
@@ -222,7 +222,7 @@ int rtems_shell_rtems_main_route(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{route} has the
following prototype:
@example
doc/shell/rtems.t
+45 -45
View File
@@ -62,7 +62,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use cpuuse:
The following is an example of how to use @code{cpuuse}:
@example
EXAMPLE_TBD
@@ -86,7 +86,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_cpuuse
The @code{COMMAND} is implemented by a C language function
The @code{cpuuse} is implemented by a C language function
which has the following prototype:
@example
@@ -96,7 +96,7 @@ int rtems_shell_rtems_main_cpuuse(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{cpuuse} has the
following prototype:
@example
@@ -131,7 +131,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use stackuse:
The following is an example of how to use @code{stackuse}:
@example
EXAMPLE_TBD
@@ -155,7 +155,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_stackuse
The @code{COMMAND} is implemented by a C language function
The @code{stackuse} is implemented by a C language function
which has the following prototype:
@example
@@ -165,7 +165,7 @@ int rtems_shell_rtems_main_stackuse(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{stackuse} has the
following prototype:
@example
@@ -200,7 +200,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use perioduse:
The following is an example of how to use @code{perioduse}:
@example
EXAMPLE_TBD
@@ -224,7 +224,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_perioduse
The @code{COMMAND} is implemented by a C language function
The @code{perioduse} is implemented by a C language function
which has the following prototype:
@example
@@ -234,7 +234,7 @@ int rtems_shell_rtems_main_perioduse(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{perioduse} has the
following prototype:
@example
@@ -269,7 +269,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use wkspace:
The following is an example of how to use @code{wkspace}:
@example
EXAMPLE_TBD
@@ -293,7 +293,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_wkspace
The @code{COMMAND} is implemented by a C language function
The @code{wkspace} is implemented by a C language function
which has the following prototype:
@example
@@ -303,7 +303,7 @@ int rtems_shell_rtems_main_wkspace(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{wkspace} has the
following prototype:
@example
@@ -338,7 +338,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use config:
The following is an example of how to use @code{config}:
@example
EXAMPLE_TBD
@@ -362,7 +362,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_config
The @code{COMMAND} is implemented by a C language function
The @code{config} is implemented by a C language function
which has the following prototype:
@example
@@ -372,7 +372,7 @@ int rtems_shell_rtems_main_config(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{config} has the
following prototype:
@example
@@ -407,7 +407,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use itask:
The following is an example of how to use @code{itask}:
@example
EXAMPLE_TBD
@@ -431,7 +431,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_itask
The @code{COMMAND} is implemented by a C language function
The @code{itask} is implemented by a C language function
which has the following prototype:
@example
@@ -441,7 +441,7 @@ int rtems_shell_rtems_main_itask(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{itask} has the
following prototype:
@example
@@ -476,7 +476,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use extension:
The following is an example of how to use @code{extension}:
@example
EXAMPLE_TBD
@@ -500,7 +500,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_extension
The @code{COMMAND} is implemented by a C language function
The @code{extension} is implemented by a C language function
which has the following prototype:
@example
@@ -510,7 +510,7 @@ int rtems_shell_rtems_main_extension(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{extension} has the
following prototype:
@example
@@ -545,7 +545,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use task:
The following is an example of how to use @code{task}:
@example
EXAMPLE_TBD
@@ -569,7 +569,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_task
The @code{COMMAND} is implemented by a C language function
The @code{task} is implemented by a C language function
which has the following prototype:
@example
@@ -579,7 +579,7 @@ int rtems_shell_rtems_main_task(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{task} has the
following prototype:
@example
@@ -614,7 +614,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use queue:
The following is an example of how to use @code{queue}:
@example
EXAMPLE_TBD
@@ -638,7 +638,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_queue
The @code{COMMAND} is implemented by a C language function
The @code{queue} is implemented by a C language function
which has the following prototype:
@example
@@ -648,7 +648,7 @@ int rtems_shell_rtems_main_queue(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{queue} has the
following prototype:
@example
@@ -683,7 +683,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use sema:
The following is an example of how to use @code{sema}:
@example
EXAMPLE_TBD
@@ -707,7 +707,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_sema
The @code{COMMAND} is implemented by a C language function
The @code{sema} is implemented by a C language function
which has the following prototype:
@example
@@ -717,7 +717,7 @@ int rtems_shell_rtems_main_sema(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{sema} has the
following prototype:
@example
@@ -752,7 +752,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use region:
The following is an example of how to use @code{region}:
@example
EXAMPLE_TBD
@@ -776,7 +776,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_region
The @code{COMMAND} is implemented by a C language function
The @code{region} is implemented by a C language function
which has the following prototype:
@example
@@ -786,7 +786,7 @@ int rtems_shell_rtems_main_region(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{region} has the
following prototype:
@example
@@ -821,7 +821,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use part:
The following is an example of how to use @code{part}:
@example
EXAMPLE_TBD
@@ -845,7 +845,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_part
The @code{COMMAND} is implemented by a C language function
The @code{part} is implemented by a C language function
which has the following prototype:
@example
@@ -855,7 +855,7 @@ int rtems_shell_rtems_main_part(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{part} has the
following prototype:
@example
@@ -890,7 +890,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use object:
The following is an example of how to use @code{object}:
@example
EXAMPLE_TBD
@@ -914,7 +914,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_object
The @code{COMMAND} is implemented by a C language function
The @code{object} is implemented by a C language function
which has the following prototype:
@example
@@ -924,7 +924,7 @@ int rtems_shell_rtems_main_object(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{object} has the
following prototype:
@example
@@ -959,7 +959,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use driver:
The following is an example of how to use @code{driver}:
@example
EXAMPLE_TBD
@@ -983,7 +983,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_driver
The @code{COMMAND} is implemented by a C language function
The @code{driver} is implemented by a C language function
which has the following prototype:
@example
@@ -993,7 +993,7 @@ int rtems_shell_rtems_main_driver(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{driver} has the
following prototype:
@example
@@ -1028,7 +1028,7 @@ NONE
@subheading EXAMPLES:
The following is an example of how to use dname:
The following is an example of how to use @code{dname}:
@example
EXAMPLE_TBD
@@ -1052,7 +1052,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_dname
The @code{COMMAND} is implemented by a C language function
The @code{dname} is implemented by a C language function
which has the following prototype:
@example
@@ -1062,7 +1062,7 @@ int rtems_shell_rtems_main_dname(
);
@end example
The configuration structure for the @code{COMMAND} has the
The configuration structure for the @code{dname} has the
following prototype:
@example