source: rtems/doc/shell/network.t @ dc1c4308

4.104.114.95
Last change on this file since dc1c4308 was dc1c4308, checked in by Joel Sherrill <joel.sherrill@…>, on 02/21/08 at 23:56:30

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.
  • Property mode set to 100644
File size: 4.3 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-2008.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@chapter Network Commands
10
11@section Introduction
12
13The RTEMS shell has the following network commands:
14
15@itemize @bullet
16
17@item @code{netstats} - obtain network statistics
18@item @code{ifconfig} - configure a network interface
19@item @code{route} - show or manipulate the IP routing table
20
21@end itemize
22
23@section Commands
24
25@c
26@c
27@c
28@page
29@subsection netstats - obtain network statistics
30
31@pgindex netstats
32
33@subheading SYNOPSYS:
34
35@example
36netstats [-Aimfpcutv]
37@end example
38
39@subheading DESCRIPTION:
40
41This command XXX
42
43@subheading EXIT STATUS:
44
45This command returns 0 on success and non-zero if an error is encountered.
46
47@subheading NOTES:
48
49NONE
50
51@subheading EXAMPLES:
52
53The following is an example of how to use @code{netstats}:
54
55@example
56EXAMPLE_TBD
57@end example
58
59@subheading CONFIGURATION:
60
61@findex CONFIGURE_SHELL_NO_COMMAND_NETSTATS
62@findex CONFIGURE_SHELL_COMMAND_NETSTATS
63
64This command is included in the default shell command set. 
65When building a custom command set, define
66@code{CONFIGURE_SHELL_COMMAND_NETSTATS} to have this
67command included.
68
69This command can be excluded from the shell command set by
70defining @code{CONFIGURE_SHELL_NO_COMMAND_NETSTATS} when all
71shell commands have been configured.
72
73@subheading PROGRAMMING INFORMATION:
74
75@findex rtems_shell_rtems_main_netstats
76
77The @code{netstats} is implemented by a C language function
78which has the following prototype:
79
80@example
81int rtems_shell_rtems_main_netstats(
82  int    argc,
83  char **argv
84);
85@end example
86
87The configuration structure for the @code{netstats} has the
88following prototype:
89
90@example
91extern rtems_shell_cmd_t rtems_shell_NETSTATS_Command;
92@end example
93
94@c
95@c
96@c
97@page
98@subsection ifconfig - configure a network interface
99
100@pgindex ifconfig
101
102@subheading SYNOPSYS:
103
104@example
105ifconfig
106@end example
107
108@subheading DESCRIPTION:
109
110This command XXX
111
112@subheading EXIT STATUS:
113
114This command returns 0 on success and non-zero if an error is encountered.
115
116@subheading NOTES:
117
118NONE
119
120@subheading EXAMPLES:
121
122The following is an example of how to use @code{ifconfig}:
123
124@example
125EXAMPLE_TBD
126@end example
127
128@subheading CONFIGURATION:
129
130@findex CONFIGURE_SHELL_NO_COMMAND_IFCONFIG
131@findex CONFIGURE_SHELL_COMMAND_IFCONFIG
132
133This command is included in the default shell command set. 
134When building a custom command set, define
135@code{CONFIGURE_SHELL_COMMAND_IFCONFIG} to have this
136command included.
137
138This command can be excluded from the shell command set by
139defining @code{CONFIGURE_SHELL_NO_COMMAND_IFCONFIG} when all
140shell commands have been configured.
141
142@subheading PROGRAMMING INFORMATION:
143
144@findex rtems_shell_rtems_main_ifconfig
145
146The @code{ifconfig} is implemented by a C language function
147which has the following prototype:
148
149@example
150int rtems_shell_rtems_main_ifconfig(
151  int    argc,
152  char **argv
153);
154@end example
155
156The configuration structure for the @code{ifconfig} has the
157following prototype:
158
159@example
160extern rtems_shell_cmd_t rtems_shell_IFCONFIG_Command;
161@end example
162
163@c
164@c
165@c
166@page
167@subsection route - show or manipulate the ip routing table
168
169@pgindex route
170
171@subheading SYNOPSYS:
172
173@example
174route [subcommand]
175@end example
176
177@subheading DESCRIPTION:
178
179This command XXX
180
181@subheading EXIT STATUS:
182
183This command returns 0 on success and non-zero if an error is encountered.
184
185@subheading NOTES:
186
187NONE
188
189@subheading EXAMPLES:
190
191The following is an example of how to use @code{route}:
192
193@example
194EXAMPLE_TBD
195@end example
196
197@subheading CONFIGURATION:
198
199@findex CONFIGURE_SHELL_NO_COMMAND_ROUTE
200@findex CONFIGURE_SHELL_COMMAND_ROUTE
201
202This command is included in the default shell command set. 
203When building a custom command set, define
204@code{CONFIGURE_SHELL_COMMAND_ROUTE} to have this
205command included.
206
207This command can be excluded from the shell command set by
208defining @code{CONFIGURE_SHELL_NO_COMMAND_ROUTE} when all
209shell commands have been configured.
210
211@subheading PROGRAMMING INFORMATION:
212
213@findex rtems_shell_rtems_main_route
214
215The @code{route} is implemented by a C language function
216which has the following prototype:
217
218@example
219int rtems_shell_rtems_main_route(
220  int    argc,
221  char **argv
222);
223@end example
224
225The configuration structure for the @code{route} has the
226following prototype:
227
228@example
229extern rtems_shell_cmd_t rtems_shell_ROUTE_Command;
230@end example
231
Note: See TracBrowser for help on using the repository browser.