aboutsummaryrefslogtreecommitdiff
path: root/website/archetypes/new-release/readme.adoc
blob: 737b86c00a69628027359f209614a127cb18dedb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
---
title: "FreeBSD X.0-RELEASE README"
sidenav: download
---

:releaseCurrent: X.0-RELEASE
:releaseType: release
:releaseBranch: X-STABLE
:releasePrevStable: X.Y-RELEASE
:releasePrev: X.Y-RELEASE

include::shared/releases.adoc[]
include::shared/en/urls.adoc[]
include::shared/en/mailing-lists.adoc[]

= FreeBSD {releaseCurrent} README

== Abstract

This document gives a brief introduction to FreeBSD {releaseCurrent}.
It includes some information on how to obtain FreeBSD, a listing of various ways to contact the FreeBSD Project, and pointers to some other sources of information.

== Table of Contents

* <<intro,Introduction>>
* <<obtain,Obtaining FreeBSD>>
* <<contacting,Contacting the FreeBSD Project>>
* <<seealso,Further Reading>>
* <<acknowledgements,Acknowledgments>>

[[intro]]
== Introduction

This distribution is a {releaseType} of FreeBSD {releaseCurrent}, the latest point along the {releaseBranch} branch.

[[about]]
== About FreeBSD

FreeBSD is an operating system based on 4.4 BSD Lite for AMD64 and Intel EM64T based PC hardware (amd64), Intel, AMD, Cyrix or NexGen x86 based PC hardware (i386), and UltraSPARC(R) machines (sparc64).
Versions for the ARM(R) (arm), MIPS(R) (mips), and PowerPC(R) (powerpc) architectures are currently under development as well. 
FreeBSD works with a wide variety of peripherals and configurations and can be used for everything from software development to games to Internet Service Provision.

This release of FreeBSD contains everything you need to run 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 users who simply want to see how it all works.

A large collection of third-party ported software (the Ports Collection) is also provided to make it easy to obtain and install all your favorite traditional UNIX(R) utilities for FreeBSD.
Each port consists of a set of scripts to retrieve, configure, build, and install a piece of software, with a single command.
Over {numports} ports, from editors to programming languages to graphical applications, make FreeBSD a powerful and comprehensive operating environment that extends far beyond what's provided by many commercial versions of UNIX(R).
Most ports are also available as pre-compiled packages, which can be quickly installed from the installation program.

[[audience]]
== Target Audience

This {releaseType} is aimed primarily at early adopters and various other users who want to get involved with the ongoing development of FreeBSD.
While the FreeBSD development team tries its best to ensure that each {releaseType} works as advertised, {releaseBranch} is very much a work-in-progress.

The basic requirements for using this {releaseType} are technical proficiency with FreeBSD and an understanding of the ongoing development process of FreeBSD {releaseBranch} (as discussed on the {freebsd-current}).

For those more interested in doing business with FreeBSD than in experimenting with new FreeBSD technology, formal releases (such as {releasePrevStable}) are frequently more appropriate.
Releases undergo a period of testing and quality assurance checking to ensure high reliability and dependability.

This {releaseType} is aimed primarily at early adopters and various other users who want to get involved with the ongoing development of FreeBSD.
While the FreeBSD development team tries its best to ensure that each {releaseType} works as advertised, {releaseBranch} is very much a work-in-progress.

The basic requirements for using this {releaseType} are technical proficiency with FreeBSD and an understanding of the ongoing development process of FreeBSD {releaseBranch} (as discussed on the {freebsd-current}).

For those more interested in doing business with FreeBSD than in experimenting with new FreeBSD technology, formal releases (such as {releasePrevStable}) are frequently more appropriate.
Releases undergo a period of testing and quality assurance checking to ensure high reliability and dependability.

This {releaseType} of FreeBSD is suitable for all users.
It has undergone a period of testing and quality assurance checking to ensure the highest reliability and dependability.

[[obtain]]
== Obtaining FreeBSD

FreeBSD may be obtained in a variety of ways. 
This section focuses on those ways that are primarily useful for obtaining a complete FreeBSD distribution, rather than updating an existing installation.

[[cdromdvd]]
=== CDROM and DVD

FreeBSD -RELEASE distributions may be ordered on CDROM or DVD from several publishers.
This is frequently the most convenient way to obtain FreeBSD for new installations, as it provides a convenient way to quickly reinstall the system if necessary.
Some distributions include some of the optional, precompiled packages from the FreeBSD Ports Collection, or other extra material.

A list of the CDROM and DVD publishers known to the project are listed in the link:{handbook}#mirrors[Obtaining FreeBSD] appendix to the Handbook.

[[ftp]]
=== FTP

You can use FTP to retrieve FreeBSD and any or all of its optional packages from `ftp://ftp.FreeBSD.org/`, which is the official FreeBSD release site, or any of its mirrors.

Lists of locations that mirror FreeBSD can be found in the link:{handbook}#mirrors-ftp[FTP Sites] section of the Handbook.
Finding a close (in networking terms) mirror from which to download the distribution is highly recommended.

Additional mirror sites are always welcome.
Contact `<freebsd-admin@FreeBSD.org>` for more details on becoming an official mirror site.
You can also find useful information for mirror sites at the link:{hubs}[Mirroring FreeBSD] article.

Mirrors generally contain the ISO images generally used to create a CDROM of a FreeBSD release.
They usually also contain floppy disk images (for applicable platforms), as well as the files necessary to do an installation over the network.
Finally mirrors sites usually contain a set of packages for the most current release.

[[contacting]]
== Contacting the FreeBSD Project

[[emailmailinglists]]
=== Email and Mailing Lists

