<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>popthelp.c File Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.2.17 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> <a class="qindex" href="pages.html">Related Pages</a> </center> <hr><h1>popt/popthelp.c File Reference</h1> <a href="#_details">More...</a> <p> <code>#include "system.h"</code><br> <code>#include "<a class="el" href="poptint_8h-source.html">poptint.h</a>"</code><br> <p> <a href="popthelp_8c-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Functions</h2></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="popthelp_8c.html#a2">displayArgs</a> (<a class="el" href="group__popt.html#a2">poptContext</a> con, enum <a class="el" href="popt_8h.html#a81">poptCallbackReason</a> foo, struct <a class="el" href="structpoptOption.html">poptOption</a> *key, const char *arg, void *data)</td></tr> <tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="popthelp_8c.html#a3">getTableTranslationDomain</a> (const struct <a class="el" href="structpoptOption.html">poptOption</a> *table)</td></tr> <tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="popthelp_8c.html#a4">getArgDescrip</a> (const struct <a class="el" href="structpoptOption.html">poptOption</a> *opt, const char *translation_domain)</td></tr> <tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="popthelp_8c.html#a5">singleOptionDefaultValue</a> (int lineLength, const struct <a class="el" href="structpoptOption.html">poptOption</a> *opt, const char *translation_domain)</td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="popthelp_8c.html#a6">singleOptionHelp</a> (FILE *fp, int maxLeftCol, const struct <a class="el" href="structpoptOption.html">poptOption</a> *opt, const char *translation_domain)</td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="popthelp_8c.html#a7">maxArgWidth</a> (const struct <a class="el" href="structpoptOption.html">poptOption</a> *opt, const char *translation_domain)</td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="popthelp_8c.html#a8">itemHelp</a> (FILE *fp, <a class="el" href="group__popt.html#a0">poptItem</a> items, int nitems, int left, const char *translation_domain)</td></tr> <tr><td> </td><td><font size=-1><em>Display popt alias and exec help.</em> <a href="#a8"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="popthelp_8c.html#a9">singleTableHelp</a> (<a class="el" href="group__popt.html#a2">poptContext</a> con, FILE *fp, const struct <a class="el" href="structpoptOption.html">poptOption</a> *table, int left, const char *translation_domain)</td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="popthelp_8c.html#a10">showHelpIntro</a> (<a class="el" href="group__popt.html#a2">poptContext</a> con, FILE *fp)</td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__popt.html#a11">poptPrintHelp</a> (<a class="el" href="group__popt.html#a2">poptContext</a> con, FILE *fp, int flags)</td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="popthelp_8c.html#a12">singleOptionUsage</a> (FILE *fp, int cursor, const struct <a class="el" href="structpoptOption.html">poptOption</a> *opt, const char *translation_domain)</td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="popthelp_8c.html#a13">itemUsage</a> (FILE *fp, int cursor, <a class="el" href="group__popt.html#a0">poptItem</a> item, int nitems, const char *translation_domain)</td></tr> <tr><td> </td><td><font size=-1><em>Display popt alias and exec usage.</em> <a href="#a13"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="popthelp_8c.html#a14">singleTableUsage</a> (<a class="el" href="group__popt.html#a2">poptContext</a> con, FILE *fp, int cursor, const struct <a class="el" href="structpoptOption.html">poptOption</a> *opt, const char *translation_domain)</td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="popthelp_8c.html#a15">showShortOptions</a> (const struct <a class="el" href="structpoptOption.html">poptOption</a> *opt, FILE *fp, char *str)</td></tr> <tr><td> </td><td><font size=-1><em>Return concatenated short options for display.</em> <a href="#a15"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__popt.html#a16">poptPrintUsage</a> (<a class="el" href="group__popt.html#a2">poptContext</a> con, FILE *fp, int flags)</td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__popt.html#a17">poptSetOtherOptionHelp</a> (<a class="el" href="group__popt.html#a2">poptContext</a> con, const char *text)</td></tr> <tr><td colspan=2><br><h2>Variables</h2></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="structpoptOption.html">poptOption</a> </td><td valign=bottom><a class="el" href="popthelp_8c.html#a0">poptAliasOptions</a> []</td></tr> <tr><td> </td><td><font size=-1><em>Empty table marker to enable displaying popt alias/exec options.</em> <a href="#a0"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="structpoptOption.html">poptOption</a> </td><td valign=bottom><a class="el" href="popthelp_8c.html#a1">poptHelpOptions</a> []</td></tr> <tr><td> </td><td><font size=-1><em>Auto help table options.</em> <a href="#a1"></a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <p> <p> Definition in file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>.<hr><h2>Function Documentation</h2> <a name="a2" doxytag="popthelp.c::displayArgs"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void displayArgs </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__popt.html#a2">poptContext</a> </td> <td class="mdname" nowrap> <em>con</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>enum <a class="el" href="popt_8h.html#a81">poptCallbackReason</a> </td> <td class="mdname" nowrap> <em>foo</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname" nowrap> <em>key</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>arg</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>void * </td> <td class="mdname" nowrap> <em>data</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>con</em> </td><td> context </td></tr> <tr><td valign=top><em>key</em> </td><td> option(s) </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00019">19</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="popt_8h-source.html#l00179">poptCallbackReason</a>, <a class="el" href="popthelp_8c-source.html#l00473">poptPrintHelp</a>(), <a class="el" href="popthelp_8c-source.html#l00632">poptPrintUsage</a>(), and <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>. </td> </tr> </table> <a name="a4" doxytag="popthelp.c::getArgDescrip"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> const char* const getArgDescrip </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname" nowrap> <em>opt</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>translation_domain</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>opt</em> </td><td> option(s) </td></tr> <tr><td valign=top><em>translation_domain</em> </td><td> translation domain </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00085">85</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="popt_8h-source.html#l00121">poptOption::argDescrip</a>, <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="poptint_8h-source.html#l00090">D_</a>, <a class="el" href="poptint_8h-source.html#l00091">POPT_</a>, <a class="el" href="popt_8h-source.html#l00035">POPT_ARG_DOUBLE</a>, <a class="el" href="popt_8h-source.html#l00034">POPT_ARG_FLOAT</a>, <a class="el" href="popt_8h-source.html#l00022">POPT_ARG_INT</a>, <a class="el" href="popt_8h-source.html#l00023">POPT_ARG_LONG</a>, <a class="el" href="popt_8h-source.html#l00037">POPT_ARG_MASK</a>, <a class="el" href="popt_8h-source.html#l00020">POPT_ARG_NONE</a>, <a class="el" href="popt_8h-source.html#l00021">POPT_ARG_STRING</a>, and <a class="el" href="popt_8h-source.html#l00033">POPT_ARG_VAL</a>. <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00343">maxArgWidth</a>(), <a class="el" href="popthelp_8c-source.html#l00182">singleOptionHelp</a>(), and <a class="el" href="popthelp_8c-source.html#l00492">singleOptionUsage</a>(). </td> </tr> </table> <a name="a3" doxytag="popthelp.c::getTableTranslationDomain"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> const char* const getTableTranslationDomain </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname1" valign="top" nowrap> <em>table</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>table</em> </td><td> option(s) </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00067">67</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="popt_8h-source.html#l00118">poptOption::arg</a>, <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="popt_8h-source.html#l00115">poptOption::longName</a>, <a class="el" href="popt_8h-source.html#l00029">POPT_ARG_INTL_DOMAIN</a>, and <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>. <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00411">singleTableHelp</a>(). </td> </tr> </table> <a name="a8" doxytag="popthelp.c::itemHelp"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void itemHelp </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FILE * </td> <td class="mdname" nowrap> <em>fp</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="group__popt.html#a0">poptItem</a> </td> <td class="mdname" nowrap> <em>items</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>nitems</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>left</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>translation_domain</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Display popt alias and exec help. <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>fp</em> </td><td> output file handle </td></tr> <tr><td valign=top><em>items</em> </td><td> alias/exec array </td></tr> <tr><td valign=top><em>nitems</em> </td><td> no. of alias/exec entries </td></tr> <tr><td valign=top><em>translation_domain</em> </td><td> translation domain </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00387">387</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="popt_8h-source.html#l00115">poptOption::longName</a>, <a class="el" href="popt_8h-source.html#l00138">poptItem_s::option</a>, <a class="el" href="popt_8h-source.html#l00045">POPT_ARGFLAG_DOC_HIDDEN</a>, <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>, and <a class="el" href="popthelp_8c-source.html#l00182">singleOptionHelp</a>(). <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00411">singleTableHelp</a>(). </td> </tr> </table> <a name="a13" doxytag="popthelp.c::itemUsage"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int itemUsage </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FILE * </td> <td class="mdname" nowrap> <em>fp</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>cursor</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="group__popt.html#a0">poptItem</a> </td> <td class="mdname" nowrap> <em>item</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>nitems</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>translation_domain</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Display popt alias and exec usage. <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>fp</em> </td><td> output file handle </td></tr> <tr><td valign=top><em>item</em> </td><td> alias/exec array </td></tr> <tr><td valign=top><em>nitems</em> </td><td> no. of ara/exec entries </td></tr> <tr><td valign=top><em>translation_domain</em> </td><td> translation domain </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00540">540</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="popt_8h-source.html#l00118">poptOption::arg</a>, <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="popt_8h-source.html#l00115">poptOption::longName</a>, <a class="el" href="popt_8h-source.html#l00138">poptItem_s::option</a>, <a class="el" href="popt_8h-source.html#l00029">POPT_ARG_INTL_DOMAIN</a>, <a class="el" href="popt_8h-source.html#l00037">POPT_ARG_MASK</a>, <a class="el" href="popt_8h-source.html#l00045">POPT_ARGFLAG_DOC_HIDDEN</a>, <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>, and <a class="el" href="popthelp_8c-source.html#l00492">singleOptionUsage</a>(). <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00632">poptPrintUsage</a>(). </td> </tr> </table> <a name="a7" doxytag="popthelp.c::maxArgWidth"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int maxArgWidth </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname" nowrap> <em>opt</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>translation_domain</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>opt</em> </td><td> option(s) </td></tr> <tr><td valign=top><em>translation_domain</em> </td><td> translation domain </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00343">343</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="popt_8h-source.html#l00118">poptOption::arg</a>, <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="popthelp_8c-source.html#l00085">getArgDescrip</a>(), <a class="el" href="popt_8h-source.html#l00115">poptOption::longName</a>, <a class="el" href="popt_8h-source.html#l00024">POPT_ARG_INCLUDE_TABLE</a>, <a class="el" href="popt_8h-source.html#l00037">POPT_ARG_MASK</a>, <a class="el" href="popt_8h-source.html#l00045">POPT_ARGFLAG_DOC_HIDDEN</a>, <a class="el" href="popt_8h-source.html#l00044">POPT_ARGFLAG_ONEDASH</a>, <a class="el" href="popt_8h-source.html#l00047">POPT_ARGFLAG_OPTIONAL</a>, and <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>. <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00473">poptPrintHelp</a>(). </td> </tr> </table> <a name="a10" doxytag="popthelp.c::showHelpIntro"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int showHelpIntro </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__popt.html#a2">poptContext</a> </td> <td class="mdname" nowrap> <em>con</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FILE * </td> <td class="mdname" nowrap> <em>fp</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>con</em> </td><td> context </td></tr> <tr><td valign=top><em>fp</em> </td><td> output file handle </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00452">452</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="poptint_8h-source.html#l00043">optionStackEntry::argv</a>, <a class="el" href="poptint_8h-source.html#l00063">poptContext_s::flags</a>, <a class="el" href="poptint_8h-source.html#l00053">poptContext_s::optionStack</a>, <a class="el" href="poptint_8h-source.html#l00091">POPT_</a>, and <a class="el" href="popt_8h-source.html#l00107">POPT_CONTEXT_KEEP_FIRST</a>. <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00473">poptPrintHelp</a>(), and <a class="el" href="popthelp_8c-source.html#l00632">poptPrintUsage</a>(). </td> </tr> </table> <a name="a15" doxytag="popthelp.c::showShortOptions"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int showShortOptions </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname" nowrap> <em>opt</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FILE * </td> <td class="mdname" nowrap> <em>fp</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>char * </td> <td class="mdname" nowrap> <em>str</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Return concatenated short options for display. <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>opt</em> </td><td> option(s) </td></tr> <tr><td valign=top><em>fp</em> </td><td> output file handle </td></tr> </table> </dl><dl compact><dt><b>Return values: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>str</em> </td><td> concatenation of short options </td></tr> </table> </dl><dl compact><dt><b>Returns :</b></dt><dd> length of display string </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00601">601</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="system_8h.html#a36">alloca</a>(), <a class="el" href="popt_8h-source.html#l00118">poptOption::arg</a>, <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="popt_8h-source.html#l00115">poptOption::longName</a>, <a class="el" href="popt_8h-source.html#l00024">POPT_ARG_INCLUDE_TABLE</a>, <a class="el" href="popt_8h-source.html#l00037">POPT_ARG_MASK</a>, and <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>. <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00632">poptPrintUsage</a>(). </td> </tr> </table> <a name="a5" doxytag="popthelp.c::singleOptionDefaultValue"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> char* singleOptionDefaultValue </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> <td class="mdname" nowrap> <em>lineLength</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname" nowrap> <em>opt</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>translation_domain</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>opt</em> </td><td> option(s) </td></tr> <tr><td valign=top><em>translation_domain</em> </td><td> translation domain </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00115">115</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="poptint_8h-source.html#l00018">_free</a>(), <a class="el" href="popt_8h-source.html#l00118">poptOption::arg</a>, <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="poptint_8h-source.html#l00090">D_</a>, <a class="el" href="popt_8h-source.html#l00035">POPT_ARG_DOUBLE</a>, <a class="el" href="popt_8h-source.html#l00034">POPT_ARG_FLOAT</a>, <a class="el" href="popt_8h-source.html#l00022">POPT_ARG_INT</a>, <a class="el" href="popt_8h-source.html#l00023">POPT_ARG_LONG</a>, <a class="el" href="popt_8h-source.html#l00037">POPT_ARG_MASK</a>, <a class="el" href="popt_8h-source.html#l00020">POPT_ARG_NONE</a>, <a class="el" href="popt_8h-source.html#l00021">POPT_ARG_STRING</a>, and <a class="el" href="popt_8h-source.html#l00033">POPT_ARG_VAL</a>. <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00182">singleOptionHelp</a>(). </td> </tr> </table> <a name="a6" doxytag="popthelp.c::singleOptionHelp"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void singleOptionHelp </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FILE * </td> <td class="mdname" nowrap> <em>fp</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>maxLeftCol</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname" nowrap> <em>opt</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>translation_domain</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>fp</em> </td><td> output file handle </td></tr> <tr><td valign=top><em>opt</em> </td><td> option(s) </td></tr> <tr><td valign=top><em>translation_domain</em> </td><td> translation domain </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00182">182</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="poptint_8h-source.html#l00018">_free</a>(), <a class="el" href="popt_8h-source.html#l00121">poptOption::argDescrip</a>, <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="poptint_8h-source.html#l00090">D_</a>, <a class="el" href="popt_8h-source.html#l00120">poptOption::descrip</a>, <a class="el" href="popthelp_8c-source.html#l00085">getArgDescrip</a>(), <a class="el" href="popt_8h-source.html#l00115">poptOption::longName</a>, <a class="el" href="rpmio__internal_8h-source.html#l00046">ops</a>, <a class="el" href="popt_8h-source.html#l00035">POPT_ARG_DOUBLE</a>, <a class="el" href="popt_8h-source.html#l00034">POPT_ARG_FLOAT</a>, <a class="el" href="popt_8h-source.html#l00022">POPT_ARG_INT</a>, <a class="el" href="popt_8h-source.html#l00023">POPT_ARG_LONG</a>, <a class="el" href="popt_8h-source.html#l00037">POPT_ARG_MASK</a>, <a class="el" href="popt_8h-source.html#l00020">POPT_ARG_NONE</a>, <a class="el" href="popt_8h-source.html#l00021">POPT_ARG_STRING</a>, <a class="el" href="popt_8h-source.html#l00033">POPT_ARG_VAL</a>, <a class="el" href="popt_8h-source.html#l00051">POPT_ARGFLAG_AND</a>, <a class="el" href="popt_8h-source.html#l00055">POPT_ARGFLAG_LOGICALOPS</a>, <a class="el" href="popt_8h-source.html#l00054">POPT_ARGFLAG_NOT</a>, <a class="el" href="popt_8h-source.html#l00044">POPT_ARGFLAG_ONEDASH</a>, <a class="el" href="popt_8h-source.html#l00047">POPT_ARGFLAG_OPTIONAL</a>, <a class="el" href="popt_8h-source.html#l00049">POPT_ARGFLAG_OR</a>, <a class="el" href="popt_8h-source.html#l00063">POPT_ARGFLAG_SHOW_DEFAULT</a>, <a class="el" href="popt_8h-source.html#l00053">POPT_ARGFLAG_XOR</a>, <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>, <a class="el" href="popthelp_8c-source.html#l00115">singleOptionDefaultValue</a>(), and <a class="el" href="popt_8h-source.html#l00119">poptOption::val</a>. <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00387">itemHelp</a>(), and <a class="el" href="popthelp_8c-source.html#l00411">singleTableHelp</a>(). </td> </tr> </table> <a name="a12" doxytag="popthelp.c::singleOptionUsage"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int singleOptionUsage </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FILE * </td> <td class="mdname" nowrap> <em>fp</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>cursor</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname" nowrap> <em>opt</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>translation_domain</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>fp</em> </td><td> output file handle </td></tr> <tr><td valign=top><em>opt</em> </td><td> option(s) </td></tr> <tr><td valign=top><em>translation_domain</em> </td><td> translation domain </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00492">492</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="popthelp_8c-source.html#l00085">getArgDescrip</a>(), <a class="el" href="popt_8h-source.html#l00115">poptOption::longName</a>, <a class="el" href="popt_8h-source.html#l00037">POPT_ARG_MASK</a>, <a class="el" href="popt_8h-source.html#l00044">POPT_ARGFLAG_ONEDASH</a>, and <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>. <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00540">itemUsage</a>(), and <a class="el" href="popthelp_8c-source.html#l00569">singleTableUsage</a>(). </td> </tr> </table> <a name="a9" doxytag="popthelp.c::singleTableHelp"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void singleTableHelp </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__popt.html#a2">poptContext</a> </td> <td class="mdname" nowrap> <em>con</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FILE * </td> <td class="mdname" nowrap> <em>fp</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname" nowrap> <em>table</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>left</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>translation_domain</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>fp</em> </td><td> output file handle </td></tr> <tr><td valign=top><em>table</em> </td><td> option(s) </td></tr> <tr><td valign=top><em>translation_domain</em> </td><td> translation domain </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00411">411</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="poptint_8h-source.html#l00061">poptContext_s::aliases</a>, <a class="el" href="popt_8h-source.html#l00118">poptOption::arg</a>, <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="poptint_8h-source.html#l00090">D_</a>, <a class="el" href="popt_8h-source.html#l00120">poptOption::descrip</a>, <a class="el" href="poptint_8h-source.html#l00064">poptContext_s::execs</a>, <a class="el" href="popthelp_8c-source.html#l00067">getTableTranslationDomain</a>(), <a class="el" href="popthelp_8c-source.html#l00387">itemHelp</a>(), <a class="el" href="popt_8h-source.html#l00115">poptOption::longName</a>, <a class="el" href="poptint_8h-source.html#l00062">poptContext_s::numAliases</a>, <a class="el" href="poptint_8h-source.html#l00065">poptContext_s::numExecs</a>, <a class="el" href="popt_8h-source.html#l00024">POPT_ARG_INCLUDE_TABLE</a>, <a class="el" href="popt_8h-source.html#l00037">POPT_ARG_MASK</a>, <a class="el" href="popt_8h-source.html#l00045">POPT_ARGFLAG_DOC_HIDDEN</a>, <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>, and <a class="el" href="popthelp_8c-source.html#l00182">singleOptionHelp</a>(). <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00473">poptPrintHelp</a>(). </td> </tr> </table> <a name="a14" doxytag="popthelp.c::singleTableUsage"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int singleTableUsage </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__popt.html#a2">poptContext</a> </td> <td class="mdname" nowrap> <em>con</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FILE * </td> <td class="mdname" nowrap> <em>fp</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>cursor</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const struct <a class="el" href="structpoptOption.html">poptOption</a> * </td> <td class="mdname" nowrap> <em>opt</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const char * </td> <td class="mdname" nowrap> <em>translation_domain</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>fp</em> </td><td> output file handle </td></tr> <tr><td valign=top><em>opt</em> </td><td> option(s) </td></tr> <tr><td valign=top><em>translation_domain</em> </td><td> translation domain </td></tr> </table> </dl> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00569">569</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. <p> References <a class="el" href="popt_8h-source.html#l00118">poptOption::arg</a>, <a class="el" href="popt_8h-source.html#l00117">poptOption::argInfo</a>, <a class="el" href="popt_8h-source.html#l00115">poptOption::longName</a>, <a class="el" href="popt_8h-source.html#l00024">POPT_ARG_INCLUDE_TABLE</a>, <a class="el" href="popt_8h-source.html#l00029">POPT_ARG_INTL_DOMAIN</a>, <a class="el" href="popt_8h-source.html#l00037">POPT_ARG_MASK</a>, <a class="el" href="popt_8h-source.html#l00045">POPT_ARGFLAG_DOC_HIDDEN</a>, <a class="el" href="popt_8h-source.html#l00116">poptOption::shortName</a>, and <a class="el" href="popthelp_8c-source.html#l00492">singleOptionUsage</a>(). <p> Referenced by <a class="el" href="popthelp_8c-source.html#l00632">poptPrintUsage</a>(). </td> </tr> </table> <hr><h2>Variable Documentation</h2> <a name="a0" doxytag="popthelp.c::poptAliasOptions"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> struct <a class="el" href="structpoptOption.html">poptOption</a> poptAliasOptions[] </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <b>Initial value:</b><div class="fragment"><pre> { <a class="code" href="popt_8h.html#a48">POPT_TABLEEND</a> }</pre></div>Empty table marker to enable displaying popt alias/exec options. <p> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00042">42</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. </td> </tr> </table> <a name="a1" doxytag="popthelp.c::poptHelpOptions"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> struct <a class="el" href="structpoptOption.html">poptOption</a> poptHelpOptions[] </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <b>Initial value:</b><div class="fragment"><pre> { { NULL, <span class="charliteral">'\0'</span>, <a class="code" href="group__popt.html#a38">POPT_ARG_CALLBACK</a>, (<span class="keywordtype">void</span> *)&displayArgs, <span class="charliteral">'\0'</span>, NULL, NULL }, { <span class="stringliteral">"help"</span>, <span class="charliteral">'?'</span>, 0, NULL, <span class="charliteral">'?'</span>, <span class="stringliteral">"Show this help message"</span> , NULL }, { <span class="stringliteral">"usage"</span>, <span class="charliteral">'\0'</span>, 0, NULL, <span class="charliteral">'u'</span>, <span class="stringliteral">"Display brief usage message"</span> , NULL }, <a class="code" href="popt_8h.html#a48">POPT_TABLEEND</a> }</pre></div>Auto help table options. <p> <p> Definition at line <a class="el" href="popthelp_8c-source.html#l00051">51</a> of file <a class="el" href="popthelp_8c-source.html">popthelp.c</a>. </td> </tr> </table> <hr><address style="align: right;"><small>Generated on Thu Sep 12 22:15:06 2002 for rpm by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.17 </small></address> </body> </html>