From 0d9894b11e0e94cde952b0112782e68e27c893da Mon Sep 17 00:00:00 2001 From: Sergio Carlavilla Delgado Date: Sun, 2 May 2021 00:51:46 +0200 Subject: [PATCH] Improve the SEO of the documentation portal Changes: - Add the description meta tag in the index, articles and books - Add a brief description in each article and book. - Remove the SVN expansion tag --- documentation/config/_default/config.toml | 3 +- .../content/en/articles/bsdl-gpl/_index.adoc | 2 +- .../en/articles/building-products/_index.adoc | 2 +- .../en/articles/committers-guide/_index.adoc | 2 +- .../en/articles/contributing/_index.adoc | 2 +- .../en/articles/contributors/_index.adoc | 2 +- .../content/en/articles/cups/_index.adoc | 2 +- .../en/articles/explaining-bsd/_index.adoc | 2 +- .../en/articles/filtering-bridges/_index.adoc | 2 +- .../content/en/articles/fonts/_index.adoc | 2 +- .../en/articles/freebsd-questions/_index.adoc | 2 +- .../en/articles/freebsd-releng/_index.adoc | 1 + .../freebsd-update-server/_index.adoc | 2 +- .../en/articles/geom-class/_index.adoc | 2 +- .../en/articles/gjournal-desktop/_index.adoc | 2 +- .../content/en/articles/hubs/_index.adoc | 2 +- .../en/articles/ipsec-must/_index.adoc | 2 +- .../content/en/articles/ldap-auth/_index.adoc | 2 +- .../en/articles/leap-seconds/_index.adoc | 2 +- .../en/articles/linux-emulation/_index.adoc | 2 +- .../en/articles/linux-users/_index.adoc | 2 +- .../en/articles/mailing-list-faq/_index.adoc | 4 +- .../content/en/articles/nanobsd/_index.adoc | 2 +- .../content/en/articles/new-users/_index.adoc | 2 +- .../content/en/articles/pam/_index.adoc | 2 +- .../content/en/articles/pgpkeys/_index.adoc | 2 +- .../port-mentor-guidelines/_index.adoc | 2 +- .../en/articles/pr-guidelines/_index.adoc | 2 +- .../en/articles/problem-reports/_index.adoc | 2 +- .../en/articles/rc-scripting/_index.adoc | 2 +- .../content/en/articles/releng/_index.adoc | 1 + .../en/articles/remote-install/_index.adoc | 4 +- .../en/articles/serial-uart/_index.adoc | 2 +- .../en/articles/solid-state/_index.adoc | 4 +- .../content/en/articles/vinum/_index.adoc | 1 + .../content/en/articles/vm-design/_index.adoc | 2 +- .../en/books/arch-handbook/_index.adoc | 4 +- .../arch-handbook/bibliography/_index.adoc | 1 + .../content/en/books/arch-handbook/book.adoc | 34 ++++----- .../en/books/arch-handbook/boot/_index.adoc | 1 + .../arch-handbook/driverbasics/_index.adoc | 1 + .../en/books/arch-handbook/isa/_index.adoc | 1 + .../en/books/arch-handbook/jail/_index.adoc | 1 + .../en/books/arch-handbook/kobj/_index.adoc | 1 + .../books/arch-handbook/locking/_index.adoc | 1 + .../en/books/arch-handbook/mac/_index.adoc | 1 + .../en/books/arch-handbook/newbus/_index.adoc | 1 + .../en/books/arch-handbook/pccard/_index.adoc | 1 + .../en/books/arch-handbook/pci/_index.adoc | 1 + .../en/books/arch-handbook/scsi/_index.adoc | 1 + .../en/books/arch-handbook/smp/_index.adoc | 1 + .../en/books/arch-handbook/sound/_index.adoc | 1 + .../books/arch-handbook/sysinit/_index.adoc | 1 + .../en/books/arch-handbook/usb/_index.adoc | 1 + .../en/books/arch-handbook/vm/_index.adoc | 1 + .../content/en/books/design-44bsd/_index.adoc | 2 +- .../content/en/books/dev-model/_index.adoc | 2 +- .../en/books/developers-handbook/_index.adoc | 4 +- .../bibliography/_index.adoc | 1 + .../en/books/developers-handbook/book.adoc | 24 +++--- .../introduction/_index.adoc | 1 + .../developers-handbook/ipv6/_index.adoc | 1 + .../kernelbuild/_index.adoc | 1 + .../kerneldebug/_index.adoc | 1 + .../developers-handbook/l10n/_index.adoc | 1 + .../developers-handbook/policies/_index.adoc | 1 + .../developers-handbook/secure/_index.adoc | 1 + .../developers-handbook/sockets/_index.adoc | 1 + .../developers-handbook/testing/_index.adoc | 1 + .../developers-handbook/tools/_index.adoc | 1 + .../books/developers-handbook/x86/_index.adoc | 1 + .../content/en/books/faq/_index.adoc | 4 +- .../content/en/books/fdp-primer/_index.adoc | 3 +- .../fdp-primer/asciidoctor-primer/_index.adoc | 1 + .../content/en/books/fdp-primer/book.adoc | 33 ++++---- .../en/books/fdp-primer/doc-build/_index.adoc | 1 + .../fdp-primer/editor-config/_index.adoc | 1 + .../en/books/fdp-primer/examples/_index.adoc | 1 + .../books/fdp-primer/manual-pages/_index.adoc | 1 + .../en/books/fdp-primer/overview/_index.adoc | 1 + .../fdp-primer/po-translations/_index.adoc | 1 + .../en/books/fdp-primer/preface/_index.adoc | 1 + .../en/books/fdp-primer/rosetta/_index.adoc | 1 + .../en/books/fdp-primer/see-also/_index.adoc | 1 + .../en/books/fdp-primer/structure/_index.adoc | 1 + .../en/books/fdp-primer/tools/_index.adoc | 1 + .../books/fdp-primer/translations/_index.adoc | 1 + .../books/fdp-primer/working-copy/_index.adoc | 1 + .../fdp-primer/writing-style/_index.adoc | 1 + .../content/en/books/handbook/_index.adoc | 2 +- .../handbook/advanced-networking/_index.adoc | 1 + .../en/books/handbook/audit/_index.adoc | 1 + .../en/books/handbook/basics/_index.adoc | 1 + .../books/handbook/bibliography/_index.adoc | 1 + .../content/en/books/handbook/book.adoc | 76 +++++++++---------- .../en/books/handbook/boot/_index.adoc | 1 + .../en/books/handbook/bsdinstall/_index.adoc | 1 + .../content/en/books/handbook/colophon.adoc | 1 + .../en/books/handbook/config/_index.adoc | 1 + .../books/handbook/cutting-edge/_index.adoc | 1 + .../en/books/handbook/desktop/_index.adoc | 1 + .../en/books/handbook/disks/_index.adoc | 1 + .../en/books/handbook/dtrace/_index.adoc | 1 + .../en/books/handbook/eresources/_index.adoc | 1 + .../en/books/handbook/filesystems/_index.adoc | 1 + .../en/books/handbook/firewalls/_index.adoc | 1 + .../en/books/handbook/geom/_index.adoc | 1 + .../content/en/books/handbook/glossary.adoc | 1 + .../books/handbook/introduction/_index.adoc | 1 + .../en/books/handbook/jails/_index.adoc | 1 + .../books/handbook/kernelconfig/_index.adoc | 1 + .../en/books/handbook/l10n/_index.adoc | 1 + .../en/books/handbook/linuxemu/_index.adoc | 1 + .../en/books/handbook/mail/_index.adoc | 1 + .../en/books/handbook/mirrors/_index.adoc | 1 + .../en/books/handbook/multimedia/_index.adoc | 1 + .../handbook/network-servers/_index.adoc | 1 + .../en/books/handbook/pgpkeys/_index.adoc | 1 + .../en/books/handbook/ports/_index.adoc | 1 + .../books/handbook/ppp-and-slip/_index.adoc | 1 + .../en/books/handbook/preface/_index.adoc | 1 + .../en/books/handbook/printing/_index.adoc | 1 + .../en/books/handbook/security/_index.adoc | 1 + .../en/books/handbook/serialcomms/_index.adoc | 1 + .../handbook/usb-device-mode/_index.adoc | 1 + .../books/handbook/virtualization/_index.adoc | 1 + .../en/books/handbook/wine/_index.adoc | 1 + .../content/en/books/handbook/x11/_index.adoc | 1 + .../content/en/books/handbook/zfs/_index.adoc | 1 + .../en/books/porters-handbook/_index.adoc | 3 +- .../en/books/porters-handbook/book.adoc | 39 +++++----- .../porters-handbook/flavors/_index.adoc | 1 + .../porters-handbook/keeping-up/_index.adoc | 1 + .../porters-handbook/makefiles/_index.adoc | 1 + .../porters-handbook/new-port/_index.adoc | 1 + .../books/porters-handbook/order/_index.adoc | 1 + .../porters-handbook/pkg-files/_index.adoc | 1 + .../books/porters-handbook/plist/_index.adoc | 1 + .../porters-handbook/porting-dads/_index.adoc | 1 + .../porting-samplem/_index.adoc | 1 + .../porters-handbook/porting-why/_index.adoc | 1 + .../quick-porting/_index.adoc | 1 + .../porters-handbook/security/_index.adoc | 1 + .../porters-handbook/slow-porting/_index.adoc | 1 + .../porters-handbook/special/_index.adoc | 1 + .../porters-handbook/testing/_index.adoc | 1 + .../porters-handbook/upgrading/_index.adoc | 1 + .../books/porters-handbook/uses/_index.adoc | 1 + .../porters-handbook/versions/_index.adoc | 1 + .../beastie/layouts/articles/baseof.html | 6 +- .../themes/beastie/layouts/books/baseof.html | 6 +- .../beastie/layouts/partials/site-head.html | 8 +- 152 files changed, 269 insertions(+), 157 deletions(-) diff --git a/documentation/config/_default/config.toml b/documentation/config/_default/config.toml index fd4b3983fc..9fbd8c26a0 100644 --- a/documentation/config/_default/config.toml +++ b/documentation/config/_default/config.toml @@ -2,7 +2,7 @@ # $FreeBSD$ baseURL = "https://docs.freebsd.org/" -title = "The FreeBSD Project" +title = "FreeBSD Documentation Portal" copyright = "BSD 2-clause 'Simplified' License" DefaultContentLanguage = "en" defaultContentLanguageInSubdir = true @@ -16,6 +16,7 @@ enableRobotsTXT = true [params] websiteURL = "https://www.FreeBSD.org/" + description = "FreeBSD Documentation Portal" [markup.asciidocExt] preserveTOC = true diff --git a/documentation/content/en/articles/bsdl-gpl/_index.adoc b/documentation/content/en/articles/bsdl-gpl/_index.adoc index 01b9cbebec..53872bcc2b 100644 --- a/documentation/content/en/articles/bsdl-gpl/_index.adoc +++ b/documentation/content/en/articles/bsdl-gpl/_index.adoc @@ -3,8 +3,8 @@ title: Why you should use a BSD style license for your Open Source Project authors: - author: Bruce Montague email: brucem@alumni.cse.ucsc.edu -releaseinfo: "$FreeBSD$" trademarks: ["freebsd", "intel", "general"] +description: Why you should use a BSD style license for your Open Source Project --- = Why you should use a BSD style license for your Open Source Project diff --git a/documentation/content/en/articles/building-products/_index.adoc b/documentation/content/en/articles/building-products/_index.adoc index 8538aea5e8..577b1d3d42 100644 --- a/documentation/content/en/articles/building-products/_index.adoc +++ b/documentation/content/en/articles/building-products/_index.adoc @@ -5,7 +5,7 @@ authors: email: jkoshy@FreeBSD.org organizations: - organization: The FreeBSD Project -releaseinfo: "$FreeBSD$" +description: Building Products with FreeBSD trademarks: ["freebsd", "general"] --- diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index a79443f48c..7aad6a68ef 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -3,7 +3,7 @@ title: Committer's Guide authors: - author: The FreeBSD Documentation Project copyright: 1999-2021 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +description: FreeBSD Committer's Guide trademarks: ["freebsd", "coverity", "ibm", "intel", "general"] --- diff --git a/documentation/content/en/articles/contributing/_index.adoc b/documentation/content/en/articles/contributing/_index.adoc index 208b019e6b..c7d61004ec 100644 --- a/documentation/content/en/articles/contributing/_index.adoc +++ b/documentation/content/en/articles/contributing/_index.adoc @@ -4,7 +4,7 @@ authors: - author: Jordan Hubbard - author: Sam Lawrance - author: Mark Linimon -releaseinfo: "$FreeBSD$" +description: Contributing to the FreeBSD Project trademarks: ["freebsd", "ieee", "general"] --- diff --git a/documentation/content/en/articles/contributors/_index.adoc b/documentation/content/en/articles/contributors/_index.adoc index 1919f846c6..afd0f120b4 100644 --- a/documentation/content/en/articles/contributors/_index.adoc +++ b/documentation/content/en/articles/contributors/_index.adoc @@ -1,6 +1,6 @@ --- title: Contributors to FreeBSD -releaseinfo: "$FreeBSD$" +description: Contributors to FreeBSD trademarks: ["freebsd", "sun", "general"] --- diff --git a/documentation/content/en/articles/cups/_index.adoc b/documentation/content/en/articles/cups/_index.adoc index 008369f0ad..1bd26b5da6 100644 --- a/documentation/content/en/articles/cups/_index.adoc +++ b/documentation/content/en/articles/cups/_index.adoc @@ -3,7 +3,7 @@ title: CUPS on FreeBSD authors: - author: Chess Griffin email: chess@chessgriffin.com -releaseinfo: "$FreeBSD$" +description: How to install and use CUPS on FreeBSD trademarks: ["freebsd", "general"] --- diff --git a/documentation/content/en/articles/explaining-bsd/_index.adoc b/documentation/content/en/articles/explaining-bsd/_index.adoc index ce636eb968..a4c56fa7fd 100644 --- a/documentation/content/en/articles/explaining-bsd/_index.adoc +++ b/documentation/content/en/articles/explaining-bsd/_index.adoc @@ -3,7 +3,7 @@ title: Explaining BSD authors: - author: Greg Lehey email: grog@FreeBSD.org -releaseinfo: "$FreeBSD$" +description: Brief explanation about BSD trademarks: ["freebsd", "amd", "apple", "intel", "linux", "opengroup", "sun", "unix", "general"] --- diff --git a/documentation/content/en/articles/filtering-bridges/_index.adoc b/documentation/content/en/articles/filtering-bridges/_index.adoc index d880fb95f6..7a3647c0fb 100644 --- a/documentation/content/en/articles/filtering-bridges/_index.adoc +++ b/documentation/content/en/articles/filtering-bridges/_index.adoc @@ -3,7 +3,7 @@ title: Filtering Bridges authors: - author: Alex Dupre email: ale@FreeBSD.org -releaseinfo: "$FreeBSD$" +description: Filtering Bridges in FreeBSD trademarks: ["freebsd", "3com", "intel", "general"] --- diff --git a/documentation/content/en/articles/fonts/_index.adoc b/documentation/content/en/articles/fonts/_index.adoc index 498371dfcb..70e52a1a91 100644 --- a/documentation/content/en/articles/fonts/_index.adoc +++ b/documentation/content/en/articles/fonts/_index.adoc @@ -4,7 +4,7 @@ subtitle: A Tutorial authors: - author: Dave Bodenstab email: imdave@synet.net -releaseinfo: "$FreeBSD$" +description: Description of the various font files that may be used with FreeBSD trademarks: ["freebsd", "adobe", "apple", "linux", "microsoft", "opengroup", "general"] --- diff --git a/documentation/content/en/articles/freebsd-questions/_index.adoc b/documentation/content/en/articles/freebsd-questions/_index.adoc index 95774ce2c6..51d18e0cef 100644 --- a/documentation/content/en/articles/freebsd-questions/_index.adoc +++ b/documentation/content/en/articles/freebsd-questions/_index.adoc @@ -3,7 +3,7 @@ title: How to get Best Results from the FreeBSD-questions Mailing List authors: - author: Greg Lehey email: grog@FreeBSD.org -releaseinfo: "$FreeBSD$" +description: How to get Best Results from the FreeBSD-questions Mailing List trademarks: ["freebsd", "microsoft", "opengroup", "qualcomm", "general"] --- diff --git a/documentation/content/en/articles/freebsd-releng/_index.adoc b/documentation/content/en/articles/freebsd-releng/_index.adoc index 65410cf4a0..5615986124 100644 --- a/documentation/content/en/articles/freebsd-releng/_index.adoc +++ b/documentation/content/en/articles/freebsd-releng/_index.adoc @@ -8,6 +8,7 @@ organizations: webpage: https://www.freebsdfoundation.org/ - organization: Rubicon Communications, LLC (Netgate) webpage: https://www.netgate.com/ +description: FreeBSD Release Engineering trademarks: ["freebsd", "intel", "general"] --- diff --git a/documentation/content/en/articles/freebsd-update-server/_index.adoc b/documentation/content/en/articles/freebsd-update-server/_index.adoc index 394836d40e..6ee32d4eee 100644 --- a/documentation/content/en/articles/freebsd-update-server/_index.adoc +++ b/documentation/content/en/articles/freebsd-update-server/_index.adoc @@ -4,7 +4,7 @@ authors: - author: Jason Helfman email: jgh@FreeBSD.org copyright: 2009-2011, 2013 Jason Helfman -releaseinfo: "$FreeBSD$" +description: Build Your Own FreeBSD Update Server trademarks: ["freebsd", "amd", "intel", "general"] --- diff --git a/documentation/content/en/articles/geom-class/_index.adoc b/documentation/content/en/articles/geom-class/_index.adoc index 81795771fd..8c93697afb 100644 --- a/documentation/content/en/articles/geom-class/_index.adoc +++ b/documentation/content/en/articles/geom-class/_index.adoc @@ -3,7 +3,7 @@ title: Writing a GEOM Class authors: - author: Ivan Voras email: ivoras@FreeBSD.org -releaseinfo: "$FreeBSD$" +description: Writing a GEOM Class in FreeBSD trademarks: ["freebsd", "intel", "general"] --- diff --git a/documentation/content/en/articles/gjournal-desktop/_index.adoc b/documentation/content/en/articles/gjournal-desktop/_index.adoc index 320a0b2295..99f51b0ac9 100644 --- a/documentation/content/en/articles/gjournal-desktop/_index.adoc +++ b/documentation/content/en/articles/gjournal-desktop/_index.adoc @@ -3,7 +3,7 @@ title: Implementing UFS Journaling on a Desktop PC authors: - author: Manolis Kiagias email: manolis@FreeBSD.org -releaseinfo: "$FreeBSD$" +description: Implementing UFS Journaling on a Desktop PC trademarks: ["freebsd", "general"] --- diff --git a/documentation/content/en/articles/hubs/_index.adoc b/documentation/content/en/articles/hubs/_index.adoc index 07bcdc840b..3819b76d71 100644 --- a/documentation/content/en/articles/hubs/_index.adoc +++ b/documentation/content/en/articles/hubs/_index.adoc @@ -9,7 +9,7 @@ authors: email: dl@leo.org - author: Ken Smith email: kensmith@FreeBSD.org -releaseinfo: "$FreeBSD$" +description: How to mirror FreeBSD trademarks: ["freebsd", "general"] --- diff --git a/documentation/content/en/articles/ipsec-must/_index.adoc b/documentation/content/en/articles/ipsec-must/_index.adoc index 04bbab552c..f514789fd4 100644 --- a/documentation/content/en/articles/ipsec-must/_index.adoc +++ b/documentation/content/en/articles/ipsec-must/_index.adoc @@ -3,7 +3,7 @@ title: Independent Verification of IPsec Functionality in FreeBSD authors: - author: David Honig email: honig@sprynet.com -releaseinfo: "$FreeBSD$" +description: Independent Verification of IPsec Functionality in FreeBSD trademarks: ["freebsd", "opengroup", "general"] --- diff --git a/documentation/content/en/articles/ldap-auth/_index.adoc b/documentation/content/en/articles/ldap-auth/_index.adoc index d848ae896e..206a6d4ed6 100644 --- a/documentation/content/en/articles/ldap-auth/_index.adoc +++ b/documentation/content/en/articles/ldap-auth/_index.adoc @@ -4,7 +4,7 @@ authors: - author: Toby Burress email: kurin@causa-sui.net copyright: 2007-2008 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +description: Guide for the configuration of an LDAP server for authentication on FreeBSD trademarks: ["freebsd", "general"] --- diff --git a/documentation/content/en/articles/leap-seconds/_index.adoc b/documentation/content/en/articles/leap-seconds/_index.adoc index 64271ff340..8ad3c6154e 100644 --- a/documentation/content/en/articles/leap-seconds/_index.adoc +++ b/documentation/content/en/articles/leap-seconds/_index.adoc @@ -1,6 +1,6 @@ --- title: FreeBSD Support for Leap Seconds -releaseinfo: "$FreeBSD$" +description: FreeBSD Support for Leap Seconds --- = FreeBSD Support for Leap Seconds diff --git a/documentation/content/en/articles/linux-emulation/_index.adoc b/documentation/content/en/articles/linux-emulation/_index.adoc index f19362a9d0..701bf524cc 100644 --- a/documentation/content/en/articles/linux-emulation/_index.adoc +++ b/documentation/content/en/articles/linux-emulation/_index.adoc @@ -3,7 +3,7 @@ title: Linux® emulation in FreeBSD authors: - author: Roman Divacky email: rdivacky@FreeBSD.org -releaseinfo: "$FreeBSD$" +description: Linux® emulation in FreeBSD trademarks: ["freebsd", "ibm", "adobe", "netbsd", "realnetworks", "oracle", "linux", "sun", "general"] --- diff --git a/documentation/content/en/articles/linux-users/_index.adoc b/documentation/content/en/articles/linux-users/_index.adoc index 2198e6d09d..5406d0b7bb 100644 --- a/documentation/content/en/articles/linux-users/_index.adoc +++ b/documentation/content/en/articles/linux-users/_index.adoc @@ -3,7 +3,7 @@ title: FreeBSD Quickstart Guide for Linux® Users authors: - author: John Ferrell copyright: 2008 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +description: This document is intended to quickly familiarize intermediate to advanced Linux® users with the basics of FreeBSD. trademarks: ["freebsd", "intel", "redhat", "linux", "unix", "general"] --- diff --git a/documentation/content/en/articles/mailing-list-faq/_index.adoc b/documentation/content/en/articles/mailing-list-faq/_index.adoc index c4430812bd..81bb9f2b07 100644 --- a/documentation/content/en/articles/mailing-list-faq/_index.adoc +++ b/documentation/content/en/articles/mailing-list-faq/_index.adoc @@ -2,8 +2,8 @@ title: Frequently Asked Questions About The FreeBSD Mailing Lists authors: - author: The FreeBSD Documentation Project -copyright: 2004-2005 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +copyright: 2004-2021 The FreeBSD Documentation Project +description: Frequently Asked Questions About The FreeBSD Mailing Lists --- = Frequently Asked Questions About The FreeBSD Mailing Lists diff --git a/documentation/content/en/articles/nanobsd/_index.adoc b/documentation/content/en/articles/nanobsd/_index.adoc index a006140591..016fa739a8 100644 --- a/documentation/content/en/articles/nanobsd/_index.adoc +++ b/documentation/content/en/articles/nanobsd/_index.adoc @@ -3,7 +3,7 @@ title: Introduction to NanoBSD authors: - author: Daniel Gerzo copyright: 2006 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +description: This document provides information about the NanoBSD tools, which can be used to create FreeBSD system images for embedded applications, suitable for use on a USB key, memory card or other mass storage media. trademarks: ["freebsd", "general"] --- diff --git a/documentation/content/en/articles/new-users/_index.adoc b/documentation/content/en/articles/new-users/_index.adoc index ff1de0b682..93588811b9 100644 --- a/documentation/content/en/articles/new-users/_index.adoc +++ b/documentation/content/en/articles/new-users/_index.adoc @@ -3,7 +3,7 @@ title: For People New to Both FreeBSD and UNIX® authors: - author: Annelise Anderson email: andrsn@andrsn.stanford.edu -releaseinfo: "$FreeBSD$" +description: Introduction for people new to both FreeBSD and UNIX® trademarks: ["freebsd", "ibm", "microsoft", "opengroup", "general"] --- diff --git a/documentation/content/en/articles/pam/_index.adoc b/documentation/content/en/articles/pam/_index.adoc index 82bd501ba2..6f3d5a22d6 100644 --- a/documentation/content/en/articles/pam/_index.adoc +++ b/documentation/content/en/articles/pam/_index.adoc @@ -3,7 +3,7 @@ title: Pluggable Authentication Modules authors: - author: Dag-Erling Smørgrav copyright: 2001-2003 Networks Associates Technology, Inc. -releaseinfo: "$FreeBSD$" +description: Pluggable Authentication Modules (PAM) in FreeBSD trademarks: ["pam", "freebsd", "linux", "opengroup", "sun", "general"] --- diff --git a/documentation/content/en/articles/pgpkeys/_index.adoc b/documentation/content/en/articles/pgpkeys/_index.adoc index a09cfe8fcd..f55d39fe46 100644 --- a/documentation/content/en/articles/pgpkeys/_index.adoc +++ b/documentation/content/en/articles/pgpkeys/_index.adoc @@ -1,6 +1,6 @@ --- title: OpenPGP Keys -releaseinfo: "$FreeBSD$" +description: List of OpenPGP keys that can be used to verify a signature or send encrypted email to FreeBSD.org officers or developers. --- = OpenPGP Keys diff --git a/documentation/content/en/articles/port-mentor-guidelines/_index.adoc b/documentation/content/en/articles/port-mentor-guidelines/_index.adoc index 1d9d5f4cbe..a8a50b05bc 100644 --- a/documentation/content/en/articles/port-mentor-guidelines/_index.adoc +++ b/documentation/content/en/articles/port-mentor-guidelines/_index.adoc @@ -3,7 +3,7 @@ title: Port Mentor Guidelines organizations: - organization: The FreeBSD Ports Management Team copyright: 2011 Thomas Abthorpe, Chris Rees -releaseinfo: "$FreeBSD$" +description: Port Mentor Guidelines for FreeBSD Mentors --- = Port Mentor Guidelines diff --git a/documentation/content/en/articles/pr-guidelines/_index.adoc b/documentation/content/en/articles/pr-guidelines/_index.adoc index deea48608d..50a0159802 100644 --- a/documentation/content/en/articles/pr-guidelines/_index.adoc +++ b/documentation/content/en/articles/pr-guidelines/_index.adoc @@ -3,7 +3,7 @@ title: Problem Report Handling Guidelines authors: - author: Dag-Erling Smørgrav - author: Hiten Pandya -releaseinfo: "$FreeBSD$" +description: These guidelines describe recommended handling practices for FreeBSD Problem Reports (PRs). trademarks: ["freebsd", "general"] --- diff --git a/documentation/content/en/articles/problem-reports/_index.adoc b/documentation/content/en/articles/problem-reports/_index.adoc index 3294a5266e..d61055bdfc 100644 --- a/documentation/content/en/articles/problem-reports/_index.adoc +++ b/documentation/content/en/articles/problem-reports/_index.adoc @@ -3,7 +3,7 @@ title: Writing FreeBSD Problem Reports authors: - author: Dag-Erling Smørgrav - author: Mark Linimon -releaseinfo: "$FreeBSD$" +description: Writing FreeBSD Problem Reports trademarks: ["freebsd", "ibm", "intel", "sun", "general"] --- diff --git a/documentation/content/en/articles/rc-scripting/_index.adoc b/documentation/content/en/articles/rc-scripting/_index.adoc index 336f5c03c2..72e71bffbd 100644 --- a/documentation/content/en/articles/rc-scripting/_index.adoc +++ b/documentation/content/en/articles/rc-scripting/_index.adoc @@ -4,7 +4,7 @@ authors: - author: Yar Tikhiy email: yar@FreeBSD.org copyright: 2005-2006, 2012 The FreeBSD Project -releaseinfo: "$FreeBSD$" +description: Practical rc.d scripting in BSD trademarks: ["freebsd", "netbsd", "general"] --- diff --git a/documentation/content/en/articles/releng/_index.adoc b/documentation/content/en/articles/releng/_index.adoc index 51a1b647c8..665c3cea45 100644 --- a/documentation/content/en/articles/releng/_index.adoc +++ b/documentation/content/en/articles/releng/_index.adoc @@ -4,6 +4,7 @@ authors: - author: Murray Stokely email: murray@FreeBSD.org webpage: https://people.FreeBSD.org/~murray/ +description: This paper describes the approach used by the FreeBSD release engineering team to make production quality releases of the FreeBSD Operating System trademarks: ["freebsd", "intel", "general"] --- diff --git a/documentation/content/en/articles/remote-install/_index.adoc b/documentation/content/en/articles/remote-install/_index.adoc index bf97ed25e6..e5343b75a9 100644 --- a/documentation/content/en/articles/remote-install/_index.adoc +++ b/documentation/content/en/articles/remote-install/_index.adoc @@ -3,8 +3,8 @@ title: Remote Installation of the FreeBSD Operating System Without a Remote Cons authors: - author: Daniel Gerzo email: danger@FreeBSD.org -copyright: 2008 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +copyright: 2008-2021 The FreeBSD Documentation Project +description: Remote Installation of the FreeBSD Operating System Without a Remote Console trademarks: ["freebsd", "general"] --- diff --git a/documentation/content/en/articles/serial-uart/_index.adoc b/documentation/content/en/articles/serial-uart/_index.adoc index aed42baa0f..9bd53781e0 100644 --- a/documentation/content/en/articles/serial-uart/_index.adoc +++ b/documentation/content/en/articles/serial-uart/_index.adoc @@ -3,7 +3,7 @@ title: Serial and UART Tutorial authors: - author: Frank Durda email: uhclem@FreeBSD.org -releaseinfo: "$FreeBSD$" +description: How to use serial hardware and UART with FreeBSD trademarks: ["freebsd", "microsoft", "general"] --- diff --git a/documentation/content/en/articles/solid-state/_index.adoc b/documentation/content/en/articles/solid-state/_index.adoc index 988a7e5aad..4a1b022fdb 100644 --- a/documentation/content/en/articles/solid-state/_index.adoc +++ b/documentation/content/en/articles/solid-state/_index.adoc @@ -3,8 +3,8 @@ title: FreeBSD and Solid State Devices authors: - author: John Kozubik email: john@kozubik.com -copyright: 2001, 2009 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +copyright: 2001 - 2021 The FreeBSD Documentation Project +description: FreeBSD and Solid State Devices trademarks: ["freebsd", "general"] --- diff --git a/documentation/content/en/articles/vinum/_index.adoc b/documentation/content/en/articles/vinum/_index.adoc index 20d786ab5a..329a417bcc 100644 --- a/documentation/content/en/articles/vinum/_index.adoc +++ b/documentation/content/en/articles/vinum/_index.adoc @@ -2,6 +2,7 @@ title: The vinum Volume Manager authors: - author: Greg Lehey +description: The vinum Volume Manager in FreeBSD --- = The vinum Volume Manager diff --git a/documentation/content/en/articles/vm-design/_index.adoc b/documentation/content/en/articles/vm-design/_index.adoc index 2b7163da83..12a60f6962 100644 --- a/documentation/content/en/articles/vm-design/_index.adoc +++ b/documentation/content/en/articles/vm-design/_index.adoc @@ -3,7 +3,7 @@ title: Design elements of the FreeBSD VM system authors: - author: Matthew Dillon email: dillon@apollo.backplane.com -releaseinfo: "$FreeBSD$" +description: Design elements of the FreeBSD VM system trademarks: ["freebsd", "linux", "microsoft", "opengroup", "daemon-news", "general"] --- diff --git a/documentation/content/en/books/arch-handbook/_index.adoc b/documentation/content/en/books/arch-handbook/_index.adoc index 2ae3066029..a5cefc4616 100644 --- a/documentation/content/en/books/arch-handbook/_index.adoc +++ b/documentation/content/en/books/arch-handbook/_index.adoc @@ -2,8 +2,8 @@ title: FreeBSD Architecture Handbook authors: - author: The FreeBSD Documentation Project -copyright: Copyright © 2000-2006, 2012-2013 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +copyright: Copyright © 2000-2006, 2012-2021 The FreeBSD Documentation Project +description: FreeBSD Architecture Handbook Index trademarks: ["freebsd", "apple", "microsoft", "unix", "general"] next: books/arch-handbook/parti --- diff --git a/documentation/content/en/books/arch-handbook/bibliography/_index.adoc b/documentation/content/en/books/arch-handbook/bibliography/_index.adoc index a33b858ee5..1ba9e79298 100644 --- a/documentation/content/en/books/arch-handbook/bibliography/_index.adoc +++ b/documentation/content/en/books/arch-handbook/bibliography/_index.adoc @@ -1,6 +1,7 @@ --- title: Bibliography prev: books/arch-handbook/partiii +description: Bibliography of the FreeBSD Architecture Handbook --- [appendix] diff --git a/documentation/content/en/books/arch-handbook/book.adoc b/documentation/content/en/books/arch-handbook/book.adoc index 4fbb953a12..2de998232c 100644 --- a/documentation/content/en/books/arch-handbook/book.adoc +++ b/documentation/content/en/books/arch-handbook/book.adoc @@ -70,28 +70,28 @@ toc::[] // Section one include::{chapters-path}parti.adoc[lines=7..8] -include::{chapters-path}boot/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}locking/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}kobj/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}jail/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}sysinit/_index.adoc[leveloffset=+1], lines=7..21;32..-1] -include::{chapters-path}mac/_index.adoc[leveloffset=+1, lines=12..26;37..-1] -include::{chapters-path}vm/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}smp/_index.adoc[leveloffset=+1, lines=7..21;32..-1] +include::{chapters-path}boot/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}locking/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}kobj/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}jail/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}sysinit/_index.adoc[leveloffset=+1], lines=8..22;33..-1] +include::{chapters-path}mac/_index.adoc[leveloffset=+1, lines=13..27;38..-1] +include::{chapters-path}vm/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}smp/_index.adoc[leveloffset=+1, lines=8..22;33..-1] // Section two include::{chapters-path}partii.adoc[lines=7..8] -include::{chapters-path}driverbasics/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}isa/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}pci/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}scsi/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}usb/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}newbus/_index.adoc[leveloffset=+1, lines=12..26;37..-1] -include::{chapters-path}sound/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}pccard/_index.adoc[leveloffset=+1, lines=7..21;32..-1] +include::{chapters-path}driverbasics/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}isa/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}pci/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}scsi/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}usb/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}newbus/_index.adoc[leveloffset=+1, lines=13..27;38..-1] +include::{chapters-path}sound/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}pccard/_index.adoc[leveloffset=+1, lines=8..22;33..-1] // Section three include::{chapters-path}partiii.adoc[lines=7..8] -include::{chapters-path}bibliography/_index.adoc[leveloffset=+1, lines=6..19;28..-1] +include::{chapters-path}bibliography/_index.adoc[leveloffset=+1, lines=7..20;29..-1] diff --git a/documentation/content/en/books/arch-handbook/boot/_index.adoc b/documentation/content/en/books/arch-handbook/boot/_index.adoc index 44b4e3c1be..e98c7114fe 100644 --- a/documentation/content/en/books/arch-handbook/boot/_index.adoc +++ b/documentation/content/en/books/arch-handbook/boot/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 1. Bootstrapping and Kernel Initialization prev: books/arch-handbook/parti next: books/arch-handbook/locking +description: Bootstrapping and Kernel Initialization --- [[boot]] diff --git a/documentation/content/en/books/arch-handbook/driverbasics/_index.adoc b/documentation/content/en/books/arch-handbook/driverbasics/_index.adoc index 07732d34bb..46c08ba0aa 100644 --- a/documentation/content/en/books/arch-handbook/driverbasics/_index.adoc +++ b/documentation/content/en/books/arch-handbook/driverbasics/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 9. Writing FreeBSD Device Drivers prev: books/arch-handbook/partii next: books/arch-handbook/isa +description: Writing FreeBSD Device Drivers --- [[driverbasics]] diff --git a/documentation/content/en/books/arch-handbook/isa/_index.adoc b/documentation/content/en/books/arch-handbook/isa/_index.adoc index a51c91ad1d..454f973fb0 100644 --- a/documentation/content/en/books/arch-handbook/isa/_index.adoc +++ b/documentation/content/en/books/arch-handbook/isa/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 10. ISA Device Drivers prev: books/arch-handbook/driverbasics next: books/arch-handbook/pci +description: ISA Device Drivers --- [[isa-driver]] diff --git a/documentation/content/en/books/arch-handbook/jail/_index.adoc b/documentation/content/en/books/arch-handbook/jail/_index.adoc index 4ea78c7bb8..46bbf2565b 100644 --- a/documentation/content/en/books/arch-handbook/jail/_index.adoc +++ b/documentation/content/en/books/arch-handbook/jail/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 4. The Jail Subsystem prev: books/arch-handbook/kobj next: books/arch-handbook/sysinit +description: The Jail Subsystem --- [[jail]] diff --git a/documentation/content/en/books/arch-handbook/kobj/_index.adoc b/documentation/content/en/books/arch-handbook/kobj/_index.adoc index bd11946acd..f2760e2252 100644 --- a/documentation/content/en/books/arch-handbook/kobj/_index.adoc +++ b/documentation/content/en/books/arch-handbook/kobj/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 3. Kernel Objects prev: books/arch-handbook/locking next: books/arch-handbook/jail +description: Kernel Objects --- [[kernel-objects]] diff --git a/documentation/content/en/books/arch-handbook/locking/_index.adoc b/documentation/content/en/books/arch-handbook/locking/_index.adoc index 517c615b99..fdbdd70d4e 100644 --- a/documentation/content/en/books/arch-handbook/locking/_index.adoc +++ b/documentation/content/en/books/arch-handbook/locking/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 2. Locking Notes prev: books/arch-handbook/boot next: books/arch-handbook/kobj +description: Locking Notes --- [[locking]] diff --git a/documentation/content/en/books/arch-handbook/mac/_index.adoc b/documentation/content/en/books/arch-handbook/mac/_index.adoc index f33be4228e..b6d2903530 100644 --- a/documentation/content/en/books/arch-handbook/mac/_index.adoc +++ b/documentation/content/en/books/arch-handbook/mac/_index.adoc @@ -7,6 +7,7 @@ authors: email: rwatson@FreeBSD.org prev: books/arch-handbook/sysinit next: books/arch-handbook/vm +description: The TrustedBSD MAC Framework --- [[mac]] diff --git a/documentation/content/en/books/arch-handbook/newbus/_index.adoc b/documentation/content/en/books/arch-handbook/newbus/_index.adoc index 797011d3f8..69a4109ec4 100644 --- a/documentation/content/en/books/arch-handbook/newbus/_index.adoc +++ b/documentation/content/en/books/arch-handbook/newbus/_index.adoc @@ -7,6 +7,7 @@ authors: email: hiten@uk.FreeBSD.org prev: books/arch-handbook/usb next: books/arch-handbook/sound +description: Newbus --- [[newbus]] diff --git a/documentation/content/en/books/arch-handbook/pccard/_index.adoc b/documentation/content/en/books/arch-handbook/pccard/_index.adoc index 1b7be9e711..6690023a19 100644 --- a/documentation/content/en/books/arch-handbook/pccard/_index.adoc +++ b/documentation/content/en/books/arch-handbook/pccard/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 16. PC Card prev: books/arch-handbook/sound next: books/arch-handbook/partiii +description: PC Card --- [[pccard]] diff --git a/documentation/content/en/books/arch-handbook/pci/_index.adoc b/documentation/content/en/books/arch-handbook/pci/_index.adoc index b4a7b72c9c..5adb945dd5 100644 --- a/documentation/content/en/books/arch-handbook/pci/_index.adoc +++ b/documentation/content/en/books/arch-handbook/pci/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 11. PCI Devices prev: books/arch-handbook/isa next: books/arch-handbook/scsi +description: PCI Devices --- [[pci]] diff --git a/documentation/content/en/books/arch-handbook/scsi/_index.adoc b/documentation/content/en/books/arch-handbook/scsi/_index.adoc index 6192c65cbd..49fcd635d4 100644 --- a/documentation/content/en/books/arch-handbook/scsi/_index.adoc +++ b/documentation/content/en/books/arch-handbook/scsi/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 12. Common Access Method SCSI Controllers prev: books/arch-handbook/pci next: books/arch-handbook/usb +description: Common Access Method SCSI Controllers --- [[scsi]] diff --git a/documentation/content/en/books/arch-handbook/smp/_index.adoc b/documentation/content/en/books/arch-handbook/smp/_index.adoc index a47de5f260..b3f9f87ccb 100644 --- a/documentation/content/en/books/arch-handbook/smp/_index.adoc +++ b/documentation/content/en/books/arch-handbook/smp/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 8. SMPng Design Document prev: books/arch-handbook/vm next: books/arch-handbook/partii +description: SMPng Design Document --- [[smp]] diff --git a/documentation/content/en/books/arch-handbook/sound/_index.adoc b/documentation/content/en/books/arch-handbook/sound/_index.adoc index a7b6567206..94c43f0172 100644 --- a/documentation/content/en/books/arch-handbook/sound/_index.adoc +++ b/documentation/content/en/books/arch-handbook/sound/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 15. Sound Subsystem prev: books/arch-handbook/newbus next: books/arch-handbook/pccard +description: FreeBSD Sound Subsystem --- [[oss]] diff --git a/documentation/content/en/books/arch-handbook/sysinit/_index.adoc b/documentation/content/en/books/arch-handbook/sysinit/_index.adoc index dab2239d7a..401dfc4c71 100644 --- a/documentation/content/en/books/arch-handbook/sysinit/_index.adoc +++ b/documentation/content/en/books/arch-handbook/sysinit/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 5. The SYSINIT Framework prev: books/arch-handbook/jail next: books/arch-handbook/mac +description: The SYSINIT Framework --- [[sysinit]] diff --git a/documentation/content/en/books/arch-handbook/usb/_index.adoc b/documentation/content/en/books/arch-handbook/usb/_index.adoc index 18a06c4a0b..f7b3d9c69a 100644 --- a/documentation/content/en/books/arch-handbook/usb/_index.adoc +++ b/documentation/content/en/books/arch-handbook/usb/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 13. USB Devices prev: books/arch-handbook/scsi next: books/arch-handbook/newbus +description: USB Devices in FreeBSD --- [[usb]] diff --git a/documentation/content/en/books/arch-handbook/vm/_index.adoc b/documentation/content/en/books/arch-handbook/vm/_index.adoc index 12b9bf56e6..5593eb4322 100644 --- a/documentation/content/en/books/arch-handbook/vm/_index.adoc +++ b/documentation/content/en/books/arch-handbook/vm/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 7. Virtual Memory System prev: books/arch-handbook/mac next: books/arch-handbook/smp +description: Virtual Memory System in FreeBSD --- [[vm]] diff --git a/documentation/content/en/books/design-44bsd/_index.adoc b/documentation/content/en/books/design-44bsd/_index.adoc index 1c730ed3b2..bab937e2fc 100644 --- a/documentation/content/en/books/design-44bsd/_index.adoc +++ b/documentation/content/en/books/design-44bsd/_index.adoc @@ -6,7 +6,7 @@ authors: - author: Michael J. Karels - author: John S. Quarterman copyright: 1996 Addison-Wesley Longman, Inc -releaseinfo: "$FreeBSD$" +description: The Design and Implementation of the 4.4BSD Operating System. Second chapter. trademarks: ["design-44bsd"] --- diff --git a/documentation/content/en/books/dev-model/_index.adoc b/documentation/content/en/books/dev-model/_index.adoc index 887493f584..c5b4061159 100644 --- a/documentation/content/en/books/dev-model/_index.adoc +++ b/documentation/content/en/books/dev-model/_index.adoc @@ -3,7 +3,7 @@ title: A project model for the FreeBSD Project authors: - author: Niklas Saers copyright: Copyright © 2002-2005 Niklas Saers -releaseinfo: "$FreeBSD$" +description: A project model for the FreeBSD Project trademarks: ["freebsd", "ibm", "ieee", "adobe", "intel", "linux", "microsoft", "opengroup", "sun", "netbsd", "general"] --- diff --git a/documentation/content/en/books/developers-handbook/_index.adoc b/documentation/content/en/books/developers-handbook/_index.adoc index 3082156c0f..c7407e78d1 100644 --- a/documentation/content/en/books/developers-handbook/_index.adoc +++ b/documentation/content/en/books/developers-handbook/_index.adoc @@ -2,8 +2,8 @@ title: FreeBSD Developers' Handbook authors: - author: The FreeBSD Documentation Project -copyright: 1995-2020 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD: head/en_US.ISO8859-1/books/developers-handbook/book.xml 54255 2020-06-15 08:13:08Z bcr $" +copyright: 1995-2021 The FreeBSD Documentation Project +description: FreeBSD Developers' Handbook Index trademarks: ["freebsd", "apple", "ibm", "ieee", "intel", "linux", "microsoft", "opengroup", "sun", "general"] next: books/developers-handbook/parti --- diff --git a/documentation/content/en/books/developers-handbook/bibliography/_index.adoc b/documentation/content/en/books/developers-handbook/bibliography/_index.adoc index fa861831c5..b4cc86fc48 100644 --- a/documentation/content/en/books/developers-handbook/bibliography/_index.adoc +++ b/documentation/content/en/books/developers-handbook/bibliography/_index.adoc @@ -1,6 +1,7 @@ --- title: Appendices prev: books/developers-handbook/partv +description: FreeBSD Developers Handbook Bibliography --- [appendix] diff --git a/documentation/content/en/books/developers-handbook/book.adoc b/documentation/content/en/books/developers-handbook/book.adoc index 7953a77d83..a9e497d499 100644 --- a/documentation/content/en/books/developers-handbook/book.adoc +++ b/documentation/content/en/books/developers-handbook/book.adoc @@ -73,27 +73,27 @@ toc::[] // Section one include::{chapters-path}parti.adoc[lines=7..8] -include::{chapters-path}introduction/_index.adoc[leveloffset=+1, lines=10..24;35..-1] -include::{chapters-path}tools/_index.adoc[leveloffset=+1, lines=10..26;37..-1] -include::{chapters-path}secure/_index.adoc[leveloffset=+1, lines=9..23;34..-1] -include::{chapters-path}l10n/_index.adoc[leveloffset=+1, lines=8..22;33..-1] -include::{chapters-path}policies/_index.adoc[leveloffset=+1, lines=10..24;35..-1] -include::{chapters-path}testing/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}introduction/_index.adoc[leveloffset=+1, lines=11..25;36..-1] +include::{chapters-path}tools/_index.adoc[leveloffset=+1, lines=11..27;38..-1] +include::{chapters-path}secure/_index.adoc[leveloffset=+1, lines=10..24;35..-1] +include::{chapters-path}l10n/_index.adoc[leveloffset=+1, lines=9..23;34..-1] +include::{chapters-path}policies/_index.adoc[leveloffset=+1, lines=11..25;36..-1] +include::{chapters-path}testing/_index.adoc[leveloffset=+1, lines=9..23;34..-1] // Section two include::{chapters-path}partii.adoc[lines=7..8] -include::{chapters-path}sockets/_index.adoc[leveloffset=+1, lines=9..23;35..-1] -include::{chapters-path}ipv6/_index.adoc[leveloffset=+1, lines=9..23;34..-1] +include::{chapters-path}sockets/_index.adoc[leveloffset=+1, lines=10..24;36..-1] +include::{chapters-path}ipv6/_index.adoc[leveloffset=+1, lines=10..24;35..-1] // Section three include::{chapters-path}partiii.adoc[lines=7..8] -include::{chapters-path}kernelbuild/_index.adoc[leveloffset=+1, lines=8..22;33..-1] -include::{chapters-path}kerneldebug/_index.adoc[leveloffset=+1, lines=11..25;36..-1] +include::{chapters-path}kernelbuild/_index.adoc[leveloffset=+1, lines=9..23;34..-1] +include::{chapters-path}kerneldebug/_index.adoc[leveloffset=+1, lines=12..26;37..-1] // Section four include::{chapters-path}partiv.adoc[lines=7..8] -include::{chapters-path}x86/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}x86/_index.adoc[leveloffset=+1, lines=9..23;34..-1] // Appendices include::{chapters-path}partv.adoc[lines=7..8] -include::{chapters-path}bibliography/_index.adoc[leveloffset=+1, lines=6..20;29..-1] +include::{chapters-path}bibliography/_index.adoc[leveloffset=+1, lines=7..21;30..-1] diff --git a/documentation/content/en/books/developers-handbook/introduction/_index.adoc b/documentation/content/en/books/developers-handbook/introduction/_index.adoc index 019f80f577..5dcd910d76 100644 --- a/documentation/content/en/books/developers-handbook/introduction/_index.adoc +++ b/documentation/content/en/books/developers-handbook/introduction/_index.adoc @@ -5,6 +5,7 @@ authors: - author: Jeroen Ruigrok van der Werven prev: books/developers-handbook/parti next: books/developers-handbook/tools +description: Introduction to the FreeBSD Developers Handbook --- [[introduction]] diff --git a/documentation/content/en/books/developers-handbook/ipv6/_index.adoc b/documentation/content/en/books/developers-handbook/ipv6/_index.adoc index 1d86a91fe4..9f781f7798 100644 --- a/documentation/content/en/books/developers-handbook/ipv6/_index.adoc +++ b/documentation/content/en/books/developers-handbook/ipv6/_index.adoc @@ -4,6 +4,7 @@ authors: - author: Yoshinobu Inoue prev: books/developers-handbook/sockets next: books/developers-handbook/partiii +description: IPv6 Internals --- [[ipv6]] diff --git a/documentation/content/en/books/developers-handbook/kernelbuild/_index.adoc b/documentation/content/en/books/developers-handbook/kernelbuild/_index.adoc index 7322b4cab3..c19392cacb 100644 --- a/documentation/content/en/books/developers-handbook/kernelbuild/_index.adoc +++ b/documentation/content/en/books/developers-handbook/kernelbuild/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 9. Building and Installing a FreeBSD Kernel authors: prev: books/developers-handbook/partiii next: books/developers-handbook/kerneldebug +description: Building and Installing a FreeBSD Kernel --- [[kernelbuild]] diff --git a/documentation/content/en/books/developers-handbook/kerneldebug/_index.adoc b/documentation/content/en/books/developers-handbook/kerneldebug/_index.adoc index 930d941c3f..a23e10fe08 100644 --- a/documentation/content/en/books/developers-handbook/kerneldebug/_index.adoc +++ b/documentation/content/en/books/developers-handbook/kerneldebug/_index.adoc @@ -6,6 +6,7 @@ authors: - author: Robert Watson prev: books/developers-handbook/kernelbuild next: books/developers-handbook/partiv +description: FreeBSD Kernel Debugging --- [[kerneldebug]] diff --git a/documentation/content/en/books/developers-handbook/l10n/_index.adoc b/documentation/content/en/books/developers-handbook/l10n/_index.adoc index 4966af0aa2..7562b785c8 100644 --- a/documentation/content/en/books/developers-handbook/l10n/_index.adoc +++ b/documentation/content/en/books/developers-handbook/l10n/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 4. Localization and Internationalization - L10N and I18N authors: prev: books/developers-handbook/secure next: books/developers-handbook/policies +description: Localization and Internationalization - L10N and I18N in FreeBSD --- [[l10n]] diff --git a/documentation/content/en/books/developers-handbook/policies/_index.adoc b/documentation/content/en/books/developers-handbook/policies/_index.adoc index 0f437fd48c..01d0ea98b9 100644 --- a/documentation/content/en/books/developers-handbook/policies/_index.adoc +++ b/documentation/content/en/books/developers-handbook/policies/_index.adoc @@ -5,6 +5,7 @@ authors: - author: Giorgos Keramidas prev: books/developers-handbook/l10n next: books/developers-handbook/testing +description: Source Tree Guidelines and Policies --- [[policies]] diff --git a/documentation/content/en/books/developers-handbook/secure/_index.adoc b/documentation/content/en/books/developers-handbook/secure/_index.adoc index 8ed21a75c2..f490e0b2dd 100644 --- a/documentation/content/en/books/developers-handbook/secure/_index.adoc +++ b/documentation/content/en/books/developers-handbook/secure/_index.adoc @@ -4,6 +4,7 @@ authors: - author: Murray Stokely prev: books/developers-handbook/tools next: books/developers-handbook/l10n +description: Secure Programming in FreeBSD --- [[secure]] diff --git a/documentation/content/en/books/developers-handbook/sockets/_index.adoc b/documentation/content/en/books/developers-handbook/sockets/_index.adoc index a224743a18..44db501822 100644 --- a/documentation/content/en/books/developers-handbook/sockets/_index.adoc +++ b/documentation/content/en/books/developers-handbook/sockets/_index.adoc @@ -4,6 +4,7 @@ authors: - author: G. Adam Stanislav prev: books/developers-handbook/partii next: books/developers-handbook/ipv6 +description: FreeBSD Sockets --- [[sockets]] diff --git a/documentation/content/en/books/developers-handbook/testing/_index.adoc b/documentation/content/en/books/developers-handbook/testing/_index.adoc index 1b8459bfd3..e8d14c74c1 100644 --- a/documentation/content/en/books/developers-handbook/testing/_index.adoc +++ b/documentation/content/en/books/developers-handbook/testing/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 6. Regression and Performance Testing authors: prev: books/developers-handbook/policies next: books/developers-handbook/partii +description: Regression and Performance Testing --- [[testing]] diff --git a/documentation/content/en/books/developers-handbook/tools/_index.adoc b/documentation/content/en/books/developers-handbook/tools/_index.adoc index feeaee40b8..3720cf414c 100644 --- a/documentation/content/en/books/developers-handbook/tools/_index.adoc +++ b/documentation/content/en/books/developers-handbook/tools/_index.adoc @@ -5,6 +5,7 @@ authors: - author: Murray Stokely prev: books/developers-handbook/introduction next: books/developers-handbook/secure +description: Programming Tools --- [[tools]] diff --git a/documentation/content/en/books/developers-handbook/x86/_index.adoc b/documentation/content/en/books/developers-handbook/x86/_index.adoc index 4307e1dd63..dcd04afa8e 100644 --- a/documentation/content/en/books/developers-handbook/x86/_index.adoc +++ b/documentation/content/en/books/developers-handbook/x86/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 11. x86 Assembly Language Programming authors: prev: books/developers-handbook/partiv next: books/developers-handbook/partv +description: x86 Assembly Language Programming --- [[x86]] diff --git a/documentation/content/en/books/faq/_index.adoc b/documentation/content/en/books/faq/_index.adoc index 5db269a12b..cf3d7379df 100644 --- a/documentation/content/en/books/faq/_index.adoc +++ b/documentation/content/en/books/faq/_index.adoc @@ -2,8 +2,8 @@ title: Frequently Asked Questions for FreeBSD 11.X, 12.X, and 13.X authors: - author: The FreeBSD Documentation Project -copyright: 1995-2020 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +copyright: 1995-2021 The FreeBSD Documentation Project +description: Frequently Asked Questions (FAQ) for FreeBSD 11.X, 12.X, and 13.X trademarks: ["freebsd", "ibm", "ieee", "adobe", "intel", "linux", "microsoft", "opengroup", "sun", "netbsd", "general"] --- diff --git a/documentation/content/en/books/fdp-primer/_index.adoc b/documentation/content/en/books/fdp-primer/_index.adoc index 3ec2036db2..403e249f11 100644 --- a/documentation/content/en/books/fdp-primer/_index.adoc +++ b/documentation/content/en/books/fdp-primer/_index.adoc @@ -3,7 +3,8 @@ title: FreeBSD Documentation Project Primer for New Contributors authors: - author: The FreeBSD Documentation Project copyright: 1998-2021 DocEng -trademarks: ["general"] +trademarks: ["general"] +description: FreeBSD Documentation Project Primer for New Contributors Index next: books/fdp-primer/preface --- diff --git a/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc b/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc index c2b5bc2ee8..87ace29ecb 100644 --- a/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc +++ b/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 6. AsciiDoctor Primer prev: books/fdp-primer/doc-build next: books/fdp-primer/rosetta +description: A brief introduction to AsciiDoctor --- [[asciidoctor-primer]] diff --git a/documentation/content/en/books/fdp-primer/book.adoc b/documentation/content/en/books/fdp-primer/book.adoc index b12b59b48e..f3668ced27 100644 --- a/documentation/content/en/books/fdp-primer/book.adoc +++ b/documentation/content/en/books/fdp-primer/book.adoc @@ -3,7 +3,8 @@ title: FreeBSD Documentation Project Primer for New Contributors authors: - author: The FreeBSD Documentation Project copyright: 1998-2021 DocEng -trademarks: ["general"] +description: FreeBSD Documentation Project Primer for New Contributors Index +trademarks: ["general"] --- = FreeBSD Documentation Project Primer for New Contributors @@ -77,38 +78,38 @@ include::content/en/books/fdp-primer/toc-examples.adoc[] :sectnums!: -include::{chapters-path}preface/_index.adoc[leveloffset=+1, lines=7..-1] +include::{chapters-path}preface/_index.adoc[leveloffset=+1, lines=8..-1] :sectnums: -include::{chapters-path}overview/_index.adoc[leveloffset=+1, lines=7..21; 25..-1] +include::{chapters-path}overview/_index.adoc[leveloffset=+1, lines=8..22; 26..-1] -include::{chapters-path}tools/_index.adoc[leveloffset=+1, lines=7..21; 25..-1] +include::{chapters-path}tools/_index.adoc[leveloffset=+1, lines=8..22; 26..-1] -include::{chapters-path}working-copy/_index.adoc[leveloffset=+1, lines=7..21; 25..-1] +include::{chapters-path}working-copy/_index.adoc[leveloffset=+1, lines=8..22; 26..-1] -include::{chapters-path}structure/_index.adoc[leveloffset=+1, lines=7..21; 25..-1] +include::{chapters-path}structure/_index.adoc[leveloffset=+1, lines=8..22; 26..-1] -include::{chapters-path}doc-build/_index.adoc[leveloffset=+1, lines=7..21; 25..-1] +include::{chapters-path}doc-build/_index.adoc[leveloffset=+1, lines=8..22; 26..-1] -include::{chapters-path}asciidoctor-primer/_index.adoc[leveloffset=+1, lines=7..21; 27..-1] +include::{chapters-path}asciidoctor-primer/_index.adoc[leveloffset=+1, lines=8..22; 28..-1] -include::{chapters-path}rosetta/_index.adoc[leveloffset=+1, lines=7..21; 25..-1] +include::{chapters-path}rosetta/_index.adoc[leveloffset=+1, lines=8..22; 26..-1] -include::{chapters-path}translations/_index.adoc[leveloffset=+1, lines=7..21; 28..-1] +include::{chapters-path}translations/_index.adoc[leveloffset=+1, lines=8..22; 29..-1] -include::{chapters-path}po-translations/_index.adoc[leveloffset=+1, lines=7..21; 27..-1] +include::{chapters-path}po-translations/_index.adoc[leveloffset=+1, lines=8..22; 28..-1] -include::{chapters-path}manual-pages/_index.adoc[leveloffset=+1, lines=7..21; 25..-1] +include::{chapters-path}manual-pages/_index.adoc[leveloffset=+1, lines=8..22; 26..-1] -include::{chapters-path}writing-style/_index.adoc[leveloffset=+1, lines=7..21; 27..-1] +include::{chapters-path}writing-style/_index.adoc[leveloffset=+1, lines=8..22; 28..-1] -include::{chapters-path}editor-config/_index.adoc[leveloffset=+1, lines=7..21; 25..-1] +include::{chapters-path}editor-config/_index.adoc[leveloffset=+1, lines=8..22; 26..-1] -include::{chapters-path}see-also/_index.adoc[leveloffset=+1, lines=7..21; 27..-1] +include::{chapters-path}see-also/_index.adoc[leveloffset=+1, lines=8..22; 28..-1] :sectnums!: -include::{chapters-path}examples/_index.adoc[leveloffset=+1, lines=6..21; 25..-1] +include::{chapters-path}examples/_index.adoc[leveloffset=+1, lines=7..22; 26..-1] :sectnums: diff --git a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc index c3a0404fd0..ef8fec17bf 100644 --- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc +++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 5. The FreeBSD Documentation Build Process prev: books/fdp-primer/structure next: books/fdp-primer/asciidoctor-primer +description: Describes the FreeBSD Documentation Build Process --- [[doc-build]] diff --git a/documentation/content/en/books/fdp-primer/editor-config/_index.adoc b/documentation/content/en/books/fdp-primer/editor-config/_index.adoc index 5f184292dd..6d925d006e 100644 --- a/documentation/content/en/books/fdp-primer/editor-config/_index.adoc +++ b/documentation/content/en/books/fdp-primer/editor-config/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 12. Editor Configuration prev: books/fdp-primer/writing-style next: books/fdp-primer/see-also +description: Configuration used in the texts editors in the FreeBSD Documentation Project --- [[editor-config]] diff --git a/documentation/content/en/books/fdp-primer/examples/_index.adoc b/documentation/content/en/books/fdp-primer/examples/_index.adoc index 65a97518ef..93cb777a0e 100644 --- a/documentation/content/en/books/fdp-primer/examples/_index.adoc +++ b/documentation/content/en/books/fdp-primer/examples/_index.adoc @@ -1,6 +1,7 @@ --- title: Appendix A. Examples prev: books/fdp-primer/see-also/ +description: Example of an article and a book used in the FreeBSD Documentation Project --- [appendix] diff --git a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc index 057e965a9d..292743d612 100644 --- a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc +++ b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 10. Manual Pages prev: books/fdp-primer/po-translations next: books/fdp-primer/writing-style +description: How to work with the FreeBSD Manual Pages --- [[manual-pages]] diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc index ba37cba76e..3fcbd195a8 100644 --- a/documentation/content/en/books/fdp-primer/overview/_index.adoc +++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 1. Overview prev: books/fdp-primer/preface next: books/fdp-primer/tools +description: Overview about the FreeBSD Documentation Process --- [[overview]] diff --git a/documentation/content/en/books/fdp-primer/po-translations/_index.adoc b/documentation/content/en/books/fdp-primer/po-translations/_index.adoc index b38f21a016..3601ce7b74 100644 --- a/documentation/content/en/books/fdp-primer/po-translations/_index.adoc +++ b/documentation/content/en/books/fdp-primer/po-translations/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 9. PO Translations prev: books/fdp-primer/translations next: books/fdp-primer/manual-pages +description: How to work with PO translation in the FreeBSD Documentation Project --- [[po-translations]] diff --git a/documentation/content/en/books/fdp-primer/preface/_index.adoc b/documentation/content/en/books/fdp-primer/preface/_index.adoc index f1ce0a6516..c3db7905f7 100644 --- a/documentation/content/en/books/fdp-primer/preface/_index.adoc +++ b/documentation/content/en/books/fdp-primer/preface/_index.adoc @@ -2,6 +2,7 @@ title: Preface prev: books/fdp-primer/ next: books/fdp-primer/overview +description: Preface about the FreeBSD Documentation Project --- [preface] diff --git a/documentation/content/en/books/fdp-primer/rosetta/_index.adoc b/documentation/content/en/books/fdp-primer/rosetta/_index.adoc index b6221643aa..3bb8298c09 100644 --- a/documentation/content/en/books/fdp-primer/rosetta/_index.adoc +++ b/documentation/content/en/books/fdp-primer/rosetta/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 7. Rosetta Stone prev: books/fdp-primer/asciidoctor-primer next: books/fdp-primer/translations +description: Rosetta Stone with the differences between Docbook and AsciiDoc --- [[rosetta]] diff --git a/documentation/content/en/books/fdp-primer/see-also/_index.adoc b/documentation/content/en/books/fdp-primer/see-also/_index.adoc index 6ab1433f4b..166b3c92ea 100644 --- a/documentation/content/en/books/fdp-primer/see-also/_index.adoc +++ b/documentation/content/en/books/fdp-primer/see-also/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 13. See Also prev: books/fdp-primer/editor-config/ next: books/fdp-primer/examples +description: More information about the FreeBSD Documentation Project --- [[see-also]] diff --git a/documentation/content/en/books/fdp-primer/structure/_index.adoc b/documentation/content/en/books/fdp-primer/structure/_index.adoc index 2f190b6dd2..7973dcd8b6 100644 --- a/documentation/content/en/books/fdp-primer/structure/_index.adoc +++ b/documentation/content/en/books/fdp-primer/structure/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 4. Documentation Directory Structure prev: books/fdp-primer/working-copy next: books/fdp-primer/doc-build +description: Documentation Directory Structure explanation used in the FreeBSD Documentation Project --- [[structure]] diff --git a/documentation/content/en/books/fdp-primer/tools/_index.adoc b/documentation/content/en/books/fdp-primer/tools/_index.adoc index 87f35747ac..9085b010a2 100644 --- a/documentation/content/en/books/fdp-primer/tools/_index.adoc +++ b/documentation/content/en/books/fdp-primer/tools/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 2. Tools prev: books/fdp-primer/overview next: books/fdp-primer/working-copy +description: Tools used in the FreeBSD Documentation Project --- [[tools]] diff --git a/documentation/content/en/books/fdp-primer/translations/_index.adoc b/documentation/content/en/books/fdp-primer/translations/_index.adoc index 897e3d5c67..ea7f0b94c6 100644 --- a/documentation/content/en/books/fdp-primer/translations/_index.adoc +++ b/documentation/content/en/books/fdp-primer/translations/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 8. Translations prev: books/fdp-primer/rosetta next: books/fdp-primer/po-translations +description: FAQ about the translation process in the FreeBSD Documentation Project --- [[translations]] diff --git a/documentation/content/en/books/fdp-primer/working-copy/_index.adoc b/documentation/content/en/books/fdp-primer/working-copy/_index.adoc index b6375a6e55..8a1abedaf8 100644 --- a/documentation/content/en/books/fdp-primer/working-copy/_index.adoc +++ b/documentation/content/en/books/fdp-primer/working-copy/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 3. The Working Copy prev: books/fdp-primer/tools next: books/fdp-primer/structure +description: How to get a working copy of the FreeBSD Documentation Project --- [[working-copy]] diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc index afb1494d6a..71f12ab1c9 100644 --- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc +++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 11. Writing Style prev: books/fdp-primer/manual-pages next: books/fdp-primer/editor-config +description: Writing Style and some conventions used in the FreeBSD Documentation Project --- [[writing-style]] diff --git a/documentation/content/en/books/handbook/_index.adoc b/documentation/content/en/books/handbook/_index.adoc index e22ea09e43..0fdd49727d 100644 --- a/documentation/content/en/books/handbook/_index.adoc +++ b/documentation/content/en/books/handbook/_index.adoc @@ -3,7 +3,7 @@ title: FreeBSD Handbook authors: - author: The FreeBSD Documentation Project copyright: 1995-2021 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +description: FreeBSD Handbook Index trademarks: ["freebsd", "ibm", "ieee", "redhat", "3com", "adobe", "apple", "intel", "linux", "microsoft", "opengroup", "sun", "realnetworks", "oracle", "3ware", "arm", "adaptec", "google", "heidelberger", "intuit", "lsilogic", "themathworks", "thomson", "vmware", "wolframresearch", "xiph", "xfree86", "general"] next: books/handbook/preface --- diff --git a/documentation/content/en/books/handbook/advanced-networking/_index.adoc b/documentation/content/en/books/handbook/advanced-networking/_index.adoc index 76fa248741..33cb761d1c 100644 --- a/documentation/content/en/books/handbook/advanced-networking/_index.adoc +++ b/documentation/content/en/books/handbook/advanced-networking/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 32. Advanced Networking part: IV. Network Communication prev: books/handbook/firewalls next: books/handbook/partv +description: "Advanced networking in FreeBSD: basics of gateways and routes, CARP, how to configure multiple VLANs on FreeBSD, etc" --- [[advanced-networking]] diff --git a/documentation/content/en/books/handbook/audit/_index.adoc b/documentation/content/en/books/handbook/audit/_index.adoc index 0b6ae95166..aa4a1bd746 100644 --- a/documentation/content/en/books/handbook/audit/_index.adoc +++ b/documentation/content/en/books/handbook/audit/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 17. Security Event Auditing part: Part III. System Administration prev: books/handbook/mac next: books/handbook/disks +description: FreeBSD security event auditing supports reliable, fine-grained, and configurable logging of a variety of security-relevant system events, including logins, configuration changes, and file and network access --- [[audit]] diff --git a/documentation/content/en/books/handbook/basics/_index.adoc b/documentation/content/en/books/handbook/basics/_index.adoc index d425efa693..dd2e767f8f 100644 --- a/documentation/content/en/books/handbook/basics/_index.adoc +++ b/documentation/content/en/books/handbook/basics/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 3. FreeBSD basics part: Part I. Getting Started prev: books/handbook/bsdinstall next: books/handbook/ports +description: Basic commands and functionality of the FreeBSD operating system --- [[basics]] diff --git a/documentation/content/en/books/handbook/bibliography/_index.adoc b/documentation/content/en/books/handbook/bibliography/_index.adoc index 3f82a9c331..c86daf08c0 100644 --- a/documentation/content/en/books/handbook/bibliography/_index.adoc +++ b/documentation/content/en/books/handbook/bibliography/_index.adoc @@ -3,6 +3,7 @@ title: Appendix B. Bibliography part: Part V. Appendices prev: books/handbook/mirrors next: books/handbook/eresources +description: FreeBSD Handbook Bibliography --- [appendix] diff --git a/documentation/content/en/books/handbook/book.adoc b/documentation/content/en/books/handbook/book.adoc index e840e6704d..31eec3bed2 100644 --- a/documentation/content/en/books/handbook/book.adoc +++ b/documentation/content/en/books/handbook/book.adoc @@ -3,7 +3,7 @@ title: FreeBSD Handbook authors: - author: The FreeBSD Documentation Project copyright: 1995-2021 The FreeBSD Documentation Project -releaseinfo: "$FreeBSD$" +description: FreeBSD Handbook trademarks: ["freebsd", "ibm", "ieee", "redhat", "3com", "adobe", "apple", "intel", "linux", "microsoft", "opengroup", "sun", "realnetworks", "oracle", "3ware", "arm", "adaptec", "google", "heidelberger", "intuit", "lsilogic", "themathworks", "thomson", "vmware", "wolframresearch", "xiph", "xfree86", "general"] --- @@ -71,97 +71,97 @@ toc::[] :sectnums!: -include::{chapters-path}preface/_index.adoc[leveloffset=+1, lines=7..-1] +include::{chapters-path}preface/_index.adoc[leveloffset=+1, lines=8..-1] :sectnums: // Section one include::{chapters-path}parti.adoc[lines=7..18] -include::{chapters-path}introduction/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}introduction/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}bsdinstall/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}bsdinstall/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}basics/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}basics/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}ports/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}ports/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}x11/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}x11/_index.adoc[leveloffset=+1, lines=8..35;45..-1] // Section two include::{chapters-path}partii.adoc[lines=7..18] -include::{chapters-path}desktop/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}desktop/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}multimedia/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}multimedia/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}kernelconfig/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}kernelconfig/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}printing/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}printing/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}linuxemu/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}linuxemu/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}wine/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}wine/_index.adoc[leveloffset=+1, lines=8..35;45..-1] // Section three include::{chapters-path}partiii.adoc[lines=7..12] -include::{chapters-path}config/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}config/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}boot/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}boot/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}security/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}security/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}jails/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}jails/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}mac/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}mac/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}audit/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}audit/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}disks/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}disks/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}geom/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}geom/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}zfs/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}zfs/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}filesystems/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}filesystems/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}virtualization/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}virtualization/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}l10n/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}l10n/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}cutting-edge/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}cutting-edge/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}dtrace/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}dtrace/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}usb-device-mode/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}usb-device-mode/_index.adoc[leveloffset=+1, lines=8..35;45..-1] // Section four include::{chapters-path}partiv.adoc[lines=7..19] -include::{chapters-path}serialcomms/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}serialcomms/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}ppp-and-slip/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}ppp-and-slip/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}mail/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}mail/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}network-servers/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}network-servers/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}firewalls/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}firewalls/_index.adoc[leveloffset=+1, lines=8..35;45..-1] -include::{chapters-path}advanced-networking/_index.adoc[leveloffset=+1, lines=8..34;44..-1] +include::{chapters-path}advanced-networking/_index.adoc[leveloffset=+1, lines=8..35;45..-1] // Section five include::{chapters-path}partv.adoc[lines=7..8] :sectnums!: -include::{chapters-path}mirrors/_index.adoc[leveloffset=+1, lines=8..21;30..-1] +include::{chapters-path}mirrors/_index.adoc[leveloffset=+1, lines=9..22;31..-1] -include::{chapters-path}bibliography/_index.adoc[leveloffset=+1, lines=8..21;29..-1] +include::{chapters-path}bibliography/_index.adoc[leveloffset=+1, lines=9..22;30..-1] -include::{chapters-path}eresources/_index.adoc[leveloffset=+1, lines=8..21;30..-1] +include::{chapters-path}eresources/_index.adoc[leveloffset=+1, lines=9..22;31..-1] -include::{chapters-path}pgpkeys/_index.adoc[leveloffset=+1, lines=8..21;31..-1] +include::{chapters-path}pgpkeys/_index.adoc[leveloffset=+1, lines=9..22;32..-1] :sectnums: diff --git a/documentation/content/en/books/handbook/boot/_index.adoc b/documentation/content/en/books/handbook/boot/_index.adoc index 6e281e8ab3..35dc1d5156 100644 --- a/documentation/content/en/books/handbook/boot/_index.adoc +++ b/documentation/content/en/books/handbook/boot/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 13. The FreeBSD Booting Process part: Part III. System Administration prev: books/handbook/config next: books/handbook/security +description: An introduction to the FreeBSD Booting Process, demonstrates how to customize the FreeBSD boot process, including everything that happens until the FreeBSD kernel has started, probed for devices, and started init --- [[boot]] diff --git a/documentation/content/en/books/handbook/bsdinstall/_index.adoc b/documentation/content/en/books/handbook/bsdinstall/_index.adoc index dee524f938..f310306e02 100644 --- a/documentation/content/en/books/handbook/bsdinstall/_index.adoc +++ b/documentation/content/en/books/handbook/bsdinstall/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 2. Installing FreeBSD part: Part I. Getting Started prev: books/handbook/introduction next: books/handbook/basics +description: Guide about how to install FreeBSD, the minimum hardware requirements and supported architectures, how to create the installation media, etc --- [[bsdinstall]] diff --git a/documentation/content/en/books/handbook/colophon.adoc b/documentation/content/en/books/handbook/colophon.adoc index 95fad7eb4b..7904bb122f 100644 --- a/documentation/content/en/books/handbook/colophon.adoc +++ b/documentation/content/en/books/handbook/colophon.adoc @@ -1,6 +1,7 @@ --- title: Colophon prev: books/handbook/glossary +description: FreeBSD Handbook Colophon --- [colophon] diff --git a/documentation/content/en/books/handbook/config/_index.adoc b/documentation/content/en/books/handbook/config/_index.adoc index 66173c1ece..146b6a92c1 100644 --- a/documentation/content/en/books/handbook/config/_index.adoc +++ b/documentation/content/en/books/handbook/config/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 12. Configuration and Tuning part: Part III. System Administration prev: books/handbook/partiii next: books/handbook/boot +description: This chapter explains much of the FreeBSD configuration process, including some of the parameters which can be set to tune a FreeBSD system. --- [[config-tuning]] diff --git a/documentation/content/en/books/handbook/cutting-edge/_index.adoc b/documentation/content/en/books/handbook/cutting-edge/_index.adoc index 3cd371ee7c..f3eb818b61 100644 --- a/documentation/content/en/books/handbook/cutting-edge/_index.adoc +++ b/documentation/content/en/books/handbook/cutting-edge/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 24. Updating and Upgrading FreeBSD part: Part III. System Administration prev: books/handbook/l10n next: books/handbook/dtrace +description: Information about how to keep a FreeBSD system up-to-date with freebsd-update or Git, how to rebuild and reinstall the entire base system, etc --- [[updating-upgrading]] diff --git a/documentation/content/en/books/handbook/desktop/_index.adoc b/documentation/content/en/books/handbook/desktop/_index.adoc index 98532722bd..68245d943d 100644 --- a/documentation/content/en/books/handbook/desktop/_index.adoc +++ b/documentation/content/en/books/handbook/desktop/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 6. Desktop Applications part: Part II. Common Tasks prev: books/handbook/partii next: books/handbook/multimedia +description: This chapter demonstrates how to install numerous desktop applications, including web browsers, productivity software, document viewers, and financial software --- [[desktop]] diff --git a/documentation/content/en/books/handbook/disks/_index.adoc b/documentation/content/en/books/handbook/disks/_index.adoc index 4f22ff2772..956450f588 100644 --- a/documentation/content/en/books/handbook/disks/_index.adoc +++ b/documentation/content/en/books/handbook/disks/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 18. Storage part: Part III. System Administration prev: books/handbook/audit next: books/handbook/geom +description: This chapter covers the use of disks and storage media in FreeBSD. This includes SCSI and IDE disks, CD and DVD media, memory-backed disks, and USB storage devices. --- [[disks]] diff --git a/documentation/content/en/books/handbook/dtrace/_index.adoc b/documentation/content/en/books/handbook/dtrace/_index.adoc index d278fa50f0..fad2d49fc5 100644 --- a/documentation/content/en/books/handbook/dtrace/_index.adoc +++ b/documentation/content/en/books/handbook/dtrace/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 25. DTrace part: Part III. System Administration prev: books/handbook/cutting-edge next: books/handbook/usb-device-mode +description: This chapter explains how to use DTrace in FreeBSD --- [[dtrace]] diff --git a/documentation/content/en/books/handbook/eresources/_index.adoc b/documentation/content/en/books/handbook/eresources/_index.adoc index b41d30622d..d2edf0d66b 100644 --- a/documentation/content/en/books/handbook/eresources/_index.adoc +++ b/documentation/content/en/books/handbook/eresources/_index.adoc @@ -3,6 +3,7 @@ title: Appendix C. Resources on the Internet part: Part V. Appendices prev: books/handbook/bibliography next: books/handbook/pgpkeys +description: FreeBSD additional resources on internet like websites, mailing lists, mirrors, etc --- [appendix] diff --git a/documentation/content/en/books/handbook/filesystems/_index.adoc b/documentation/content/en/books/handbook/filesystems/_index.adoc index b517d6458a..3fa8a2cd64 100644 --- a/documentation/content/en/books/handbook/filesystems/_index.adoc +++ b/documentation/content/en/books/handbook/filesystems/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 21. Other File Systems part: Part III. System Administration prev: books/handbook/zfs next: books/handbook/virtualization +description: This chapter shows the other filesystems supported by FreeBSD --- [[filesystems]] diff --git a/documentation/content/en/books/handbook/firewalls/_index.adoc b/documentation/content/en/books/handbook/firewalls/_index.adoc index 0343c2b003..eda3d742cb 100644 --- a/documentation/content/en/books/handbook/firewalls/_index.adoc +++ b/documentation/content/en/books/handbook/firewalls/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 31. Firewalls part: IV. Network Communication prev: books/handbook/network-servers next: books/handbook/advanced-networking +description: "FreeBSD has three firewalls built into the base system: PF, IPFW, and IPFILTER. This chapter covers how to define packet filtering rules, the differences between the firewalls built into FreeBSD and how to use them" --- [[firewalls]] diff --git a/documentation/content/en/books/handbook/geom/_index.adoc b/documentation/content/en/books/handbook/geom/_index.adoc index c09077d153..9d1f99dfe3 100644 --- a/documentation/content/en/books/handbook/geom/_index.adoc +++ b/documentation/content/en/books/handbook/geom/_index.adoc @@ -3,6 +3,7 @@ title: "Chapter 19. GEOM: Modular Disk Transformation Framework" part: Part III. System Administration prev: books/handbook/disks next: books/handbook/zfs +description: In FreeBSD, the GEOM framework permits access and control to classes, such as Master Boot Records and BSD labels, through the use of providers, or the disk devices in /dev. --- [[geom]] diff --git a/documentation/content/en/books/handbook/glossary.adoc b/documentation/content/en/books/handbook/glossary.adoc index 20b6323a1c..2a6c755a35 100644 --- a/documentation/content/en/books/handbook/glossary.adoc +++ b/documentation/content/en/books/handbook/glossary.adoc @@ -2,6 +2,7 @@ title: FreeBSD Glossary prev: books/handbook/pgpkeys next: books/handbook/colophon +description: FreeBSD Handbook Glossary --- [glossary] diff --git a/documentation/content/en/books/handbook/introduction/_index.adoc b/documentation/content/en/books/handbook/introduction/_index.adoc index 06ba49148b..423c6e428f 100644 --- a/documentation/content/en/books/handbook/introduction/_index.adoc +++ b/documentation/content/en/books/handbook/introduction/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 1. Introduction part: Part I. Getting Started prev: books/handbook/parti next: books/handbook/bsdinstall +description: This chapter covers various aspects of the FreeBSD Project, such as its history, goals, development model, and so on --- [[introduction]] diff --git a/documentation/content/en/books/handbook/jails/_index.adoc b/documentation/content/en/books/handbook/jails/_index.adoc index 6c636f4176..d55839a785 100644 --- a/documentation/content/en/books/handbook/jails/_index.adoc +++ b/documentation/content/en/books/handbook/jails/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 15. Jails part: Part III. System Administration prev: books/handbook/security next: books/handbook/mac +description: Jails improve on the concept of the traditional chroot environment in several ways --- [[jails]] diff --git a/documentation/content/en/books/handbook/kernelconfig/_index.adoc b/documentation/content/en/books/handbook/kernelconfig/_index.adoc index 61e173ed84..5be666a641 100644 --- a/documentation/content/en/books/handbook/kernelconfig/_index.adoc +++ b/documentation/content/en/books/handbook/kernelconfig/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 8. Configuring the FreeBSD Kernel part: Part II. Common Tasks prev: books/handbook/multimedia next: books/handbook/printing +description: This chapter covers how to configure the FreeBSD Kernel. When to build a custom kernel, how to take a hardware inventory, how to customize a kernel configuration file, etc --- [[kernelconfig]] diff --git a/documentation/content/en/books/handbook/l10n/_index.adoc b/documentation/content/en/books/handbook/l10n/_index.adoc index 17e19a2393..d422996c82 100644 --- a/documentation/content/en/books/handbook/l10n/_index.adoc +++ b/documentation/content/en/books/handbook/l10n/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 23. Localization - i18n/L10n Usage and Setup part: Part III. System Administration prev: books/handbook/virtualization next: books/handbook/cutting-edge +description: FreeBSD supports localization into many languages, allowing users to view, input, or process data in non-English languages --- [[l10n]] diff --git a/documentation/content/en/books/handbook/linuxemu/_index.adoc b/documentation/content/en/books/handbook/linuxemu/_index.adoc index d82ee1858f..8ce8274cd5 100644 --- a/documentation/content/en/books/handbook/linuxemu/_index.adoc +++ b/documentation/content/en/books/handbook/linuxemu/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 10. Linux® Binary Compatibility part: Part II. Common Tasks prev: books/handbook/printing next: books/handbook/wine +description: FreeBSD provides binary compatibility with Linux®, allowing users to install and run most Linux® binaries on a FreeBSD system without having to first modify the binary --- [[linuxemu]] diff --git a/documentation/content/en/books/handbook/mail/_index.adoc b/documentation/content/en/books/handbook/mail/_index.adoc index d603424c36..e7d1d8f0e1 100644 --- a/documentation/content/en/books/handbook/mail/_index.adoc +++ b/documentation/content/en/books/handbook/mail/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 29. Electronic Mail part: IV. Network Communication prev: books/handbook/ppp-and-slip next: books/handbook/network-servers +description: This chapter provides a basic introduction to running a mail server on FreeBSD, as well as an introduction to sending and receiving email using FreeBSD --- [[mail]] diff --git a/documentation/content/en/books/handbook/mirrors/_index.adoc b/documentation/content/en/books/handbook/mirrors/_index.adoc index b4187c2139..2f1f895a81 100644 --- a/documentation/content/en/books/handbook/mirrors/_index.adoc +++ b/documentation/content/en/books/handbook/mirrors/_index.adoc @@ -3,6 +3,7 @@ title: Appendix A. Obtaining FreeBSD part: Part V. Appendices prev: books/handbook/partv next: books/handbook/bibliography +description: "How to get FreeBSD: CD and DVD sets, FTP sites and how to install and use Git" --- [appendix] diff --git a/documentation/content/en/books/handbook/multimedia/_index.adoc b/documentation/content/en/books/handbook/multimedia/_index.adoc index a586b57e68..847f2d800e 100644 --- a/documentation/content/en/books/handbook/multimedia/_index.adoc +++ b/documentation/content/en/books/handbook/multimedia/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 7. Multimedia part: Part II. Common Tasks prev: books/handbook/desktop next: books/handbook/kernelconfig +description: FreeBSD supports a wide variety of sound cards, allowing users to enjoy high fidelity output from a FreeBSD system --- [[multimedia]] diff --git a/documentation/content/en/books/handbook/network-servers/_index.adoc b/documentation/content/en/books/handbook/network-servers/_index.adoc index 092271bf56..a3fdacf0b8 100644 --- a/documentation/content/en/books/handbook/network-servers/_index.adoc +++ b/documentation/content/en/books/handbook/network-servers/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 30. Network Servers part: IV. Network Communication prev: books/handbook/mail next: books/handbook/firewalls +description: This chapter covers some of the more frequently used network services on UNIX systems --- [[network-servers]] diff --git a/documentation/content/en/books/handbook/pgpkeys/_index.adoc b/documentation/content/en/books/handbook/pgpkeys/_index.adoc index e569fc5d9a..07c45357cb 100644 --- a/documentation/content/en/books/handbook/pgpkeys/_index.adoc +++ b/documentation/content/en/books/handbook/pgpkeys/_index.adoc @@ -3,6 +3,7 @@ title: Appendix D. OpenPGP Keys part: Part V. Appendices prev: books/handbook/eresources next: books/handbook/glossary +description: List of OpenPGP keys of the FreeBSD officers are shown here --- [appendix] diff --git a/documentation/content/en/books/handbook/ports/_index.adoc b/documentation/content/en/books/handbook/ports/_index.adoc index cd49ab7eb9..26af9c7292 100644 --- a/documentation/content/en/books/handbook/ports/_index.adoc +++ b/documentation/content/en/books/handbook/ports/_index.adoc @@ -3,6 +3,7 @@ title: "Chapter 4. Installing Applications: Packages and Ports" part: Part I. Getting Started prev: books/handbook/basics next: books/handbook/x11 +description: "FreeBSD provides two complementary technologies for installing third-party software: the FreeBSD Ports Collection, for installing from source, and packages, for installing from pre-built binaries" --- [[ports]] diff --git a/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc b/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc index 0292741014..95ec634319 100644 --- a/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc +++ b/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 28. PPP part: IV. Network Communication prev: books/handbook/serialcomms next: books/handbook/mail +description: FreeBSD supports the Point-to-Point (PPP) protocol which can be used to establish a network or Internet connection using a dial-up modem --- [[ppp-and-slip]] diff --git a/documentation/content/en/books/handbook/preface/_index.adoc b/documentation/content/en/books/handbook/preface/_index.adoc index 1c0216159b..0458e59d58 100644 --- a/documentation/content/en/books/handbook/preface/_index.adoc +++ b/documentation/content/en/books/handbook/preface/_index.adoc @@ -2,6 +2,7 @@ title: Preface prev: books/handbook/ next: books/handbook/parti +description: The FreeBSD newcomer will find that the first section of this book guides the user through the FreeBSD installation process and gently introduces the concepts and conventions that underpin UNIX --- [preface] diff --git a/documentation/content/en/books/handbook/printing/_index.adoc b/documentation/content/en/books/handbook/printing/_index.adoc index d475e637ce..3f2cf4bb17 100644 --- a/documentation/content/en/books/handbook/printing/_index.adoc +++ b/documentation/content/en/books/handbook/printing/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 9. Printing part: Part II. Common Tasks prev: books/handbook/kernelconfig next: books/handbook/linuxemu +description: This chapter covers the printing system in FreeBSD --- [[printing]] diff --git a/documentation/content/en/books/handbook/security/_index.adoc b/documentation/content/en/books/handbook/security/_index.adoc index 8c194efdac..461f532239 100644 --- a/documentation/content/en/books/handbook/security/_index.adoc +++ b/documentation/content/en/books/handbook/security/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 14. Security part: Part III. System Administration prev: books/handbook/boot next: books/handbook/jails +description: Hundreds of standard practices have been authored about how to secure systems and networks, and as a user of FreeBSD, understanding how to protect against attacks and intruders is a must --- [[security]] diff --git a/documentation/content/en/books/handbook/serialcomms/_index.adoc b/documentation/content/en/books/handbook/serialcomms/_index.adoc index f461ff723c..4c5ca164df 100644 --- a/documentation/content/en/books/handbook/serialcomms/_index.adoc +++ b/documentation/content/en/books/handbook/serialcomms/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 27. Serial Communications part: Part IV. Network Communication prev: books/handbook/partiv next: books/handbook/ppp-and-slip +description: This chapter covers some of the ways serial communications can be used on FreeBSD --- [[serialcomms]] diff --git a/documentation/content/en/books/handbook/usb-device-mode/_index.adoc b/documentation/content/en/books/handbook/usb-device-mode/_index.adoc index a0a2d2baba..938425a6b0 100644 --- a/documentation/content/en/books/handbook/usb-device-mode/_index.adoc +++ b/documentation/content/en/books/handbook/usb-device-mode/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 26. USB Device Mode / USB OTG part: Part III. System Administration prev: books/handbook/dtrace next: books/handbook/partiv +description: This chapter covers the use of USB Device Mode and USB On The Go (USB OTG) in FreeBSD --- [[usb-device-mode]] diff --git a/documentation/content/en/books/handbook/virtualization/_index.adoc b/documentation/content/en/books/handbook/virtualization/_index.adoc index 235485fbc4..a36bc3550e 100644 --- a/documentation/content/en/books/handbook/virtualization/_index.adoc +++ b/documentation/content/en/books/handbook/virtualization/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 22. Virtualization part: Part III. System Administration prev: books/handbook/filesystems next: books/handbook/l10n +description: Virtualization software allows multiple operating systems to run simultaneously on the same computer --- [[virtualization]] diff --git a/documentation/content/en/books/handbook/wine/_index.adoc b/documentation/content/en/books/handbook/wine/_index.adoc index 9cf6a58e7c..39d3d8cab3 100644 --- a/documentation/content/en/books/handbook/wine/_index.adoc +++ b/documentation/content/en/books/handbook/wine/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 11. WINE part: Part II. Common Tasks prev: books/handbook/linuxemu next: books/handbook/partiii +description: This chapter will describe how to install WINE on a FreeBSD system and how to configure WINE --- [[wine]] diff --git a/documentation/content/en/books/handbook/x11/_index.adoc b/documentation/content/en/books/handbook/x11/_index.adoc index 81365c5356..a925660070 100644 --- a/documentation/content/en/books/handbook/x11/_index.adoc +++ b/documentation/content/en/books/handbook/x11/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 5. The X Window System part: Part I. Getting Started prev: books/handbook/ports next: books/handbook/partii +description: This chapter describes how to install and configure Xorg on FreeBSD, which provides the open source X Window System used to provide a graphical environment --- [[x11]] diff --git a/documentation/content/en/books/handbook/zfs/_index.adoc b/documentation/content/en/books/handbook/zfs/_index.adoc index 66aaafc27f..f1e890bcdf 100644 --- a/documentation/content/en/books/handbook/zfs/_index.adoc +++ b/documentation/content/en/books/handbook/zfs/_index.adoc @@ -3,6 +3,7 @@ title: Chapter 20. The Z File System (ZFS) part: Part III. System Administration prev: books/handbook/geom next: books/handbook/filesystems +description: The Z File System, or ZFS, is an advanced file system designed to overcome many of the major problems found in previous designs --- [[zfs]] diff --git a/documentation/content/en/books/porters-handbook/_index.adoc b/documentation/content/en/books/porters-handbook/_index.adoc index 0a2f7a0c11..60a9df7f8a 100644 --- a/documentation/content/en/books/porters-handbook/_index.adoc +++ b/documentation/content/en/books/porters-handbook/_index.adoc @@ -2,7 +2,8 @@ title: FreeBSD Porter's Handbook authors: - author: The FreeBSD Documentation Project -copyright: 2000-2020 The FreeBSD Documentation Project +copyright: 2000-2021 The FreeBSD Documentation Project +description: FreeBSD Porter's Handbook Index trademarks: ["freebsd", "sun", "unix", "general"] next: books/porters-handbook/porting-why --- diff --git a/documentation/content/en/books/porters-handbook/book.adoc b/documentation/content/en/books/porters-handbook/book.adoc index 3c56e705f4..3b9c23bffa 100644 --- a/documentation/content/en/books/porters-handbook/book.adoc +++ b/documentation/content/en/books/porters-handbook/book.adoc @@ -2,7 +2,8 @@ title: FreeBSD Porter's Handbook authors: - author: The FreeBSD Documentation Project -copyright: 2000-2020 The FreeBSD Documentation Project +copyright: 2000-2021 The FreeBSD Documentation Project +description: FreeBSD Porter's Handbook trademarks: ["freebsd", "sun", "unix", "general"] --- @@ -61,21 +62,21 @@ include::{chapters-path}toc-tables.adoc[] include::{chapters-path}toc-examples.adoc[] -include::{chapters-path}porting-why/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}new-port/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}quick-porting/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}slow-porting/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}makefiles/_index.adoc[leveloffset=+1, lines=7..22;33..-1] -include::{chapters-path}special/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}flavors/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}plist/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}pkg-files/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}testing/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}upgrading/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}security/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}porting-dads/_index.adoc[leveloffset=+1, lines=7..23;34..-1] -include::{chapters-path}porting-samplem/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}order/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}keeping-up/_index.adoc[leveloffset=+1, lines=7..21;32..-1] -include::{chapters-path}uses/_index.adoc[leveloffset=+1, lines=7..22;33..-1] -include::{chapters-path}versions/_index.adoc[leveloffset=+1, lines=6..20;31..-1] +include::{chapters-path}porting-why/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}new-port/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}quick-porting/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}slow-porting/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}makefiles/_index.adoc[leveloffset=+1, lines=8..23;34..-1] +include::{chapters-path}special/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}flavors/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}plist/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}pkg-files/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}testing/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}upgrading/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}security/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}porting-dads/_index.adoc[leveloffset=+1, lines=8..24;35..-1] +include::{chapters-path}porting-samplem/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}order/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}keeping-up/_index.adoc[leveloffset=+1, lines=8..22;33..-1] +include::{chapters-path}uses/_index.adoc[leveloffset=+1, lines=8..23;34..-1] +include::{chapters-path}versions/_index.adoc[leveloffset=+1, lines=7..21;32..-1] diff --git a/documentation/content/en/books/porters-handbook/flavors/_index.adoc b/documentation/content/en/books/porters-handbook/flavors/_index.adoc index 0e540c204d..660d4bc0c1 100644 --- a/documentation/content/en/books/porters-handbook/flavors/_index.adoc +++ b/documentation/content/en/books/porters-handbook/flavors/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 7. Flavors prev: books/porters-handbook/special next: books/porters-handbook/plist +description: Flavors are a way to have multiple variations of a port --- [[flavors]] diff --git a/documentation/content/en/books/porters-handbook/keeping-up/_index.adoc b/documentation/content/en/books/porters-handbook/keeping-up/_index.adoc index 90929c9877..11396904ac 100644 --- a/documentation/content/en/books/porters-handbook/keeping-up/_index.adoc +++ b/documentation/content/en/books/porters-handbook/keeping-up/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 16. Keeping Up prev: books/porters-handbook/order next: books/porters-handbook/uses +description: How to keep up the FreeBSD Ports Collection --- [[keeping-up]] diff --git a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc index 99a66179dd..7cf6fc4f9a 100644 --- a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc +++ b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 5. Configuring the Makefile prev: books/porters-handbook/slow-porting next: books/porters-handbook/special +description: Configuring the Makefile for FreeBSD Ports --- [[makefiles]] diff --git a/documentation/content/en/books/porters-handbook/new-port/_index.adoc b/documentation/content/en/books/porters-handbook/new-port/_index.adoc index 32eee5a9ea..ae040fb893 100644 --- a/documentation/content/en/books/porters-handbook/new-port/_index.adoc +++ b/documentation/content/en/books/porters-handbook/new-port/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 2. Making a New Port prev: books/porters-handbook/porting-why next: books/porters-handbook/quick-porting +description: How to make a new FreeBSD Port --- [[own-port]] diff --git a/documentation/content/en/books/porters-handbook/order/_index.adoc b/documentation/content/en/books/porters-handbook/order/_index.adoc index 0802c2e28a..171a802641 100644 --- a/documentation/content/en/books/porters-handbook/order/_index.adoc +++ b/documentation/content/en/books/porters-handbook/order/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 15. Order of Variables in Port Makefiles prev: books/porters-handbook/porting-samplem next: books/porters-handbook/keeping-up +description: Order of Variables in FreeBSD Port Makefiles --- [[porting-order]] diff --git a/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc b/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc index 9a8bd74cea..500f45c63f 100644 --- a/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc +++ b/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 9. pkg-* prev: books/porters-handbook/plist next: books/porters-handbook/testing +description: Tricks about the pkg-* files --- [[pkg-files]] diff --git a/documentation/content/en/books/porters-handbook/plist/_index.adoc b/documentation/content/en/books/porters-handbook/plist/_index.adoc index e1868a6f4f..765544a7b1 100644 --- a/documentation/content/en/books/porters-handbook/plist/_index.adoc +++ b/documentation/content/en/books/porters-handbook/plist/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 8. Advanced pkg-plist Practices prev: books/porters-handbook/flavors next: books/porters-handbook/pkg-files +description: Advanced pkg-plist Practices --- [[plist]] diff --git a/documentation/content/en/books/porters-handbook/porting-dads/_index.adoc b/documentation/content/en/books/porters-handbook/porting-dads/_index.adoc index abb3fcbdd9..03e9c7ff29 100644 --- a/documentation/content/en/books/porters-handbook/porting-dads/_index.adoc +++ b/documentation/content/en/books/porters-handbook/porting-dads/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 13. Dos and Don'ts prev: books/porters-handbook/security next: books/porters-handbook/porting-samplem +description: A list of common dos and don'ts that are encountered during the FreeBSD porting process --- [[porting-dads]] diff --git a/documentation/content/en/books/porters-handbook/porting-samplem/_index.adoc b/documentation/content/en/books/porters-handbook/porting-samplem/_index.adoc index 0307f18a51..6cc090c65c 100644 --- a/documentation/content/en/books/porters-handbook/porting-samplem/_index.adoc +++ b/documentation/content/en/books/porters-handbook/porting-samplem/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 14. A Sample Makefile prev: books/porters-handbook/porting-dads next: books/porters-handbook/order +description: A sample Makefile that can be used to create a new FreeBSD Port --- [[porting-samplem]] diff --git a/documentation/content/en/books/porters-handbook/porting-why/_index.adoc b/documentation/content/en/books/porters-handbook/porting-why/_index.adoc index 66ee06036a..87ee609d9d 100644 --- a/documentation/content/en/books/porters-handbook/porting-why/_index.adoc +++ b/documentation/content/en/books/porters-handbook/porting-why/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 1. Introduction prev: books/porters-handbook/ next: books/porters-handbook/new-port +description: Why port a program to the FreeBSD Ports Collection --- [[why-port]] diff --git a/documentation/content/en/books/porters-handbook/quick-porting/_index.adoc b/documentation/content/en/books/porters-handbook/quick-porting/_index.adoc index 5f587c54e9..95c4e3efe3 100644 --- a/documentation/content/en/books/porters-handbook/quick-porting/_index.adoc +++ b/documentation/content/en/books/porters-handbook/quick-porting/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 3. Quick Porting prev: books/porters-handbook/new-port next: books/porters-handbook/slow-porting +description: How to quickly create a new FreeBSD Port --- [[quick-porting]] diff --git a/documentation/content/en/books/porters-handbook/security/_index.adoc b/documentation/content/en/books/porters-handbook/security/_index.adoc index d2919d9774..9e5c3d7790 100644 --- a/documentation/content/en/books/porters-handbook/security/_index.adoc +++ b/documentation/content/en/books/porters-handbook/security/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 12. Security prev: books/porters-handbook/upgrading next: books/porters-handbook/porting-dads +description: Security instructions when making a FreeBSD Port --- [[security]] diff --git a/documentation/content/en/books/porters-handbook/slow-porting/_index.adoc b/documentation/content/en/books/porters-handbook/slow-porting/_index.adoc index 4146408768..f61c4f2135 100644 --- a/documentation/content/en/books/porters-handbook/slow-porting/_index.adoc +++ b/documentation/content/en/books/porters-handbook/slow-porting/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 4. Slow Porting prev: books/porters-handbook/quick-porting next: books/porters-handbook/makefiles +description: Description about creating a FreeBSD Port when the program need some modifications --- [[slow-porting]] diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc index 71a35cd0ef..e5fb6ec03a 100644 --- a/documentation/content/en/books/porters-handbook/special/_index.adoc +++ b/documentation/content/en/books/porters-handbook/special/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 6. Special Considerations prev: books/porters-handbook/makefiles next: books/porters-handbook/flavors +description: Special considerations when creating a new FreeBSD Port --- [[special]] diff --git a/documentation/content/en/books/porters-handbook/testing/_index.adoc b/documentation/content/en/books/porters-handbook/testing/_index.adoc index c23adf3a17..eb569e32f6 100644 --- a/documentation/content/en/books/porters-handbook/testing/_index.adoc +++ b/documentation/content/en/books/porters-handbook/testing/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 10. Testing the Port prev: books/porters-handbook/pkg-files next: books/porters-handbook/upgrading +description: Testing a FreeBSD Port --- [[testing]] diff --git a/documentation/content/en/books/porters-handbook/upgrading/_index.adoc b/documentation/content/en/books/porters-handbook/upgrading/_index.adoc index 69b161d486..1dde7f32e8 100644 --- a/documentation/content/en/books/porters-handbook/upgrading/_index.adoc +++ b/documentation/content/en/books/porters-handbook/upgrading/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 11. Upgrading a Port prev: books/porters-handbook/testing next: books/porters-handbook/security +description: Upgrading a FreeBSD Port --- [[port-upgrading]] diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc index fcfdfc1d46..6359e4867b 100644 --- a/documentation/content/en/books/porters-handbook/uses/_index.adoc +++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc @@ -2,6 +2,7 @@ title: Chapter 17. Using USES Macros prev: books/porters-handbook/keeping-up next: books/porters-handbook/versions +description: USES macros make it easy to declare requirements and settings for a FreeBSD Port --- [[uses]] diff --git a/documentation/content/en/books/porters-handbook/versions/_index.adoc b/documentation/content/en/books/porters-handbook/versions/_index.adoc index 906490dfb9..463c577fad 100644 --- a/documentation/content/en/books/porters-handbook/versions/_index.adoc +++ b/documentation/content/en/books/porters-handbook/versions/_index.adoc @@ -1,6 +1,7 @@ --- title: Chapter 18. __FreeBSD_version Values prev: books/porters-handbook/uses +description: A list of changes into the sys/param.h file --- [[versions]] diff --git a/documentation/themes/beastie/layouts/articles/baseof.html b/documentation/themes/beastie/layouts/articles/baseof.html index 08af64b0f0..f0dc57dcc3 100644 --- a/documentation/themes/beastie/layouts/articles/baseof.html +++ b/documentation/themes/beastie/layouts/articles/baseof.html @@ -2,10 +2,12 @@ - + + + - + {{ block "title" . }}{{ with .Params.Title }} {{ . }}{{ end }}{{ end }} diff --git a/documentation/themes/beastie/layouts/books/baseof.html b/documentation/themes/beastie/layouts/books/baseof.html index 08af64b0f0..f0dc57dcc3 100644 --- a/documentation/themes/beastie/layouts/books/baseof.html +++ b/documentation/themes/beastie/layouts/books/baseof.html @@ -2,10 +2,12 @@ - + + + - + {{ block "title" . }}{{ with .Params.Title }} {{ . }}{{ end }}{{ end }} diff --git a/documentation/themes/beastie/layouts/partials/site-head.html b/documentation/themes/beastie/layouts/partials/site-head.html index 489f8114fc..5242f76004 100644 --- a/documentation/themes/beastie/layouts/partials/site-head.html +++ b/documentation/themes/beastie/layouts/partials/site-head.html @@ -1,11 +1,11 @@ - - - + + + - {{ block "title" . }}{{ .Site.Title }} {{ with .Params.Title }} | {{ . }}{{ end }}{{ end }} + {{ block "title" . }}{{ .Site.Title }}{{ with .Params.Title }} | {{ . }}{{ end }}{{ end }}