For any questions or general technical support issues, please send mail to the {freebsd-questions}.

If you're tracking the {releaseBranch} development efforts, you must join the {freebsd-current}, in order to keep abreast of recent developments and changes that may affect the way you use and maintain the system.

Being a largely-volunteer effort, the FreeBSD 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 {freebsd-hackers}.

Please note that these mailing lists can experience significant amounts of traffic.
If you have slow or expensive mail access, or are only interested in keeping up with major FreeBSD events, you may find it preferable to subscribe instead to the {freebsd-announce}.

All of the mailing lists can be freely joined by anyone wishing to do so.
Visit the link:https://lists.freebsd.org[FreeBSD Mailing Lists Page].
This will give you more information on joining the various lists, accessing archives, etc.
There are a number of mailing lists targeted at special interest groups not mentioned here; more information can be obtained either from the Mailman pages or the link:../../../support/#mailing-list[mailing lists section] of the FreeBSD Web site.

[IMPORTANT]
====
Do not send email to the lists asking to be subscribed. Use the Mailman interface instead.
====

[[pr]]
=== Submitting Problem Reports

Suggestions, bug reports and contributions of code are always valued-please do not hesitate to report any problems you may find.
Bug reports with attached fixes are of course even more welcome.

The preferred method to submit bug reports from a machine with Internet connectivity is to use the Bugzilla bug tracker.
Problem Reports (PRs) submitted in this way will be filed and their progress tracked; the FreeBSD developers will do their best to respond to all reported bugs as soon as possible.
link:https://bugs.freebsd.org/search/[A list of all active PRs] is available on the FreeBSD Web site; this list is useful to see what potential problems other users have encountered.

Note that man:send-pr[1] is deprecated.

For more information, link:{problem-reports}["Writing FreeBSD Problem Reports"], available on the FreeBSD Web site, has a number of helpful hints on writing and submitting effective problem reports.

[[seealso]]
== Further Reading

There are many sources of information about FreeBSD; some are included with this distribution, while others are available on-line or in print versions.

[[release-docs]]
=== Release Documentation

A number of other files provide more specific information about this {releaseType} distribution.
These files are provided in various formats.
Most distributions will include both ASCII text ([.filename]`.TXT`) and HTML ([.filename]`.HTM`) renditions.
Some distributions may also include other formats such as Portable Document Format ([.filename]`.PDF`).

* [.filename]`README.TXT`: This file, which gives some general information about FreeBSD as well as some cursory notes about obtaining a distribution.
* [.filename]`RELNOTES.TXT`: The release notes, showing what's new and different in FreeBSD {releaseCurrent} compared to the previous release (FreeBSD {releasePrev}).
* [.filename]`HARDWARE.TXT`: The hardware compatibility list, showing devices with which FreeBSD has been tested and is known to work.
* [.filename]`ERRATA.TXT`: 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 FreeBSD, as it contains the latest information on problems which have been found and fixed since the release was created.

On platforms that support man:bsdinstall[8] (currently amd64, i386, and sparc64), these documents are generally available via the Documentation menu during installation.
Once the system is installed, you can revisit this menu by re-running the man:bsdinstall[8] utility.

[NOTE]
====
It is extremely important to read the errata for any given release before installing it, to learn about any late-breaking news 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 current errata for this release.
These other copies of the errata are located at link:../../releases/[https://www.FreeBSD.org/releases] (as well as any sites which keep up-to-date mirrors of this location).
====

[[manpages]]
=== Manual Pages

As with almost all UNIX(R) like operating systems, FreeBSD comes with a set of on-line manual pages, accessed through the {{< manpage man:[1] command or through the http://link:www.freebsd.org/cgi/man.cgi[hypertext manual pages gateway] on the FreeBSD Web site.
In general, the manual pages provide information on the different commands and APIs available to the FreeBSD user.

In some cases, manual pages are written to give 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 FreeBSD security), and man:style[9] (a style guide to kernel coding).

[[booksarticles]]
=== Books and Articles

Two highly-useful collections of FreeBSD-related information, maintained by the FreeBSD Project, are the FreeBSD Handbook and FreeBSD FAQ(Frequently Asked Questions document).
On-line versions of the link:{handbook}[Handbook] and link:{faq}[FAQ] are always available from the link:../../../doc[FreeBSD Documentation page] or its mirrors.
If you install the [.filename]`doc` distribution set, you can use a Web browser to read the Handbook and FAQ locally.
In particular, note that the Handbook contains a step-by-step guide to installing FreeBSD.

A number of on-line books and articles, also maintained by the FreeBSD Project, cover more-specialized, FreeBSD-related topics.
This material spans a wide range of topics, from effective use of the mailing lists, to dual-booting FreeBSD with other operating systems, to guidelines for new committers.
Like the Handbook and FAQ, these documents are available from the FreeBSD Documentation Page or in the doc distribution set.

A listing of other books and documents about FreeBSD can be found in the link:{handbook}#bibliography[bibliography]of the FreeBSD Handbook.
Because of FreeBSD's strong UNIX(R) heritage, many other articles and books written for UNIX(R) systems are applicable as well, some of which are also listed in the bibliography.

[[acknowledgements]]
== Acknowledgments

FreeBSD represents the cumulative work of many hundreds, if not thousands, of individuals from around the world who have worked countless hours to bring about this {releaseType}.
For a complete list of FreeBSD developers and contributors, please see link:{contributors}["Contributors to FreeBSD"] on the FreeBSD Web site or any of its mirrors.

Special thanks also go to the many thousands of FreeBSD users and testers all over the world, without whom this {releaseType} simply would not have been possible.