2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=UTF-8" >
< title > ChibiOS/RT: shell.h File Reference< / title >
< link href = "custom.css" rel = "stylesheet" type = "text/css" >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" >
< / head > < body >
< table style = "text-align: center; width: 100%;" border = "0"
cellpadding="2" cellspacing="2">
< tbody >
< tr >
< td style = "width: 80px;" > < img alt = "ChibiOS/RT Logo" src = "logo_small.png" > < / td >
< td > < big > < big > ChibiOS/RT< / big > < / big > < br > < br > Architecture - Reference Manual - Guides< / td >
< td style = "width: 80px;" > < / td >
< / tr >
< / tbody >
< / table >
< hr size = "1" >
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
< div class = "navigation" id = "top" >
< div class = "tabs" >
2010-11-22 05:53:37 +00:00
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "main.html" > < span > Main Page< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data Structures< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "tabs2" >
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "files.html" > < span > File List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > Globals< / span > < / a > < / li >
< / ul >
< / div >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Data Structures< / a > |
< a href = "#define-members" > Defines< / a > |
< a href = "#typedef-members" > Typedefs< / a > |
< a href = "#func-members" > Functions< / a > |
< a href = "#var-members" > Variables< / a > < / div >
< div class = "headertitle" >
< h1 > shell.h File Reference< / h1 > < / div >
< / div >
2010-08-10 03:11:02 +00:00
< div class = "contents" >
2010-11-22 05:53:37 +00:00
2010-08-10 03:11:02 +00:00
< p > Simple CLI shell header.
< a href = "#_details" > More...< / a > < / p >
< p > < a href = "shell_8h_source.html" > Go to the source code of this file.< / a > < / p >
2010-11-22 05:53:37 +00:00
< table class = "memberdecls" >
< tr > < td colspan = "2" > < h2 > < a name = "nested-classes" > < / a >
Data Structures< / h2 > < / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > struct < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_shell_command.html" > ShellCommand< / a > < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Custom command entry type. < a href = "struct_shell_command.html#_details" > More...< / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > struct < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_shell_config.html" > ShellConfig< / a > < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Shell descriptor type. < a href = "struct_shell_config.html#_details" > More...< / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td colspan = "2" > < h2 > < a name = "define-members" > < / a >
Defines< / h2 > < / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#ga0aee139645cf59df04bc31635f553024" > SHELL_MAX_LINE_LENGTH< / a > 64< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Shell maximum input line length. < a href = "group___s_h_e_l_l.html#ga0aee139645cf59df04bc31635f553024" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#ga730dd92884d4fce406efb6678aea8062" > SHELL_MAX_ARGUMENTS< / a > 4< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Shell maximum arguments per command. < a href = "group___s_h_e_l_l.html#ga730dd92884d4fce406efb6678aea8062" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#ga73b5fc520b80ade7b64b2f22c835dbd7" > SHELL_USE_IPRINTF< / a > TRUE< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Enforces the use of iprintf() on newlib. < a href = "group___s_h_e_l_l.html#ga73b5fc520b80ade7b64b2f22c835dbd7" > < / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td colspan = "2" > < h2 > < a name = "typedef-members" > < / a >
Typedefs< / h2 > < / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > typedef void(* < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#gac6a0d1d8a290b0c82979a1739e804bc1" > shellcmd_t< / a > )(< a class = "el" href = "struct_base_channel.html" > BaseChannel< / a > *chp, int argc, char *argv[])< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Command handler function type. < a href = "group___s_h_e_l_l.html#gac6a0d1d8a290b0c82979a1739e804bc1" > < / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td colspan = "2" > < h2 > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#ga0b1dba28bb03cb29749f32a595d5ec57" > shellInit< / a > (void)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Shell manager initialization. < a href = "group___s_h_e_l_l.html#ga0b1dba28bb03cb29749f32a595d5ec57" > < / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "struct_thread.html" > Thread< / a > * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#gaa1ede2e94e6d3eba37cdda717f6c1656" > shellCreate< / a > (const < a class = "el" href = "struct_shell_config.html" > ShellConfig< / a > *scp, size_t size, < a class = "el" href = "group__types.html#ga5f2488ba73e5969cbc0f7033735374ee" > tprio_t< / a > prio)< / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Spawns a new shell. < a href = "group___s_h_e_l_l.html#gaa1ede2e94e6d3eba37cdda717f6c1656" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#ga4660b06c861d5506fb35d9844e2d8288" > shellPrint< / a > (< a class = "el" href = "struct_base_channel.html" > BaseChannel< / a > *chp, const char *msg)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Prints a string. < a href = "group___s_h_e_l_l.html#ga4660b06c861d5506fb35d9844e2d8288" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#ga7bffb6aa1f0ec1e12dfaa86c3b692330" > shellPrintLine< / a > (< a class = "el" href = "struct_base_channel.html" > BaseChannel< / a > *chp, const char *msg)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Prints a string with a final newline. < a href = "group___s_h_e_l_l.html#ga7bffb6aa1f0ec1e12dfaa86c3b692330" > < / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "group__types.html#ga7556af1cb61728b53228fa3af1c851de" > bool_t< / a > < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#ga1c7aadcfefdc616bd8450117b6972274" > shellGetLine< / a > (< a class = "el" href = "struct_base_channel.html" > BaseChannel< / a > *chp, char *line, unsigned size)< / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Reads a whole line from the input channel. < a href = "group___s_h_e_l_l.html#ga1c7aadcfefdc616bd8450117b6972274" > < / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td colspan = "2" > < h2 > < a name = "var-members" > < / a >
Variables< / h2 > < / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "struct_event_source.html" > EventSource< / a > < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___s_h_e_l_l.html#ga168440e44c637282589a4e28eb3a91b8" > shell_terminated< / a > < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Shell termination event source. < a href = "group___s_h_e_l_l.html#ga168440e44c637282589a4e28eb3a91b8" > < / a > < br / > < / td > < / tr >
< / table >
< hr / > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
< p > Simple CLI shell header. < / p >
< p > Definition in file < a class = "el" href = "shell_8h_source.html" > shell.h< / a > .< / p >
< / div >
< hr size = "1" > < address style = "text-align: right;" > < small >
2010-11-22 05:53:37 +00:00
Generated on Sun Oct 24 2010 09:40:38 for ChibiOS/RT by < a href = "http://www.doxygen.org/index.html" > < img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.7.1< / small > < / address >
2010-08-10 03:11:02 +00:00
< / body >
< / html >
