Update of /cvsroot/leaf/doc/howto
In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv3761

Modified Files:
        apkg-howto.xml 
Log Message:
reviewed and enhanced to refelct the latest additions to apkg


Index: apkg-howto.xml
===================================================================
RCS file: /cvsroot/leaf/doc/howto/apkg-howto.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** apkg-howto.xml      24 Aug 2006 16:47:52 -0000      1.1
--- apkg-howto.xml      4 Nov 2006 00:18:11 -0000       1.2
***************
*** 23,27 ****
  
          <affiliation>
!           <address><email>espakman at users.sourceforge.net</email></address>
          </affiliation>
        </author>
--- 23,31 ----
  
          <affiliation>
!           <address><email>espakman at users.sourceforge.net</email><firstname>
! 
! Luis</firstname><surname>Correia</surname><affiliation>
!               <address><email>lfcorreia at 
users.sourceforge.net</email></address>
!             </affiliation></address>
          </affiliation>
        </author>
***************
*** 32,36 ****
          <revnumber>1.0</revnumber>
  
!         <date>August 2006</date>
  
          <revremark>Initial document</revremark>
--- 36,40 ----
          <revnumber>1.0</revnumber>
  
!         <date>November 2006</date>
  
          <revremark>Initial document</revremark>
***************
*** 45,113 ****
        <title>What is apkg?</title>
  
!       <para><filename>apkg</filename> is the tool for package management and
!       configuration backup in the <ulink
        
url="http://leaf.sourceforge.net/mod.php?mod=userpage&amp;menu=910&amp;page_id=36";>Bering-uClibc</ulink>
!       branch of LEAF. It is first introduced with version 3.0 of Bering-uClibc
!       and replaces the aged <filename>lrpkg</filename> scripts.</para>
  
!       <para><filename>apkg</filename> simplifies configuration saving, is
!       extendable and eases package updates. The most visible difference is
!       that all changes to the various configuration files and directories are
!       saved in configdb.lrp. Modules are saved in moddb.lrp.</para>
      </section>
  
      <section>
!       <title>Acknowledgments and Thanks</title>
  
!       <para>Eric Spakman re-wrote "apkg" as a replacement for lrpkg. His work
!       is based on David Douthitt, Nathan Angelacos and Natanael Copa's efforts
!       towards a more advanced package management tool.</para>
      </section>
  
      <section>
!       <title>Saving your configuration</title>
  
!       <para>The "<computeroutput>LEAF configuration menu</computeroutput>" is
!       the first screen you'll see after login. You can always start it from
!       the shell prompt with the <command>lrcfg</command> command. In this menu
!       you'll find in the lower right corner the commands to save
!       configurations ("<command>s</command>) Save config") and backup the
!       modules ("<command>m</command>) Backup modules).</para>
  
!       <para>The first one will save all changed configuration files and
!       directories. You can change the options "always writing to /tmp before
!       /mnt" and the confirmation question before writing the lrp to your
!       storage media in <filename>/etc/config.cfg</filename>. Setting CWRT to
!       "off" allows you to save your completly configured box with only two
!       keystrokes ("<command>s</command>" and "<command>m</command>" )</para>
      </section>
  
      <section>
!       <title>apkg command line options</title>
  
!       <para>apkg supports the following commands:</para>
  
!       <itemizedlist>
!         <listitem>
!           <para>-i [path]&lt;package&gt; install package</para>
!         </listitem>
  
!         <listitem>
!           <para>-u [path]&lt;package&gt; upgrade package</para>
!         </listitem>
  
!         <listitem>
!           <para>-c [path]&lt;package&gt; list contents of package</para>
!         </listitem>
  
!         <listitem>
!           <para>-l [&lt;package&gt;] list installed packages; if
!           &lt;package&gt; given, tell if it is installed</para>
!         </listitem>
  
!         <listitem>
!           <para>-h this help</para>
!         </listitem>
!       </itemizedlist>
      </section>
  
--- 49,212 ----
        <title>What is apkg?</title>
  
!       <para><filename>apkg</filename> is the new tool for package management
!       and configuration in LEAF's <ulink
        
url="http://leaf.sourceforge.net/mod.php?mod=userpage&amp;menu=910&amp;page_id=36";>Bering-uClibc</ulink>
!       branch.</para>
  
!       <para>It was first introduced with Bering-uClibc 3.0 and replaces the
!       aged <filename>lrpkg</filename> scripts.</para>
      </section>
  
      <section>
!       <title>Why is apkg better then lrpkg?</title>
  
!       <para><filename>apkg</filename> simplifies configuration saving, is
!       extensible and eases package updates.</para>
! 
!       <para>The difference from the old <filename>lrpkg</filename> package
!       management scripts is that, from now on the <filename>.lrp</filename>
!       packages become effectively read-only, while the changes to the various
!       configuration files are saved in a new package called
!       <filename>configdb.lrp</filename>. As for the kernel modules (ie: the
!       files in <filename>/lib/modules</filename>), they are now stored in
!       another new package called <filename>moddb.lrp</filename>.</para>
! 
!       <para>This approach improves not only the way packages are handled, by
!       saving only the information that has changed, but also provides new
!       options for preparing special base installations (such as a simple
!       fileset for WRAP boards), while providing easy package upgrades.</para>
      </section>
  
      <section>
!       <title>Using apkg</title>
  
!       <para><filename>apgk</filename> has two modes of operation, just like
!       <filename>lrpkg</filename>. The most used mode is interactive, it's the
!       one you see right after logging in. But it can also be used via the
!       shell prompt using switches.</para>
  
!       <para><note>
!           <para>The first time the router boots, there is no
!           <filename>configdb.lrp</filename> (unless added by hand). You may
!           see some 'not found' errors, this is an expected behaviour and will
!           disapear once you save the config.</para>
!         </note></para>
      </section>
  
      <section>
!       <title>Saving your configuration</title>
  
!       <section>
!         <title>Interactive mode</title>
  
!         <para>The "<computeroutput>LEAF configuration menu</computeroutput>"
!         is the first screen you'll see after login. You can always start it
!         from the shell prompt with the <command>lrcfg</command>
!         command.</para>
  
!         <para>This menu has some changes in the lower right corner, the
!         available commands are now:</para>
  
!         <itemizedlist>
!           <listitem>
!             <para><command>s</command>) Save config</para>
!           </listitem>
!         </itemizedlist>
  
!         <itemizedlist>
!           <listitem>
!             <para><command>m</command>) Backup modules</para>
!           </listitem>
!         </itemizedlist>
  
!         <itemizedlist>
!           <listitem>
!             <para><command>c</command>) Configuration changed since last
!             save</para>
!           </listitem>
!         </itemizedlist>
! 
!         <itemizedlist>
!           <listitem>
!             <para><command>d</command>) Configuration changed from
!             distribution</para>
!           </listitem>
!         </itemizedlist>
! 
!         <para><command>s</command> - will save all changed configuration files
!         and directories to <filename>configdb.lrp</filename>.</para>
! 
!         <para><command>m</command> -backs up the modules directory
!         <filename>/lib/modules</filename> to
!         <filename>moddb.lrp</filename>.</para>
! 
!         <note>
!           <para>The file <filename>/etc/modules</filename> will be saved in
!           <filename>configdb.lrp</filename>. If you only changed the entries
!           in this file, "Save config" is enough. But if you add a new module
!           and changed <filename>/etc/modules</filename> you have to save both
!           - the configuration and the modules.</para>
!         </note>
! 
!         <para>You can change the confirmation question before writing the lrp
!         to your storage media in /etc/config.cfg. Setting CWRT to "off" allows
!         you to save your completly configured box with only two keystrokes
!         ("s" and "m" ).</para>
! 
!         <para>There are two more commands available regarding configuration
!         changes and saving:</para>
! 
!         <itemizedlist>
!           <listitem>
!             <para><command>c</command>) Configuration changed since last
!             save</para>
! 
!             <para>This command shows the changes in all your configuration
!             files and directories since you saved your configuration.</para>
!           </listitem>
! 
!           <listitem>
!             <para><command>d</command>) Configuration changed from
!             distribution</para>
! 
!             <para>This command shows all changes between your setup and the
!             native distribution.</para>
!           </listitem>
!         </itemizedlist>
! 
!         <note>
!           <para>Both commands only work if you saved configurations at least
!           once.</para>
!         </note>
!       </section>
! 
!       <section>
!         <title>Command line switches</title>
! 
!         <para>apkg supports the following commands:</para>
! 
!         <itemizedlist>
!           <listitem>
!             <para>-i [path]&lt;package&gt; install package</para>
!           </listitem>
! 
!           <listitem>
!             <para>-u [path]&lt;package&gt; upgrade package</para>
!           </listitem>
! 
!           <listitem>
!             <para>-c [path]&lt;package&gt; list contents of package</para>
!           </listitem>
! 
!           <listitem>
!             <para>-l [&lt;package&gt;] list installed packages; if
!             &lt;package&gt; given, tell if it is installed</para>
!           </listitem>
! 
!           <listitem>
!             <para>-h this help</para>
!           </listitem>
!         </itemizedlist>
!       </section>
      </section>
  
***************
*** 122,132 ****
        <filename>configdb.lrp</filename>.</para>
  
!       <para>You can also use the <command>apkg -u</command> upgrade command,
!       created by Cedric Schieli. When <command>apkg -u</command> in invoked,
!       the user will be prompted for each changed configuration file - you can
!       keep the old file, install the new file, view a diff or edit a merged
!       version. If a configuration file has not changed between two releases
!       (e.g. no new defaults, no new options etc), the file modified by the
!       user will be kept without asking.</para>
  
        <note>
--- 221,231 ----
        <filename>configdb.lrp</filename>.</para>
  
