diff options
author | bmah <bmah@FreeBSD.org> | 2002-01-06 17:17:55 +0000 |
---|---|---|
committer | bmah <bmah@FreeBSD.org> | 2002-01-06 17:17:55 +0000 |
commit | f611e6aa01b8009999d8905b3b4e69717ef5fa0a (patch) | |
tree | dbcbfb419900cb4cb3cbe8e75af8a674dc1e1648 /release/doc/en_US.ISO8859-1/readme | |
parent | 6d6bb6e826865c62e4fdf0c5345732bc001bc8ba (diff) | |
download | FreeBSD-src-f611e6aa01b8009999d8905b3b4e69717ef5fa0a.zip FreeBSD-src-f611e6aa01b8009999d8905b3b4e69717ef5fa0a.tar.gz |
MFS: Sync to 4-STABLE...wordsmithing and markup fixes, also mention
manpages as a source for further reading.
article.sgml 1.1.2.9->1.1.2.10, 1.1.2.11->1.1.2.12
Diffstat (limited to 'release/doc/en_US.ISO8859-1/readme')
-rw-r--r-- | release/doc/en_US.ISO8859-1/readme/article.sgml | 79 |
1 files changed, 58 insertions, 21 deletions
diff --git a/release/doc/en_US.ISO8859-1/readme/article.sgml b/release/doc/en_US.ISO8859-1/readme/article.sgml index f3c3349..ab26c77 100644 --- a/release/doc/en_US.ISO8859-1/readme/article.sgml +++ b/release/doc/en_US.ISO8859-1/readme/article.sgml @@ -29,9 +29,10 @@ <abstract> <para>This document gives a brief introduction to &os; - &release.current;. It includes a roadmap to the other release - documentation files, as well as some pointers on obtaining &os; and - contacting the &os; development team.</para> + &release.current;. It includes some information on how to + obtain &os;, a listing of various ways to contact the &os; + Project, and pointers to some other sources of + information.</para> </abstract> <sect1> @@ -115,7 +116,7 @@ <title>Obtaining &os;</title> <para>&os; may be obtained in a variety of ways. This section - focuses on those ways that are primarily of use for obtaining a + focuses on those ways that are primarily useful for obtaining a complete &os; distribution, rather than updating an existing installation.</para> @@ -159,8 +160,8 @@ <para>Mirrors generally contain the floppy disk images necessary to begin an installation, as well as the distribution files - needed for the install process itself. Some mirrors also - contain some of the ISO images necessary to create a CDROM of + needed for the install process itself. Many mirrors also + contain the ISO images necessary to create a CDROM of a &os; release.</para> </sect2> @@ -180,17 +181,16 @@ keep abreast of recent developments and changes that may affect the way you use and maintain the system. - <para>Additionally, being a largely-volunteer effort, the &os; - Project is always happy to have extra hands willing to help - — there are already far more desired enhancements than + <para>Being a largely-volunteer effort, the &os; + Project is always happy to have extra hands willing to help—there are already far more desired enhancements than there is time to implement them. To contact the developers on technical matters, or with offers of help, please send mail to the &a.hackers;.</para> <para>Please note that these mailing lists can experience - <emphasis>significant</emphasis> amounts of traffic and if you - have slow or expensive mail access and are only interested in - keeping up with significant &os; events, you may find it + <emphasis>significant</emphasis> amounts of traffic. If you + have slow or expensive mail access, or are only interested in + keeping up with major &os; events, you may find it preferable to subscribe instead to the &a.announce;.</para> <para>All of the mailing lists can be freely joined by anyone @@ -215,7 +215,7 @@ <title>Submitting Problem Reports</title> <para>Suggestions, bug reports and contributions of code are - always valued — please do not hesitate to report any + always valued—please do not hesitate to report any problems you may find. Bug reports with attached fixes are of course even more welcome.</para> @@ -238,15 +238,21 @@ are unable to use &man.send-pr.1; to submit a bug report, you can try to send it to the &a.bugs;.</para> - <para>In any case, before submitting a PR, please try to - determine whether the problem might have already been fixed - since.</para> + <para>For more information, <ulink + url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/problem-reports/"><quote>Writing + FreeBSD Problem Reports</quote></ulink>, available on the &os; Web + site, has a number of helpful hints on writing and submitting + effective problem reports.</para> </sect2> </sect1> <sect1> <title>Further Reading</title> + <para>There are many sources of information about &os;; some are + included with this distribution, while others are available + on-line or in print versions.</para> + <sect2 id="release-docs"> <title>Release Documentation</title> @@ -270,8 +276,8 @@ <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> + &release.current; compared to the previous release (&os; + &release.prev;).</para> </listitem> <listitem> @@ -297,9 +303,22 @@ created.</para> </listitem> </itemizedlist> + + <note> + <para>Several of these documents (in particular, + <filename>RELNOTES.TXT</filename>, + <filename>HARDWARE.TXT</filename>, and + <filename>INSTALL.TXT</filename>) contain information that + is specific to a particular hardware architecture. For + example, the alpha release notes contain information not + applicable to the i386, and vice versa. The architecture + for which each document applies will be listed in that + document's title.</para> + </note> + </para> - <para>Most of this information is also available from the + <para>These documents are generally available via the Documentation menu during installation. Once the system is installed, you can revisit this menu by running the &man.sysinstall.8; utility.</para> @@ -320,6 +339,24 @@ </sect2> <sect2> + <title>Manual Pages</title> + + <para>As with almost all UNIX-like operating systems, &os; comes + with a set of on-line manual pages, accessed through the + &man.man.1; command or through the <ulink + url="http://www.FreeBSD.org/cgi/man.cgi">hypertext manual + pages gateway</ulink> on the &os; Web site. In general, the + manual pages provide information on the different commands and + APIs available to the &os; user.</para> + + <para>In some cases, manual pages are written to given + information on particular topics. Notable examples of such + manual pages are &man.tuning.7; (a guide to performance tuning), + &man.security.7; (an introduction to &os; security), and + &man.style.9; (a style guide to kernel coding).</para> + </sect2> + + <sect2> <title>Books and Articles</title> <para>Two highly-useful collections of &os;-related information, @@ -362,8 +399,8 @@ countless hours to bring about this &release.type;. For a complete list of &os; developers and contributors, please see <ulink - url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/contributors/">Contributors - to FreeBSD</ulink> on the &os; Web site or any of its + url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/contributors/"><quote>Contributors + to FreeBSD</quote></ulink> on the &os; Web site or any of its mirrors.</para> <para>Special thanks also go to the many thousands of &os; users |