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 General Commands |
---|
10 | |
---|
11 | @section Introduction |
---|
12 | |
---|
13 | The RTEMS shell has the following general commands: |
---|
14 | |
---|
15 | @itemize @bullet |
---|
16 | |
---|
17 | @item @code{alias} - Add alias for an existing command |
---|
18 | @item @code{date} - Print current date and time |
---|
19 | @item @code{id} - show uid gid euid and egid |
---|
20 | @item @code{tty} - show ttyname |
---|
21 | @item @code{whoami} - show current user |
---|
22 | @item @code{logoff} - logoff from the system |
---|
23 | @item @code{exit} - alias for logoff command |
---|
24 | |
---|
25 | @end itemize |
---|
26 | |
---|
27 | @section Commands |
---|
28 | |
---|
29 | @c |
---|
30 | @c |
---|
31 | @c |
---|
32 | @page |
---|
33 | @subsection alias - add alias for an existing command |
---|
34 | |
---|
35 | @pgindex alias |
---|
36 | |
---|
37 | @subheading SYNOPSYS: |
---|
38 | |
---|
39 | @example |
---|
40 | alias oldCommand newCommand |
---|
41 | @end example |
---|
42 | |
---|
43 | @subheading DESCRIPTION: |
---|
44 | |
---|
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 |
---|
61 | @end example |
---|
62 | |
---|
63 | @subheading CONFIGURATION: |
---|
64 | |
---|
65 | @findex CONFIGURE_SHELL_NO_COMMAND_ALIAS |
---|
66 | @findex CONFIGURE_SHELL_COMMAND_ALIAS |
---|
67 | |
---|
68 | This command is included in the default shell command set. |
---|
69 | When building a custom command set, define |
---|
70 | @code{CONFIGURE_SHELL_COMMAND_ALIAS} to have this |
---|
71 | command included. |
---|
72 | |
---|
73 | This command can be excluded from the shell command set by |
---|
74 | defining @code{CONFIGURE_SHELL_NO_COMMAND_ALIAS} when all |
---|
75 | shell commands have been configured. |
---|
76 | |
---|
77 | @subheading PROGRAMMING INFORMATION: |
---|
78 | |
---|
79 | @findex rtems_shell_rtems_main_alias |
---|
80 | |
---|
81 | The @code{COMMAND} is implemented by a C language function |
---|
82 | which has the following prototype: |
---|
83 | |
---|
84 | @example |
---|
85 | int rtems_shell_rtems_main_alias( |
---|
86 | int argc, |
---|
87 | char **argv |
---|
88 | ); |
---|
89 | @end example |
---|
90 | |
---|
91 | The configuration structure for the @code{COMMAND} has the |
---|
92 | following prototype: |
---|
93 | |
---|
94 | @example |
---|
95 | extern rtems_shell_cmd_t rtems_shell_ALIAS_Command; |
---|
96 | @end example |
---|
97 | |
---|
98 | @c |
---|
99 | @c |
---|
100 | @c |
---|
101 | @page |
---|
102 | @subsection date - print current date and time |
---|
103 | |
---|
104 | @pgindex date |
---|
105 | |
---|
106 | @subheading SYNOPSYS: |
---|
107 | |
---|
108 | @example |
---|
109 | date |
---|
110 | @end example |
---|
111 | |
---|
112 | @subheading DESCRIPTION: |
---|
113 | |
---|
114 | This command XXX |
---|
115 | |
---|
116 | @subheading EXIT STATUS: |
---|
117 | |
---|
118 | This command returns 0 on success and non-zero if an error is encountered. |
---|
119 | |
---|
120 | @subheading NOTES: |
---|
121 | |
---|
122 | NONE |
---|
123 | |
---|
124 | @subheading EXAMPLES: |
---|
125 | |
---|
126 | The following is an example of how to use date: |
---|
127 | |
---|
128 | @example |
---|
129 | EXAMPLE_TBD |
---|
130 | @end example |
---|
131 | |
---|
132 | @subheading CONFIGURATION: |
---|
133 | |
---|
134 | @findex CONFIGURE_SHELL_NO_COMMAND_DATE |
---|
135 | @findex CONFIGURE_SHELL_COMMAND_DATE |
---|
136 | |
---|
137 | This command is included in the default shell command set. |
---|
138 | When building a custom command set, define |
---|
139 | @code{CONFIGURE_SHELL_COMMAND_DATE} to have this |
---|
140 | command included. |
---|
141 | |
---|
142 | This command can be excluded from the shell command set by |
---|
143 | defining @code{CONFIGURE_SHELL_NO_COMMAND_DATE} when all |
---|
144 | shell commands have been configured. |
---|
145 | |
---|
146 | @subheading PROGRAMMING INFORMATION: |
---|
147 | |
---|
148 | @findex rtems_shell_rtems_main_date |
---|
149 | |
---|
150 | The @code{COMMAND} is implemented by a C language function |
---|
151 | which has the following prototype: |
---|
152 | |
---|
153 | @example |
---|
154 | int rtems_shell_rtems_main_date( |
---|
155 | int argc, |
---|
156 | char **argv |
---|
157 | ); |
---|
158 | @end example |
---|
159 | |
---|
160 | The configuration structure for the @code{COMMAND} has the |
---|
161 | following prototype: |
---|
162 | |
---|
163 | @example |
---|
164 | extern rtems_shell_cmd_t rtems_shell_DATE_Command; |
---|
165 | @end example |
---|
166 | |
---|
167 | @c |
---|
168 | @c |
---|
169 | @c |
---|
170 | @page |
---|
171 | @subsection id - show uid gid euid and egid |
---|
172 | |
---|
173 | @pgindex id |
---|
174 | |
---|
175 | @subheading SYNOPSYS: |
---|
176 | |
---|
177 | @example |
---|
178 | id |
---|
179 | @end example |
---|
180 | |
---|
181 | @subheading DESCRIPTION: |
---|
182 | |
---|
183 | This command XXX |
---|
184 | |
---|
185 | @subheading EXIT STATUS: |
---|
186 | |
---|
187 | This command returns 0 on success and non-zero if an error is encountered. |
---|
188 | |
---|
189 | @subheading NOTES: |
---|
190 | |
---|
191 | NONE |
---|
192 | |
---|
193 | @subheading EXAMPLES: |
---|
194 | |
---|
195 | The following is an example of how to use id: |
---|
196 | |
---|
197 | @example |
---|
198 | EXAMPLE_TBD |
---|
199 | @end example |
---|
200 | |
---|
201 | @subheading CONFIGURATION: |
---|
202 | |
---|
203 | @findex CONFIGURE_SHELL_NO_COMMAND_ID |
---|
204 | @findex CONFIGURE_SHELL_COMMAND_ID |
---|
205 | |
---|
206 | This command is included in the default shell command set. |
---|
207 | When building a custom command set, define |
---|
208 | @code{CONFIGURE_SHELL_COMMAND_ID} to have this |
---|
209 | command included. |
---|
210 | |
---|
211 | This command can be excluded from the shell command set by |
---|
212 | defining @code{CONFIGURE_SHELL_NO_COMMAND_ID} when all |
---|
213 | shell commands have been configured. |
---|
214 | |
---|
215 | @subheading PROGRAMMING INFORMATION: |
---|
216 | |
---|
217 | @findex rtems_shell_rtems_main_id |
---|
218 | |
---|
219 | The @code{COMMAND} is implemented by a C language function |
---|
220 | which has the following prototype: |
---|
221 | |
---|
222 | @example |
---|
223 | int rtems_shell_rtems_main_id( |
---|
224 | int argc, |
---|
225 | char **argv |
---|
226 | ); |
---|
227 | @end example |
---|
228 | |
---|
229 | The configuration structure for the @code{COMMAND} has the |
---|
230 | following prototype: |
---|
231 | |
---|
232 | @example |
---|
233 | extern rtems_shell_cmd_t rtems_shell_ID_Command; |
---|
234 | @end example |
---|
235 | |
---|
236 | @c |
---|
237 | @c |
---|
238 | @c |
---|
239 | @page |
---|
240 | @subsection tty - show ttyname |
---|
241 | |
---|
242 | @pgindex tty |
---|
243 | |
---|
244 | @subheading SYNOPSYS: |
---|
245 | |
---|
246 | @example |
---|
247 | tty |
---|
248 | @end example |
---|
249 | |
---|
250 | @subheading DESCRIPTION: |
---|
251 | |
---|
252 | This command XXX |
---|
253 | |
---|
254 | @subheading EXIT STATUS: |
---|
255 | |
---|
256 | This command returns 0 on success and non-zero if an error is encountered. |
---|
257 | |
---|
258 | @subheading NOTES: |
---|
259 | |
---|
260 | NONE |
---|
261 | |
---|
262 | @subheading EXAMPLES: |
---|
263 | |
---|
264 | The following is an example of how to use tty: |
---|
265 | |
---|
266 | @example |
---|
267 | EXAMPLE_TBD |
---|
268 | @end example |
---|
269 | |
---|
270 | @subheading CONFIGURATION: |
---|
271 | |
---|
272 | @findex CONFIGURE_SHELL_NO_COMMAND_TTY |
---|
273 | @findex CONFIGURE_SHELL_COMMAND_TTY |
---|
274 | |
---|
275 | This command is included in the default shell command set. |
---|
276 | When building a custom command set, define |
---|
277 | @code{CONFIGURE_SHELL_COMMAND_TTY} to have this |
---|
278 | command included. |
---|
279 | |
---|
280 | This command can be excluded from the shell command set by |
---|
281 | defining @code{CONFIGURE_SHELL_NO_COMMAND_TTY} when all |
---|
282 | shell commands have been configured. |
---|
283 | |
---|
284 | @subheading PROGRAMMING INFORMATION: |
---|
285 | |
---|
286 | @findex rtems_shell_rtems_main_tty |
---|
287 | |
---|
288 | The @code{COMMAND} is implemented by a C language function |
---|
289 | which has the following prototype: |
---|
290 | |
---|
291 | @example |
---|
292 | int rtems_shell_rtems_main_tty( |
---|
293 | int argc, |
---|
294 | char **argv |
---|
295 | ); |
---|
296 | @end example |
---|
297 | |
---|
298 | The configuration structure for the @code{COMMAND} has the |
---|
299 | following prototype: |
---|
300 | |
---|
301 | @example |
---|
302 | extern rtems_shell_cmd_t rtems_shell_TTY_Command; |
---|
303 | @end example |
---|
304 | |
---|
305 | @c |
---|
306 | @c |
---|
307 | @c |
---|
308 | @page |
---|
309 | @subsection whoami - show current user |
---|
310 | |
---|
311 | @pgindex whoami |
---|
312 | |
---|
313 | @subheading SYNOPSYS: |
---|
314 | |
---|
315 | @example |
---|
316 | whoami |
---|
317 | @end example |
---|
318 | |
---|
319 | @subheading DESCRIPTION: |
---|
320 | |
---|
321 | This command XXX |
---|
322 | |
---|
323 | @subheading EXIT STATUS: |
---|
324 | |
---|
325 | This command returns 0 on success and non-zero if an error is encountered. |
---|
326 | |
---|
327 | @subheading NOTES: |
---|
328 | |
---|
329 | NONE |
---|
330 | |
---|
331 | @subheading EXAMPLES: |
---|
332 | |
---|
333 | The following is an example of how to use whoami: |
---|
334 | |
---|
335 | @example |
---|
336 | EXAMPLE_TBD |
---|
337 | @end example |
---|
338 | |
---|
339 | @subheading CONFIGURATION: |
---|
340 | |
---|
341 | @findex CONFIGURE_SHELL_NO_COMMAND_WHOAMI |
---|
342 | @findex CONFIGURE_SHELL_COMMAND_WHOAMI |
---|
343 | |
---|
344 | This command is included in the default shell command set. |
---|
345 | When building a custom command set, define |
---|
346 | @code{CONFIGURE_SHELL_COMMAND_WHOAMI} to have this |
---|
347 | command included. |
---|
348 | |
---|
349 | This command can be excluded from the shell command set by |
---|
350 | defining @code{CONFIGURE_SHELL_NO_COMMAND_WHOAMI} when all |
---|
351 | shell commands have been configured. |
---|
352 | |
---|
353 | @subheading PROGRAMMING INFORMATION: |
---|
354 | |
---|
355 | @findex rtems_shell_rtems_main_whoami |
---|
356 | |
---|
357 | The @code{COMMAND} is implemented by a C language function |
---|
358 | which has the following prototype: |
---|
359 | |
---|
360 | @example |
---|
361 | int rtems_shell_rtems_main_whoami( |
---|
362 | int argc, |
---|
363 | char **argv |
---|
364 | ); |
---|
365 | @end example |
---|
366 | |
---|
367 | The configuration structure for the @code{COMMAND} has the |
---|
368 | following prototype: |
---|
369 | |
---|
370 | @example |
---|
371 | extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command; |
---|
372 | @end example |
---|
373 | |
---|
374 | @c |
---|
375 | @c |
---|
376 | @c |
---|
377 | @page |
---|
378 | @subsection logoff - logoff from the system |
---|
379 | |
---|
380 | @pgindex logoff |
---|
381 | |
---|
382 | @subheading SYNOPSYS: |
---|
383 | |
---|
384 | @example |
---|
385 | logoff |
---|
386 | @end example |
---|
387 | |
---|
388 | @subheading DESCRIPTION: |
---|
389 | |
---|
390 | This command XXX |
---|
391 | |
---|
392 | @subheading EXIT STATUS: |
---|
393 | |
---|
394 | This command returns 0 on success and non-zero if an error is encountered. |
---|
395 | |
---|
396 | @subheading NOTES: |
---|
397 | |
---|
398 | NONE |
---|
399 | |
---|
400 | @subheading EXAMPLES: |
---|
401 | |
---|
402 | The following is an example of how to use logoff: |
---|
403 | |
---|
404 | @example |
---|
405 | EXAMPLE_TBD |
---|
406 | @end example |
---|
407 | |
---|
408 | @subheading CONFIGURATION: |
---|
409 | |
---|
410 | @findex CONFIGURE_SHELL_NO_COMMAND_LOGOFF |
---|
411 | @findex CONFIGURE_SHELL_COMMAND_LOGOFF |
---|
412 | |
---|
413 | This command is included in the default shell command set. |
---|
414 | When building a custom command set, define |
---|
415 | @code{CONFIGURE_SHELL_COMMAND_LOGOFF} to have this |
---|
416 | command included. |
---|
417 | |
---|
418 | This command can be excluded from the shell command set by |
---|
419 | defining @code{CONFIGURE_SHELL_NO_COMMAND_LOGOFF} when all |
---|
420 | shell commands have been configured. |
---|
421 | |
---|
422 | @subheading PROGRAMMING INFORMATION: |
---|
423 | |
---|
424 | @findex rtems_shell_rtems_main_logoff |
---|
425 | |
---|
426 | The @code{COMMAND} is implemented by a C language function |
---|
427 | which has the following prototype: |
---|
428 | |
---|
429 | @example |
---|
430 | int rtems_shell_rtems_main_logoff( |
---|
431 | int argc, |
---|
432 | char **argv |
---|
433 | ); |
---|
434 | @end example |
---|
435 | |
---|
436 | The configuration structure for the @code{COMMAND} has the |
---|
437 | following prototype: |
---|
438 | |
---|
439 | @example |
---|
440 | extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command; |
---|
441 | @end example |
---|
442 | |
---|
443 | @c |
---|
444 | @c |
---|
445 | @c |
---|
446 | @page |
---|
447 | @subsection exit - alias for logoff command |
---|
448 | |
---|
449 | @pgindex exit |
---|
450 | |
---|
451 | @subheading SYNOPSYS: |
---|
452 | |
---|
453 | @example |
---|
454 | exit |
---|
455 | @end example |
---|
456 | |
---|
457 | @subheading DESCRIPTION: |
---|
458 | |
---|
459 | This command XXX |
---|
460 | |
---|
461 | @subheading EXIT STATUS: |
---|
462 | |
---|
463 | This command returns 0 on success and non-zero if an error is encountered. |
---|
464 | |
---|
465 | @subheading NOTES: |
---|
466 | |
---|
467 | NONE |
---|
468 | |
---|
469 | @subheading EXAMPLES: |
---|
470 | |
---|
471 | The following is an example of how to use exit: |
---|
472 | |
---|
473 | @example |
---|
474 | EXAMPLE_TBD |
---|
475 | @end example |
---|
476 | |
---|
477 | @subheading CONFIGURATION: |
---|
478 | |
---|
479 | @findex CONFIGURE_SHELL_NO_COMMAND_EXIT |
---|
480 | @findex CONFIGURE_SHELL_COMMAND_EXIT |
---|
481 | |
---|
482 | This command is included in the default shell command set. |
---|
483 | When building a custom command set, define |
---|
484 | @code{CONFIGURE_SHELL_COMMAND_EXIT} to have this |
---|
485 | command included. |
---|
486 | |
---|
487 | This command can be excluded from the shell command set by |
---|
488 | defining @code{CONFIGURE_SHELL_NO_COMMAND_EXIT} when all |
---|
489 | shell commands have been configured. |
---|
490 | |
---|
491 | @subheading PROGRAMMING INFORMATION: |
---|
492 | |
---|
493 | @findex rtems_shell_rtems_main_exit |
---|
494 | |
---|
495 | The @code{COMMAND} is implemented by a C language function |
---|
496 | which has the following prototype: |
---|
497 | |
---|
498 | @example |
---|
499 | int rtems_shell_rtems_main_exit( |
---|
500 | int argc, |
---|
501 | char **argv |
---|
502 | ); |
---|
503 | @end example |
---|
504 | |
---|
505 | The configuration structure for the @code{COMMAND} has the |
---|
506 | following prototype: |
---|
507 | |
---|
508 | @example |
---|
509 | extern rtems_shell_cmd_t rtems_shell_EXIT_Command; |
---|
510 | @end example |
---|
511 | |
---|