!       <para>You can also use the <command>apkg -u</command> upgrade command.
!       When <command>apkg -u</command> is invoked, the user will be prompted
!       for each changed configuration file - you can keep the old file, install
!       the new file, view a diff or edit a merged version. If a configuration
!       file has not changed between two releases (e.g. no new defaults, no new
!       options etc), the file modified by the user will be kept without
!       asking.</para>
  
        <note>
***************
*** 142,146 ****
        <para>Every package has a <filename>&lt;package&gt;.local</filename>
        file with files listed which shall be saved. At startup (linuxrc) the
!       sha1 sums of everything listed in the
        <filename>&lt;package&gt;.local</filename> file are calculated and saved
        in <filename>&lt;package&gt;.sha1</filename> files. This part is done
--- 241,245 ----
        <para>Every package has a <filename>&lt;package&gt;.local</filename>
        file with files listed which shall be saved. At startup (linuxrc) the
!       sha1sums of everything listed in the
        <filename>&lt;package&gt;.local</filename> file are calculated and saved
        in <filename>&lt;package&gt;.sha1</filename> files. This part is done
***************
*** 150,170 ****
        processed multiple times which cost time and processing power. During
        backup the sha1sums of the files in memory are compared with the saved
!       *.sha1 sums, new files are detected and duplicates are filtered out. For
!       example: when one package has an etc/ppp directory in
        <filename>&lt;package&gt;.local</filename> and another one an
        <filename>etc/ppp/dsl-providers</filename> file listed, the
        <filename>dsl-provider</filename> file would be find twice and also
!       stored twice in the configdb. Changed files are saved in
!       <filename>configdb.lrp</filename> with a "full" backup, this is dynamic
!       so installing (or removing) a package will also be taken into account.
!       The first device in the PKGPATH list is used as backup device. The
!       configdb and moddb will always loaded last by linuxrc. This loading is
!       automatic so there is no need to specify configdb and moddb in the
!       packages list. Modules system, a very simple implementation: The
!       complete /lib/modules directory is backuped to
        <filename>moddb.lrp</filename> and the /lib/modules/'kernel version' is
        excluded. This also means that the <filename>modules.lrp</filename>
        package now only contains the insmod logic and no modules.</para>
      </section>
    </section>
  </article>
\ No newline at end of file
--- 249,306 ----
        processed multiple times which cost time and processing power. During
        backup the sha1sums of the files in memory are compared with the saved
!       *.sha1 sums, new files are detected and duplicates are filtered
!       out.</para>
! 
!       <para>For example: when one package has an etc/ppp directory in
        <filename>&lt;package&gt;.local</filename> and another one an
        <filename>etc/ppp/dsl-providers</filename> file listed, the
        <filename>dsl-provider</filename> file would be find twice and also
!       stored twice in the <filename>configdb</filename>. Changed files are
!       saved in <filename>configdb.lrp</filename> with a "full" backup, this is
!       dynamic so installing (or removing) a package will also be taken into
!       account.</para>
! 
!       <para>The first device in the PKGPATH list is used as backup device. The
!       <filename>configdb</filename> and <filename>moddb</filename> will always
!       loaded last by linuxrc. This loading is automatic so there is no need to
!       specify <filename>configdb</filename> and <filename>moddb</filename> in
!       the packages list. Modules system, a very simple implementation: The
!       complete <filename>/lib/modules</filename> directory is backuped to
        <filename>moddb.lrp</filename> and the /lib/modules/'kernel version' is
        excluded. This also means that the <filename>modules.lrp</filename>
        package now only contains the insmod logic and no modules.</para>
      </section>
+ 
+     <section>
+       <title>Customizing packages</title>
+ 
+       <para>apkg only saves configuration files, declared in
+       &lt;package&gt;.local. It does never save the complete package. It is
+       also not recommended to add binaries to the configdb file.</para>
+ 
+       <para>So, if you want to customize a package, like replacing a file in
+       the LRP or adding new files to the LRP, it is suggested that you build a
+       new package from scratch.</para>
+ 
+       <para>Building a LRP for a few small scripts, that are added on a
+       running system and are not part of any package can shurely be overkill.
+       By adding those files to the /var/lib/lrpkg/local.local file, they will
+       be forced to be saved in the config database. The format is simple, just
+       list the full path to the file without a leading slash:
+       <filename>etc/init.d/example.sh</filename> </para>
+ 
+       <para><emphasis>Don't remove the first entry in this
+       file.</emphasis></para>
+     </section>
+ 
+     <section>
+       <title>Acknowledgments and Thanks</title>
+ 
+       <para>"apkg" was rewritten by Eric Spakman a replacement for lrpkg. His
+       work was based on David Douthitt, Nathan Angelacos and Natanael Copa's
+       efforts towards a more advanced package management tool. Cedric Schieli
+       and Paul S. Traina added new features and helped to fix and cleanup
+       Eric's work.</para>
+     </section>
    </section>
  </article>
\ No newline at end of file


-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
leaf-cvs-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/leaf-cvs-commits

Reply via email to