release/doc/en_US.ISO8859-1/readme/article.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN"
   3         "../../../share/xml/freebsd50.dtd" [
   4 <!ENTITY % release PUBLIC "-//FreeBSD//ENTITIES Release Specification//EN" "release.ent">
   5  %release;
   6 ]>
   7 <!--
   8      Local Variables:
   9      mode: sgml
  10      sgml-indent-data: t
  11      sgml-omittag: nil
  12      sgml-always-quote-attributes: t
  13      End:
  14 -->
  15 <article xmlns="http://docbook.org/ns/docbook"
  16   xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
  17
  18   <info>
  19     <title>&os; &release.current; README</title>
  20
  21     <author><orgname>The &os; Project</orgname></author>
  22
  23     <pubdate>$FreeBSD$</pubdate>
  24
  25     <copyright>
  26       <year>2000</year>
  27       <year>2001</year>
  28       <year>2002</year>
  29       <year>2003</year>
  30       <year>2004</year>
  31       <year>2005</year>
  32       <year>2006</year>
  33       <year>2007</year>
  34       <year>2008</year>
  35       <year>2009</year>
  36       <year>2010</year>
  37       <year>2011</year>
  38       <year>2012</year>
  39       <year>2013</year>
  40       <year>2014</year>
  41       <year>2015</year>
  42       <year>2016</year>
  43       <year>2017</year>
  44       <holder role="mailto:doc@FreeBSD.org">The &os; Documentation
  45         Project</holder>
  46     </copyright>
  47
  48     <legalnotice xml:id="trademarks" role="trademarks">
  49       &tm-attrib.freebsd;
  50       &tm-attrib.intel;
  51       &tm-attrib.opengroup;
  52       &tm-attrib.sparc;
  53       &tm-attrib.general;
  54     </legalnotice>
  55
  56     <abstract>
  57       <para>This document gives a brief introduction to &os;
  58         &release.current;.  It includes some information on how to
  59         obtain &os;, a listing of various ways to contact the &os;
  60         Project, and pointers to some other sources of
  61         information.</para>
  62     </abstract>
  63   </info>
  64
  65   <sect1 xml:id="intro">
  66     <title>Introduction</title>
  67
  68     <para>This distribution is a &release.type; of &os;
  69       &release.current;, the latest point along the &release.branch;
  70       branch.</para>
  71
  72     <sect2>
  73       <title>About &os;</title>
  74
  75       <para>&os; is an operating system based on 4.4 BSD Lite for
  76         AMD64 and Intel EM64T based PC hardware (&arch.amd64;),
  77         Intel, AMD, Cyrix or NexGen <quote>x86</quote> based PC
  78         hardware (&arch.i386;), NEC PC-9801/9821 series PCs and
  79         compatibles (&arch.pc98;), and &ultrasparc; machines
  80         (&arch.sparc64;).  Versions for the &arm; (&arch.arm;), &mips;
  81         (&arch.mips;), and &powerpc; (&arch.powerpc;) architectures
  82         are currently under development as well.  &os; works with
  83         a wide variety of peripherals and configurations and can be
  84         used for everything from software development to games to
  85         Internet Service Provision.</para>
  86
  87       <para>This release of &os; contains everything you need to run
  88         such a system, including full source code for the kernel and
  89         all utilities in the base distribution.  With the source
  90         distribution installed, you can literally recompile the entire
  91         system from scratch with one command, making it ideal for
  92         students, researchers, or users who simply want to see how it
  93         all works.</para>
  94
  95       <para>A large collection of third-party ported software (the
  96         <quote>Ports Collection</quote>) is also provided to make it
  97         easy to obtain and install all your favorite traditional
  98         &unix; utilities for &os;.  Each <quote>port</quote> consists
  99         of a set of scripts to retrieve, configure, build, and install
 100         a piece of software, with a single command.  Over
 101         &os.numports; ports, from editors to programming languages to
 102         graphical applications, make &os; a powerful and comprehensive
 103         operating environment that extends far beyond what's provided
 104         by many commercial versions of &unix;.  Most ports are also
 105         available as pre-compiled <quote>packages</quote>, which can
 106         be quickly installed from the installation program.</para>
 107     </sect2>
 108
 109     <sect2>
 110       <title>Target Audience</title>
 111
 112       <para releasetype="current">This &release.type; is aimed
 113         primarily at early adopters and various other users who want
 114         to get involved with the ongoing development of &os;.  While
 115         the &os; development team tries its best to ensure that each
 116         &release.type; works as advertised, &release.branch; is very
 117         much a work-in-progress.</para>
 118
 119       <para releasetype="current">The basic requirements for using
 120         this &release.type; are technical proficiency with &os; and an
 121         understanding of the ongoing development process of &os;
 122         &release.branch; (as discussed on the &a.current;).</para>
 123
 124       <para releasetype="current">For those more interested in doing
 125         business with &os; than in experimenting with new &os;
 126         technology, formal releases (such as &release.prev.stable;)
 127         are frequently more appropriate.  Releases undergo a period of
 128         testing and quality assurance checking to ensure high
 129         reliability and dependability.</para>
 130
 131       <para releasetype="snapshot">This &release.type; is aimed
 132         primarily at early adopters and various other users who want
 133         to get involved with the ongoing development of &os;.  While
 134         the &os; development team tries its best to ensure that each
 135         &release.type; works as advertised, &release.branch; is very
 136         much a work-in-progress.</para>
 137
 138       <para releasetype="snapshot">The basic requirements for using
 139         this &release.type; are technical proficiency with &os; and an
 140         understanding of the ongoing development process of &os;
 141         &release.branch; (as discussed on the &a.current;).</para>
 142
 143       <para releasetype="snapshot">For those more interested in doing
 144         business with &os; than in experimenting with new &os;
 145         technology, formal releases (such as &release.prev.stable;)
 146         are frequently more appropriate.  Releases undergo a period of
 147         testing and quality assurance checking to ensure high
 148         reliability and dependability.</para>
 149
 150       <para releasetype="release">This &release.type; of &os; is
 151         suitable for all users.  It has undergone a period of testing
 152         and quality assurance checking to ensure the highest
 153         reliability and dependability.</para>
 154     </sect2>
 155   </sect1>
 156
 157   <sect1 xml:id="obtain">
 158     <title>Obtaining &os;</title>
 159
 160     <para>&os; may be obtained in a variety of ways.  This section
 161       focuses on those ways that are primarily useful for obtaining a
 162       complete &os; distribution, rather than updating an existing
 163       installation.</para>
 164
 165     <sect2>
 166       <title>CDROM and DVD</title>
 167
 168       <para>&os; -RELEASE distributions may be ordered on CDROM or DVD
 169         from several publishers.  This is frequently the most
 170         convenient way to obtain &os; for new installations, as it
 171         provides a convenient way to quickly reinstall the system if
 172         necessary.  Some distributions include some of the optional,
 173         precompiled <quote>packages</quote> from the &os; Ports
 174         Collection, or other extra material.</para>
 175
 176       <para>A list of the CDROM and DVD publishers known to the
 177         project are listed in the <link
 178           xlink:href="&url.books.handbook;/mirrors.html"><quote>Obtaining
 179             &os;</quote></link> appendix to the Handbook.</para>
 180     </sect2>
 181
 182     <sect2>
 183       <title>HTTPS</title>
 184
 185       <para>&os; releases may be downloaded via
 186         <acronym>HTTPS</acronym> from <uri
 187           xlink:href="https://download.FreeBSD.org/">https://download.FreeBSD.org/</uri>,
 188         which is the official &os; release site.</para>
 189     </sect2>
 190
 191     <sect2>
 192       <title>FTP</title>
 193
 194       <para>You can use FTP to retrieve &os; and any or all of its
 195         optional packages from <uri
 196           xlink:href="ftp://ftp.FreeBSD.org/">ftp://ftp.FreeBSD.org/</uri>,
 197         or any of its <quote>mirrors</quote>.</para>
 198
 199       <para>Lists of locations that mirror &os; can be found in the
 200         <link xlink:href="&url.books.handbook;/mirrors-ftp.html">FTP
 201         Sites</link> section of the Handbook.
 202         Finding a close (in networking terms) mirror from which to
 203         download the distribution is highly recommended.</para>
 204
 205       <para>Additional mirror sites are always welcome.  Contact
 206         <email>freebsd-admin@FreeBSD.org</email> for more details on
 207         becoming an official mirror site.  You can also find useful
 208         information for mirror sites at the <link
 209           xlink:href="&url.articles.hubs;/">Mirroring &os;</link>
 210         article.</para>
 211
 212       <para>Mirrors generally contain the ISO images generally used to
 213         create a CDROM of a &os; release.  They usually also contain
 214         floppy disk images (for applicable platforms), as well as the
 215         files necessary to do an installation over the network.
 216         Finally mirrors sites usually contain a set of packages for
 217         the most current release.</para>
 218     </sect2>
 219   </sect1>
 220
 221   <sect1 xml:id="contacting">
 222     <title>Contacting the &os; Project</title>
 223
 224     <sect2>
 225       <title>Email and Mailing Lists</title>
 226
 227       <para>For any questions or general technical support issues,
 228         please send mail to the &a.questions;.</para>
 229
 230       <para>If you are tracking the &release.branch; development
 231         efforts, you <emphasis>must</emphasis> join the &a.current;,
 232         in order to keep abreast of recent developments and changes
 233         that may affect the way you use and maintain the
 234         system.</para>
 235
 236       <para>Being a largely-volunteer effort, the &os; Project is
 237         always happy to have extra hands willing to help&mdash;there
 238         are already far more desired enhancements than there is time
 239         to implement them.  To contact the developers on technical
 240         matters, or with offers of help, please send mail to the
 241         &a.hackers;.</para>
 242
 243       <para>Please note that these mailing lists can experience
 244         <emphasis>significant</emphasis> amounts of traffic.  If you
 245         have slow or expensive mail access, or are only interested in
 246         keeping up with major &os; events, you may find it
 247         preferable to subscribe instead to the &a.announce;.</para>
 248
 249       <para>All of the mailing lists can be freely joined by anyone
 250         wishing to do so.  Visit the <link
 251           xlink:href="&url.base;/mailman/listinfo">&os; Mailman Info
 252           Page</link>.  This will give you more information on joining
 253         the various lists, accessing archives, etc.  There are
 254         a number of mailing lists targeted at special interest groups
 255         not mentioned here; more information can be obtained either
 256         from the Mailman pages or the <link
 257           xlink:href="&url.base;/support.html#mailing-list">mailing
 258           lists section</link> of the &os; Web site.</para>
 259
 260       <important>
 261         <para>Do <emphasis>not</emphasis> send email to the lists
 262           asking to be subscribed.  Use the Mailman interface
 263           instead.</para>
 264       </important>
 265     </sect2>
 266
 267     <sect2>
 268       <title>Submitting Problem Reports</title>
 269
 270       <para>Suggestions, bug reports and contributions of code are
 271         always valued&mdash;please do not hesitate to report any
 272         problems you may find.  Bug reports with attached fixes are of
 273         course even more welcome.</para>
 274
 275       <para>The preferred method to submit bug reports from a machine
 276         with Internet connectivity is to use the
 277         <application>Bugzilla</application> bug tracker.
 278         <quote>Problem Reports</quote> (PRs) submitted in this way
 279         will be filed and their progress tracked; the &os; developers
 280         will do their best to respond to all reported bugs as soon as
 281         possible.  <link
 282           xlink:href="https://bugs.FreeBSD.org/search/">A list of all
 283           active PRs</link> is available on the &os; Web site; this
 284         list is useful to see what potential problems other users have
 285         encountered.</para>
 286
 287       <para>Note that &man.send-pr.1; is deprecated.</para>
 288
 289       <para>For more information, <link
 290           xlink:href="&url.articles.problem-reports;/"><quote>Writing
 291             &os; Problem Reports</quote></link>, available on the &os;
 292         Web site, has a number of helpful hints on writing and
 293         submitting effective problem reports.</para>
 294     </sect2>
 295   </sect1>
 296
 297   <sect1 xml:id="seealso">
 298     <title>Further Reading</title>
 299
 300     <para>There are many sources of information about &os;; some are
 301       included with this distribution, while others are available
 302       on-line or in print versions.</para>
 303
 304     <sect2 xml:id="release-docs">
 305       <title>Release Documentation</title>
 306
 307       <para>A number of other files provide more specific information
 308         about this &release.type; distribution.  These files are
 309         provided in various formats.  Most distributions will include
 310         both ASCII text (<filename>.TXT</filename>) and HTML
 311         (<filename>.HTM</filename>) renditions.  Some distributions
 312         may also include other formats such as Portable Document
 313         Format (<filename>.PDF</filename>).</para>
 314
 315       <itemizedlist>
 316         <listitem>
 317           <para><filename>README.TXT</filename>: This file, which
 318             gives some general information about &os; as well as
 319             some cursory notes about obtaining a
 320             distribution.</para>
 321         </listitem>
 322
 323         <listitem>
 324           <para><filename>RELNOTES.TXT</filename>: The release
 325             notes, showing what's new and different in &os;
 326             &release.current; compared to the previous release (&os;
 327             &release.prev;).</para>
 328         </listitem>
 329
 330         <listitem>
 331           <para><filename>HARDWARE.TXT</filename>: The hardware
 332             compatibility list, showing devices with which &os; has
 333             been tested and is known to work.</para>
 334         </listitem>
 335
 336         <listitem>
 337           <para><filename>ERRATA.TXT</filename>: Release errata.
 338             Late-breaking, post-release information can be found in
 339             this file, which is principally applicable to releases
 340             (as opposed to snapshots).  It is important to consult
 341             this file before installing a release of &os;, as it
 342             contains the latest information on problems which have
 343             been found and fixed since the release was
 344             created.</para>
 345         </listitem>
 346       </itemizedlist>
 347
 348       <para>On platforms that support &man.bsdinstall.8; (currently
 349         &arch.amd64;, &arch.i386;, &arch.pc98;, and &arch.sparc64;),
 350         these documents are generally available via the Documentation
 351         menu during installation.  Once the system is installed, you
 352         can revisit this menu by re-running the &man.bsdinstall.8;
 353         utility.</para>
 354
 355       <note>
 356         <para>It is extremely important to read the errata for any
 357           given release before installing it, to learn about any
 358           <quote>late-breaking news</quote> or post-release problems.
 359           The errata file accompanying each release (most likely right
 360           next to this file) is already out of date by definition, but
 361           other copies are kept updated on the Internet and should be
 362           consulted as the <quote>current errata</quote> for this
 363           release.  These other copies of the errata are located at
 364           <uri
 365             xlink:href="&url.base;/releases/">&url.base;/releases/</uri>
 366           (as well as any sites which keep up-to-date mirrors of this
 367           location).</para>
 368       </note>
 369     </sect2>
 370
 371     <sect2>
 372       <title>Manual Pages</title>
 373
 374       <para>As with almost all &unix; like operating systems, &os;
 375         comes with a set of on-line manual pages, accessed through the
 376         &man.man.1; command or through the <link
 377           xlink:href="http://www.FreeBSD.org/cgi/man.cgi">hypertext
 378           manual pages gateway</link> on the &os; Web site.  In
 379         general, the manual pages provide information on the different
 380         commands and APIs available to the &os; user.</para>
 381
 382       <para>In some cases, manual pages are written to give
 383         information on particular topics.  Notable examples of such
 384         manual pages are &man.tuning.7; (a guide to performance
 385         tuning), &man.security.7; (an introduction to &os; security),
 386         and &man.style.9; (a style guide to kernel coding).</para>
 387     </sect2>
 388
 389     <sect2>
 390       <title>Books and Articles</title>
 391
 392       <para>Two highly-useful collections of &os;-related information,
 393         maintained by the &os; Project,
 394         are the &os; Handbook and &os; FAQ (Frequently Asked Questions
 395         document).  On-line versions of the <link
 396           xlink:href="&url.books.handbook;/">Handbook</link> and <link
 397           xlink:href="&url.books.faq;/">FAQ</link> are always
 398         available from the <link
 399           xlink:href="&url.base;/docs.html">&os; Documentation
 400           page</link> or its mirrors.  If you install the
 401         <filename>doc</filename> distribution set, you can use a Web
 402         browser to read the Handbook and FAQ locally.  In particular,
 403         note that the Handbook contains a step-by-step guide to
 404         installing &os;.</para>
 405
 406       <para>A number of on-line books and articles, also maintained by
 407         the &os; Project, cover more-specialized, &os;-related topics.
 408         This material spans a wide range of topics, from effective use
 409         of the mailing lists, to dual-booting &os; with other
 410         operating systems, to guidelines for new committers.  Like the
 411         Handbook and FAQ, these documents are available from the &os;
 412         Documentation Page or in the <filename>doc</filename>
 413         distribution set.</para>
 414
 415       <para>A listing of other books and documents about &os; can be
 416         found in the <link
 417           xlink:href="&url.books.handbook;/bibliography.html">bibliography</link>
 418         of the &os; Handbook.  Because of &os;'s strong &unix;
 419         heritage, many other articles and books written for &unix;
 420         systems are applicable as well, some of which are also listed
 421         in the bibliography.</para>
 422     </sect2>
 423   </sect1>
 424
 425   <sect1 xml:id="acknowledgements">
 426     <title>Acknowledgments</title>
 427
 428     <para>&os; represents the cumulative work of many hundreds, if not
 429       thousands, of individuals from around the world who have worked
 430       countless hours to bring about this &release.type;.  For
 431       a complete list of &os; developers and contributors, please see
 432       <link
 433         xlink:href="&url.articles.contributors;/"><quote>Contributors
 434           to &os;</quote></link> on the &os; Web site or any of its
 435       mirrors.</para>
 436
 437     <para>Special thanks also go to the many thousands of &os; users
 438       and testers all over the world, without whom this &release.type;
 439       simply would not have been possible.</para>
 440   </sect1>
 441 </article>