Bug#504588: Some minor errors in the manual
Package: installation-guide
----- Forwarded message from Jens Seidel <jensseidel@users.sf.net> -----
From: Jens Seidel <jensseidel@users.sf.net>
Subject: Some errors in the manual
Date: Fri, 17 Oct 2008 19:28:10 +0200
To: debian-boot@lists.debian.org
Mail-Followup-To: Jens Seidel <jensseidel@users.sf.net>,
debian-boot@lists.debian.org
User-Agent: Mutt/1.5.18 (2008-05-17)
Hi,
I noticed a few (partly trivial) errors in the Installer guide. I tried
first to send a proper patch but to be honest I don't have the time for
it.
I extented the code by some comments, I hope you find these useful. See
the attached file (which you have to edit, sorry about this).
The most important stuff:
> If you've had to change <filename>/etc/inetd.conf</filename>, you'll have to
> +<!-- inetd is no longer a command, there exists openbsd-inetd, ... -->
> notify the running <command>inetd</command> process that the file has changed.
Debian has no longer a /etc/init.d/inetd binary but many alternatives
(without using /etc/alternatives/). You have to rewrite this.
> One of the most common installations is onto a system that already
> contains DOS (including Windows 3.1), Win32 (such as Windows 95, 98, Me,
> -NT, 2000, XP), or OS/2, and it is desired to put Debian onto the same disk
> +NT, 2000, XP, ReactOS), or OS/2, and it is desired to put Debian onto the same disk
Let's at least mention one free Win32 platform (with a URL?), right?
Also at least FreeDos should be mentioned when you refer to DOS systems.
> without destroying the previous system. Note that the installer supports
> +<!-- NTFS is supported? -->
> resizing of FAT and NTFS filesystems as used by DOS and Windows. Simply
I wasn't very sure whether NTFS is supported by the installer. Here is
it mentioned, at a different location in the source it is missing ...
> -fetchmail.
> +<command>fetchmail</command>.
There are a few tags missing, I hope I chose the right ones (I didn't
test it). If you don't want to apply these parts because unfuzzying
translations is to hard for you, I can help you ...
> In a lot of cases the smarthost will be your ISP's mail server, which
> makes this option very suitable for dial-up users. It can also be a
> +<!-- except that multiple local users could have different ISP and a
> + foreign ISP normally rejects mails from other users ...
> + (Hint: web.de just evaluate the header "Sender:" and ignores From:
> + in this case, so add this header for all mails!?) -->
> company mail server, or even another system on your own network.
Email configuration still needs some additional text (e.g. how to add a
proper From: based on the mapping in /etc/email-addresses). The current
information is probably not useful for most users because only
very few users have a static IP (other require a smarthost which needs
a special configuration). (exim4 isn't designed for dynamic Internet
access which is the root of all problems.)
The installation guide is probably not the best location for such
additional info but where should it be described?
> <application>aptitude</application>. Note apt will also let you merge
> +<!-- "export-restricted"??? non-US no longer exists! -->
> main, contrib, and non-free so you can have export-restricted packages
> as well as standard versions.
non-US no longer exists!
Again sorry for not providing a proper patch but I hope it helps
nevertheless.
PS: Please CC: me.
Jens
----- End forwarded message -----
Index: install-methods/install-tftp.xml
===================================================================
--- install-methods/install-tftp.xml (Revision 56576)
+++ install-methods/install-tftp.xml (Arbeitskopie)
@@ -128,6 +128,7 @@
</footnote>; you'll need that below.
If you've had to change <filename>/etc/inetd.conf</filename>, you'll have to
+<!-- inetd is no longer a command, there exists openbsd-inetd, ... -->
notify the running <command>inetd</command> process that the file has changed.
On a Debian machine, run <userinput>/etc/init.d/inetd reload</userinput>; on
other machines, find out the process ID for <command>inetd</command>, and run
Index: install-methods/tftp/bootp.xml
===================================================================
--- install-methods/tftp/bootp.xml (Revision 56576)
+++ install-methods/tftp/bootp.xml (Arbeitskopie)
@@ -17,7 +17,7 @@
To use CMU <command>bootpd</command>, you must first uncomment (or
add) the relevant line in <filename>/etc/inetd.conf</filename>. On
&debian;, you can run <userinput>update-inetd --enable
-bootps</userinput>, then <userinput>/etc/init.d/inetd
+bootps</userinput>, then <userinput>/etc/init.d/*inetd
reload</userinput> to do so. Just in case your BOOTP server does not
run Debian, the line in question should look like:
Index: preparing/nondeb-part/alpha.xml
===================================================================
--- preparing/nondeb-part/alpha.xml (Revision 56576)
+++ preparing/nondeb-part/alpha.xml (Arbeitskopie)
@@ -6,7 +6,8 @@
<para>
Tru64 UNIX, formerly known as Digital UNIX, which is in turn formerly
-known as OSF/1, uses the partitioning scheme similar to the BSD <quote>disk
+<!-- Compare "Sun disk label" in preparing/nondeb-part/sparc.xml -->
+known as OSF/1, uses the partitioning scheme similar to the <quote>BSD disk
label</quote>, which allows for up to eight partitions per disk drive. The
partitions are numbered <quote>1</quote> through to <quote>8</quote> in
Linux and <quote>lettered</quote> <quote>a</quote> through to
Index: preparing/nondeb-part/x86.xml
===================================================================
--- preparing/nondeb-part/x86.xml (Revision 56576)
+++ preparing/nondeb-part/x86.xml (Arbeitskopie)
@@ -32,13 +32,16 @@
One of the most common installations is onto a system that already
contains DOS (including Windows 3.1), Win32 (such as Windows 95, 98, Me,
-NT, 2000, XP), or OS/2, and it is desired to put Debian onto the same disk
+NT, 2000, XP, ReactOS), or OS/2, and it is desired to put Debian onto the same disk
without destroying the previous system. Note that the installer supports
+<!-- NTFS is supported? -->
resizing of FAT and NTFS filesystems as used by DOS and Windows. Simply
start the installer and when you get to the partitioning step, select the
option for <menuchoice> <guimenuitem>Manual</guimenuitem> </menuchoice>
partitioning, select the partition to resize, and specify its new size.
So in most cases you should not need to use the method described below.
+<!-- In what cases do the following steps apply? (Only if the installer
+ returned an error?) -->
</para><para>
@@ -78,6 +81,7 @@
later, can easily do the job. See the <command>fips</command> documentation
for a list of other software that may do the trick. Note that if you
have Windows 9x, you must run <command>defrag</command> from there, since
+<!-- I doubt that e.g. FreeDos has this restriction -->
DOS doesn't understand VFAT, which is used to support for long
filenames, used in Windows 95 and higher.
Index: preparing/nondeb-part/powerpc.xml
===================================================================
--- preparing/nondeb-part/powerpc.xml (Revision 56576)
+++ preparing/nondeb-part/powerpc.xml (Arbeitskopie)
@@ -32,6 +32,7 @@
</para><para>
+<!-- According to preparing/nondeb-part/alpha.xml Linux supports UFS, or is it another filesystem?-->
GNU/Linux is unable to access information on UFS partitions, but does
support HFS+ (aka MacOS Extended) partitions. OS X requires one of these
two types for its boot partition. MacOS 9 can be installed on either HFS
Index: preparing/install-overview.xml
===================================================================
--- preparing/install-overview.xml (Revision 56576)
+++ preparing/install-overview.xml (Arbeitskopie)
@@ -129,6 +129,7 @@
For &arch-title; you have the option of using
<phrase arch="x86">a</phrase>
<phrase arch="powerpc">an experimental</phrase>
+<!-- No other architecture possible, right? -->
graphical version of the installation system. For more information about
this graphical installer, see <xref linkend="graphical"/>.
Index: post-install/mail-setup.xml
===================================================================
--- post-install/mail-setup.xml (Revision 56576)
+++ post-install/mail-setup.xml (Arbeitskopie)
@@ -192,12 +192,16 @@
The smarthost also usually stores incoming mail addressed to your
computer, so you don't need to be permanently online. That also means
you have to download your mail from the smarthost via programs like
-fetchmail.
+<command>fetchmail</command>.
</para><para>
In a lot of cases the smarthost will be your ISP's mail server, which
makes this option very suitable for dial-up users. It can also be a
+<!-- except that multiple local users could have different ISP and a
+ foreign ISP normally rejects mails from other users ...
+ (Hint: web.de just evaluate the header "Sender:" and ignores From:
+ in this case, so add this header for all mails!?) -->
company mail server, or even another system on your own network.
</para></listitem>
Index: post-install/further-reading.xml
===================================================================
--- post-install/further-reading.xml (Revision 56576)
+++ post-install/further-reading.xml (Arbeitskopie)
@@ -17,7 +17,7 @@
information. To submit bugs, look at
<filename>/usr/share/doc/debian/bug*</filename>. To read about
Debian-specific issues for particular programs, look at
-<filename>/usr/share/doc/(package name)/README.Debian</filename>.
+<filename>/usr/share/doc/<replaceable>package name</replaceable>/README.Debian</filename>.
</para><para>
Index: post-install/orientation.xml
===================================================================
--- post-install/orientation.xml (Revision 56576)
+++ post-install/orientation.xml (Arbeitskopie)
@@ -60,7 +60,9 @@
One of the best installation methods is apt. You can use the command
line version <command>apt-get</command> or full-screen text version
+<!-- <application> instead of <command>? -->
<application>aptitude</application>. Note apt will also let you merge
+<!-- "export-restricted"??? non-US no longer exists! -->
main, contrib, and non-free so you can have export-restricted packages
as well as standard versions.
@@ -71,7 +73,7 @@
<para>
-Alternative versions of applications are managed by update-alternatives. If
+Alternative versions of applications are managed by <command>update-alternatives</command>. If
you are maintaining multiple versions of your applications, read the
update-alternatives man page.
@@ -93,14 +95,15 @@
On the other hand, if you have a cron job that (a) needs to run as a
special user, or (b) needs to run at a special time or frequency, you
can use either <filename>/etc/crontab</filename>, or, better yet,
-<filename>/etc/cron.d/whatever</filename>. These particular files
+<filename>/etc/cron.d/<replaceable>file</replaceable></filename>. These particular files
also have an extra field that allows you to stipulate the user account
under which the cron job runs.
</para><para>
-In either case, you just edit the files and cron will notice them
+In either case, you just edit the files and <command>cron</command> will notice them
automatically. There is no need to run a special command. For more
+<!-- manpage tags? -->
information see cron(8), crontab(5), and
<filename>/usr/share/doc/cron/README.Debian</filename>.
Index: using-d-i/modules/partman.xml
===================================================================
--- using-d-i/modules/partman.xml (Revision 56576)
+++ using-d-i/modules/partman.xml (Arbeitskopie)
@@ -260,6 +260,7 @@
that may not be very obvious at a first glance is that you can
resize the partition by selecting the item displaying the size of the
partition. Filesystems known to work are at least fat16, fat32, ext2,
+<!-- what about NTFS? Supported according to preparing/nondeb-part/x86.xml -->
ext3 and swap. This menu also allows you to delete a partition.
</para><para>
Reply to: