diff options
Diffstat (limited to 'debian/tmp/usr/share/doc/dhelp/dhelp.html')
| -rw-r--r-- | debian/tmp/usr/share/doc/dhelp/dhelp.html | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/debian/tmp/usr/share/doc/dhelp/dhelp.html b/debian/tmp/usr/share/doc/dhelp/dhelp.html new file mode 100644 index 0000000..00e2f5c --- /dev/null +++ b/debian/tmp/usr/share/doc/dhelp/dhelp.html @@ -0,0 +1,189 @@ +<HTML> +<TITLE>dhelp</TITLE> +<BODY BGCOLOR=#FFFFFF> +<IMG SRC="debian.jpg" ALT="Debian GNU/Linux"><p> +<H1>dhelp</H1> + +<H2>What's dhelp?</H2> +dhelp is an online help system for Debian GNU/Linux. A Debian package +can register its HTML documents and dhelp builds an index of +all documents. + +The user doesn't need a WWW server to browse the HTML tree. + +<H2>How to use dhelp</H2> +If you have installed a WWW server on your system simply browse +<BLOCKQUOTE><TT><A HREF="http://localhost/doc/HTML/index.html"> +http://localhost/doc/HTML/index.html</A></TT></BLOCKQUOTE><P> + +If you haven't installed a WWW server use the dhelp command: + +<BLOCKQUOTE>$ dhelp</BLOCKQUOTE> + +<H2>The .dhelp file</H2> + +Programs supporting dhelp have to install a <tt>.dhelp</tt> file +in every directory under <tt>/usr/share/doc</tt>. For every HTML file that +should appear in the dhelp index the <tt>.dhelp</tt> file have to contain +the following section:<P> + +<DL> +<DT><TT><item></TT> +<DT><TT><directory></TT> +<DD>Defines in which section of the index the document should be linked. + I suggest that you use the same names like in <em>Section:</em> + in <tt>control</tt>. For example for a game you would use + <tt>games</tt>. A German document should linked to <tt>de/games</tt> + and so on. + You can find all supported sections in + <tt><A HREF=".dhelp">.dhelp</A></tt>. You can create additional + sections if necessary. +<DT><TT><dirtitle></TT> +<DD>Defines the title of a new section. +<DT><TT><linkname></TT> +<DD>This short text appears as link text in the index. This + is typical the filename without the <tt>.html suffix</tt>. +<DT><TT><filename></TT> +<DD>The filename of the HTML file with a path relative to the + <tt>.dhelp</tt> file. If your document is called + <tt>/usr/share/doc/dhelp/test.html</tt> and the <tt>.dhelp</tt> + is installed in <tt>/usr/share/doc/dhelp</tt> you must use + <tt>test.html</tt>. +<DT><PRE> +<description> +... +</description> +</PRE> +<DD> +A long description of the content of the document (optional). +<DT><TT></item></TT> +</DL><P> + +You can have only one tag per line! Something like the following will +not work:<P> + +<PRE> +<item><directory>de/foo + <dirtitle>The foo section + <linkname>foo + <filename>foo.html +<descrip>foo foo foo</descrip></item> +</PRE> + +You have to use this:<P> + +<PRE> +<item> +<directory>de/foo +<dirtitle>The foo section +<linkname>foo +<filename>foo.html +<descrip> +foo foo foo +</descrip> +</item> +</PRE> + +You can have several <item> sections in one <tt>.dhelp</tt> +file. + + +<H2>Add a .dhelp file to the index</H2> + +To add a <tt>.dhelp</tt> file to the document index you have +to call <tt>dhelp_parse</tt>:<P> + +<BLOCKQUOTE># dhelp_parse -a /usr/share/doc/directory</BLOCKQUOTE> + +I would suggest to add the following to your package <tt>postinst</tt> +script:<P> + +<BLOCKQUOTE><PRE> +if [ -f /usr/sbin/dhelp_parse ]; then + /usr/sbin/dhelp_parse -a /usr/share/doc/directory +fi +</PRE></BLOCKQUOTE><P> + +In <tt>prerm</tt> you should use:<P> + +<BLOCKQUOTE><PRE> +if [ -f /usr/sbin/dhelp_parse ]; then + /usr/sbin/dhelp_parse -d /usr/share/doc/directory +fi +</PRE></BLOCKQUOTE><P> + +<!-- +If your package conforms to the latest policy, the <tt>postinst</tt> +script should look like this:<P> + +<BLOCKQUOTE><PRE> +if [ -f /usr/sbin/dhelp_parse ]; then + /usr/sbin/dhelp_parse -a /usr/share/doc/directory +fi + +if [ -f /usr/sbin/dhelp_parse_fsstnd ]; then + /usr/sbin/dhelp_parse_fsstnd -a /usr/doc/directory +fi +</PRE></BLOCKQUOTE><P> + +In <tt>prerm</tt> you should use:<P> + +<BLOCKQUOTE><PRE> +if [ -f /usr/sbin/dhelp_parse ]; then + /usr/sbin/dhelp_parse -d /usr/share/doc/directory +fi + +if [ -f /usr/sbin/dhelp_parse_fsstnd ]; then + /usr/sbin/dhelp_parse_fsstnd -d /usr/doc/directory +fi +</PRE></BLOCKQUOTE><P> +--> + +Or you can use the script <tt>dh_dhelp</tt>. This script installs +the <tt>debian/dhelp</tt> file in <tt>/usr/share/doc/package</tt> and +creates the <tt>postinst</tt> and <tt>prerm</tt> scripts of all +<tt>.dhelp</tt> files found in <tt>/usr/share/doc</tt>. + + +<H2>Scripts for .dhelp file</H2> + +<H3>sgml2dhelp</H3> + +If the HTML files were produced by the sgml-tools (linuxdoc-sgml) +you can use the script <tt><a href="sgml2dhelp.pl">sgml2dhelp.pl</a></tt>. +This script produces a <tt>.dhelp</tt>, a <tt>.dwww-index</tt>, +and a <tt>index.html</tt> file.<P> + +Run this script in every directory containing HTML files. +You have to call the script with to options:<P> + +<BLOCKQUOTE> +<b>sgml2dhelp</b> <i><dhelp section> <dwww section></i> +</BLOCKQUOTE> + +If your documents should go in the German HOWTO section for example, you +have to enter:<P> + +<BLOCKQUOTE><TT># dhelp.build de/HOWTO general</TT></BLOCKQUOTE> <P> + +<h3>dhelp2dwww</h3> + +If you have written a <tt>.dhelp</tt>, you can convert it to +a <tt>.dwww-index</tt> file with the script +<tt><a href="dhelp2dwww.pl">dhelp2dwww.pl</a></tt>.<p> + +<blockquote> +<b>dhelp2dwww</b> <i><dwww section></i> +</blockquote> + +<H2>What can I do for dhelp?</H2> + +If you like dhelp please ask maintainers of Debian packages including +HTML documentation to add dhelp support.<P> + +If you have any comments or problems please feel free to send +an email to the dhelp package maintainer: +<A HREF="mailto:dhelp@packages.debian.org">dhelp@packages.debian.org</A> + +</BODY> +</HTML>
\ No newline at end of file |