system/freebsd-src
system/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src synced 2024-10-07 09:00:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

More README file cleanup, mostly for style. Also punt the readers

Browse source 
to the Handbook for more documentation sources.  Mention INSTALL.TXT
as one of the other release documentation files.
This commit is contained in:
Bruce A. Mah 2001-07-19 16:29:28 +00:00
parent a8dd67f3c2
commit e0c7ae7028
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=79974
3 changed files with 107 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

121
release/doc/en_US.ISO8859-1/readme/about.sgml
View file

@ -12,91 +12,92 @@ come from the old ABOUT.TXT.
<sect1>
<title>About &os;</title>
<para>What is &os;? &os; is an operating system based on 4.4 BSD
<para>&os; is an operating system based on 4.4 BSD
Lite for Intel, AMD, Cyrix or NexGen <quote>x86</quote> based PC
hardware and Compaq (formerly DEC) Alpha computers. Versions for
the IA64 and PowerPC architectures are currently under
development as well. &os; works with a
very wide variety of PC peripherals and configurations and can be
used for everything from software development to Internet Service
wide variety of peripherals and configurations and can be
used for everything from software development to games to Internet Service
Provision.</para>
<para>This release of &os; contains everything you need to run
such a system, including full source code for everything. With the
source distribution installed you can literally recompile the entire
such a system, including full source code for the kernel and all
utilities in the base distribution. With the
source distribution installed, you can literally recompile the entire
system from scratch with one command, making it ideal for students,
researchers or folks who simply want to see how it all works.</para>
researchers, or users who simply want to see how it all works.</para>
<para>A large collection of third party ported software (the
<quote>Ports Collection</quote>) is also provided to make it easier
for you to obtain and install all your favorite traditional UNIX
utilities for &os;. Over 5000 ports, from editors to programming
<para>A large collection of third-party ported software (the
<quote>Ports Collection</quote>) is also provided to make it easy
to obtain and install all your favorite traditional UNIX
utilities for &os;. Each
<quote>port</quote> consists of a set of scripts to retrieve,
configure, build, and install a piece of software, with a single
command. Over 5000 ports, from editors to programming
languages to graphical applications, make &os; a powerful and
comprehensive operating environment that extends far beyond what's
provided by many commercial versions of UNIX.</para>
provided by many commercial versions of UNIX. Most ports are also
available as pre-compiled <quote>packages</quote>, which can be
quickly installed from the installation program.</para>
<para>For more documentation on this system it is recommended that
you purchase The Complete FreeBSD, available from local bookstores
and from The FreeBSD Mall (<ulink
url="http://www.freebsdmall.com">http://www.freebsdmall.com</ulink>),
as well as the 4.4BSD Document Set from O'Reilly Associates and the
USENIX Association, ISBN 1-56592-082-1. We have no connection with
O'Reilly, we're just satisfied customers!</para>
<para>Pointers to more documentation on &os; can be found in the
<ulink
url="http://www.freebsd.org/handbook/bibliography.html#BIBLIOGRAPHY-FREEBSD">Books
&amp; Magazines Specific to FreeBSD</ulink> section of the <ulink
url="http://www.freebsd.org/handbook/">FreeBSD Handbook</ulink>.
Because of &os;'s strong UNIX heritage, many other documents written
for UNIX systems are applicable as well. A selection of these books
can be found in the Handbook's <ulink
url="http://www.freebsd.org/handbook/bibliography.html">Bibliography</ulink>.
</para>
<para>If you're new to &os; then you should also read
<emphasis>everything</emphasis>
listed in the Documentation menu on the boot floppy. It may seem
like a lot to read, but you should at least acquaint yourself with
the types of information available should you later get stuck. Once
the system is installed, you can also revisit this menu and use a
Web browser to read the installed FAQ (Frequently Asked Questions)
and Handbook HTML documentation sets for &os;. Note that on-line
all of the documentation files listed in <xref linkend="release-docs">,
all of which are available from the Documentation menu in the
installation program.
It may seem
like a lot to read, but it's important to at least acquaint yourself with
the types of information available, should you run into problems later. Once
the system is installed, you can also revisit this menu by running
the &man.sysinstall.8; utility.</para>
<para>On-line
versions of the <ulink
url="http://www.freebsd.org/faq/">FAQ</ulink> and <ulink
url="http://www.freebsd.org/handbook/">Handbook</ulink> are also
url="http://www.freebsd.org/faq/">FAQ (Frequently Asked
Questions)</ulink> document and <ulink
url="http://www.freebsd.org/handbook/">Handbook</ulink> are always
available from the <ulink
url="http://www.freebsd.org/">FreeBSD Project Web
site</ulink>, if you have an Internet connection. See
<filename>README.TXT</filename> for more information on the
resources available to you.</para>
site</ulink> or its mirrors.
If you install the
<filename>doc</filename> distribution set, you can use a
Web browser to read the FAQ and Handbook locally.</para>
<note>
<para>If you read no other documentation before installing a given
version of &os;, you should at least by all means <emphasis>read
the errata</emphasis> for that release so that you don't stumble
over problems which have already been found and fixed. The
<filename>ERRATA.TXT</filename> file accompanying your release (it
should be right next to this file) is obviously already out of
date by definition, but other copies are kept updated on the net
<para>It is extremely important to read the errata for any given
release before installing it, to learn about any
<quote>late-breaking news</quote> or post-release problems.
The
errata file accompanying each release
(most likely right next to this file) is already out of
date by definition, but other copies are kept updated on the Internet
and should be consulted as the <quote>current errata</quote> for
your release (this is also what your
<filename>ERRATA.TXT</filename> file says, by the way). These
other copies of the errata are located at:
<orderedlist>
<listitem>
<para><ulink url="http://www.freebsd.org/releases/">http://www.freebsd.org/releases/</ulink></para>
</listitem>
<listitem>
<para>ftp://ftp.freebsd.org/pub/FreeBSD/releases/your-release/ERRATA.TXT
(and any sites which keep up-to-date mirrors of this
location).</para>
</listitem>
</orderedlist>
</para>
this release. These
other copies of the errata are located at
<ulink url="http://www.freebsd.org/releases/"></ulink>
(as well as any sites which keep up-to-date mirrors of this
location).</para>
</note>
<warning>
<para>While &os; does its best to safeguard against accidental
loss of data, it's still more than possible to <emphasis>wipe out
your entire disk</emphasis>
with this installation! Please do not proceed to the
final &os; installation menu unless you've adequately backed up
any important data first! We really mean it!</para>
loss of data, it is still more than possible to accidentally <emphasis>erase
entire disks</emphasis>
with this installation. Please remember to back up any important
data <emphasis>before</emphasis> beginning the &os;
installation process.</para>
</warning>
</sect1>

75
release/doc/en_US.ISO8859-1/readme/intro.sgml
View file

@ -12,49 +12,56 @@ old README.TXT (the file with Chuck in ASCII art).
<sect1>
<title>Introduction</title>
<para>This is a binary snapshot of &os; &release.current;, the
&release.branch; branch that is currently moving towards
&release.next;.</para>
<para>Feedback or offers to help with anything you see in this
release are most welcome and should be sent to one of the
appropriate mailing lists, as listed in <xref linkend="contacting">.</para>
<para>This distribution is a &release.type; of &os; &release.current;, the
latest point along the &release.branch; branch.</para>
<sect2>
<title>Target Audience</title>
<para>This release is aimed primarily at early-adopters and the
various other folks who want to get involved with the ongoing
development of &os; and are willing to deal with a few bumps in
the road. We do our best to ensure that each snapshot works as
advertised, but tracking -CURRENT is a process which frequently
has its off days.</para>
<![ %release.type.snapshot; [
<para>This &release.type; is aimed primarily at early adopters and
various other users who want to get involved with the ongoing
development of &os;. While the &os; development team tries its
best to ensure that each &release.type; works as
advertised, &release.branch; is very much a work-in-progress.</para>
<para>If you're both technically proficient and know exactly what
you're getting into here (e.g. you've been following -CURRENT)
then this snapshot is probably for you. If you're more interested
in doing business with &os; than in playing with the cutting
edge of technology, however, then 3.x or 4.x is almost certainly
your best bet.</para>
<para>The basic requirements for using this &release.type are
technical proficiency with &os; and an understanding of the ongoing
development process of &os; &release.current;
(as discussed on the &a.current;).</para>
<para>For those more interested
in doing business with &os; than in experimenting with new &os;
technology, formal releases (such as &release.prev;) are frequently more
appropriate. Releases undergo a period of testing and quality
assurance checking to ensure high reliability and dependability.</para>
]]>
<![ %release.type.release; [
<para>This &release.type; of &os; is suitable for all users. It has
undergone a period of testing and quality assurance
checking to ensure the highest reliability and dependability.</para>
]]>
<para>If you're a developer/hobbiest and not interested in QA'd
releases so much as simply keeping up to date on the latest &os;
technology, you can also install one of our
<quote>snapshot</quote> releases.
</para>
</sect2>
<sect2>
<title>For More Information</title>
<sect2 id="release-docs">
<title>Release Documentation</title>
<para>A number of other files provide more specific information
about this distribution.
about this &release.type; distribution. These files are provided
in various formats. Most distributions will include both ASCII
text (<filename>.TXT</filename>) and HTML
(<filename>.HTM</filename>) renditions. Some distributions may
also include other formats such as PostScript
(<filename>.PS</filename>) or Portable Document Format
(<filename>.PDF</filename>).
<itemizedlist>
<listitem>
<para><filename>README.TXT</filename>: This file, which
gives some general information about &os; as well as some
cursory notes about installation..</para>
cursory notes about obtaining a distribution.</para>
</listitem>
<listitem>
<para><filename>RELNOTES.TXT</filename>: The release notes,
@ -66,13 +73,19 @@ old README.TXT (the file with Chuck in ASCII art).
compatability list, showing devices with which &os; has been
tested and is known to work.</para>
</listitem>
<listitem>
<para><filename>INSTALL.TXT</filename>: Installation
instructions for installing &os; from its distribution
media.</para>
</listitem>
<listitem>
<para><filename>ERRATA.TXT</filename>: Release errata.
Late-breaking, post-release information can be found in this
file. Read this file! It will tell you where to look for
file, which is principally applicable to releases (as opposed to
snapshots). It is important to consult this file before
installing a release of &os;, as it contains
the latest information on problems which have been found and
fixed since this release was created (and may bite
you).</para>
fixed since the release was created.</para>
</listitem>
</itemizedlist>

2
release/doc/share/sgml/release.ent
View file

@ -25,6 +25,8 @@
<!-- The type of release (usually this will be either "snapshot"
or "release" -->
<!ENTITY release.type "snapshot">
<!ENTITY % release.type.snapshot "INCLUDE">
<!ENTITY % release.type.release "IGNORE">
<!-- Text constants which probably don't need to be changed.-->