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

   Up to  [Platon] / libcfg+ / doc / sgml
Diff for libcfg+/doc/sgml/libcfg+.sgml between version 1.1 and 1.2


version 1.1, 2002/04/07 18:06:06
version 1.2, 2002/04/08 20:57:35



Line 3 




Line 3 




 
 


 <book id="libcfg-manual">
 <book id="libcfg-manual">


 <bookinfo>
 <bookinfo>


     <date>2001-02-26</date>
     <date>2002-04-08</date>


         <title>libcfg</title>
         <title>libcfg</title>


     <abbrev>libcfg</abbrev>
     <abbrev>libcfg</abbrev>


         <subtitle>precise command line and config file parsing library</subtitle>
         <subtitle>precise command line and config file parsing library</subtitle>




Line 16 




Line 16 




                 </author>
                 </author>


         </authorgroup>
         </authorgroup>


         <copyright>
         <copyright>


           <year>2000</year>
 


           <year>2001</year>
           <year>2001</year>


 
           <year>2002</year>


           <holder>Ondrej 'Nepto' Jombik</holder>
           <holder>Ondrej 'Nepto' Jombik</holder>


         </copyright>
         </copyright>


 </bookinfo>
 </bookinfo>




Line 28 




Line 28 




         <sect1 id="overview">
         <sect1 id="overview">


                 <title>Overview</title>
                 <title>Overview</title>


                 <para>
                 <para>


 
 libcfg is precise command line and config file parsing library. It is


 
 supposed to be used as and universal command line and config file


 
 parsing extension of your program. It is written in C. C++ wrapper is


 
 currently under development.


 
                 </para>


 
 


 
                 <important>


 
                         <para>


 
 Note that this is exactly the first release of libcfg library.


 
 Although it seems to work fine, a lot of improvements will be done in


 
 nearly future. So please, if you find some bug or missing feature,


 
 notice us and we will fix this as soon as it will be possible.


 
                         </para>


 
                 </important>


 
 


 
                 <para>


 
 There are two ways how to use it.


 
                         <itemizedlist mark=opencircle>


 
                                 <listitem>


 
                                         <para>


 
 


 
 Install it as a separate library on your and/or customer's system and


 
 link you application dynamically agains this library. You can always


 
 check in your <filename>./configure</filename> script if libcfg is or


 
 isn't installed on target system and if not notice user to install it.


 
 </para>


 
 


 
                                         <para>


 
 


 
 We are working on possibility that your application will check


 
 installation of libcfg library automatically. Than if libcfg not


 
 exists on target system or it is not required version, it will be


 
 added to existing system. Your application than can be properly


 
 compiled and linked agains shared library.


 
 


 
                                         </para>


 
                                         <para>


 
 


 
 We know that this is a little bit sophisticated thing with need of lot


 
 of testing and improving on various systems and platforms. An enhanced


 
 examples how to detect and that install or reinstall libcfg library


 
 will be included. Your experiences in this topic will expressivelly


 
 help us to improve libcfg library in this way.


 
 


 
                                         </para>


 
                                 </listitem>


 
                                 <listitem>


 
                                         <para>


 
 


 
 The second way of usage libcfg is simply add library source codes to


 
 your source codes (in example into subdirectory <filename


 
 class=directory>libcfg/</filename>) and include main libcfg header


 
 file <filename class=headerfile>cfg.h</filename> in your appropriate


 
 source codes. In your <filename>Makefile</filename> simply compile all


 
 library C files and finally link it all together.


 
 


 
                                         </para>


 
                                 </listitem>


 
                         </itemizedlist>


                 </para>
                 </para>


         </sect1>
 


         <sect1 id="features">
 


                 <title>Features</title>
 


                 <para>
                 <para>


 
 


 
 Some of the ideas were inspired from popt command line parsing library


 
 and parsecfg config file parsing library. Although this, all code is


 
 written from scratch.


 
 


                 </para>
                 </para>


         </sect1>
         </sect1>


         <sect1 id="requirements">
         <sect1 id="requirements">


                 <title>Requirements</title>
                 <title>Features</title>


                 <para>
                 <para>


 
 


                 </para>
                 </para>









