Date: Sun, 26 May 2002 12:18:01 +0200 From: Marc Fonvieille <marc@blackend.org> To: FreeBSD-gnats-submit@FreeBSD.org, freebsd-doc@FreeBSD.org Subject: Re: docs/38540: sysinstall application name should be Sysinstall with right tags in all the Handbook Message-ID: <20020526121801.E44744@abigail.blackend.org> In-Reply-To: <200205251140.g4PBe2f48418@freefall.freebsd.org>; from FreeBSD-gnats-submit@FreeBSD.org on Sat, May 25, 2002 at 04:40:02AM -0700 References: <200205251127.g4PBRDQS043038@abigail.blackend.org> <200205251140.g4PBe2f48418@freefall.freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
[-- Attachment #1 --]
Hello,
Here's my mega-patch according to community opinion. I need to find a
brave soul to work on it :)
Some details:
- in text sysinstall is without upper case and between application tags
- fdisk is fdisk not FDisk etc...
- use of disklabel instead of Disklabel in the text.
- use of fips instead of FIPS.
- Partition Magic is not changed, the commercial name is with uppercases
- DEFRAG should be defrag.
- Norton Disk Tools, Stacker, and DoubleSpace are apps, and so need
application tags.
Marc
[-- Attachment #2 --]
diff -ruN handbook.org/advanced-networking/chapter.sgml handbook/advanced-networking/chapter.sgml
--- handbook.org/advanced-networking/chapter.sgml Thu May 16 03:42:20 2002
+++ handbook/advanced-networking/chapter.sgml Sun May 26 11:59:55 2002
@@ -3384,7 +3384,7 @@
<primary><application>sysinstall</application></primary>
</indexterm>
<para>DHCP is supported by <application>sysinstall</application>.
- When configuring a network interface within sysinstall,
+ When configuring a network interface within <application>sysinstall</application>,
the first question asked is, "Do you want to try DHCP
configuration of this interface?" Answering affirmatively will
execute <command>dhclient</command>, and if successful, will fill
diff -ruN handbook.org/install/chapter.sgml handbook/install/chapter.sgml
--- handbook.org/install/chapter.sgml Sun May 26 01:11:10 2002
+++ handbook/install/chapter.sgml Sun May 26 11:59:12 2002
@@ -34,10 +34,10 @@
<indexterm><primary>installation</primary></indexterm>
<para>FreeBSD is provided with a text-based, easy to use installation
- program called <application>Sysinstall</application>. This is the
+ program called <application>sysinstall</application>. This is the
default installation program for FreeBSD, although vendors are free to
provide their own installation suite if they wish. This chapter
- describes how to use <application>Sysinstall</application> to install
+ describes how to use <application>sysinstall</application> to install
FreeBSD.</para>
<para>After reading this chapter, you will know:</para>
@@ -52,11 +52,11 @@
</listitem>
<listitem>
- <para>How to start <application>Sysinstall</application>.</para>
+ <para>How to start <application>sysinstall</application>.</para>
</listitem>
<listitem>
- <para>The questions <application>Sysinstall</application> will ask
+ <para>The questions <application>sysinstall</application> will ask
you, what they mean, and how to answer them.</para>
</listitem>
</itemizedlist>
@@ -1052,7 +1052,7 @@
<para>Answer <keycap>Y</keycap> to save the parameters and the
probing will start. After displaying the probe results in white
- on black text <application>Sysinstall</application> will start
+ on black text <application>sysinstall</application> will start
and display its main menu
(<xref linkend="sysinstall-main">).</para>
@@ -1193,10 +1193,10 @@
divided into a number of menus and screens that you can use to
configure and control the installation process.</para>
- <para>The <application>Sysinstall</application> menu system is controlled
+ <para>The <application>sysinstall</application> menu system is controlled
by the arrow keys, <keycap>Enter</keycap>, <keycap>Space</keycap>, and
other keys. A detailed description of these keys, and what they do, is
- contained in <application>Sysinstall's</application> usage
+ contained in <application>sysinstall</application>'s usage
information.</para>
<para>To review this information, ensure that the
@@ -1364,7 +1364,7 @@
<title>Allocating Disk Space</title>
<para>Your first task is to allocate disk space for FreeBSD, and label
- that space so that <application>Sysinstall</application> can prepare
+ that space so that <application>sysinstall</application> can prepare
it. In order to do this you need to know how FreeBSD expects to find
information on the disk.</para>
@@ -1736,7 +1736,7 @@
meaning associated with it, although that is now gone. To
this day, some tools may operate oddly if told to work on
partition <literal>d</literal>, so
- <application>Sysinstall</application> will not normally create
+ <application>sysinstall</application> will not normally create
partition <literal>d</literal>.</entry>
</row>
</tbody>
@@ -1930,18 +1930,18 @@
<sect2 id="main-fdisk">
- <title>Creating Slices using FDisk</title>
+ <title>Creating Slices Using Fdisk</title>
<note>
<para>No changes you make at this point will be written to the disk.
If you think you have made a mistake and want to start again you can
- use the menus to exit <application>Sysinstall</application> and try
+ use the menus to exit <application>sysinstall</application> and try
again. If you get confused and can not see how to exit you can
always turn your computer off.</para>
</note>
<para>After choosing to begin a standard installation in
- <application>Sysinstall</application> you will be shown this
+ <application>sysinstall</application> you will be shown this
message:</para>
<screen> Message
@@ -1964,7 +1964,7 @@
<devicename>ad0</devicename> and <devicename>ad2</devicename>.</para>
<figure id="sysinstall-fdisk-drive1">
- <title>Select Drive for FDisk</title>
+ <title>Select Drive For Fdisk</title>
<mediaobject>
<imageobject>
@@ -2007,10 +2007,10 @@
<para>You should select the disk on which you want to install FreeBSD,
and then press &gui.ok;.
- <application>FDisk</application> will start, with a display similar to
+ The utility <application>fdisk</application> will start, with a display similar to
that shown in <xref linkend="sysinstall-fdisk1">.</para>
- <para>The <application>FDisk</application> display is broken into three
+ <para>The <application>fdisk</application> display is broken into three
sections.</para>
<para>The first section, covering the first two lines of the display,
@@ -2026,7 +2026,7 @@
slice, which may contain other drive letters for DOS / Windows.</para>
<para>The third section shows the commands that are available in
- <application>FDisk</application>.</para>
+ <application>fdisk</application>.</para>
<figure id="sysinstall-fdisk1">
<title>Typical Fdisk Partitions Before Editing</title>
@@ -2043,7 +2043,7 @@
<para>If you want to use FreeBSD for the entire disk (which will delete
all the other data on this disk when you confirm that you want
- <application>Sysinstall</application> to continue later in the
+ <application>sysinstall</application> to continue later in the
installation process) then you can press <keycap>A</keycap>, which
corresponds to the <guimenuitem>Use Entire Disk</guimenuitem> option.
The existing slices will be removed, and replaced with a small area
@@ -2079,7 +2079,7 @@
</figure>
<para>When finished, press <keycap>Q</keycap>. Your changes will be
- saved in <application>Sysinstall</application>, but will not yet be
+ saved in <application>sysinstall</application>, but will not yet be
written to disk.</para>
</sect2>
@@ -2126,7 +2126,7 @@
Select Drives screen after the boot manager selection. If you wish to
install FreeBSD on to more than one disk, then you can select another
disk here and repeat the slice process using
- <application>FDisk</application>.</para>
+ <application>fdisk</application>.</para>
<figure id="sysinstall-fdisk-drive2">
<title>Exit Select Drive</title>
@@ -2150,7 +2150,7 @@
<sect2 id="disklabeleditor">
<title>Creating Partitions using
- <application>Disklabel</application></title>
+ <application>disklabel</application></title>
<para>You must now create some partitions inside each slice that you
have just created. Remember that each partition is lettered, from
@@ -2308,7 +2308,7 @@
partition on a slice is reserved for the filesystem that will
be the root (<filename>/</filename>) filesystem. You do not
have to follow this convention, but
- <application>Sysinstall</application> does, so following it
+ <application>sysinstall</application> does, so following it
yourself makes the installation slightly cleaner. You can
choose to mount this filesystem anywhere; this example
suggests that you mount them as directories
@@ -2321,7 +2321,7 @@
</table>
<para>Having chosen your partition layout you can now create it using
- <application>Sysinstall</application>. You will see this
+ <application>sysinstall</application>. You will see this
message:</para>
<screen> Message
@@ -2335,15 +2335,15 @@
[ OK ] </screen>
<para>Press <keycap>Enter</keycap> to start the FreeBSD partition
- editor, called <application>Disklabel</application>.</para>
+ editor, called <application>disklabel</application>.</para>
<para><xref linkend="sysinstall-label"> shows the display when you first
- start <application>Disklabel</application>. The display is divided in
+ start <application>disklabel</application>. The display is divided in
to three sections.</para>
<para>The first few lines show the name of the disk you are currently
working on, and the slice that contains the partitions you are
- creating (at this point <application>Disklabel</application> calls
+ creating (at this point <application>disklabel</application> calls
this the <literal>Partition name</literal> rather than slice name).
This display also shows the amount of free space within the slice;
that is, space that was set aside in the slice, but that has not yet
@@ -2355,7 +2355,7 @@
filesystem.</para>
<para>The bottom third of the screen shows the keystrokes that are valid
- in <application>Disklabel</application>.</para>
+ in <application>disklabel</application>.</para>
<figure id="sysinstall-label">
<title>Sysinstall Disklabel Editor</title>
@@ -2367,7 +2367,7 @@
</mediaobject>
</figure>
- <para><application>Disklabel</application> can automatically create
+ <para>The utility <application>disklabel</application> can automatically create
partitions for you and assign them default sizes. Try this now, by
Pressing <keycap>A</keycap>. You will see a display similar to that
shown in <xref linkend="sysinstall-label2">. Depending on the size of
@@ -2454,7 +2454,7 @@
</figure>
<para>Finally, because you are creating a filesystem, you must tell
- <application>Disklabel</application> where the filesystem is to be
+ <application>disklabel</application> where the filesystem is to be
mounted. The dialog box is shown in
<xref linkend="sysinstall-label-mount">. The root filesystem's mount
point is <filename>/</filename>, so type <userinput>/</userinput>, and
@@ -4660,23 +4660,23 @@
<answer>
<para>If your machine is already running MS-DOS and has little
or no free space available for the FreeBSD installation, all
- hope is not lost! You may find the <application>FIPS</application>
+ hope is not lost! You may find the <application>fips</application>
utility, provided
in the <filename>tools</filename> directory on the FreeBSD
CDROM or various FreeBSD FTP sites to be quite
useful.</para>
<indexterm>
- <primary><command>FIPS</command></primary>
+ <primary><command>fips</command></primary>
</indexterm>
- <para><application>FIPS</application> allows you to split an
+ <para>The utility <application>fips</application> allows you to split an
existing MS-DOS partition into two pieces, preserving the
original partition and allowing you to install onto the second
free piece. You first defragment your MS-DOS partition using
- the Windows <application>DEFRAG</application> utility (go into
+ the Windows <application>defrag</application> utility (go into
Explorer, right-click on the hard drive, and choose to defrag
- your hard drive), or Norton Disk Tools. You then must run
- <application>FIPS</application>. It will prompt you for the
+ your hard drive), or <application>Norton Disk Tools</application>. You then must run
+ <application>fips</application>. It will prompt you for the
rest of the information it needs. Afterwards, you can reboot
and install FreeBSD on the new free slice. See the
<emphasis>Distributions</emphasis> menu for an estimate of how
@@ -4690,10 +4690,10 @@
from <ulink url="http://www.powerquest.com/">PowerQuest</ulink>;
called <application>Partition Magic</application>. This
application has far more functionality than
- <application>FIPS</application>, and is highly recommended if
+ <application>fips</application>, and is highly recommended if
you plan to often add/remove operating systems (like me).
However, it does cost money, and if you plan to install FreeBSD
- once and then leave it there, <application>FIPS</application>
+ once and then leave it there, <application>fips</application>
will probably be fine for you.</para>
</answer>
</qandaentry>
@@ -4706,8 +4706,8 @@
<answer>
<para>No. If you are using a utility such as
- <trademark class="trade">Stacker</trademark> or
- <trademark class="trade">DoubleSpace</trademark>, FreeBSD
+ <trademark class="trade"><application>Stacker</application></trademark> or
+ <trademark class="trade"><application>DoubleSpace</application></trademark>, FreeBSD
will only be able to use whatever portion of the filesystem
you leave uncompressed. The rest of the filesystem will
show up as one large file (the stacked/double spaced file!).
@@ -5001,7 +5001,7 @@
<para>There may be some situations in which you need to create your own
FreeBSD installation media and/or source. This might be physical media,
- such as a tape, or a source that <application>Sysinstall</application>
+ such as a tape, or a source that <application>sysinstall</application>
can use to retrieve the files, such as a local FTP site, or an MS-DOS
partition. For example:</para>
diff -ruN handbook.org/l10n/chapter.sgml handbook/l10n/chapter.sgml
--- handbook.org/l10n/chapter.sgml Wed Mar 27 02:16:54 2002
+++ handbook/l10n/chapter.sgml Sun May 26 12:00:51 2002
@@ -470,7 +470,7 @@
<para>Also be sure to set the correct keymap and screenmap for your
single C chars character set through
<filename>/stand/sysinstall</filename>.
- Once inside sysinstall, choose <literal>Configure</literal>, then
+ Once inside <application>sysinstall</application>, choose <literal>Configure</literal>, then
<literal>Console</literal>. Alternatively, you can add the
following to <filename>/etc/rc.conf</filename>:</para>
diff -ruN handbook.org/ports/chapter.sgml handbook/ports/chapter.sgml
--- handbook.org/ports/chapter.sgml Sat May 4 17:20:00 2002
+++ handbook/ports/chapter.sgml Sun May 26 12:03:08 2002
@@ -451,7 +451,7 @@
</para>
<para>When installing your FreeBSD system,
- <application>Sysinstall</application> asked if you would like to
+ <application>sysinstall</application> asked if you would like to
install the ports collection. If you chose no, you can follow
these instructions to obtain the ports collection.</para>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020526121801.E44744>