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 $ |
---|
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 | |
---|
18 | @item @code{netstats} - obtain network statistics |
---|
19 | |
---|
20 | @item @code{ifconfig} - configure a network interface |
---|
21 | |
---|
22 | @item @code{route} - show or manipulate the IP routing table |
---|
23 | |
---|
24 | @end itemize |
---|
25 | |
---|
26 | @section Commands |
---|
27 | |
---|
28 | @c |
---|
29 | @c |
---|
30 | @c |
---|
31 | @page |
---|
32 | @subsection netstats - obtain network statistics |
---|
33 | |
---|
34 | @pgindex netstats |
---|
35 | |
---|
36 | @subheading SYNOPSYS: |
---|
37 | |
---|
38 | netstats [-Aimfpcutv] |
---|
39 | |
---|
40 | @subheading DESCRIPTION: |
---|
41 | |
---|
42 | This command XXX |
---|
43 | |
---|
44 | @subheading NOTES: |
---|
45 | |
---|
46 | NONE |
---|
47 | |
---|
48 | @subheading EXAMPLES: |
---|
49 | |
---|
50 | The following is an example of how to use netstats: |
---|
51 | |
---|
52 | @example |
---|
53 | EXAMPLE_TBD |
---|
54 | @end example |
---|
55 | |
---|
56 | @subheading CONFIGURATION: |
---|
57 | |
---|
58 | @findex CONFIGURE_SHELL_NO_COMMAND_NETSTATS |
---|
59 | @findex CONFIGURE_SHELL_COMMAND_NETSTATS |
---|
60 | |
---|
61 | In order to disable this command out if you are configuring all commands, |
---|
62 | define @code{CONFIGURE_SHELL_NO_COMMAND_NETSTATS}. |
---|
63 | |
---|
64 | In order to enable this command if you are building a custom command set |
---|
65 | define @code{CONFIGURE_SHELL_COMMAND_NETSTATS}. |
---|
66 | |
---|
67 | |
---|
68 | @subheading PROGRAMMING INFORMATION: |
---|
69 | |
---|
70 | @findex rtems_shell_rtems_main_netstats |
---|
71 | |
---|
72 | The @code{COMMAND} is implemented by a C language function |
---|
73 | which has the following prototype: |
---|
74 | |
---|
75 | @example |
---|
76 | int rtems_shell_rtems_main_netstats( |
---|
77 | int argc, |
---|
78 | char **argv |
---|
79 | ); |
---|
80 | @end example |
---|
81 | |
---|
82 | The configuration structure for the @code{COMMAND} has the |
---|
83 | following prototype: |
---|
84 | |
---|
85 | @example |
---|
86 | extern rtems_shell_cmd_t rtems_shell_NETSTATS_Command; |
---|
87 | @end example |
---|
88 | |
---|
89 | @c |
---|
90 | @c |
---|
91 | @c |
---|
92 | @page |
---|
93 | @subsection ifconfig - configure a network interface |
---|
94 | |
---|
95 | @pgindex ifconfig |
---|
96 | |
---|
97 | @subheading SYNOPSYS: |
---|
98 | |
---|
99 | ifconfig |
---|
100 | |
---|
101 | @subheading DESCRIPTION: |
---|
102 | |
---|
103 | This command XXX |
---|
104 | |
---|
105 | @subheading NOTES: |
---|
106 | |
---|
107 | NONE |
---|
108 | |
---|
109 | @subheading EXAMPLES: |
---|
110 | |
---|
111 | The following is an example of how to use ifconfig: |
---|
112 | |
---|
113 | @example |
---|
114 | EXAMPLE_TBD |
---|
115 | @end example |
---|
116 | |
---|
117 | @subheading CONFIGURATION: |
---|
118 | |
---|
119 | @findex CONFIGURE_SHELL_NO_COMMAND_IFCONFIG |
---|
120 | @findex CONFIGURE_SHELL_COMMAND_IFCONFIG |
---|
121 | |
---|
122 | In order to disable this command out if you are configuring all commands, |
---|
123 | define @code{CONFIGURE_SHELL_NO_COMMAND_IFCONFIG}. |
---|
124 | |
---|
125 | In order to enable this command if you are building a custom command set |
---|
126 | define @code{CONFIGURE_SHELL_COMMAND_IFCONFIG}. |
---|
127 | |
---|
128 | |
---|
129 | @subheading PROGRAMMING INFORMATION: |
---|
130 | |
---|
131 | @findex rtems_shell_rtems_main_ifconfig |
---|
132 | |
---|
133 | The @code{COMMAND} is implemented by a C language function |
---|
134 | which has the following prototype: |
---|
135 | |
---|
136 | @example |
---|
137 | int rtems_shell_rtems_main_ifconfig( |
---|
138 | int argc, |
---|
139 | char **argv |
---|
140 | ); |
---|
141 | @end example |
---|
142 | |
---|
143 | The configuration structure for the @code{COMMAND} has the |
---|
144 | following prototype: |
---|
145 | |
---|
146 | @example |
---|
147 | extern rtems_shell_cmd_t rtems_shell_IFCONFIG_Command; |
---|
148 | @end example |
---|
149 | |
---|
150 | @c |
---|
151 | @c |
---|
152 | @c |
---|
153 | @page |
---|
154 | @subsection route - show or manipulate the ip routing table |
---|
155 | |
---|
156 | @pgindex route |
---|
157 | |
---|
158 | @subheading SYNOPSYS: |
---|
159 | |
---|
160 | route [subcommand] |
---|
161 | |
---|
162 | @subheading DESCRIPTION: |
---|
163 | |
---|
164 | This command XXX |
---|
165 | |
---|
166 | @subheading NOTES: |
---|
167 | |
---|
168 | NONE |
---|
169 | |
---|
170 | @subheading EXAMPLES: |
---|
171 | |
---|
172 | The following is an example of how to use route: |
---|
173 | |
---|
174 | @example |
---|
175 | EXAMPLE_TBD |
---|
176 | @end example |
---|
177 | |
---|
178 | @subheading CONFIGURATION: |
---|
179 | |
---|
180 | @findex CONFIGURE_SHELL_NO_COMMAND_ROUTE |
---|
181 | @findex CONFIGURE_SHELL_COMMAND_ROUTE |
---|
182 | |
---|
183 | In order to disable this command out if you are configuring all commands, |
---|
184 | define @code{CONFIGURE_SHELL_NO_COMMAND_ROUTE}. |
---|
185 | |
---|
186 | In order to enable this command if you are building a custom command set |
---|
187 | define @code{CONFIGURE_SHELL_COMMAND_ROUTE}. |
---|
188 | |
---|
189 | |
---|
190 | @subheading PROGRAMMING INFORMATION: |
---|
191 | |
---|
192 | @findex rtems_shell_rtems_main_route |
---|
193 | |
---|
194 | The @code{COMMAND} is implemented by a C language function |
---|
195 | which has the following prototype: |
---|
196 | |
---|
197 | @example |
---|
198 | int rtems_shell_rtems_main_route( |
---|
199 | int argc, |
---|
200 | char **argv |
---|
201 | ); |
---|
202 | @end example |
---|
203 | |
---|
204 | The configuration structure for the @code{COMMAND} has the |
---|
205 | following prototype: |
---|
206 | |
---|
207 | @example |
---|
208 | extern rtems_shell_cmd_t rtems_shell_ROUTE_Command; |
---|
209 | @end example |
---|
210 | |
---|