<refentry id="gnome-gnome-popt">
<refmeta>
<refentrytitle>gnome-popt</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GNOME Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gnome-popt</refname><refpurpose>Command line argument parser</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<synopsis>

#include &lt;gnome.h&gt;


void        <link linkend="gnomelib-register-popt-table">gnomelib_register_popt_table</link>    (const struct <link linkend="poptOption">poptOption</link> *options,
                                             const char *description);
<link linkend="poptContext">poptContext</link> <link linkend="gnomelib-parse-args">gnomelib_parse_args</link>             (int argc,
                                             char *argv[],
                                             int popt_flags);
</synopsis>
</refsynopsisdiv>





<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gnomelib-register-popt-table">gnomelib_register_popt_table ()</title>
<programlisting>void        gnomelib_register_popt_table    (const struct <link linkend="poptOption">poptOption</link> *options,
                                             const char *description);</programlisting>
<para>
Registers the <parameter>options</parameter> table of command line options for the GNOME command line
argument parser.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>options</parameter>&nbsp;:</entry>
<entry> a poptOption table to register
</entry></row>
<row><entry align="right"><parameter>description</parameter>&nbsp;:</entry>
<entry> description for this table of options.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnomelib-parse-args">gnomelib_parse_args ()</title>
<programlisting><link linkend="poptContext">poptContext</link> gnomelib_parse_args             (int argc,
                                             char *argv[],
                                             int popt_flags);</programlisting>
<para>
Parses the arguments in argv according to all of the registered
tables.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>argc</parameter>&nbsp;:</entry>
<entry> the argument count to parse
</entry></row>
<row><entry align="right"><parameter>argv</parameter>&nbsp;:</entry>
<entry> a vector with the argument values
</entry></row>
<row><entry align="right"><parameter>popt_flags</parameter>&nbsp;:</entry>
<entry> popt flags that control the parse process
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a poptContext to the remaining arguments.
</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>




</refentry>
