os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Created a new set of entities for manual pages.

Browse source 
The construct:

    <citerefentry>
      <refentrytitle>foobar</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>

is a pain to type, and messes up the pretty-printing of the source code.
Replace every occurence of a entry like that with:

    &man.foobar.1;

Adjusting the manual page name and section number appropriately.

The definitions for these entities are stored in man-refs.ent. This
file is in doc/share/sgml because it is not just specific to the Handbook.
I expect the DocBook'd FAQ and Tutorials (coming RSN) to use them as
well.

A new PUBLIC identifier has been created for these entities, and added to
the catalog file.
This commit is contained in:
Nik Clayton 1999-03-07 16:32:22 +00:00
parent 1c05a644f3
commit 62a7d13816
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=4471
64 changed files with 1392 additions and 2015 deletions
Download patch file Download diff file Expand all files Collapse all files

201
en/handbook/backups/chapter.sgml
View file

@ -179,14 +179,9 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready</screen>
<para>Use the front panel button to eject the tape.</para>
<para>Re-insert the tape and
<citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> data to the tape.</para>
&man.dump.8; data to the tape.</para>
<para><citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> will report <literal>DUMP:
<para>&man.dump.8; will report <literal>DUMP:
End of tape detected</literal> and the console will show:
<literal>HARDWARE FAILURE info:280 asc:80,96</literal></para>
@ -200,75 +195,35 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready</screen>
<title>Backup Programs</title>
<para>The three major programs are
<citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>,
<citerefentry>
<refentrytitle>tar</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>,
&man.dump.8;,
&man.tar.1;,
and
<citerefentry>
<refentrytitle>cpio</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>.</para>
&man.cpio.1;.</para>
<sect2>
<title>Dump and Restore</title>
<para><citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> and <citerefentry>
<refentrytitle>restore</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> are the traditional Unix backup programs. They operate
<para>&man.dump.8; and &man.restore.8; are the traditional Unix backup programs. They operate
on the drive as a collection of disk blocks, below the abstractions of
files, links and directories that are created by the filesystems.
<citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> backs up devices, entire filesystems, not parts of a
&man.dump.8; backs up devices, entire filesystems, not parts of a
filesystem and not directory trees that span more than one filesystem,
using either soft links <citerefentry>
<refentrytitle>ln</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> or mounting one filesystem onto another.
<citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> does not write files and directories to tape, but
using either soft links &man.ln.1; or mounting one filesystem onto another.
&man.dump.8; does not write files and directories to tape, but
rather writes the data blocks that are the building blocks of files
and directories. <citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> has quirks that remain from its early days in
and directories. &man.dump.8; has quirks that remain from its early days in
Version 6 of ATT Unix (circa 1975). The default parameters are
suitable for 9-track tapes (6250 bpi), not the high-density media
available today (up to 62,182 ftpi). These defaults must be overridden
on the command line to utilize the capacity of current tape
drives.</para>
<para><citerefentry>
<refentrytitle>rdump</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> and <citerefentry>
<refentrytitle>rrestore</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> backup data across the
<para>&man.rdump.8; and &man.rrestore.8; backup data across the
network to a tape drive attached to another computer. Both programs
rely upon <citerefentry>
<refentrytitle>rcmd</refentrytitle>
<manvolnum>3</manvolnum>
</citerefentry> and <citerefentry>
<refentrytitle>ruserok</refentrytitle>
<manvolnum>3</manvolnum></citerefentry> to access the remote tape
rely upon &man.rcmd.3; and &man.ruserok.3; to access the remote tape
drive. Therefore, the user performing the backup must have
<literal>rhosts</literal> access to the remote computer. The
arguments to <citerefentry>
<refentrytitle>rdump</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> and <citerefentry>
<refentrytitle>rrestore</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> must suitable to use on the remote computer. (e.g.
arguments to &man.rdump.8; and &man.rrestore.8; must suitable to use on the remote computer. (e.g.
When <command>rdump</command>'ing from a FreeBSD computer to an
Exabyte tape drive connected to a Sun called
<hostid>komodo</hostid>, use: <command>/sbin/rdump 0dsbfu 54000
@ -280,95 +235,52 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready</screen>
<sect2>
<title>Tar</title>
<para><citerefentry>
<refentrytitle>tar</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> also dates back to Version 6 of ATT Unix (circa
1975). <citerefentry>
<refentrytitle>tar</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> operates in cooperation with the filesystem;
<citerefentry>
<refentrytitle>tar</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> writes files and directories to tape.
<citerefentry>
<refentrytitle>tar</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> does not support the full range of options that are
available from <citerefentry>
<refentrytitle>cpio</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>, but <citerefentry>
<refentrytitle>tar</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> does not require the
unusual command pipeline that <citerefentry>
<refentrytitle>cpio</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> uses.</para>
<para>&man.tar.1; also dates back to Version 6 of ATT Unix (circa
1975). &man.tar.1; operates in cooperation with the filesystem;
&man.tar.1; writes files and directories to tape.
&man.tar.1; does not support the full range of options that are
available from &man.cpio.1;, but &man.tar.1; does not require the
unusual command pipeline that &man.cpio.1; uses.</para>
<para>Most versions of <citerefentry>
<refentrytitle>tar</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> do not support backups across the network. The GNU
version of <citerefentry>
<refentrytitle>tar</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>, which FreeBSD utilizes,
<para>Most versions of &man.tar.1; do not support backups across the network. The GNU
version of &man.tar.1;, which FreeBSD utilizes,
supports remote devices using the same syntax as
<command>rdump</command>. To <citerefentry>
<refentrytitle>tar</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> to an Exabyte tape drive connected to a Sun called
komodo, use: <command>/usr/bin/tar cf komodo:/dev/nrst8 .
&man.rdump.8;. To &man.tar.1; to an Exabyte tape drive connected to a Sun called
<hostid>komodo</hostid>, use: <command>/usr/bin/tar cf komodo:/dev/nrst8 .
2>&amp;1</command>. For versions without remote device support,
you can use a pipeline and <citerefentry>
<refentrytitle>rsh</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> to send the data to a
you can use a pipeline and &man.rsh.1; to send the data to a
remote tape drive. (XXX add an example command)</para>
</sect2>
<sect2>
<title>Cpio</title>
<para><citerefentry>
<refentrytitle>cpio</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> is the original Unix
file interchange tape program for magnetic media. <citerefentry>
<refentrytitle>cpio</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> has options (among many
<para>&man.cpio.1; is the original Unix
file interchange tape program for magnetic media. &man.cpio.1; has options (among many
others) to perform byte-swapping, write a number of different
archives format, and pipe the data to other programs. This last
feature makes <citerefentry>
<refentrytitle>cpio</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> and excellent choice for
installation media. <citerefentry>
<refentrytitle>cpio</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> does not know how to walk
feature makes &man.cpio.1; and excellent choice for
installation media. &man.cpio.1; does not know how to walk
the directory tree and a list of files must be provided thru
<filename>STDIN</filename>.</para>
<para><citerefentry>
<refentrytitle>cpio</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> does not support backups
across the network. You can use a pipeline and <citerefentry>
<refentrytitle>rsh</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> to send the data to a
<para>&man.cpio.1; does not support backups
across the network. You can use a pipeline and &man.rsh.1; to send the data to a
remote tape drive. (XXX add an example command)</para>
</sect2>
<sect2>
<title>Pax</title>
<para><citerefentry>
<refentrytitle>pax</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> is IEEE/POSIX's answer to
<command>tar</command> and <command>cpio</command>. Over the years the
various versions of <command>tar</command> and <command>cpio</command>
<para>&man.pax.1; is IEEE/POSIX's answer to
&man.tar.1; and &man.cpio.1;. Over the years the
various versions of &man.tar.1; and &man.cpio.1;
have gotten slightly incompatible. So rather than fight it out to
fully standardize them, POSIX created a new archive utility.
<command>pax</command> attempts to read and write many of the various
cpio and tar formats, plus new formats of its own. Its command set
more resembles <command>cpio</command> than
<command>tar</command>.</para>
&man.pax.1; attempts to read and write many of the various
&man.cpio.1; and &man.tar.1; formats, plus new formats of its own. Its command set
more resembles &man.cpio.1; than
&man.tar.1;.</para>
</sect2>
<sect2 id="backups-programs-amanda">
@ -422,14 +334,10 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready</screen>
<sect2>
<title>Which Backup Program is Best?</title>
<para><citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> <emphasis>Period.</emphasis>
<para>&man.dump.8; <emphasis>Period.</emphasis>
Elizabeth D. Zwicky torture tested all the backup programs discussed
here. The clear choice for preserving all your data and all the
peculiarities of Unix filesystems is <citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>. Elizabeth created
peculiarities of Unix filesystems is &man.dump.8;. Elizabeth created
filesystems containing a large variety of unusual conditions (and some
not so unusual ones) and tested each program by do a backup and
restore of that filesystems. The peculiarities included: files with
@ -465,22 +373,10 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready</screen>
<para>Otherwise, you have to create two custom bootable floppies
which has a kernel that can mount your all of your disks and
access your tape drive. These floppies must contain:
<citerefentry>
<refentrytitle>fdisk</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
<refentrytitle>disklabel</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
<refentrytitle>newfs</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
<refentrytitle>mount</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, and whichever backup
&man.fdisk.8;, &man.disklabel.8;, &man.newfs.8;, &man.mount.8;, and whichever backup
program you use. These programs must be statically linked. If you
use <citerefentry>
<refentrytitle>dump</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, the floppy must contain
<citerefentry>
<refentrytitle>restore</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>.</para>
use &man.dump.8;, the floppy must contain
&man.restore.8;.</para>
<para>Third, create backup tapes regularly. Any changes that you make
after your last backup may be irretrievably lost. Write-protect the
@ -686,18 +582,11 @@ chmod 644 /mnt/etc/passwd
<para>Recover each filesystem separately.</para>
<para>Try to <citerefentry>
<refentrytitle>mount</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>(e.g. <command>mount /dev/sd0a
<para>Try to &man.mount.8; (e.g. <command>mount /dev/sd0a
/mnt</command>) the root partition of your first disk. If the
disklabel was damaged, use <citerefentry>
<refentrytitle>disklabel</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> to re-partition and
disklabel was damaged, use &man.disklabel.8; to re-partition and
label the disk to match the label that your printed and saved. Use
<citerefentry>
<refentrytitle>newfs</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> to re-create the
&man.newfs.8; to re-create the
filesystems. Re-mount the root partition of the floppy read-write
(<command>mount -u -o rw /mnt</command>). Use your backup program
and backup tapes to recover the data for this filesystem (e.g.