Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

13.3R/readme: corrections, changes #346

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

13.3R/readme: corrections, changes #346

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83f17cb
13.3R/readme: FreeBSD Handbook bibliography
grahamperrin Mar 3, 2024
1662317
13.3R/readme: sentence markup
grahamperrin Mar 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 45 additions & 19 deletions website/content/en/releases/13.3R/readme.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ include::shared/en/mailing-lists.adoc[]

== 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.
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

Expand All @@ -39,14 +40,19 @@ FreeBSD is an open source operating system derived from 4.4 BSD Lite2 for 64-bit

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.
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 via the {{< manpage "pkg" "8">}} utility.
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 via the {{< manpage "pkg" "8">}} utility.

[[audience]]
== Target Audience

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

[[obtain]]
== Obtaining FreeBSD
Expand All @@ -68,18 +74,25 @@ For general questions or technical support, please address the {freebsd-question

If you track the `{releaseBranch}` branch: you must subscribe to the {freebsd-stable}, to keep abreast of developments and changes that may affect your use and maintainance of the system.

Being a largely volunteer effort, the Project is always happy to have extra hands willing to help -- there are far more desired enhancements than there is time to implement them. To contact the developers on technical matters, or with offers of help, please address the {freebsd-hackers}.
Being a largely volunteer effort, the Project is always happy to have extra hands willing to help -- there are far more desired enhancements than there is time to implement them.
To contact the developers on technical matters, or with offers of help, please address the {freebsd-hackers}.

These lists above can experience significant amounts of traffic. If you have slow or expensive email access, or if you are only interested in major announcements, you may prefer subscription to the {freebsd-announce}.
These lists above can experience significant amounts of traffic.
If you have slow or expensive email access, or if you are only interested in major announcements, you may prefer subscription to the {freebsd-announce}.

All public mailing lists can be joined by anyone wishing to do so. More than a hundred lists are public; https://lists.freebsd.org/[] shows them all, and provides information about browsing the archives, subscribing, and unsubscribing.
All public mailing lists can be joined by anyone wishing to do so.
More than a hundred lists are public; https://lists.freebsd.org/[] shows them all, and provides information about browsing the archives, subscribing, and unsubscribing.

[[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.
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 link:https://bugs.freebsd.org[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.
The preferred method to submit bug reports from a machine with Internet connectivity is to use the link:https://bugs.freebsd.org[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.

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.

Expand All @@ -91,19 +104,26 @@ There are many sources of information about FreeBSD; some are included with this
[[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`).
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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it still true that most distributions include all four of README.TXT, RELNOTES.TXT, HARDWARE.TXT, and ERRATA.TXT – plus .HTM counterparts?

Without me digging: this smells, to me, like a type of statement that might be outdated. (If my sense of smell is mistaken: I'm probably misguided by https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=264483.)

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.
* [.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.

During installation, these documents are available via the Documentation menu. Once the system is installed, you can revisit this menu by re-running the {{< manpage "bsdinstall" "8">}} utility.
During installation, these documents are available via the Documentation menu.
Once the system is installed, you can revisit this menu by re-running the {{< manpage "bsdinstall" "8">}} utility.

[.note]
*Note*: +
To learn about any late-breaking news or post-release problems, it is extremely important to read the errata for any given release before installing it.
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).
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
Expand All @@ -112,22 +132,28 @@ As with almost all UNIX(R)-like operating systems, FreeBSD includes a set of man

In general, these pages provide information on the different commands and APIs available to the FreeBSD user.

Some pages are written to give information on particular topics. Notable examples include {{< manpage "tuning" "7">}} (a guide to performance tuning), {{< manpage "security" "7">}} (an introduction to FreeBSD security), and {{< manpage "style" "9">}} (a style guide for kernel coding).
Some pages are written to give information on particular topics.
Notable examples include {{< manpage "tuning" "7">}} (a guide to performance tuning), {{< manpage "security" "7">}} (an introduction to FreeBSD security), and {{< manpage "style" "9">}} (a style guide for kernel coding).

[[booksarticles]]
=== Books and Articles

FreeBSD Project-maintained documentation includes the highly useful _FreeBSD Handbook_, which includes a detailed guide to installing and upgrading the operating system, and _FreeBSD FAQ_ (Frequently Asked Questions). The link:{handbook}[Handbook] and link:{faq}[FAQ] are online in the link:{main-site}[documentation portal] and at mirror sites.
FreeBSD Project-maintained documentation includes the highly useful _FreeBSD Handbook_, which includes a detailed guide to installing and upgrading the operating system, and _FreeBSD FAQ_ (Frequently Asked Questions).
The link:{handbook}[Handbook] and link:{faq}[FAQ] are online in the link:{main-site}[documentation portal] and at mirror sites.

Other Project-maintained books and articles are more specialized -- covering 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 in the portal, mirrors and [.filename]`doc` repository.
Other Project-maintained books and articles are more specialized -- covering 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 in the portal, mirrors and [.filename]`doc` repository.

For offline documentation in HTML and PDF formats: you can install a language-specific package such as package:misc/freebsd-doc-en[] (_-en_ for English), or multi-language package:misc/freebsd-doc-all[]. Alternatively, use a copy of the [.filename]`doc` repo to build and install from source code.
For offline documentation in HTML and PDF formats: you can install a language-specific package such as package:misc/freebsd-doc-en[] (_-en_ for English), or multi-language package:misc/freebsd-doc-all[].
Alternatively, use a copy of the [.filename]`doc` repo to build and install from source code.

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.
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.
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.
Loading