Opensource.Platon.SK CVS: libcfg+/doc/sgml/usage.context-flags.sgml - diff

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

Diff for libcfg+/doc/sgml/usage.context-flags.sgml between version 1.12 and 1.13

version 1.12, 2003/03/01 02:26:20

version 1.13, 2003/08/16 01:43:42

Line 1

<!-- MAN:

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [

Line 30

<para>

For setting particular context flags there are these functions:

The following functions can be used to set various context flags:

</para>

<para>

Line 70 For setting particular context flags the

<para>

These functions and macros manipulate with context flags. The function

You can set a context flag with <function>cfg_set_context_flag()</function>.

<function>cfg_set_context_flag()</function> sets one particular context flag.

You can clear a flag with<function>cfg_clear_context_flag()</function>. To see

Similary, function <function>cfg_clear_context_flag()</function> clears one

whether a flag is set, use <function>cfg_get_context_flag()</function>. It has

context flags. Function <function>cfg_get_context_flag()</function> detects if

a macro alias <function>cfg_is_context_flag()</function>, which is identical

particular context flag is set. It has the macro alias

in every way.

<function>cfg_is_context_flag()</function> which is indentical in every way.

</para>

<para>

Remaining two functions <function>cfg_set_context_flags()</function> and

The functions <function>cfg_set_context_flags()</function> and

<function>cfg_get_context_flags()</function> can set and get all flags in one

<function>cfg_get_context_flags()</function> can set and retrieve the value of

call. Note that when you set flags with

all flags in one call.

<function>cfg_set_context_flags()</function> current flag state of context is

overwritten by <parameter>flags</parameter> parameter passed to this function.

</para>

<para>

List of setable context flags is described in following table.

A list of all settable context flags is provided in the following table.

</para>

<para>

Line 100 List of setable context flags is describ

Line 96 List of setable context flags is describ

<varlistentry><term><constant>CFG_IGNORE_MULTI</constant></term>

<para>Ignore multiple arguments for single option. First one will be used

<para>

to store option value, furthers are skipped.</para>

Ignore multiple arguments for a single option. The first argument will

<para>By default, multiple arguments for option that has not allowed them,

be used to store the option value. The others are skipped.

cause <constant>CFG_ERROR_MULTI</constant> error.</para>

</para>

<para>

By default, multiple arguments for an option that has not allowed

them, cause the <constant>CFG_ERROR_MULTI</constant> error.

</para>

</listitem></varlistentry>

<varlistentry><term><constant>CFG_IGNORE_UNKNOWN</constant></term>

<para>Ignore all unknown options.</para>

<para>The default behaviour is, that any unknown option causes

<para>

<constant>CFG_ERROR_UNKNOWN</constant> error.</para>

The default behaviour is to produce the

<constant>CFG_ERROR_UNKNOWN</constant> error when an unknown option is

encountered.

</para>

</listitem></varlistentry>

<varlistentry><term><constant>CFG_SKIP_FIRST</constant></term>

<para>Processing of the first argument on command line is skipped. This flag

<para>

affects only command line related context.</para>

Setting this flag will cause the first argument on the command line to

<para>By default is also the first argument on command line

be skipped. This flag affects only command line contexts.

processed.</para>

</para>

<para>The default behaviour is to parse all command line arguments.</para>

</listitem></varlistentry>

<varlistentry><term><constant>CFG_ADVANCED_LEFTOVERS</constant></term>

<para>Advanced leftover arguments. It means that leftover arguments do not

<para>

need to be be posixly correct.</para>

Advanced leftover arguments. Setting this flag will drop the

<para>The default behaviour is, that leftover arguments have to be posixly

requirement of the leftover arguments to conform to the

correct. Thus all options must go before any leftover argument. Once the

<acronym>POSIX</acronym> standard.

first leftover argument is found, all further arguments are considered as

</para>

leftovers.</para>

<para>

The default behaviour is to require the leftover arguments to conform

to <acronym>POSIX</acronym>. According to <acronym>POSIX</acronym>,

all option arguments must precede any non-option (leftover) arguments.

Once a non-option argument is found, all remaining arguments are also

interpreted as non-option.

</para>

</listitem></varlistentry>

<varlistentry><term><constant>CFG_STRICT_LEFTOVERS</constant></term>

<para>Strict leftover arguments initialization in file.</para>

<para>Strict initialization of leftover arguments in a file.</para>

<para>By default are leftover arguments in file initialized in normal way

<para>

(as they are).</para>

By default, leftover arguments in a file are initialized in the normal

way (as they are).

</para>

</listitem></varlistentry>

<varlistentry><term><constant>CFG_FILE_LINE_POS_USAGE</constant></term>

<para>Positions and size in configuration file are specified in lines

<para>

starting from 0.</para>

Setting this flag will cause the parsing of configuration file to

<para>The default behaviour is, that positions and size in configuration

become line- instead of byte-oriented. This will also change the

file are specified in bytes starting from 0.</para>

meaning of the values stored in <parameter>begin_pos</parameter> and

<parameter>size</parameter>.

</para>

<para>By default, parsing is byte-oriented.</para>

</listitem></varlistentry>

</variablelist>

Line 151 List of setable context flags is describ

Line 166 List of setable context flags is describ

<para>

If you have some flag set and you want to get default behaviour back, simply

You can use the <function>cfg_clear_context_flag()</function> function to

clear that flag using <function>cfg_clear_context_flag()</function> function.

restore the value of a flag to its default value.

<!--

Constants <constant>CFG_SKIP_FIRST</constant> (Skip processing of the first

argument on command line.), <constant>CFG_POSIXLY_LEFTOVERS</constant> (Posixly

correct leftover arguments.), <constant>CFG_NORMAL_LEFTOVERS</constant> (Normal

leftover arguments initialization in file.) and

<constant>CFG_FILE_BYTE_POS_USAGE</constant> (Byte type position usage in file.)

are set by default. Note that these constants contain real values of

<constant>0</constant>, thus they cannot be set. Instead of that, clear

appropriate opposite equivalent described in <xref

linkend="usage.context-flags.table" endterm="usage.context-flags.table.title">

table to get result.

-->

</para>

</sect1>

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


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