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 | |
---|
13 | The 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 |
---|
36 | netstats [-Aimfpcutv] |
---|
37 | @end example |
---|
38 | |
---|
39 | @subheading DESCRIPTION: |
---|
40 | |
---|
41 | This command XXX |
---|
42 | |
---|
43 | @subheading EXIT STATUS: |
---|
44 | |
---|
45 | This command returns 0 on success and non-zero if an error is encountered. |
---|
46 | |
---|
47 | @subheading NOTES: |
---|
48 | |
---|
49 | NONE |
---|
50 | |
---|
51 | @subheading EXAMPLES: |
---|
52 | |
---|
53 | The following is an example of how to use @code{netstats}: |
---|
54 | |
---|
55 | @example |
---|
56 | EXAMPLE_TBD |
---|
57 | @end example |
---|
58 | |
---|
59 | @subheading CONFIGURATION: |
---|
60 | |
---|
61 | @findex CONFIGURE_SHELL_NO_COMMAND_NETSTATS |
---|
62 | @findex CONFIGURE_SHELL_COMMAND_NETSTATS |
---|
63 | |
---|
64 | This command is included in the default shell command set. |
---|
65 | When building a custom command set, define |
---|
66 | @code{CONFIGURE_SHELL_COMMAND_NETSTATS} to have this |
---|
67 | command included. |
---|
68 | |
---|
69 | This command can be excluded from the shell command set by |
---|
70 | defining @code{CONFIGURE_SHELL_NO_COMMAND_NETSTATS} when all |
---|
71 | shell commands have been configured. |
---|
72 | |
---|
73 | @subheading PROGRAMMING INFORMATION: |
---|
74 | |
---|
75 | @findex rtems_shell_rtems_main_netstats |
---|
76 | |
---|
77 | The @code{netstats} is implemented by a C language function |
---|
78 | which has the following prototype: |
---|
79 | |
---|
80 | @example |
---|
81 | int rtems_shell_rtems_main_netstats( |
---|
82 | int argc, |
---|
83 | char **argv |
---|
84 | ); |
---|
85 | @end example |
---|
86 | |
---|
87 | The configuration structure for the @code{netstats} has the |
---|
88 | following prototype: |
---|
89 | |
---|
90 | @example |
---|
91 | extern 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 |
---|
105 | ifconfig |
---|
106 | @end example |
---|
107 | |
---|
108 | @subheading DESCRIPTION: |
---|
109 | |
---|
110 | This command XXX |
---|
111 | |
---|
112 | @subheading EXIT STATUS: |
---|
113 | |
---|
114 | This command returns 0 on success and non-zero if an error is encountered. |
---|
115 | |
---|
116 | @subheading NOTES: |
---|
117 | |
---|
118 | NONE |
---|
119 | |
---|
120 | @subheading EXAMPLES: |
---|
121 | |
---|
122 | The following is an example of how to use @code{ifconfig}: |
---|
123 | |
---|
124 | @example |
---|
125 | EXAMPLE_TBD |
---|
126 | @end example |
---|
127 | |
---|
128 | @subheading CONFIGURATION: |
---|
129 | |
---|
130 | @findex CONFIGURE_SHELL_NO_COMMAND_IFCONFIG |
---|
131 | @findex CONFIGURE_SHELL_COMMAND_IFCONFIG |
---|
132 | |
---|
133 | This command is included in the default shell command set. |
---|
134 | When building a custom command set, define |
---|
135 | @code{CONFIGURE_SHELL_COMMAND_IFCONFIG} to have this |
---|
136 | command included. |
---|
137 | |
---|
138 | This command can be excluded from the shell command set by |
---|
139 | defining @code{CONFIGURE_SHELL_NO_COMMAND_IFCONFIG} when all |
---|
140 | shell commands have been configured. |
---|
141 | |
---|
142 | @subheading PROGRAMMING INFORMATION: |
---|
143 | |
---|
144 | @findex rtems_shell_rtems_main_ifconfig |
---|
145 | |
---|
146 | The @code{ifconfig} is implemented by a C language function |
---|
147 | which has the following prototype: |
---|
148 | |
---|
149 | @example |
---|
150 | int rtems_shell_rtems_main_ifconfig( |
---|
151 | int argc, |
---|
152 | char **argv |
---|
153 | ); |
---|
154 | @end example |
---|
155 | |
---|
156 | The configuration structure for the @code{ifconfig} has the |
---|
157 | following prototype: |
---|
158 | |
---|
159 | @example |
---|
160 | extern 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 |
---|
174 | route [subcommand] |
---|
175 | @end example |
---|
176 | |
---|
177 | @subheading DESCRIPTION: |
---|
178 | |
---|
179 | This command XXX |
---|
180 | |
---|
181 | @subheading EXIT STATUS: |
---|
182 | |
---|
183 | This command returns 0 on success and non-zero if an error is encountered. |
---|
184 | |
---|
185 | @subheading NOTES: |
---|
186 | |
---|
187 | NONE |
---|
188 | |
---|
189 | @subheading EXAMPLES: |
---|
190 | |
---|
191 | The following is an example of how to use @code{route}: |
---|
192 | |
---|
193 | @example |
---|
194 | EXAMPLE_TBD |
---|
195 | @end example |
---|
196 | |
---|
197 | @subheading CONFIGURATION: |
---|
198 | |
---|
199 | @findex CONFIGURE_SHELL_NO_COMMAND_ROUTE |
---|
200 | @findex CONFIGURE_SHELL_COMMAND_ROUTE |
---|
201 | |
---|
202 | This command is included in the default shell command set. |
---|
203 | When building a custom command set, define |
---|
204 | @code{CONFIGURE_SHELL_COMMAND_ROUTE} to have this |
---|
205 | command included. |
---|
206 | |
---|
207 | This command can be excluded from the shell command set by |
---|
208 | defining @code{CONFIGURE_SHELL_NO_COMMAND_ROUTE} when all |
---|
209 | shell commands have been configured. |
---|
210 | |
---|
211 | @subheading PROGRAMMING INFORMATION: |
---|
212 | |
---|
213 | @findex rtems_shell_rtems_main_route |
---|
214 | |
---|
215 | The @code{route} is implemented by a C language function |
---|
216 | which has the following prototype: |
---|
217 | |
---|
218 | @example |
---|
219 | int rtems_shell_rtems_main_route( |
---|
220 | int argc, |
---|
221 | char **argv |
---|
222 | ); |
---|
223 | @end example |
---|
224 | |
---|
225 | The configuration structure for the @code{route} has the |
---|
226 | following prototype: |
---|
227 | |
---|
228 | @example |
---|
229 | extern rtems_shell_cmd_t rtems_shell_ROUTE_Command; |
---|
230 | @end example |
---|
231 | |
---|