Opensource.Platon.SK CVS: libcfg+/doc/sgml/usage.options-set.sgml - diff

Up to [Platon] / libcfg+ / doc / sgml

Diff for libcfg+/doc/sgml/usage.options-set.sgml between version 1.7 and 1.8

version 1.7, 2002/09/02 16:01:56

version 1.8, 2002/09/03 20:11:16

Line 33 follows:

struct <structname>cfg_option</structname> {

const char <structfield>*cmdline_long_name</structfield>;

const char *<structfield>cmdline_long_name</structfield>;

const char <structfield>cmdline_short_name</structfield>;

const char <structfield>*cfgfile_name</structfield>;

const char *<structfield>cfgfile_name</structfield>;

const enum cfg_option_type <structfield>type</structfield>;

void <structfield>*value</structfield>;

int <structfield>val</structfield>;

Line 48 struct <structname>cfg_option</structnam

First two members of <structname>cfg_option</structname> structure,

<structfield>cmdline_long_name</structfield> and

<structfield>cmdline_short_name</structfield> concert to command line. They

<structfield>cmdline_short_name</structfield> concern to command line. They

specify command line long name and short name. Configuration file option name

specify command line long name and short name. Configuration file option name is

is specified by third structure member <structfield>cfgfile_name</structfield>.

specified by third structure member <structfield>cfgfile_name</structfield>.

Fields <structfield>cmdline_long_name</structfield> and

<structfield>cfgfile_name</structfield> are strings (pointers to char) and may

be <constant>NULL</constant>, what means undefined. Field

Line 60 be <constant>NULL</constant>, what means

</para>

<para>

Next structure member <structfield>type</structfield> specify an option type

Note that, any whitespace you will use in

<structfield>cmdline_long_name</structfield> or

<structfield>cfgfile_name</structfield> will match any non-zero amount of

whitespaces during parsing. For example if separator is one space, also tab will

match, two or more spaces too, etc. This is feature for icreasing simplicity of

your application confiration, because users must not pay attention to number of

spaces used in configurarion option. In example "debug level", "debug\tlevel"

and "debug \tlevel" will match the same configuration option.

</para>

<para>

Next structure member <structfield>type</structfield> defines an option type

with option type flags. They are summarized in the <xref

linkend="usage.option-types.table" endterm="usage.option-types.table.title">

linkend="usage.option-types.table" endterm="usage.option-types.table.title"> and

and <xref linkend="usage.option-type-flags.table"

<xref linkend="usage.option-type-flags.table"

endterm="usage.option-type-flags.table.title"> tables.

The <structfield>value</structfield> member tells the address where option

Line 89 idea to keep these values positive to pr

Line 101 idea to keep these values positive to pr

<tbody>

<row>

<entry><constant>CFG_BOOL</constant>, <constant>CFG_BOOLEAN</constant></entry>

<entry> int</entry>

<entry>Boolean datatype with two states. No argument for an option is expected.</entry>

<entry>No argument for an option is expected. Boolean datatype with two states.</entry>

</row>

<row>

<entry><constant>CFG_INT</constant>, <constant>CFG_INTEGER</constant></entry>

<entry> int</entry>

<entry>Integer argument.</entry>

<entry>Integer argument</entry>

</row>

<row>

<entry><constant>CFG_UINT</constant>, <constant>CFG_UNSIGNED</constant>,

<constant>CFG_UNSIGNED_INT</constant></entry>

<entry>unsigned int</entry>

<entry> unsigned int</entry>

<entry>Unsigned integer argument.</entry>

<entry>Unsigned integer argument</entry>

</row>

<row>

<entry> long int</entry>

<entry>Long integer argument.</entry>

<entry>Long integer argument</entry>

</row>

<row>

<entry><constant>CFG_ULONG</constant>,

<constant>CFG_UNSIGNED_LONG</constant></entry>

<entry>unsigned long int</entry>

<entry> unsigned long int</entry>

<entry>Unsigned long integer argument.</entry>

<entry>Unsigned long integer argument</entry>

</row>

<row>

<entry><constant>CFG_FLOAT</constant></entry>

<entry>float</entry>

<entry> float</entry>

<entry>Float argument.</entry>

<entry>Float argument</entry>

</row>

<row>

<entry><constant>CFG_DOUBLE</constant></entry>

<entry>double</entry>

<entry> double</entry>

<entry>Double argument.</entry>

<entry>Double argument</entry>

</row>

<row>

<entry><constant>CFG_STR</constant>, <constant>CFG_STRING</constant></entry>

<entry> char *</entry>

<entry>String argument.</entry>

<entry>String argument</entry>

</row>

</tbody>

</tgroup>

Platon Group <platon@platon.org> http://platon.org/


Copyright © 2002-2006 Platon Group Site powered by Metafox CMS	Go to Top