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