mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-15 10:17:20 +00:00
Reorganization of FreeBSD README document. This change adds no new
content or whitespace changes; it just moves sections around for better organization; the content of this file used to be fairly fragmented because it originally was derived from parts of several other documents. The first half of "About FreeBSD" has been pulled into the Introduction section. The remainder of "About FreeBSD" plus the "Release Documentation" section now make up a new <sect1></sect1> level section entitled "Further Reading".
This commit is contained in:
Bruce A. Mah
parent
d3de42035d
commit
d97e531329
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=81339
@ -35,88 +35,6 @@
|
||||
latest point along the &release.branch; branch.</para>
|
||||
|
||||
<sect2>
|
||||
<title>Target Audience</title>
|
||||
|
||||
<![ %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>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>
|
||||
]]>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2 id="release-docs">
|
||||
<title>Release Documentation</title>
|
||||
|
||||
<para>A number of other files provide more specific information
|
||||
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 obtaining a distribution.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><filename>RELNOTES.TXT</filename>: The release notes,
|
||||
showing what's new and different in &os; &release.current;
|
||||
compared to &os; &release.prev;.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><filename>HARDWARE.TXT</filename>: The hardware
|
||||
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, 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 the release was created.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
</para>
|
||||
|
||||
<para>Most information is also available from the
|
||||
Documentation menu during installation.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>About &os;</title>
|
||||
|
||||
<para>&os; is an operating system based on 4.4 BSD
|
||||
@ -147,55 +65,38 @@
|
||||
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>
|
||||
</sect2>
|
||||
|
||||
<para>Pointers to more documentation on &os; can be found in the
|
||||
<ulink
|
||||
url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/bibliography.html#BIBLIOGRAPHY-FREEBSD">Books
|
||||
& Magazines Specific to FreeBSD</ulink> section of the &os; Handbook.
|
||||
Because of &os;'s strong UNIX heritage, many other articles and books written
|
||||
for UNIX systems are applicable as well. A selection of these documents
|
||||
can be found in the Handbook's <ulink
|
||||
url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/bibliography.html">Bibliography</ulink>.
|
||||
</para>
|
||||
<sect2>
|
||||
<title>Target Audience</title>
|
||||
|
||||
<para>If you're new to &os; then you should also read
|
||||
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>
|
||||
<![ %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>On-line
|
||||
versions of the <ulink
|
||||
url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/faq/">FAQ</ulink>
|
||||
(Frequently Asked Questions document) and <ulink
|
||||
url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/">Handbook</ulink> are always
|
||||
available from the <ulink
|
||||
url="http://www.FreeBSD.org/docs.html">FreeBSD Documentation
|
||||
page</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>
|
||||
<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>
|
||||
]]>
|
||||
|
||||
</sect2>
|
||||
|
||||
<note>
|
||||
<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
|
||||
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>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Obtaining &os;</title>
|
||||
|
||||
@ -325,6 +226,115 @@
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
<sect1>
|
||||
<title>Further Reading</title>
|
||||
|
||||
<sect2 id="release-docs">
|
||||
<title>Release Documentation</title>
|
||||
|
||||
<para>A number of other files provide more specific information
|
||||
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 obtaining a distribution.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><filename>RELNOTES.TXT</filename>: The release notes,
|
||||
showing what's new and different in &os; &release.current;
|
||||
compared to &os; &release.prev;.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><filename>HARDWARE.TXT</filename>: The hardware
|
||||
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, 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 the release was created.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
</para>
|
||||
|
||||
<para>Most information is also available from the
|
||||
Documentation menu during installation.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
|
||||
<title>Books and Articles</title>
|
||||
|
||||
<para>Pointers to more documentation on &os; can be found in the
|
||||
<ulink
|
||||
url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/bibliography.html#BIBLIOGRAPHY-FREEBSD">Books
|
||||
& Magazines Specific to FreeBSD</ulink> section of the &os; Handbook.
|
||||
Because of &os;'s strong UNIX heritage, many other articles and books written
|
||||
for UNIX systems are applicable as well. A selection of these documents
|
||||
can be found in the Handbook's <ulink
|
||||
url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/bibliography.html">Bibliography</ulink>.
|
||||
</para>
|
||||
|
||||
<para>If you're new to &os; then you should also read
|
||||
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/doc/en_US.ISO8859-1/books/faq/">FAQ</ulink>
|
||||
(Frequently Asked Questions document) and <ulink
|
||||
url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/">Handbook</ulink> are always
|
||||
available from the <ulink
|
||||
url="http://www.FreeBSD.org/docs.html">FreeBSD Documentation
|
||||
page</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>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
|
||||
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>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect1>
|
||||
<title>Acknowledgments</title>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user