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.2 and 1.3


version 1.2, 2002/04/08 20:57:35
version 1.3, 2002/05/10 00:38:18



Line 1 




Line 1 




 <!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [


 
         <!ENTITY name "libcfg+">


 
         <!ENTITY version "0.5">


 
         <!ENTITY preface                                        SYSTEM  "preface.sgml">


 
         <!ENTITY introduction                           SYSTEM  "introduction.sgml">


 
         <!ENTITY introduction.overwiev          SYSTEM  "introduction.overview.sgml">


 
         <!ENTITY introduction.installation      SYSTEM  "introduction.installation.sgml">


 
         <!ENTITY usage                                          SYSTEM  "usage.sgml">


 
         <!ENTITY usage.options-set                      SYSTEM  "usage.options-set.sgml">


 
         <!ENTITY usage.context-manipulation     SYSTEM  "usage.context-manipulation.sgml">


 
         <!ENTITY usage.context-flags            SYSTEM  "usage.context-flags.sgml">


 
         <!ENTITY usage.parsing                          SYSTEM  "usage.parsing.sgml">


 
         <!ENTITY usage.special-properties       SYSTEM  "usage.special-properties.sgml">


 
         <!ENTITY other-information                      SYSTEM  "other-information.sgml">


 
 ]>


 
 


 <!-- $Id$ -->
 <!-- $Id$ -->


 
 


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


 <bookinfo>
 <bookinfo>


     <date>2002-04-08</date>
     <date>2002-04-08</date>


         <title>libcfg</title>
         <title>&name;</title>


     <abbrev>libcfg</abbrev>
     <abbrev>&name;</abbrev>


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


     <releaseinfo>This document is the user's manual for libcfg.</releaseinfo>
     <releaseinfo>This document is the user's manual for &name;.</releaseinfo>


         <authorgroup>
         <authorgroup>


                 <author>
                 <author>


                         <firstname>Ondrej</firstname>
                         <firstname>Ondrej</firstname>


                         <othername>'Nepto'</othername>
                         <othername>'Nepto'</othername>


                         <surname>Jombik</surname>
                         <surname>Jomb&iacute;k</surname>


                 </author>
                 </author>


         </authorgroup>
         </authorgroup>


         <copyright>
         <copyright>


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


           <year>2002</year>
           <year>2002</year>


           <holder>Ondrej 'Nepto' Jombik</holder>
           <holder>Platon software development group</holder>


         </copyright>
         </copyright>


 </bookinfo>
 </bookinfo>


 
 


 
 &preface;


 <chapter id="introduction">
 &introduction;


         <title>Introduction</title>
 &usage;


         <sect1 id="overview">
 &other-information;


                 <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>
 


                 <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>Features</title>
 


                 <para>
 


 
 


                 </para>
 


         </sect1>
 


 </chapter>
 


 <chapter id="usage">
 


         <title>Usage</title>
 


         <sect1 id="installation">
 


                 <title>Installation</title>
 


                 <para>
 


 
 


                 </para>
 


         </sect1>
 


         <sect1 id="configuration">
 


                 <title>Configuration</title>
 


                 <para>
 


 
 


                 </para>
 


         </sect1>
 


         <sect1 id="running">
 


                 <title>Running</title>
 


                 <para>
 


 
 


                 </para>
 


         </sect1>
 


         <sect1 id="security-notes">
 


                 <title>Security notes</title>
 


                 <para>
 


 
 


                 </para>
 


         </sect1>
 


 </chapter>
 


 
 


 <chapter id="others">
 


         <title>Other information</title>
 


 
 


         <sect1 id="license">
 


                 <title>License</title>
 


                 <para>
 


 Copyright (c) 2001-2002 Ondrej Jombik <email>nepto@pobox.sk</email>
 


                 </para>
 


                 <para>
 


 This program is free software; you can redistribute it and/or modify
 


 it under the terms of the GNU General Public License as published by
 


 the Free Software Foundation; either version 2, or (at your option)
 


 any later version.
 


                 </para>
 


                 <para>
 


 This program is distributed in the hope that it will be useful, but
 


 WITHOUT ANY WARRANTY; without even the implied warranty of
 


 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 


 General Public License for more details.
 


                 </para>
 


                 <para>
 


 You should have received a copy of the GNU General Public License
 


 along with this program; if not, write to the Free Software
 


 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
 


 USA.
 


                 </para>
 


         </sect1>
 


         <sect1 id="request-to-users">
 


                 <title>Request to users</title>
 


                 <para>
 


 I have an incomplete mastery of the English language, so please help
 


 correct the text of the documents and messages in this program.
 


 Comments, suggestions, bug reports and patches are always welcome.
 


 Please e-mail them to the following address.
 


                 </para>
 


         </sect1>
 


         <sect1 id="author-and-homepage">
 


                 <title>Author and homepage</title>
 


                 <para>
 


 Author is Ondrej Jombik <email>nepto@pobox.sk</email>, <ulink url="http://nepto.sk/">http://nepto.sk/</ulink>.
 


                 </para>
 


                 <para>
 


 Feel free to e-mail me any bug reports, suggestions and question
 


 about this library.
 


                 </para>
 


                 <para>
 


 
 


 The latest official release of libcfg is available from: <ulink
 


 url="http://www.platon.sk/projects/libcfg/">http://www.platon.sk/projects/libcfg/</ulink>
 


 
 


                 </para>
 


         </sect1>
 


         <sect1 id="history">
 


                 <title>Version history</title>
 


 
 


                 <para>
 


 Current version is 0.1 and it was released in 5th April 2002.
 


                 </para>
 


 
 


         </sect1>
 


 </chapter>
 


 
 


 </book>
 </book>


 
 