Legend:


Removed from v.1.1
 


changed lines


 
Added in v.1.2


















Platon Group <platon@platon.org> http://platon.org/
  Up to  [Platon] / libcfg+ / doc / sgml
-version 1.1, 2002/04/07 18:06:06
+version 1.2, 2002/04/08 20:57:35
 Line 3
 Line 3
 Line 3
  <book id="libcfg-manual">
  <bookinfo>
-     <date>2001-02-26</date>
+     <date>2002-04-08</date>
          <title>libcfg</title>
      <abbrev>libcfg</abbrev>
          <subtitle>precise command line and config file parsing library</subtitle>
 Line 16
 Line 16
 Line 16
                  </author>
          </authorgroup>
          <copyright>
-           <year>2000</year>
            <year>2001</year>
+           <year>2002</year>
            <holder>Ondrej 'Nepto' Jombik</holder>
          </copyright>
  </bookinfo>
 Line 28
 Line 28
 Line 28
          <sect1 id="overview">
                  <title>Overview</title>
                  <para>
+ libcfg is precise command line and config file parsing library. It is
+ supposed to be used as and universal command line and config file
+ parsing extension of your program. It is written in C. C++ wrapper is
+ currently under development.
+                 </para>
+                 <important>
+                         <para>
+ Note that this is exactly the first release of libcfg library.
+ Although it seems to work fine, a lot of improvements will be done in
+ nearly future. So please, if you find some bug or missing feature,
+ notice us and we will fix this as soon as it will be possible.
+                         </para>
+                 </important>
+                 <para>
+ There are two ways how to use it.
+                         <itemizedlist mark=opencircle>
+                                 <listitem>
+                                         <para>
+ Install it as a separate library on your and/or customer's system and
+ link you application dynamically agains this library. You can always
+ check in your <filename>./configure</filename> script if libcfg is or
+ isn't installed on target system and if not notice user to install it.
+ </para>
+                                         <para>
+ We are working on possibility that your application will check
+ installation of libcfg library automatically. Than if libcfg not
+ exists on target system or it is not required version, it will be
+ added to existing system. Your application than can be properly
+ compiled and linked agains shared library.
+                                         </para>
+                                         <para>
+ We know that this is a little bit sophisticated thing with need of lot
+ of testing and improving on various systems and platforms. An enhanced
+ examples how to detect and that install or reinstall libcfg library
+ will be included. Your experiences in this topic will expressivelly
+ help us to improve libcfg library in this way.
+                                         </para>
+                                 </listitem>
+                                 <listitem>
+                                         <para>
+ The second way of usage libcfg is simply add library source codes to
+ your source codes (in example into subdirectory <filename
+ class=directory>libcfg/</filename>) and include main libcfg header
+ file <filename class=headerfile>cfg.h</filename> in your appropriate
+ source codes. In your <filename>Makefile</filename> simply compile all
+ library C files and finally link it all together.
+                                         </para>
+                                 </listitem>
+                         </itemizedlist>
                  </para>
-         </sect1>
-         <sect1 id="features">
-                 <title>Features</title>
                  <para>
+ Some of the ideas were inspired from popt command line parsing library
+ and parsecfg config file parsing library. Although this, all code is
+ written from scratch.
                  </para>
          </sect1>
          <sect1 id="requirements">
-                 <title>Requirements</title>
+                 <title>Features</title>
                  <para>
                  </para>
 Legend:


Removed from v.1.1
 


changed lines


 
Added in v.1.2
 Legend:


Removed from v.1.1
 


changed lines


 
Added in v.1.2
-Removed from v.1.1
+Added in v.1.2


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