[Cdd-commits] r465 - in cdd/trunk/cdd/doc: . en
CDD Subversion Commit
noreply at alioth.debian.org
Mon Sep 10 18:40:19 UTC 2007
Author: tille
Date: Mon Sep 10 18:40:19 2007
New Revision: 465
Removed:
cdd/trunk/cdd/doc/VERSION
Modified:
cdd/trunk/cdd/doc/en/04_existing_cdds.sgml
cdd/trunk/cdd/doc/en/06_technology.sgml
cdd/trunk/cdd/doc/en/08_todo.sgml
cdd/trunk/cdd/doc/en/A_devel.sgml
cdd/trunk/cdd/doc/en/B_quickintro.sgml
Log:
Several changes in the docs that are not finished at all. Just want to commit my backlog from offline because of DSL problems.
Modified: cdd/trunk/cdd/doc/en/04_existing_cdds.sgml
==============================================================================
--- cdd/trunk/cdd/doc/en/04_existing_cdds.sgml (original)
+++ cdd/trunk/cdd/doc/en/04_existing_cdds.sgml Mon Sep 10 18:40:19 2007
@@ -136,8 +136,12 @@
intended to be used in schools. For instance there are:
<taglist>
<tag><url id="http://www.linex.org/" name="LinEX"></tag>
- <item>A Debian derivative distribution used in all schools in
- Extremadura.</item>
+ <item><p>A Debian derivative distribution used in all schools in
+ Extremadura.</p>
+ <p>Currently a fruitful cooperation between Debian-Edu and
+ LinEX is established.
+ </p>
+ </item>
<tag><url id="http://www.lliurex.net/" name="LliureX"></tag>
<item>A Debian derivative distribution in development to be used in
schools in Valencia. The goal is to integrate as much as
@@ -200,6 +204,29 @@
</p>
</sect>
+<sect id="debian-gis">
+ <heading>Debian-GIS: Geographical Information Systems</heading>
+
+</sect>
+
+<sect id="debichem">
+ <heading>DebiChem: Debian for Chemestry</heading>
+
+</sect>
+
+<sect id="debian-science">
+ <heading>Debian-Science: Debian for science</heading>
+
+<p>
+ While there are Custom Debian Distributions that care for certain
+ sciences (Debian-Med deals in a main part with Biology, DebiChem for
+ Chemestry and Debian-GIS for geography) not all sciences are covered
+ by a specific CDD. The main reason is that at the moment not enough
+ people support such an effort for every science. The temporary
+ solution was to build a general Debian-Science CDD that makes use of
+ the work of other CDDs in case it exists.
+</p>
+</sect>
<sect id="debian-desktop">
<heading>Debian-Desktop: Debian GNU/Linux for everybody</heading>
@@ -239,8 +266,10 @@
</p>
</sect>
+<sect id="stalled-cdds">
+ <heading>CDDs that were announced but development is stalled</heading>
- <sect id="debian-lex">
+ <sect1 id="debian-lex">
<heading>Debian-Lex: Debian GNU/Linux for Lawyers</heading>
<p>
@@ -267,10 +296,10 @@
</taglist>
The word <em>lex</em> is the Latin word for law.
</p>
-</sect>
+</sect1>
- <sect id="debian-np">
+ <sect1 id="debian-np">
<heading>Debian-NP: Debian GNU/Linux for Non-profit Organisations</heading>
<p>
@@ -293,10 +322,10 @@
</taglist>
Non-profits are often familiar with Free Software.
</p>
-</sect>
+</sect1>
- <sect id="accessibility">
+ <sect1 id="accessibility">
<heading>Debian Accessibility Project</heading>
<p>
@@ -333,10 +362,10 @@
</taglist>
</p>
-</sect>
+</sect1>
- <sect id="debian-enterprise">
+ <sect1 id="debian-enterprise">
<heading>Debian Enterprise</heading>
<p>
@@ -392,9 +421,9 @@
</taglist>
</p>
-</sect>
+</sect1>
- <sect id="other">
+ <sect1 id="other">
<heading>Other possible Custom Debian Distributions</heading>
<p>
There are fields that could be served nicely by not yet existing
@@ -407,8 +436,6 @@
<item>Could cover all office issues.</item>
<tag>Accounting</tag>
<item>Could integrate accounting systems into Debian.</item>
- <tag>Geography</tag>
- <item>Could look after geographical information systems (GIS).</item>
<tag>Biology</tag>
<item>Could perhaps take over some stuff from Debian-Med.</item>
<tag>Physics</tag>
@@ -419,6 +446,7 @@
<item>There are a lot more potential Custom Debian Distributions.</item>
</taglist>
</p>
+</sect1>
</sect>
Modified: cdd/trunk/cdd/doc/en/06_technology.sgml
==============================================================================
--- cdd/trunk/cdd/doc/en/06_technology.sgml (original)
+++ cdd/trunk/cdd/doc/en/06_technology.sgml Mon Sep 10 18:40:19 2007
@@ -68,8 +68,14 @@
<item><prgn>cfengine</prgn> scripts (or similar see <ref id="EnhancingTechnology">)</item>
</list>
</item>
- <item>Special meta package:
- <package><var><cdd></var>-common</package></item>
+ <item>Special meta packages:
+ <list>
+ <item><package><var><cdd></var>-tasks</package>:
+ Contains information for <prgn>tasksel</prgn></item>
+ <item><package><var><cdd></var>-config</package>:
+ Special configurations, basic stuff for user menus</item>
+ </list>
+ </item>
</list>
</p>
<p>
@@ -87,8 +93,8 @@
<taglist>
<tag><package>junior-puzzle</package></tag>
<item>Debian Jr. Puzzles</item>
- <tag><package>debian-edu-config</package></tag>
- <item>Configuration files for SkoleLinux systems</item>
+ <tag><package>education-tasks</package></tag>
+ <item>Tasksel files for SkoleLinux systems</item>
<tag><package>med-bio</package></tag>
<item>Debian-Med micro-biology packages</item>
</taglist>
@@ -655,8 +661,7 @@
It is strongly suggested to use the package <package>cdd-dev</package>
to build meta packages of a Custom Debian Distribution that will move
all necessary files right into place if there exists a
-<file>menu</file> directory with the menu entries as described in <ref
-id="cdd-install-helper">. Note, that the users
+<file>menu</file> directory with the menu entries. Note, that the users
<file>${HOME}/.menu</file> directory remains untouched.
</p>
</sect2>
@@ -665,9 +670,8 @@
<heading>Managing Custom Debian Distribution users with <prgn>debconf</prgn></heading>
<p>
-Using <manref name="cdd-install-helper" section="8"> (see <ref
-id="cdd-install-helper">) it is very easy to build a
-<var>cdd</var><package>-common</package> package that contains
+Using <package>cdd-dev</package> it is very easy to build a
+<var>cdd</var><package>-config</package> package that contains
<prgn>debconf</prgn> scripts to configure system users who should
belong to the group of users of the Custom Debian Distribution <var>cdd</var>.
For example see the <package>med-common</package> package.
Modified: cdd/trunk/cdd/doc/en/08_todo.sgml
==============================================================================
--- cdd/trunk/cdd/doc/en/08_todo.sgml (original)
+++ cdd/trunk/cdd/doc/en/08_todo.sgml Mon Sep 10 18:40:19 2007
@@ -39,22 +39,23 @@
| | +- doc -+- 0.1 [older versions of this doc]
| | +- 0.2
| | +- 0.3
+ | | [Since 0.4.1 the doc is in cdd directory]
| |
- | +- trunk ----+-- cdd [code in development for cdd source package]
- | |
- | +-- doc [this document = cdd-doc package]
+ | +- trunk ----cdd [code in development for cdd source package]
+ | |
+ | +-- doc [this document = cdd-doc package]
|
- +- projects -+- junior -+- branches
- | |
- | +- tags
- | |
- | +- trunk [development version of Debian-Jr]
+ +- projects -+--- med ---+- branches
+ | |
+ | +- tags
+ | |
+ | +- trunk [development version of Debian-Med]
|
- +- med ----+- branches
- | |
- | +- tags
- | |
- | +- trunk [development version of Debian-Med]
+ +- science -+- branches
+ | |
+ | +- tags
+ | |
+ | +- trunk [development version of Debian-Science]
|
+- ...
|
@@ -436,266 +437,25 @@
<p>
But Knoppix is a very common demonstration and its purpose is to work
in everyday live. There is no room left for special applications and
-thus people started to adopt it for there special needs. This
-adaptation can have different focuses:
-<taglist>
- <tag>Distribution</tag>
- <item>The original Knoppix CD is based on a mixture of Debian
- <tt>testing</tt>, <tt>unstable</tt> and even packages from
- other sources than the official Debian mirror. There are
- Knoppix derivatives like <url id="http://www.gnoppix.org/"
- name="Gnoppix"> which try to stick to <tt>stable</tt> or at
- least to one defined set of Debian packages.
-
- </item>
- <tag>User interface</tag>
- <item>Knoppix has a highly customised KDE environment which just
- works as it is. There are efforts to release live CDs with
- Gnome interface (Gnoppix), XFCE or other desktops which are
- able to cope with less system resources.
- </item>
- <tag>Kernel</tag>
- <item>There are certain reasons to exchange the kernel of the
- Knoppix CD like in the <url
- id="http://bofh.be/clusterknoppix/"
- name="ClusterKnoppix">-Project which uses an OpenMosix kernel.
- </item>
- <tag>Special applications</tag>
- <item>Most of the Knoppix derivatives aim at providing special
- applications for the purpose of demonstration, training of a
- classroom using the Knoppix net-boot feature or just having
- the favourite application always available by just carrying a
- CD in the wallet. Examples are:
- <taglist>
- <tag><url id="http://www.osef.org/"
- name="Knoppix4Kids"></tag>
- <item>Knoppix for Children - connected to Debian-Jr.</item>
- <tag><url id="http://dirk.eddelbuettel.com/quantian.html"
- name="Quantian"></tag>
- <item>Re-mastered "ClusterKnoppix" for the needs of Mathematicians</item>
- <tag><url
- id="http://sourceforge.net/project/showfiles.php?group_id=9295"
- name="LiveOIO">
- <item>Knoppix with PostgreSQL and Zope to run OIO -
- interesting for Debian-Med.</item>
- <tag><url
- id="http://marvin.ba-loerrach.de/gnumed.iso"
- name="ISO image of GnuMed Knoppix">
- <item>Knoppix with PostgreSQL and GnuMed -
- interesting for Debian-Med.</item>
- <tag><url
- id="http://www.vigyaancd.org/"
- name="Vigyaan">
- <item>Knoppix for computational biology and computational
- chemistry containing ClustalX, BLAST (NCBI-tools),
- Open Babel, EMBOSS tools, GROMACS, Ghemical, PyMOL and
- others.</item>
- <tag><url
- id="http://bioknoppix.hpcf.upr.edu/"
- name="BioKnoppix">
- <item>A very similar project to the previous which
- specialises Knoppix for computational biology
- chemistry containing EMBOSS, Jemboss, Artemis,
- ClustalX, Cn3D, ImageJ, BioPython, Rasmol, BioPerl,
- Bioconductor and others.</item>
- </taglist>
- </item>
- <tag>Similar projects</tag>
- <item>In the past there was some confusion about of the goals of
- Live-CD building projects. Even at the Debian development
- platform <url id="alioth.debian.org"> do some similar
- projects exist.
- <taglist>
- <tag><url id="http://alioth.debian.org/projects/debix/"
- name="Debix">
- <item><p>Debix is a collection of scripts to create live
- filesystems ranging from cloning any existing Linux
- system, providing a comfortable environment for the
- boot-floppies and debian installer up to a full blown
- live filesystem comparable with Knoppix.</p>
- <p>When the author Goswin von Brederlow
- <email>brederlo at informatik.uni-tuebingen.de</email> was
- asked about his goals he answered: "Debix is a level
- below knoppix I would say. If you handle the knoppix
- debs and scripts you could use debix to make seemingly
- writable cd images out of a tar.gz or a directory
- containing the knoppix tree."
- </p>
- <p>Debix is more than one thing:
- <enumlist>
- <item>A tool to make a live-cd out of any Linux system.</item>
- <item>Pre-made sets of package lists and configuration and patches to
- automatically create nice live-cds like knoppix.</item>
- </enumlist>
- In cvs (on Alioth) is a version of Debix that can be
- called "proof of concept" of part 1. Work is in
- progress of changing the build scripts to be modular
- and flexible so part 2 can be started.
- </p>
- <p>Debix can provide the infrastructure. Knoppix has to
- supply the debs that should be in a Knoppix set for
- debix. The 2 parts mean that Debix is supposed as tool
- to create a live-cd from an existing or hand build
- system but also a tool that can build such system
- automatically according to preset rules (list of debs
- and some cleanup scripts if needed).
- </p>
- </item>
- <tag><url id="http://alioth.debian.org/projects/metadistros/" name="Metadistros">
- <item><p>Debian Metadistros goal is to allow you easily
- re-mastering Live-CD distributions like Knoppix to fit
- your or you users needs, within Debian.</p>
- <p>It is a little bit hard to get information about
- this project, because most of the information is in
- Spanish language.</p>
- <p>One piece of the docs which Sergio Talens-Oliag
- <email>sto at debian.org</email> has kindly translated
- says: "... the main problem is that Debian wants a
- Debian tool to make its own Live-CDs but Metadistros
- wants to give tools to let anyone create a
- distribution that can be used as Live-CD and/or
- installed and be based in whatever Linux
- distribution the user wants. Anyway, he said that
- if they can cooperate in any way they will be happy
- to do it."
- </p>
- </item>
- <tag><url id="http://www.morphix.org/" name="Morphix">
- <item><p>Morphix is a modular GNU/Linux distribution on live-Cd's
- (you burn the CD, you put it in your CD-ROM drive, you
- boot and it works... no harddisk-installation
- necessary, doesn't touch your data). Also, installing
- Morphix on a harddisk is a breeze, if you want to. Just
- click on the icon on the desktop, or choose the
- installer from the Morphix/babytux submenu. Morphix
- should still be considered experimental in nature. No
- guarantees are given, use Morphix at your own risk!</p>
- <p>
- ISO's with XFCE4, Gnome2.4, KDE3.1, a game iso and a
- large number of derivatives are available. Morphix is an Open
- Source/Free software project, based on Debian GNU/Linux
- and Knoppix.</p>
- </item>
- <tag><url id="http://ibuild.livecd.net/howto.en.php" name="Intellibuild">
- <item><p>Intellibuild (iBuild) is a set of python scripts
- designed to make the creation/re-master of a Morphix or
- Knoppix Live-CD very simple and easy to do. You can
- easily modify changes and test them without having to
- remember all of the syntax of the re-mastering
- commands.</p>
- <p>The idea is to be able to write XML file that would
- call python scripts that install debian packages and
- customise system for you. It is still under heavy
- development but Slo-Tech Linux and GNUSTEP Live-CD
- already use it.</p>
- <p>Currently work is done to build a GUI that will
- allow you select modules via scripts. It's currently
- Morphix based even though it could be easily tuned for
- knoppix or any other debian approaches to Live-CDs.
- </p>
- </item>
- </taglist>
- </item>
-</taglist>
+thus people started to adopt it for there special needs. In fact
+there exist so many Debian based Live CDs that it makes hardly sense
+to list them all here. The main problem is that most of them
+containing special applications and thus are interesting in the CDD
+scope are out of date because they way the usually were builded was a
+pain. One exception is perhaps <url id="http://dirk.eddelbuettel.com/quantian.html"
+name="Quantian"> which is quite regularly updated and is intended for
+scientists.
+</p>
+<p>
+The good news is that the problem of orphaned or outdated Live CDs can
+easily solved by debian-live and the <package>live-helper</package>.
+This package turns all work to get an up to date ISO image for a Live
+CD into calling a single script. For the CDD tools this would simply
+mean that the tasks files have to be turned into a live-helper input
+file and the basic work is done. This will be done in a future
+cdd-dev version.
+</p>
-So building Live CDs is a common issue for each Custom Debian
-Distribution and the goal is to develop a mastering system which
-drastically decreases the effort to build such live CDs. To
-accomplish this goal the <url
-id="http://alioth.debian.org/projects/debian-knoppix"
-name="debian-knoppix"> project on Alioth was created.
-</p>
-<p>
-Currently <em>re-mastering</em> is a top-down strategy: People who want to
-build there own Knoppix-based live CD proceed this way
-<enumlist>
- <item>Download a complete ISO image. Even with
- <package>bittorrent</package> or similar techniques it makes
- no sense to download 700MBytes for each new Knoppix version if
- you might probably need only half of this size for your
- intended use. Moreover regarding to the fact that Knoppix
- consists mostly of installed Debian packages you might have
- nearly all stuff you need on a local (or at least nearby)
- Debian mirror with a fast connection.
- </item>
- <item>Copy the stuff from the CD to a temporary space.
- </item>
- <item>Remove packages which are not needed. This requires some
- research for packages which are worth removing (regarding the
- space which is gained) and which are not needed later on.
- </item>
- <item>After these steps (all of these are quite time consuming and
- need a certain amount of knowledge) some further packages can
- be installed. In case you want to include some database
- applications or some other applications that need to write a
- certain amount of data your are more or less on your own to
- invent techniques to find out how to do that. Except from
- some postings in the Knoppix-Mailing list there is no
- reasonable documentation, how to do this right.
- </item>
- <item>Create ISO image from chroot environment and burn it.
- </item>
-</enumlist>
-
-It would make much more sense to use a bottom-up strategy and
-<em>master</em> the CD instead of re-mastering. It might even make
-sense to build a Custom Debian Distribution for itself to build the
-necessary tools for this <em>mastering a Knoppix-Live-CD</em>
-approach. The general way would be as follows:
-
-<enumlist>
- <item>Use <package>debootstrap</package> to build a basic system you
- could <prgn>chroot</prgn> into.
- </item>
- <item>Install Knoppix stuff into chroot environment. This is the
- hardware detection stuff, the special configuration, etc.
- After this step the system should be in a state like after
- step 3. of the re-mastering process above. The tricky part to
- accomplish this is to build reasonable Debian packages like
- this:
- <taglist>
- <tag><package>knoppix-hardware</package></tag>
- <item>Contains all the hardware detection stuff</item>
- <tag><package>knoppix-x</package></tag>
- <item>Contains stuff from Knoppix which cares for X. This is
- not necessarily needed for simple rescue CDs.
- </item>
- <tag><package>knoppix-config</package></tag>
- <item>Special configuration stuff. Please note these
- packages will be installed into a chroot environment
- which is <em>not</em> a Debian host system. It might be
- necessary to change the configuration of some packages
- installed in this chroot environment which conflicts to
- Debian policy in a <em>real</em> Debian system. But
- here we face a special part of our hard-disk (say
- <file>/var/cache/knoppix/etc</file>) which is not
- covered by policy. The only point is to make sure that
- this <package>knoppix-config</package> package will not
- be installed on a Debian host system (if and only if anything
- is really needed which would not comply with the policy).
- </item>
- <tag><package>knoppix-misc</package></tag>
- <item>Whatever might be needed and is not covered by the
- things above. Here user support for integrating
- database applications might be integrated.
- </item>
- </taglist>
- </item>
- <item>Customise chroot environment for intended purpose. This is
- the same as in the re-mastering step 4. but it could be
- supported by some tools from <package>knoppix-misc</package>.
- </item>
- <item>Create ISO image from chroot environment and burn it. While
- this is the same as step 5. but it might also be supported by
- some nifty tools which would simplify things for anybody
- wanting to build their own CD.
- </item>
-</enumlist>
-
-This approach would have the additional advantage of being portable
-also to non-i386 architectures and in fact Fabian Franz
-<email>FabianFranz at gmx.de</email> managed to prove this true for
-Power-PC architecture.
</sect>
<sect id="new_ways_of_distribution">
Modified: cdd/trunk/cdd/doc/en/A_devel.sgml
==============================================================================
--- cdd/trunk/cdd/doc/en/A_devel.sgml (original)
+++ cdd/trunk/cdd/doc/en/A_devel.sgml Mon Sep 10 18:40:19 2007
@@ -23,188 +23,38 @@
<file>/etc/cdd</file>.
</p>
<p>
-The current Debian-Med packages provide a working example how to use
-the tools described below.
-</p>
-
-<sect1 id="cdd-gen-control(1)">
- <heading><!-- document type does not allow element "MANREF" here--><tt>cdd-gen-control(1)</tt></heading>
+The best idea to use the tools provided by the
+<package>cdd-dev</package> is to put a <file>Makefile</file> into the
+build directory containig one single line
-<p>
-<taglist>
- <tag>NAME</tag>
- <item>
- <prgn>cdd-gen-control</prgn> - generate debian/control file from tasks directory
- </item>
- <tag>SYNOPSIS</tag>
- <item>
- <prgn>cdd-gen-control</prgn>
- </item>
- <tag>DESCRIPTION</tag>
- <item>The script <prgn>cdd-gen-control</prgn> parses the
- <file>tasks</file> directory for text files that have a similar
- syntax to <file>debian/control</file> files. Each text file is
- used as template for a
- <var>cdd</var><file>-</file><var>textfile_name</var> meta package
- and has to define the dependencies. In addition there is a further
- tag named <tt>Task</tt> which is mandatory and is used later as
- registry of all tasks in <file>/usr/share/cdd/tasks/<var>cdd</var></file>.
- </item>
- <tag>OPTIONS</tag>
- <item>
- <taglist>
- <tag><tt>-c</tt></tag>
- <item>Create debian/control file using template
- <file>debian/control.stub</file>.
- </item>
- <tag><tt>-d</tt></tag>
- <item>Turn on debugging mode.</item>
- <tag><tt>-a</tt></tag>
- <item>Print all available packages.</item>
- <tag><tt>-e</tt></tag>
- <item>Print excluded packages.</item>
- <tag><tt>-m</tt></tag>
- <item>Print missing packages.</item>
- <tag><tt>-s</tt> <var>dist</var></tag>
- <item>Without the <tt>-s</tt> option
- <file>/etc/cdd/sources.list</file> is used to verify
- which packages are available. You can specify one of
- <tt>stable</tt>, <tt>testing</tt> or <tt>unstable</tt> as
- argument or a complete path to a valid
- <file>sources.list</file> file.
- </item>
- </taglist>
- </item>
- <tag>AUTHORS</tag>
- <item>Petter Reinholdtsen <email>pere at hungry.com</email>, Andreas
- Tille <email>tille at debian.org</email>
- </item>
-</taglist>
+<example>
+ include /usr/share/cdd-dev/Makefile
+</example>
-The interesting thing in this script is that it can be ensured that
-the resulting meta package can be installed in the target
-distribution. For instance it might be possible that for certain
-reasons a meta package should work together with the current Debian
-<tt>stable</tt> distribution. If the package is built against a sources.list
-package that contains entries for <tt>stable</tt> and some newer packages are
-not yet available, those packages are not listed as dependencies but only
-as suggested packages. That way, it is possible to provide meta
-packages for a <tt>stable</tt> distribution using the same package source
-as for <tt>testing</tt> or <tt>unstable</tt>, where new packages
-normally go.
-</p>
-<p>
-For an example of valid <file>tasks</file> files see the
-<file>/usr/share/doc/cdd-dev/examples/tasks</file> or the source
-package of <package>debian-med (>=0.8.9)</package>.
+(see <file>/usr/share/doc/cdd-dev/examples/Makefile</file>). Using
+this <file>Makefile</file> all tools that were contained in
+<package>cdd-dev</package> package versions before 0.4. These tools
+are moved to <file>/usr/share/cdd-dev/</file> because there is no need
+to call them directly. Here is a list of the <file>make</file> targets.
+</p>
+
+<sect1 id="cdd-tasks.desc">
+ <heading>CDD<tt>-tasks.desk</tt></heading>
+
+<p>
+This target is the description file that is used in
+<prgn>tasksel</prgn> to enable selecting the tasks belonging to the
+CDD. The file will be moved to the
+<var>cdd</var><package>-tasks</package>. All information is obtained
+from the single task files in the <file>tasks</file> directory of the
+CDD source.
</p>
</sect1>
-<sect1 id="cdd-install-helper">
- <heading><!-- document type does not allow element "MANREF" here--><tt>cdd-install-helper(1)</tt></heading>
+<sect1 id="debian_control">
+ <heading><tt>debian/control</tt></heading>
<p>
-<taglist>
- <tag>NAME</tag>
- <item>
- <prgn>cdd-install-helper</prgn> - install menu and link to helper bin
- and according manpage
- </item>
- <tag>SYNOPSIS</tag>
- <item>
- <prgn>cdd-install-helper</prgn>
- </item>
- <tag>DESCRIPTION</tag>
- <item>
- <p>
- This script can be used in <file>debian/rules</file> file to
- install the user menu files to
- <file>/etc/cdd/</file><var><cdd></var><file>/menu/</file><var><package></var>,
- a link for the helper script of every <var><cdd></var>-*
- package and the link to the manpage for this script.
- </p><p>
- <taglist>
- <tag><file>menu</file></tag>
- <item>
- <p>
- If a directory <file>menu</file> exists in the building directory
- it checks subdirectories <file>menu/<var><task></var></file>
- (named like meta package without the <var>cdd</var>- name prefix).
- This subdirectory might contain three types of files:
- <taglist>
- <tag><file><var><dep></var>.menu</file></tag>
- <item>These files should be valid menu files as they are
- provided for Debian packages in
- <file>debian/menu</file>. They will be copied to
- <file>usr/share/cdd/<var><cdd></var>/menu/<var><dep></var></file>
- and can be used to override the menu items which are provided
- by the maintainer of the package
- <package><var><dep></var></package> in case the meta
- package author likes to change the normal menu item for the
- user menus.
- </item>
- <tag><file><var><dep></var>.html</file></tag>
- <item>These files might contain documentation of the
- dependency in HTML format if it makes no sense to
- provide a menu entry to actually call a program in the
- package.
- </item>
- <tag><file><var><dep></var>.txt</file></tag>
- <item>These files might contain documentation of the
- dependency in text format if it makes no sense to
- provide a menu entry to actually call a program in the
- package.
- </item>
- </taglist>
-
- The rationale of the latter both types is to enable a menu entry
- in the user menus for <strong>every</strong> call a certain
- program via the menu. These files should provide reasonable
- information how to use this program in text form. This is better
- than having no menu entry at all because the target user might
- use the menu as the first interface of information of his
- system.
- </p>
- </item>
- <tag><package>common</package></tag>
- <item>
- If there exists a file <file>common/common</file> and has a size
- greater than 0 a <var><cdd></var>-common package is builded. The
- file <file>common/control</file> was just used to build the
- appropriate <file>debian/control</file> file using the
- <manref name="cdd-gen-control" section="1"> tool.
- </item>
- <tag><file>conf</file></tag>
- <item>
- If there exists a file <file>common/conf</file> and has a size
- greater than 0 this is used as that special configuration file
- <file>/etc/cdd/<var><cdd></var>/<var><cdd></var>.conf</file>,
- which
- can override variables from the general configuration file
- <file>/etc/cdd/cdd.conf</file> or add further variables. Because
- it is sourced from shell, it has to follow shell syntax.
- </item>
-
- <tag><file>install</file></tag>
- <item>
- Here the extra files which might be needed in a meta package
- (like scripts, manpages, etc.) should be copied in a directory
- named
- <file>install/</file><var><pkg_without_cdd-prefix></var><file>/</file>
- and the files should be moved into place by using
- <file>debian/<var><pkg></var>.install</file> or
- <file>debian/<var><pkg></var>.manpages</file> etc.
- </item>
- </taglist>
- </p>
- </item>
- <tag>EXAMPLES</tag>
- <item>For the usage of this tool just have a look at the
- <package>debian-med</package> source package.
- </item>
- <tag>AUTHOR</tag>
- <item>Andreas Tille <email>tille at debian.org</email>.</item>
- </taglist>
</p>
</sect1>
@@ -526,6 +376,10 @@
</item>
</taglist>
</p>
+<p>
+The current Debian-Med packages provide a working example how to use
+the tools described below.
+</p>
</sect>
</appendix>
Modified: cdd/trunk/cdd/doc/en/B_quickintro.sgml
==============================================================================
--- cdd/trunk/cdd/doc/en/B_quickintro.sgml (original)
+++ cdd/trunk/cdd/doc/en/B_quickintro.sgml Mon Sep 10 18:40:19 2007
@@ -71,8 +71,7 @@
Distribution has to be inserted where the template contains
<var>_CDD_</var>. Depending from the way the
<file>sources.list</file> should be scanned the options for the
-<prgn>gen-control</prgn> call can be adjusted (see <ref
-id="cdd-gen-control(1)">).
+<prgn>gen-control</prgn> call can be adjusted.
</p>
<p>
Optionally a source tarball can be created by
More information about the Cdd-commits
mailing list