Legend:


Removed from v.1.2
 


changed lines


 
Added in v.1.3


















Platon Group <platon@platon.org> http://platon.org/
  Up to  [Platon] / libcfg+ / doc / sgml
-version 1.2, 2002/04/08 20:57:35
+version 1.3, 2002/05/10 00:38:18
 Line 1
 Line 1
 Line 1
- <!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
+ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+         <!ENTITY name "libcfg+">
+         <!ENTITY version "0.5">
+         <!ENTITY preface                                        SYSTEM  "preface.sgml">
+         <!ENTITY introduction                           SYSTEM  "introduction.sgml">
+         <!ENTITY introduction.overwiev          SYSTEM  "introduction.overview.sgml">
+         <!ENTITY introduction.installation      SYSTEM  "introduction.installation.sgml">
+         <!ENTITY usage                                          SYSTEM  "usage.sgml">
+         <!ENTITY usage.options-set                      SYSTEM  "usage.options-set.sgml">
+         <!ENTITY usage.context-manipulation     SYSTEM  "usage.context-manipulation.sgml">
+         <!ENTITY usage.context-flags            SYSTEM  "usage.context-flags.sgml">
+         <!ENTITY usage.parsing                          SYSTEM  "usage.parsing.sgml">
+         <!ENTITY usage.special-properties       SYSTEM  "usage.special-properties.sgml">
+         <!ENTITY other-information                      SYSTEM  "other-information.sgml">
+ ]>
  <!-- $Id$ -->
- <book id="libcfg-manual">
+ <book id="index">
  <bookinfo>
      <date>2002-04-08</date>
-         <title>libcfg</title>
+         <title>&name;</title>
-     <abbrev>libcfg</abbrev>
+     <abbrev>&name;</abbrev>
          <subtitle>precise command line and config file parsing library</subtitle>
-     <releaseinfo>This document is the user's manual for libcfg.</releaseinfo>
+     <releaseinfo>This document is the user's manual for &name;.</releaseinfo>
          <authorgroup>
                  <author>
                          <firstname>Ondrej</firstname>
                          <othername>'Nepto'</othername>
-                         <surname>Jombik</surname>
+                         <surname>Jomb&iacute;k</surname>
                  </author>
          </authorgroup>
          <copyright>
            <year>2001</year>
            <year>2002</year>
-           <holder>Ondrej 'Nepto' Jombik</holder>
+           <holder>Platon software development group</holder>
          </copyright>
  </bookinfo>
+ &preface;
- <chapter id="introduction">
+ &introduction;
-         <title>Introduction</title>
+ &usage;
-         <sect1 id="overview">
+ &other-information;
-                 <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>
-                 <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>Features</title>
-                 <para>
-                 </para>
-         </sect1>
- </chapter>
- <chapter id="usage">
-         <title>Usage</title>
-         <sect1 id="installation">
-                 <title>Installation</title>
-                 <para>
-                 </para>
-         </sect1>
-         <sect1 id="configuration">
-                 <title>Configuration</title>
-                 <para>
-                 </para>
-         </sect1>
-         <sect1 id="running">
-                 <title>Running</title>
-                 <para>
-                 </para>
-         </sect1>
-         <sect1 id="security-notes">
-                 <title>Security notes</title>
-                 <para>
-                 </para>
-         </sect1>
- </chapter>
- <chapter id="others">
-         <title>Other information</title>
-         <sect1 id="license">
-                 <title>License</title>
-                 <para>
- Copyright (c) 2001-2002 Ondrej Jombik <email>nepto@pobox.sk</email>
-                 </para>
-                 <para>
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2, or (at your option)
- any later version.
-                 </para>
-                 <para>
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- General Public License for more details.
-                 </para>
-                 <para>
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
- USA.
-                 </para>
-         </sect1>
-         <sect1 id="request-to-users">
-                 <title>Request to users</title>
-                 <para>
- I have an incomplete mastery of the English language, so please help
- correct the text of the documents and messages in this program.
- Comments, suggestions, bug reports and patches are always welcome.
- Please e-mail them to the following address.
-                 </para>
-         </sect1>
-         <sect1 id="author-and-homepage">
-                 <title>Author and homepage</title>
-                 <para>
- Author is Ondrej Jombik <email>nepto@pobox.sk</email>, <ulink url="http://nepto.sk/">http://nepto.sk/</ulink>.
-                 </para>
-                 <para>
- Feel free to e-mail me any bug reports, suggestions and question
- about this library.
-                 </para>
-                 <para>
- The latest official release of libcfg is available from: <ulink
- url="http://www.platon.sk/projects/libcfg/">http://www.platon.sk/projects/libcfg/</ulink>
-                 </para>
-         </sect1>
-         <sect1 id="history">
-                 <title>Version history</title>
-                 <para>
- Current version is 0.1 and it was released in 5th April 2002.
-                 </para>
-         </sect1>
- </chapter>
  </book>
 Legend:


Removed from v.1.2
 


changed lines


 
Added in v.1.3
 Legend:


Removed from v.1.2
 


changed lines


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


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