diff options
Diffstat (limited to 'documentation/content/en/books')
21 files changed, 51 insertions, 51 deletions
diff --git a/documentation/content/en/books/arch-handbook/_index.adoc b/documentation/content/en/books/arch-handbook/_index.adoc index 7124ef877e..85f45ef41c 100644 --- a/documentation/content/en/books/arch-handbook/_index.adoc +++ b/documentation/content/en/books/arch-handbook/_index.adoc @@ -1,6 +1,6 @@ --- title: FreeBSD Architecture Handbook -authors: +authors: - author: The FreeBSD Documentation Project copyright: 2000-2006, 2012-2023 The FreeBSD Documentation Project description: For FreeBSD system developers. This book covers the architectural details of many important FreeBSD kernel subsystems @@ -51,6 +51,6 @@ Abstract Welcome to the FreeBSD Architecture Handbook. This manual is a _work in progress_ and is the work of many individuals. Many sections do not yet exist and some of those that do exist need to be updated. If you are interested in helping with this project, send email to the {freebsd-doc}. -The latest version of this document is always available from the link:https://www.FreeBSD.org/[FreeBSD World Wide Web server]. It may also be downloaded in a variety of formats and compression options from the https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}[mirror sites, mirrors]. +The latest version of this document is always available from the link:https://www.FreeBSD.org/[FreeBSD World Wide Web server]. It may also be downloaded in a variety of formats and compression options from the https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}mirrors[mirror sites, mirrors]. ''' diff --git a/documentation/content/en/books/arch-handbook/book.adoc b/documentation/content/en/books/arch-handbook/book.adoc index 3273926895..14d618f830 100644 --- a/documentation/content/en/books/arch-handbook/book.adoc +++ b/documentation/content/en/books/arch-handbook/book.adoc @@ -1,6 +1,6 @@ --- title: FreeBSD Architecture Handbook -authors: +authors: - author: The FreeBSD Documentation Project copyright: 2000-2006, 2012-2023 The FreeBSD Documentation Project description: For FreeBSD system developers. This book covers the architectural details of many important FreeBSD kernel subsystems @@ -49,7 +49,7 @@ Abstract Welcome to the FreeBSD Architecture Handbook. This manual is a _work in progress_ and is the work of many individuals. Many sections do not yet exist and some of those that do exist need to be updated. If you are interested in helping with this project, send email to the {freebsd-doc}. -The latest version of this document is always available from the link:https://www.FreeBSD.org/[FreeBSD World Wide Web server]. It may also be downloaded in a variety of formats and compression options from the https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}[mirror sites, mirrors]. +The latest version of this document is always available from the link:https://www.FreeBSD.org/[FreeBSD World Wide Web server]. It may also be downloaded in a variety of formats and compression options from the https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}mirrors[mirror sites, mirrors]. ''' diff --git a/documentation/content/en/books/arch-handbook/boot/_index.adoc b/documentation/content/en/books/arch-handbook/boot/_index.adoc index 9065a9a183..8508f6f116 100644 --- a/documentation/content/en/books/arch-handbook/boot/_index.adoc +++ b/documentation/content/en/books/arch-handbook/boot/_index.adoc @@ -258,7 +258,7 @@ start: .[.filename]#stand/i386/boot0/boot0.S# [[boot-boot0-entrypoint]] This first block of code is the entry point of the program. It is where the BIOS transfers control. -First, it makes sure that the string operations autoincrement its pointer operands (the `cld` instruction) footnote:[When in doubt, we refer the reader to the official Intel manuals, which describe the exact semantics for each instruction: .]. +First, it makes sure that the string operations autoincrement its pointer operands (the `cld` instruction) footnote:[When in doubt, we refer the reader to the official Intel manuals, which describe the exact semantics for each instruction.]. Then, as it makes no assumption about the state of the segment registers, it initializes them. Finally, it sets the stack pointer register (`%sp`) to ($LOAD = address `0x7c00`), so we have a working stack. @@ -719,8 +719,8 @@ The code after the call to `nread` locates the beginning of [.filename]#boot2# i This is because the BTX server arranges [.filename]#boot2# to execute in a segment starting at `0xa000`. We explore this in detail in the following section. -The last code block of [.filename]#boot1# enables access to memory above 1MB footnote:[This is necessary for legacy reasons. -Interested readers should see .] and concludes with a jump to the starting point of the BTX server: +The last code block of [.filename]#boot1# enables access to memory above 1MB footnote:[This is necessary for legacy reasons.] +and concludes with a jump to the starting point of the BTX server: [.programlisting] .... @@ -1530,7 +1530,7 @@ sys/kern/init_main.c: } .... -Although the sysinit framework is described in the link:/books/developers-handbook[Developers' Handbook], I will discuss the internals of it. +Although the sysinit framework is described in the extref:{developers-handbook}[Developers' Handbook], I will discuss the internals of it. Every system initialization object (sysinit object) is created by calling a SYSINIT() macro. Let us take as example an `announce` sysinit object. diff --git a/documentation/content/en/books/arch-handbook/jail/_index.adoc b/documentation/content/en/books/arch-handbook/jail/_index.adoc index a77ce2ae10..734b224060 100644 --- a/documentation/content/en/books/arch-handbook/jail/_index.adoc +++ b/documentation/content/en/books/arch-handbook/jail/_index.adoc @@ -50,7 +50,7 @@ endif::[] On most UNIX(R) systems, `root` has omnipotent power. This promotes insecurity. If an attacker gained `root` on a system, he would have every function at his fingertips. In FreeBSD there are sysctls which dilute the power of `root`, in order to minimize the damage caused by an attacker. Specifically, one of these functions is called `secure levels`. Similarly, another function which is present from FreeBSD 4.0 and onward, is a utility called man:jail[8]. Jail chroots an environment and sets certain restrictions on processes which are forked within the jail. For example, a jailed process cannot affect processes outside the jail, utilize certain system calls, or inflict any damage on the host environment. -Jail is becoming the new security model. People are running potentially vulnerable servers such as Apache, BIND, and sendmail within jails, so that if an attacker gains `root` within the jail, it is only an annoyance, and not a devastation. This article mainly focuses on the internals (source code) of jail. For information on how to set up a jail see the extref:{handbook}[handbook entry on jails, jails]. +Jail is becoming the new security model. People are running potentially vulnerable servers such as Apache, BIND, and sendmail within jails, so that if an attacker gains `root` within the jail, it is only an annoyance, and not a devastation. This article mainly focuses on the internals (source code) of jail. For information on how to set up a jail see the extref:{handbook}jails[handbook entry on jails, jails]. [[jail-arch]] == Architecture diff --git a/documentation/content/en/books/arch-handbook/sound/_index.adoc b/documentation/content/en/books/arch-handbook/sound/_index.adoc index 395cade887..f7a7d6c19f 100644 --- a/documentation/content/en/books/arch-handbook/sound/_index.adoc +++ b/documentation/content/en/books/arch-handbook/sound/_index.adoc @@ -152,7 +152,7 @@ When playing, the general transfer mechanism is as follows (reverse the idea for ==== channel_init `xxxchannel_init()` is called to initialize each of the play or record channels. -The calls are initiated from the sound driver attach routine. (See the crossref:sound[pcm-probe-and-attach,probe and attach section). +The calls are initiated from the sound driver attach routine. (See the crossref:sound[pcm-probe-and-attach,probe and attach section]). [.programlisting] .... diff --git a/documentation/content/en/books/arch-handbook/usb/_index.adoc b/documentation/content/en/books/arch-handbook/usb/_index.adoc index 94a22e850b..a1c8f2b579 100644 --- a/documentation/content/en/books/arch-handbook/usb/_index.adoc +++ b/documentation/content/en/books/arch-handbook/usb/_index.adoc @@ -65,7 +65,7 @@ _Lennart Augustsson has done most of the implementation of the USB support for t The development of drivers for the USB subsystem and devices connected to it is supported by the specifications that have been developed and will be developed. These specifications are publicly available from the USB home pages. Apple has been very strong in pushing for standards based drivers, by making drivers for the generic classes available in their operating system MacOS and discouraging the use of separate drivers for each new device. This chapter tries to collate essential information for a basic understanding of the USB 2.0 implementation stack in FreeBSD/NetBSD. It is recommended however to read it together with the relevant 2.0 specifications and other developer resources: * USB 2.0 Specification (http://www.usb.org/developers/docs/usb20_docs/[http://www.usb.org/developers/docs/usb20_docs/]) -* Universal Host Controller Interface (UHCI) Specification (link:ftp://ftp.netbsd.org/pub/NetBSD/misc/blymn/uhci11d.pdf[ftp://ftp.netbsd.org/pub/NetBSD/misc/blymn/uhci11d.pdf)] +* Universal Host Controller Interface (UHCI) Specification (link:ftp://ftp.netbsd.org/pub/NetBSD/misc/blymn/uhci11d.pdf[ftp://ftp.netbsd.org/pub/NetBSD/misc/blymn/uhci11d.pdf]) * Open Host Controller Interface (OHCI) Specification(link:ftp://ftp.compaq.com/pub/supportinformation/papers/hcir1_0a.pdf[ftp://ftp.compaq.com/pub/supportinformation/papers/hcir1_0a.pdf]) * Developer section of USB home page (http://www.usb.org/developers/[http://www.usb.org/developers/]) diff --git a/documentation/content/en/books/developers-handbook/_index.adoc b/documentation/content/en/books/developers-handbook/_index.adoc index b25ae41a62..b4979f3a2f 100644 --- a/documentation/content/en/books/developers-handbook/_index.adoc +++ b/documentation/content/en/books/developers-handbook/_index.adoc @@ -55,6 +55,6 @@ Many sections do not yet exist and some of those that do exist need to be update If you are interested in helping with this project, send email to the {freebsd-doc}. The latest version of this document is always available from the link:https://www.FreeBSD.org[FreeBSD World Wide Web server]. -It may also be downloaded in a variety of formats and compression options from the link:https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}[mirror sites, mirrors]. +It may also be downloaded in a variety of formats and compression options from the link:https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}mirrors[mirror sites, mirrors]. ''' diff --git a/documentation/content/en/books/developers-handbook/book.adoc b/documentation/content/en/books/developers-handbook/book.adoc index 63a89edddc..510467b290 100644 --- a/documentation/content/en/books/developers-handbook/book.adoc +++ b/documentation/content/en/books/developers-handbook/book.adoc @@ -53,7 +53,7 @@ Many sections do not yet exist and some of those that do exist need to be update If you are interested in helping with this project, send email to the {freebsd-doc}. The latest version of this document is always available from the link:https://www.FreeBSD.org[FreeBSD World Wide Web server]. -It may also be downloaded in a variety of formats and compression options from the link:https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}[mirror sites, mirrors]. +It may also be downloaded in a variety of formats and compression options from the link:https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}mirrors[mirror sites, mirrors]. ''' diff --git a/documentation/content/en/books/developers-handbook/ipv6/_index.adoc b/documentation/content/en/books/developers-handbook/ipv6/_index.adoc index a97feddf59..e80cf22dbd 100644 --- a/documentation/content/en/books/developers-handbook/ipv6/_index.adoc +++ b/documentation/content/en/books/developers-handbook/ipv6/_index.adoc @@ -80,7 +80,7 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[ ** IPv4 compatible address is not supported. ** automatic tunneling (described in 4.3 of this RFC) is not supported. ** man:gif[4] interface implements IPv[46]-over-IPv[46] tunnel in a generic way, - and it covers "configured tunnel" described in the spec. See crossref:ipv6[gif,23.5.1.5] in this document for details. + and it covers "configured tunnel" described in the spec. See crossref:ipv6[gif,Generic Tunnel Interface] in this document for details. * RFC1981: Path MTU Discovery for IPv6 * RFC2080: RIPng for IPv6 @@ -114,15 +114,15 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[ * RFC2460: IPv6 specification * RFC2461: Neighbor discovery for IPv6 -** See crossref:ipv6[neighbor-discovery,23.5.1.2] in this document for details. +** See crossref:ipv6[neighbor-discovery,Neighbor Discovery] in this document for details. * RFC2462: IPv6 Stateless Address Autoconfiguration -** See crossref:ipv6[ipv6-pnp,23.5.1.4] in this document for details. +** See crossref:ipv6[ipv6-pnp,Plug and Play] in this document for details. * RFC2463: ICMPv6 for IPv6 specification -** See crossref:ipv6[icmpv6,23.5.1.9] in this document for details. +** See crossref:ipv6[icmpv6,ICMPv6] in this document for details. * RFC2464: Transmission of IPv6 Packets over Ethernet Networks * RFC2465: MIB for IPv6: Textual Conventions and General Group @@ -138,11 +138,11 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[ * RFC2553: Basic Socket Interface Extensions for IPv6 ** IPv4 mapped address (3.7) and special behavior of IPv6 wildcard bind socket - (3.8) are supported. See crossref:ipv6[ipv6-wildcard-socket,23.5.1.12] in this document for details. + (3.8) are supported. See crossref:ipv6[ipv6-wildcard-socket,IPv4 Mapped Address and IPv6 Wildcard Socket] in this document for details. * RFC2675: IPv6 Jumbograms -** See crossref:ipv6[ipv6-jumbo,23.5.1.7] in this document for details. +** See crossref:ipv6[ipv6-jumbo,Jumbo Payload] in this document for details. * RFC2710: Multicast Listener Discovery for IPv6 * RFC2711: IPv6 router alert option @@ -156,7 +156,7 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[ * [.filename]#draft-itojun-ipv6-tcp-to-anycast-00#: Disconnecting TCP connection toward IPv6 anycast address * [.filename]#draft-yamamoto-wideipv6-comm-model-00# -** See crossref:ipv6[ipv6-sas,23.5.1.6] in this document for details. +** See crossref:ipv6[ipv6-sas,Source Address Selection] in this document for details. * [.filename]#draft-ietf-ipngwg-scopedaddr-format-00.txt#: An Extension of Format for IPv6 Scoped Addresses @@ -315,7 +315,7 @@ RFC2462 has validation rule against incoming RA prefix information option, in 5. This is to protect hosts from malicious (or misconfigured) routers that advertise very short prefix lifetime. There was an update from Jim Bound to ipngwg mailing list (look for "(ipng 6712)" in the archive) and it is implemented Jim's update. -See crossref:ipv6[neighbor-discovery,23.5.1.2] in the document for relationship between DAD and autoconfiguration. +See crossref:ipv6[neighbor-discovery,Neighbor Discovery] in the document for relationship between DAD and autoconfiguration. [[gif]] ==== Generic Tunnel Interface @@ -334,7 +334,7 @@ It is very easy to configure interfaces and routing tables to perform infinite l _Please be warned_. gif can be configured to be ECN-friendly. -See crossref:ipv6[ipsec-ecn,23.5.4.5] for ECN-friendliness of tunnels, and man:gif[4] for how to configure. +See crossref:ipv6[ipsec-ecn,ECN Consideration on IPsec Tunnels] for ECN-friendliness of tunnels, and man:gif[4] for how to configure. If you would like to configure an IPv4-in-IPv6 tunnel with gif interface, read man:gif[4] carefully. You will need to remove IPv6 link-local address automatically assigned to the gif interface. @@ -354,7 +354,7 @@ This is the most typical case. . If there is no address that satisfies the above condition, choose the address associated with the routing table entry for the destination. This is the last resort, which may cause scope violation. For instance, ::1 is selected for ff01::1, fe80:1::200:f8ff:fe01:6317 for -fe80:1::2a0:24ff:feab:839b (note that embedded interface index - described in crossref:ipv6[ipv6-scope-index,23.5.1.3] - helps us choose the right source address. +fe80:1::2a0:24ff:feab:839b (note that embedded interface index - described in crossref:ipv6[ipv6-scope-index,Scope Index] - helps us choose the right source address. Those embedded indices will not be on the wire). If the outgoing interface has multiple address for the scope, a source is selected longest match basis (rule 3). Suppose 2001:0DB8:808:1:200:f8ff:fe01:6317 and 2001:0DB8:9:124:200:f8ff:fe01:6317 are given to the outgoing interface. 2001:0DB8:808:1:200:f8ff:fe01:6317 is chosen as the source for the destination 2001:0DB8:800::1. diff --git a/documentation/content/en/books/developers-handbook/l10n/_index.adoc b/documentation/content/en/books/developers-handbook/l10n/_index.adoc index 5760eaef62..34153230f6 100644 --- a/documentation/content/en/books/developers-handbook/l10n/_index.adoc +++ b/documentation/content/en/books/developers-handbook/l10n/_index.adoc @@ -152,7 +152,7 @@ The below lines need to be put into a common header file of the program, which i #ifdef WITHOUT_NLS #define getstr(n) nlsstr[n] #else -#include nl_types.h +#include <nl_types.h> extern nl_catd catalog; #define getstr(n) catgets(catalog, 1, n, nlsstr[n]) @@ -166,7 +166,7 @@ Next, put these lines into the global declaration part of the main source file: [.programlisting] .... #ifndef WITHOUT_NLS -#include nl_types.h +#include <nl_types.h> nl_catd catalog; #endif @@ -209,7 +209,7 @@ First, here is an example that does not use libc error messages: [.programlisting] .... -#include err.h +#include <err.h> ... if (!S_ISDIR(st.st_mode)) errx(1, "argument is not a directory"); @@ -219,8 +219,8 @@ This can be transformed to print an error message by reading `errno` and printin [.programlisting] .... -#include err.h -#include errno.h +#include <err.h> +#include <errno.h> ... if (!S_ISDIR(st.st_mode)) { errno = ENOTDIR; @@ -236,7 +236,7 @@ It is worth to note that there are cases when `errno` is set automatically by a [.programlisting] .... -#include err.h +#include <err.h> ... if ((p = malloc(size)) == NULL) err(1, NULL); diff --git a/documentation/content/en/books/developers-handbook/tools/_index.adoc b/documentation/content/en/books/developers-handbook/tools/_index.adoc index bcae63ad03..14a6250329 100644 --- a/documentation/content/en/books/developers-handbook/tools/_index.adoc +++ b/documentation/content/en/books/developers-handbook/tools/_index.adoc @@ -105,7 +105,7 @@ Indeed, part of the original UNIX(R) philosophy was to provide lots of small uti Here is a list of interpreters that are available from the FreeBSD Ports Collection, with a brief discussion of some of the more popular interpreted languages. -Instructions on how to get and install applications from the Ports Collection can be found in the extref:{handbook}[Ports section, ports-using] of the handbook. +Instructions on how to get and install applications from the Ports Collection can be found in the extref:{handbook}ports[Ports section, ports-using] of the handbook. BASIC:: Short for Beginner's All-purpose Symbolic Instruction Code. @@ -939,7 +939,7 @@ Now all that is needed is to attach to the child, set PauseMode to `0` with `exp [NOTE] ==== The described functionality is available starting with LLDB version 12.0.0. -Users of FreeBSD releases containing an earlier LLDB version may wish to use the snapshot available in extref:{handbook}[ports or packages, ports-using], as package:devel/llvm-devel[]. +Users of FreeBSD releases containing an earlier LLDB version may wish to use the snapshot available in extref:{handbook}ports[ports or packages, ports-using], as package:devel/llvm-devel[]. ==== Starting with LLDB 12.0.0, remote debugging is supported on FreeBSD. diff --git a/documentation/content/en/books/developers-handbook/x86/_index.adoc b/documentation/content/en/books/developers-handbook/x86/_index.adoc index de7cd9e992..b0ca446359 100644 --- a/documentation/content/en/books/developers-handbook/x86/_index.adoc +++ b/documentation/content/en/books/developers-handbook/x86/_index.adoc @@ -171,7 +171,7 @@ open: int 80h .... -This convention has a great disadvantage over the UNIX(R) way, at least as far as assembly language programming is concerned: +This convention has a great disadvantage over the UNIX(R) way, at least as far as assembly language programming is concerned: Every time you make a kernel call you must `push` the registers, then `pop` them later. This makes your code bulkier and slower. Nevertheless, FreeBSD gives you a choice. @@ -2789,7 +2789,7 @@ Plus, this value is for the daylight only: Other types of light will require a d ==== The F-Number The f-number is a very useful measure of how much light reaches the film. -A light meter can determine that, for example, to expose a film of specific sensitivity with f5.6 mkay require the exposure to last 1/1000 sec. +A light meter can determine that, for example, to expose a film of specific sensitivity with f/5.6 may require the exposure to last 1/1000 sec. It does not matter whether it is a 35-mm camera, or a 6x9cm camera, etc. As long as we know the f-number, we can determine the proper exposure. diff --git a/documentation/content/en/books/handbook/config/_index.adoc b/documentation/content/en/books/handbook/config/_index.adoc index 6089cf402d..6f2701d077 100644 --- a/documentation/content/en/books/handbook/config/_index.adoc +++ b/documentation/content/en/books/handbook/config/_index.adoc @@ -168,7 +168,7 @@ The state to be retrieved or set is described using a "Management Information Ba |Kernel functions and features |vm -|virtual memory +|Virtual memory |vfs |Filesystem @@ -991,7 +991,7 @@ Configuring centralized logging can reduce some of the administrative burden of In FreeBSD, centralized log file aggregation, merging, and rotation can be configured using syslogd and newsyslog. -This section demonstrates an example configuration, where host `A`, named `logserv.example.com`, will collect logging information for the local network. +This section demonstrates an example configuration, where host `A`, named `logserv.example.com`, will collect logging information for the local network. Host `B`, named `logclient.example.com`, will be configured to pass logging information to the logging server. diff --git a/documentation/content/en/books/handbook/cutting-edge/_index.adoc b/documentation/content/en/books/handbook/cutting-edge/_index.adoc index 04f7e9d37d..bb583c1185 100644 --- a/documentation/content/en/books/handbook/cutting-edge/_index.adoc +++ b/documentation/content/en/books/handbook/cutting-edge/_index.adoc @@ -538,7 +538,7 @@ refer to the FreeBSD Documentation Project Primer for New Contributors (extref:{ === Updating Documentation from Source Rebuilding the FreeBSD documentation from source requires a collection of tools which are not part of the FreeBSD base system. -The required tools can be installed following extref:{fdp-primer}[these steps, overview-quick-start] from the FreeBSD Documentation Project Primer. +The required tools can be installed following extref:{fdp-primer}overview[these steps, overview-quick-start] from the FreeBSD Documentation Project Primer. Once installed, use `git` to fetch a clean copy of the documentation source: diff --git a/documentation/content/en/books/handbook/desktop/_index.adoc b/documentation/content/en/books/handbook/desktop/_index.adoc index fd6e26e695..f533c80c26 100644 --- a/documentation/content/en/books/handbook/desktop/_index.adoc +++ b/documentation/content/en/books/handbook/desktop/_index.adoc @@ -949,7 +949,7 @@ For example, for the version localized in Spanish, it is necessary to install th [source,shell] .... -# pkg install libreoffice-es +# pkg install es-libreoffice .... [[calligra]] diff --git a/documentation/content/en/books/handbook/disks/_index.adoc b/documentation/content/en/books/handbook/disks/_index.adoc index b86395f9e4..5b792ccb47 100644 --- a/documentation/content/en/books/handbook/disks/_index.adoc +++ b/documentation/content/en/books/handbook/disks/_index.adoc @@ -1485,7 +1485,7 @@ For more details about `mdmfs`, refer to man:mdmfs[8]. [[snapshots]] == File System Snapshots -FreeBSD offers a feature in conjunction with crossref:config[soft-updates,Soft Updates]: file system snapshots. +FreeBSD offers a feature in conjunction with soft updates: file system snapshots. UFS snapshots allow a user to create images of specified file systems, and treat them as a file. When using the crossref:zfs[,Z file system (ZFS)], refer to crossref:zfs[zfs-zfs-snapshot,"Managing Snapshots"] on how to use snapshots. diff --git a/documentation/content/en/books/handbook/introduction.adoc b/documentation/content/en/books/handbook/introduction.adoc index e5cb8134a9..5cd3572d97 100644 --- a/documentation/content/en/books/handbook/introduction.adoc +++ b/documentation/content/en/books/handbook/introduction.adoc @@ -8,5 +8,5 @@ Those interested in helping to update and expand this document should send email The latest version of this book is available from the https://www.FreeBSD.org/[FreeBSD web site]. Previous versions can be obtained from https://docs.FreeBSD.org/doc/[https://docs.FreeBSD.org/doc/]. -The book can be downloaded in a variety of formats and compression options from the https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous link:./mirrors#mirrors[mirror sites]. +The book can be downloaded in a variety of formats and compression options from the https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous link:#mirrors[mirror sites]. Searches can be performed on the handbook and other documents on the link:https://www.FreeBSD.org/search/[search page]. diff --git a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc index e6842bec60..bce34cc330 100644 --- a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc +++ b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc @@ -114,17 +114,17 @@ See below on how to use man:pkg-version[8] to compare versions. [source,shell] .... % pkg version -t 1.2 1.3 -< <.> + < <.> % pkg version -t 1.2 1.2 -= <.> + = <.> % pkg version -t 1.2 1.2.0 -= <.> + = <.> % pkg version -t 1.2 1.2.p1 -> <.> + > <.> % pkg version -t 1.2.a1 1.2.b1 -< <.> + < <.> % pkg version -t 1.2 1.2p1 -< <.> + < <.> .... <.> `1.2` is before `1.3`. @@ -1586,7 +1586,7 @@ GH_TAGNAME= c472d66b .... This creates a versioning scheme that increases over time, and that is still before version `0`. -See crossref:makefiles[makefile-versions-ex-pkg-version, this secion on how to compare versions] using man:pkg-version[8]): +See crossref:makefiles[makefile-versions-ex-pkg-version, this secion on how to compare versions] using man:pkg-version[8]: [source,shell] .... @@ -1631,7 +1631,7 @@ USE_GITHUB= yes .... This creates a versioning scheme that increases over time (well, over commits), and does not conflict with the creation of a `0.7.4` version. -See crossref:makefiles[makefile-versions-ex-pkg-version, this section for how to compare versions] using man:pkg-version[8]): +See crossref:makefiles[makefile-versions-ex-pkg-version, this section for how to compare versions] using man:pkg-version[8]: [source,shell] .... diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc index 15a559a033..87604ac0cb 100644 --- a/documentation/content/en/books/porters-handbook/special/_index.adoc +++ b/documentation/content/en/books/porters-handbook/special/_index.adoc @@ -4844,7 +4844,7 @@ See crossref:uses[uses-sqlite,`sqlite`] for more information. [.filename]#rc.d# scripts are used to start services on system startup, and to give administrators a standard way of stopping, starting and restarting the service. Ports integrate into the system [.filename]#rc.d# framework. -Details on its usage can be found in extref:{handbook}[the rc.d Handbook chapter, configtuning-rcd]. +Details on its usage can be found in extref:{handbook}config[the rc.d Handbook chapter, configtuning-rcd]. Detailed explanation of the available commands is provided in man:rc[8] and man:rc.subr[8]. Finally, there is extref:{rc-scripting}[an article] on practical aspects of [.filename]#rc.d# scripting. diff --git a/documentation/content/en/books/porters-handbook/upgrading/_index.adoc b/documentation/content/en/books/porters-handbook/upgrading/_index.adoc index 3da3d330c5..c6d733ef6b 100644 --- a/documentation/content/en/books/porters-handbook/upgrading/_index.adoc +++ b/documentation/content/en/books/porters-handbook/upgrading/_index.adoc @@ -90,7 +90,7 @@ Before using it, please read [.filename]#/usr/ports/Tools/scripts/README.patchto If the port is unmaintained, and it is actively being used, please consider volunteering to become its maintainer. FreeBSD has over 4000 ports without maintainers, and this is an area where more volunteers are always needed. -(For a detailed description of the responsibilities of maintainers, refer to the section in the extref:{developers-handbook}[Developer's Handbook, POLICIES-MAINTAINER].) +(For a detailed description of the responsibilities of maintainers, refer to the section in the extref:{developers-handbook}policies[Developer's Handbook, policies-maintainer].) To submit the diff, use the https://bugs.freebsd.org/submit/[bug submit form] (product `Ports & Packages`, component `Individual Port(s)`). Always include the category with the port name, followed by colon, and brief description of the issue. diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc index 84c6123b80..3f23a7e0f4 100644 --- a/documentation/content/en/books/porters-handbook/uses/_index.adoc +++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc @@ -819,8 +819,8 @@ Add a dependency to the client library of the Firebird database. Possible arguments: (none), `fc`, `fontsdir` (default), `none` Adds a runtime dependency on tools needed to register fonts. -Depending on the argument, add a `crossref:plist[plist-keywords-fc,`@fc`] -${FONTSDIR}` line, `crossref:plist[plist-keywords-fontsdir,`@fontsdir`] ${FONTSDIR}` line, or no line if the argument is `none`, to the plist. +Depending on the argument, add a `crossref:plist[plist-keywords-fc,@fc] ${FONTSDIR}` line, +`crossref:plist[plist-keywords-fontsdir,@fontsdir] ${FONTSDIR}` line, or no line if the argument is `none`, to the plist. `FONTSDIR` defaults to [.filename]#${PREFIX}/share/fonts/${FONTNAME}# and `FONTNAME` to `${PORTNAME}`. Add `FONTSDIR` to `PLIST_SUB` and `SUB_LIST` |