Re: apt man pages
Op vrijdag 14 november 2003 06:37, schreef Jason Gunthorpe:
> I think a patch to correct the docbook SGML documents is probably a good
> idea.
>
> I don't know of any tool that will normalize the markup without mangling
> the indentation in the document. sgmlnorm (run on a system with the
> mangled DTDTYPE) will remove all tag minimization (and also expand
> entities, etc), but the resulting output is too mangled to be useful.
Jason and all,
I went ahead and made some (manual) changes to apt.ent and apt-cdrom to start
with. Please find the updated files attached. I use docbook4 I hope that it
does not clash with docbook3. If I run 'nsgmls -s apt-cdrom.8.sgml' no
errors are reported and the exit value is 0 (zero)
However if I run docbook2man apt-cdrom.8.sgml the following errors are
reported:
nsgmls:/home/richard/packages/SOURCES/apt-0.5.15cnc2/doc/
apt-cdrom.8.sgml:2:59:W: cannot generate system identifier for public text
"-//OASIS//DTD DocBook V4.2//EN"
nsgmls:/home/richard/packages/SOURCES/apt-0.5.15cnc2/doc/apt.ent:165:0:Q:
length of interpreted parameter literal must not exceed LITLEN (1024)
-----
This is for:
<!-- Should be used within the option section of the text to
put in the blurb about -h, -v, -c and -o -->
<!ENTITY apt-commonoptions "
<VarListEntry><term><option>-h</option></term>
<term><option>--help</option></term>
The entry contains about 1150 characters. If I remove enough characters
the error is gone.
-----
nsgmls:/home/richard/packages/SOURCES/apt-0.5.15cnc2/doc/
apt-cdrom.8.sgml:7:0:E: reference to entity "REFENTRY" for which no system
identifier could be generated
nsgmls:/home/richard/packages/SOURCES/apt-0.5.15cnc2/doc/apt-cdrom.8.sgml:2:0:
entity was defined here
nsgmls:/home/richard/packages/SOURCES/apt-0.5.15cnc2/doc/
apt-cdrom.8.sgml:165:10:E: there is no attribute "URL"
Can't call method "value" on an undefined value at /usr/share/sgml/docbook/
utils-0.6.6/helpers/docbook2man-spec.pl line 297, <STDIN> line 15.
---end of errors ----
apt-0.5.15cnc2/doc> docbook2man -v
DocBook-utils version 0.6.6 (jw version 1.1)
apt-0.5.15cnc2/doc> docbook2man -h
jw - Jade Wrapper
Any idea what might be wrong here? Is it my docbook2man version, is it
something in the sgml docs?
--
Richard Bos
Without a home the journey is endless
<!-- -*- mode: sgml; mode: fold -*- -->
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;
]>
<refentry>
<refmeta>
<refentrytitle>apt-cdrom</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<!-- Man page title -->
<refnamediv>
<refname>apt-cdrom</refname>
<refpurpose>APT CDROM management utility</refpurpose>
</refnamediv>
<!-- Arguments -->
<refsynopsisdiv>
<cmdsynopsis>
<command>apt-cdrom</command>
<arg><option>-hvrmfan</option></arg>
<arg><option>-d=replaceable/cdrom mount point/</option></arg>
<arg><option>-o=replaceable/config string/</option></arg>
<arg><option>-c=replaceable/file/</option></arg>
<group>
<arg>add</arg>
<arg>ident</arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<RefSect1><Title>Description</Title>
<para>
<command>apt-cdrom</command> is used to add a new CDROM to APTs list of available
sources. <command/apt-cdrom/ takes care of determining the structure of
the disc as well as correcting for several possible mis-burns and
verifying the index files.
</para>
<para>
It is necessary to use <command>apt-cdrom</command> to add CDs to the APT system,
it cannot be done by hand. Furthermore each disk in a multi-cd set must be
inserted and scanned separately to account for possible mis-burns.
</para>
<para>
Unless the <option>-h</option>, or <option>--help</option> option is given one of the
commands below must be present.
<VariableList>
<VarListEntry><Term>add</Term>
<ListItem><Para>
<literal>add</literal> is used to add a new disc to the source list. It will unmount the
CDROM device, prompt for a disk to be inserted and then procceed to
scan it and copy the index files. If the disc does not have a proper
<filename>disk</filename> directory you will be prompted for a descriptive
title.
</para>
<para>
APT uses a CDROM ID to track which disc is currently in the drive and
maintains a database of these IDs in
<filename>&statedir;/cdroms.list</filename>
</para>
</listitem>
</VarListEntry>
<VarListEntry><Term>ident</Term>
<ListItem><Para>
A debugging tool to report the identity of the current disc as well
as the stored file name
</para>
</listitem>
</VarListEntry>
</VariableList>
</para>
</RefSect1>
<RefSect1><Title>Options</Title>
&apt-cmdblurb;
<VariableList>
<VarListEntry><term><option>-d</option></term><term><option>--cdrom</option></term>
<ListItem><Para>
Mount point; specify the location to mount the cdrom. This mount
point must be listed in <filename>/etc/fstab</filename> and properly configured.
Configuration Item: <literal>Acquire::cdrom::mount</literal>.
</para>
</listitem>
</VarListEntry>
<VarListEntry><term><option>-r</option></term><term><option>--rename</option></term>
<ListItem><Para>
Rename a disc; change the label of a disk or override the disks
given label. This option will cause <command>apt-cdrom</command> to prompt for
a new label.
Configuration Item: <literal>APT::CDROM::Rename</literal>.
</para>
</listitem>
</VarListEntry>
<VarListEntry><term><option>-m</option></term><term><option>--no-mount</option></term>
<ListItem><Para>
No mounting; prevent <command/apt-cdrom/ from mounting and unmounting
the mount point.
Configuration Item: <literal>/APT::CDROM::NoMount/</literal>.
</para>
</listitem>
</VarListEntry>
<VarListEntry><term><option>-f</option></term><term><option>--fast</option></term>
<ListItem><Para>
Fast Copy; Assume the package files are valid and do not check
every package. This option should be used only if
<command/apt-cdrom/ has been run on this disc before and did not detect
any errors.
Configuration Item: <literal>/APT::CDROM::Fast/</literal>.
</para>
</listitem>
</VarListEntry>
<VarListEntry><term><option>-a</option><term><option>--thorough</option></term>
<ListItem><Para>
Thorough Package Scan; This option may be needed with some old
Debian 1.1/1.2 discs that have Package files in strange places. It
takes much longer to scan the CD but will pick them all up.
</para>
</listitem>
</VarListEntry>
<VarListEntry><term><option>-n</option></term>
<term><option>--just-print</option></term>
<term><option>--recon</option></term>
<term><option>--no-act</option></term>
<ListItem><Para>
No Changes; Do not change the &sources-list; file and do not
write index files. Everything is still checked however.
Configuration Item: <literal>/APT::CDROM::NoAct/</literal>.
</para>
</listitem>
</VarListEntry>
&apt-commonoptions;
</VariableList>
</RefSect1>
<RefSect1><Title>See Also</>
<para>
&apt-conf;, &apt-get;, &sources-list;
</para>
</RefSect1>
<RefSect1><Title>Diagnostics</>
<para>
<command/apt-cdrom/ returns zero on normal operation, decimal 100 on error.
</para>
</RefSect1>
&manbugs;
&manauthor;
</refentry>
<<< text/html; charset="iso-8859-1"; name="apt.ent": Unrecognized >>>
Reply to: