Date: 8 Oct 1999 16:21:11 -0000 From: nbm@rucus.ru.ac.za To: FreeBSD-gnats-submit@freebsd.org Subject: docs/14210: markup fixes for formatting-media article Message-ID: <19991008162111.61820.qmail@mithrandr.moria.org>
next in thread | raw e-mail | index | archive | help
>Number: 14210
>Category: docs
>Synopsis: markup fixes for formatting-media article
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: change-request
>Submitter-Id: current-users
>Arrival-Date: Fri Oct 8 10:50:01 PDT 1999
>Closed-Date:
>Last-Modified:
>Originator: Neil Blakey-Milner
>Release: FreeBSD 4.0-CURRENT i386
>Organization:
Rhodes University Computer Users' Society
>Environment:
FreeBSD mithrandr.moria.org 4.0-CURRENT FreeBSD 4.0-CURRENT #2: Wed Sep 29 17:30:21 SAST 1999 root@mithrandr.moria.org:/usr/src/sys/compile/MITHRANDR i386
>Description:
I've changed formatting-media to use <procedure>s and <step>s,
fixed up the <screen>s without &prompt references, and used
<lineannotate> for annotations.
I've removed <para> wrappings of lists, where appropriate and possible.
Replaced <citereference>s to man pages with &man entities.
>How-To-Repeat:
>Fix:
cvs diff: Diffing .
Index: article.sgml
===================================================================
RCS file: /home/nbm/ncvs/doc/en_US.ISO_8859-1/articles/formatting-media/article.sgml,v
retrieving revision 1.8
diff -u -r1.8 article.sgml
--- article.sgml 1999/10/04 21:48:24 1.8
+++ article.sgml 1999/10/08 16:14:09
@@ -1,4 +1,7 @@
-<!DOCTYPE ARTICLE PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN">
+<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
+<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN">
+%man;
+]>
<!-- $FreeBSD: doc/en_US.ISO_8859-1/articles/formatting-media/article.sgml,v 1.8 1999/10/04 21:48:24 jesusr Exp $ -->
<article>
@@ -39,6 +42,7 @@
FreeBSD. </para>
<para>There are two possible modes of disk formatting:
+</para>
<itemizedlist>
<listitem><para><firstterm>compatibility mode</firstterm>: Arranging a
@@ -50,7 +54,6 @@
adding disks easier, however non-FreeBSD operating systems may not
accept the disk. </para> </listitem>
</itemizedlist>
-</para>
<para>For most cases, dedicated mode is the easiest to set up and use
in existing systems, as a new disk is usually dedicated entirely to
@@ -169,42 +172,42 @@
confusion from slicing disks. For FreeBSD versions 2.1.7 and later,
this is perhaps the simplest way to slice disks.</para>
-<orderedlist>
-<listitem><para>Start sysinstall as root by typing
+<procedure>
+<step><para>Start sysinstall as root by typing
<informalexample>
-<screen><userinput>/stand/sysinstall</userinput></screen>
+<screen>&prompt.root; <userinput>/stand/sysinstall</userinput></screen>
</informalexample>
-from the command prompt.</para></listitem>
+from the command prompt.</para></step>
-<listitem><para>Select <command>Index</command>.</para></listitem>
-<listitem><para>Select <command>Partition</command>.</para></listitem>
-<listitem><para>Select the disk to edit with arrow keys and
+<step><para>Select <command>Index</command>.</para></step>
+<step><para>Select <command>Partition</command>.</para></step>
+<step><para>Select the disk to edit with arrow keys and
<keycap>SPACE</keycap>.</para>
-</listitem>
-<listitem><para>If you are using this entire disk for FreeBSD, select
-<command>A</command>.</para></listitem>
-<listitem><para>When asked:
+</step>
+<step><para>If you are using this entire disk for FreeBSD, select
+<command>A</command>.</para></step>
+<step><para>When asked:
<informalexample>
<screen>
Do you want to do this with a true partition entry so as to remain
cooperative with any future possible operating systems on the
drive(s)?
</screen>
-</informalexample>answer <command>No</command>.</para></listitem>
-<listitem><para>When asked if you still want to do this, answer
-<command>Yes</command>.</para></listitem>
-<listitem><para>Select <command>Write</command>.</para></listitem>
-<listitem><para>When warned about Writing on installed systems, answer
-<command>Yes</command>.</para></listitem>
-<listitem><para><command>Quit</command>the FDISK Editor and
-<keycap>ESCAPE</keycap> back to the Index menu.</para></listitem>
-<listitem><para>Select <command>Label</command> from the Index
-menu.</para></listitem>
-<listitem><para>Label as desired. For a single partition, enter
+</informalexample>answer <command>No</command>.</para></step>
+<step><para>When asked if you still want to do this, answer
+<command>Yes</command>.</para></step>
+<step><para>Select <command>Write</command>.</para></step>
+<step><para>When warned about Writing on installed systems, answer
+<command>Yes</command>.</para></step>
+<step><para><command>Quit</command>the FDISK Editor and
+<keycap>ESCAPE</keycap> back to the Index menu.</para></step>
+<step><para>Select <command>Label</command> from the Index
+menu.</para></step>
+<step><para>Label as desired. For a single partition, enter
<command>C</command> to Create a partition, accept the
default size, partition type Filesystem, and a mountpoint (which isn't
-used).</para></listitem>
-<listitem><para>Enter <command>W</command> when done and confirm to
+used).</para></step>
+<step><para>Enter <command>W</command> when done and confirm to
continue. The filesystem will be newfs'd for you, unless you select
otherwise (for news partitions you'll want to do this!). You'll get
the error:
@@ -212,9 +215,9 @@
<screen>Error mounting /mnt/dev/wd2s1e on /mnt/blah : No such file or directory </screen>
</informalexample>
Ignore.
-</para></listitem>
-<listitem><para>Exit out by repeatedly pressing <keycap>ESCAPE</keycap>.</para></listitem>
-</orderedlist>
+</para></step>
+<step><para>Exit out by repeatedly pressing <keycap>ESCAPE</keycap>.</para></step>
+</procedure>
</sect2>
<sect2>
@@ -225,12 +228,10 @@
name. Lines beginning with # are comments. </para>
<informalexample>
<screen>
-<userinput>
- dd if=/dev/zero of=/dev/rwd2 count=2
- disklabel /dev/rwd2 | disklabel -B -R -r wd2 /dev/stdin
- # We only want one partition, so using slice 'c' should be fine:
- newfs /dev/rwd2c
-</userinput>
+&prompt.root; <userinput>dd if=/dev/zero of=/dev/rwd2 count=2</userinput>
+&prompt.root; <userinput>disklabel /dev/rwd2 | disklabel -B -R -r wd2 /dev/stdin</userinput>
+<lineannotation>We only want one partition, so using slice 'c' should be fine:</lineannotation>
+&prompt.root; <userinput>newfs /dev/rwd2c</userinput>
</screen>
</informalexample>
@@ -239,14 +240,12 @@
<informalexample>
<screen>
-<userinput>
- dd if=/dev/zero of=/dev/rwd2 count=2
- disklabel /dev/r$d > /tmp/label
- # Edit disklabel to add partitions:
- vi /tmp/label
- disklabel -B -R -r wd2 /tmp/label
- # newfs partitions appropriately
-</userinput>
+&prompt.root; <userinput>dd if=/dev/zero of=/dev/rwd2 count=2</userinput>
+&prompt.root; <userinput>disklabel /dev/r$d > /tmp/label</userinput>
+<lineannotation>Edit disklabel to add partitions:</lineannotation>
+&prompt.root; <userinput>vi /tmp/label</userinput>
+&prompt.root; <userinput>disklabel -B -R -r wd2 /tmp/label</userinput>
+<lineannotation>newfs partitions appropriately</lineannotation>
</screen>
</informalexample>
@@ -271,50 +270,50 @@
<title>Making Compatibility Mode Disks Using Sysinstall</title>
-<orderedlist>
-<listitem><para>Start sysinstall as root by typing
+<procedure>
+<step><para>Start sysinstall as root by typing
<informalexample>
-<screen><userinput>/stand/sysinstall</></screen>
+<screen>&prompt.root; <userinput>/stand/sysinstall</></screen>
</informalexample>
-from the command prompt.</para></listitem>
+from the command prompt.</para></step>
-<listitem><para>Select <command>Index</command>.</para> </listitem>
-<listitem><para>Select <command>Partition</command>.</para></listitem>
-<listitem><para>Select the disk to edit with arrow keys and
+<step><para>Select <command>Index</command>.</para> </step>
+<step><para>Select <command>Partition</command>.</para></step>
+<step><para>Select the disk to edit with arrow keys and
<keycap>SPACE</keycap>.
-</para></listitem>
-<listitem><para>If you are using this entire disk for FreeBSD, select
-<command>A</command>.</para></listitem>
+</para></step>
+<step><para>If you are using this entire disk for FreeBSD, select
+<command>A</command>.</para></step>
-<listitem><para>When asked:
+<step><para>When asked:
<informalexample>
<screen>
Do you want to do this with a true partition entry so as to remain
cooperative with any future possible operating systems on the
drive(s)?
</screen>
-</informalexample> answer <command>yes</command>.</para></listitem>
-<listitem><para>Select <command>Write</command>.</para></listitem>
-<listitem><para>When asked to install the boot manager, select None with
-<keycap>SPACE</keycap> then hit <keycap>ENTER</keycap> for OK.</para></listitem>
-<listitem><para><command>Quit</command> the FDISK Editor.</para></listitem>
-<listitem><para>You'll be asked about the boot manager, select
+</informalexample> answer <command>yes</command>.</para></step>
+<step><para>Select <command>Write</command>.</para></step>
+<step><para>When asked to install the boot manager, select None with
+<keycap>SPACE</keycap> then hit <keycap>ENTER</keycap> for OK.</para></step>
+<step><para><command>Quit</command> the FDISK Editor.</para></step>
+<step><para>You'll be asked about the boot manager, select
<command>None</command>
-again. </para></listitem>
-<listitem><para>Select <command>Label</command> from the Index
-menu.</para></listitem>
-<listitem><para>Label as desired. For a single partition, accept the
+again. </para></step>
+<step><para>Select <command>Label</command> from the Index
+menu.</para></step>
+<step><para>Label as desired. For a single partition, accept the
default size, type filesystem, and a mountpoint (which isn't
-used).</para></listitem>
-<listitem><para>The filesystem will be newfs'd for you, unless you select otherwise (for news partitions you'll want to do this!). You'll get the error:
+used).</para></step>
+<step><para>The filesystem will be newfs'd for you, unless you select otherwise (for news partitions you'll want to do this!). You'll get the error:
<informalexample>
<screen>
Error mounting /mnt/dev/wd2s1e on /mnt/blah : No such file or directory </screen>
</informalexample>
Ignore.
-</para></listitem>
-<listitem><para>Exit out by repeatedly pressing <keycap>ESCAPE</keycap>.</para></listitem>
-</orderedlist>
+</para></step>
+<step><para>Exit out by repeatedly pressing <keycap>ESCAPE</keycap>.</para></step>
+</procedure>
<para>Your new disk is now ready for use.</para>
@@ -330,36 +329,36 @@
Although adding swap space to existing disks is very difficult, a new
disk can be partitioned with additional swap space. </para>
-<para>To add swap space when adding a disk to a system:
-<orderedlist>
-<listitem><para>When partitioning the disk, edit the disklabel and
+<para>To add swap space when adding a disk to a system:</para>
+<procedure>
+<step><para>When partitioning the disk, edit the disklabel and
allocate the amount of swap space to add in partition `b' and the
remainder in another partition, such as `a' or `e'. The size is given
-in 512 byte blocks. </para></listitem>
-<listitem><para>When newfsing the drive, do NOT newfs the `c'
+in 512 byte blocks. </para></step>
+<step><para>When newfsing the drive, do NOT newfs the `c'
partition. Instead, newfs the partition where the non-swap space
-lies.</para></listitem>
-<listitem><para>Add an entry to <filename>/etc/fstab</filename> as follows:
+lies.</para></step>
+<step><para>Add an entry to <filename>/etc/fstab</filename> as follows:</para>
<informalexample>
<programlisting>
/dev/wd0b none swap sw 0 0
</programlisting>
</informalexample>
+<para>
Change /dev/wd0b to the device of the newly added
-space.</para></listitem>
-<listitem><para>To make the new space immediately available, use the
+space.</para></step>
+<step><para>To make the new space immediately available, use the
<command>swapon</command> command.
<informalexample>
<screen>
<userinput>
-$ swapon /dev/sd0b
+&prompt.root; swapon /dev/sd0b
</userinput>
swapon: added /dev/sd0b as swap space
</screen>
</informalexample>
-</para></listitem>
-</orderedlist>
-</para>
+</para></step>
+</procedure>
</sect2>
<sect2>
@@ -371,13 +370,11 @@
do:
<informalexample>
<screen>
-<userinput>
-mount /dev/wd2 /mnt
-pax -r -w -p e /usr/home /mnt
-umount /mnt
-rm -rf /usr/home/*
-mount /dev/wd2 /usr/home
-</userinput>
+&prompt.root; <userinput>mount /dev/wd2 /mnt</userinput>
+&prompt.root; <userinput>pax -r -w -p e /usr/home /mnt</userinput>
+&prompt.root; <userinput>umount /mnt</userinput>
+&prompt.root; <userinput>rm -rf /usr/home/*</userinput>
+&prompt.root; <userinput>mount /dev/wd2 /usr/home</userinput>
</screen>
</informalexample>
</para>
@@ -390,7 +387,7 @@
<para>
The Concatenated Disk Driver, or CCD, allows you to treat several identical disks as a single disk.
Striping can result in increased disk performance by distributing reads and
-writes across the disks. See the ccd(4) and ccdconfig(4) man pages or the
+writes across the disks. See the &man.ccd.4; and &man.ccdconfig.8; man pages or the
<ulink URL="http://stampede.cs.berkeley.edu/ccd/">CCD Homepage</ulink> for further details.</para>
<para>To create a new CCD, execute the following commands. This describes
@@ -406,21 +403,22 @@
<informalexample>
<screen>
-<userinput>
-cd /dev ; sh MAKDEV ccd0
-
-disklabel -r -w sd0 auto
-disklabel -r -w sd1 auto
-disklabel -r -w sd2 auto
+&prompt.root; <userinput>cd /dev ; sh MAKDEV ccd0</userinput>
-disklabel -e sd0c # change type to 4.2BSD
-disklabel -e sd1c # change type to 4.2BSD
-disklabel -e sd2c # change type to 4.2BSD
+&prompt.root; <userinput>disklabel -r -w sd0 auto</userinput>
+&prompt.root; <userinput>disklabel -r -w sd1 auto</userinput>
+&prompt.root; <userinput>disklabel -r -w sd2 auto</userinput>
+
+&prompt.root; <userinput>disklabel -e sd0c</userinput>
+<lineannotation>change type to 4.2BSD</lineannotation>
+&prompt.root; <userinput>disklabel -e sd1c</userinput>
+<lineannotation>change type to 4.2BSD</lineannotation>
+&prompt.root; <userinput>disklabel -e sd2c</userinput>
+<lineannotation>change type to 4.2BSD</lineannotation>
-ccdconfig ccd0 32 0 /dev/sd0c /dev/sd1c /dev/sd2c
+&prompt.root; <userinput>ccdconfig ccd0 32 0 /dev/sd0c /dev/sd1c /dev/sd2c</userinput>
-newfs /dev/rccd0c
-</userinput>
+&prompt.root; <userinput>newfs /dev/rccd0c</userinput>
</screen>
</informalexample>
@@ -436,7 +434,7 @@
<para>The author would like to thank the following individuals for
-their contributions to this project:
+their contributions to this project:</para>
<itemizedlist>
<listitem><para>Darryl Okahata
(<email>darrylo@hpnmhjw.sr.hp.com</email>) for his
@@ -453,7 +451,6 @@
work and pointing out inaccuracies, as well as miscellaneous support.
</para></listitem>
</itemizedlist>
-</para>
</sect1>
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19991008162111.61820.qmail>