Wrap overlong lines in the ports chapter, cleanup trailing whitespace on a

sentence break, and change the capitalization of a title.

Found by:   textproc/igor
This commit is contained in:
Benedict Reuschling 2018-08-16 13:18:30 +00:00
parent 0ea0848dc4
commit 3c7fb45a82
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=52134

View file

@ -71,7 +71,8 @@
<step> <step>
<para>Unpack the software from its distribution format. This <para>Unpack the software from its distribution format. This
is typically a tarball compressed with a program such as is typically a tarball compressed with a program such as
&man.compress.1;, &man.gzip.1;, &man.bzip2.1; or &man.xz.1;.</para> &man.compress.1;, &man.gzip.1;, &man.bzip2.1; or
&man.xz.1;.</para>
</step> </step>
<step> <step>
@ -104,11 +105,11 @@
on &os;, the source code might need editing in on &os;, the source code might need editing in
order for it to install and run properly.</para> order for it to install and run properly.</para>
<para>However, over <para>However, over <link
<link xlink:href="&url.base;/ports/index.html">&os.numports;</link> xlink:href="&url.base;/ports/index.html">&os.numports;</link>
third-party applications have already been third-party applications have already been ported to &os;. When
ported to &os;. When feasible, these applications are made feasible, these applications are made available for download as
available for download as pre-compiled <emphasis>packages</emphasis>.</para> pre-compiled <emphasis>packages</emphasis>.</para>
<para>Packages <para>Packages
can be manipulated with the &os; package management can be manipulated with the &os; package management
@ -277,10 +278,10 @@ subversion-static-<replaceable>1.8.8_2</replaceable>
subversion16-<replaceable>1.6.23_4</replaceable> subversion16-<replaceable>1.6.23_4</replaceable>
subversion17-<replaceable>1.7.16_2</replaceable></screen> subversion17-<replaceable>1.7.16_2</replaceable></screen>
<para>Package names include the version number and, in the case of <para>Package names include the version number and, in the
ports based on python, the version number of the version of case of ports based on python, the version number of the
python the package was built with. Some ports also have version of python the package was built with. Some ports
multiple versions available. In the case of also have multiple versions available. In the case of
<application>Subversion</application>, there are different <application>Subversion</application>, there are different
versions available, as well as different compile options. versions available, as well as different compile options.
In this case, the statically linked version of In this case, the statically linked version of
@ -409,9 +410,9 @@ Info: Lists information about open files (similar to fstat(1))</screen>
from the &os; mirrors, managing packages with from the &os; mirrors, managing packages with
<application>pkg</application> can be sufficient.</para> <application>pkg</application> can be sufficient.</para>
<para>However, for those sites building from source or using <para>However, for those sites building from source or using their
their own repositories, a separate own repositories, a separate <link
<link linkend="ports-upgrading-tools">port management tool</link> linkend="ports-upgrading-tools">port management tool</link>
will be needed.</para> will be needed.</para>
<para>Since <application>pkg</application> only works with <para>Since <application>pkg</application> only works with
@ -741,17 +742,17 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen>
<para>The Ports Collection is a set of <para>The Ports Collection is a set of
<filename>Makefiles</filename>, patches, and description files. <filename>Makefiles</filename>, patches, and description files.
Each set of these files is used to compile and install an individual Each set of these files is used to compile and install an
application on &os;, and is called a <emphasis>port</emphasis>.</para> individual application on &os;, and is called a
<emphasis>port</emphasis>.</para>
<para>By default, the Ports Collection itself is stored as a subdirectory <para>By default, the Ports Collection itself is stored as a
of <filename>/usr/ports</filename>.</para> subdirectory of <filename>/usr/ports</filename>.</para>
<para>Before an <para>Before an application can be compiled using a port, the
application can be compiled using a port, the Ports Collection Ports Collection must first be installed. If it was not
must first be installed. If it was not installed during the installed during the installation of &os;, use one of the
installation of &os;, use one of the following methods to following methods to install it:</para>
install it:</para>
<procedure xml:id="ports-using-portsnap-method"> <procedure xml:id="ports-using-portsnap-method">
<title>Portsnap Method</title> <title>Portsnap Method</title>
@ -1001,15 +1002,14 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen>
options, or allow for other customizations. Examples options, or allow for other customizations. Examples
include <package>www/firefox</package>, include <package>www/firefox</package>,
<package>security/gpgme</package>, and <package>security/gpgme</package>, and
<package>mail/sylpheed-claws</package>. <package>mail/sylpheed-claws</package>. If the port depends
If the port depends upon other ports which have configurable upon other ports which have configurable options, it may
options, it may pause several times for user interaction pause several times for user interaction as the default
as the default behavior is to prompt the user to select behavior is to prompt the user to select options from a
options from a menu. To avoid this and do all of the configuration menu. To avoid this and do all of the configuration in one
in one batch, run <command>make config-recursive</command> batch, run <command>make config-recursive</command> within
within the port skeleton. Then, run <command>make the port skeleton. Then, run <command>make install
install [clean]</command> to compile and install the [clean]</command> to compile and install the port.</para>
port.</para>
<tip> <tip>
<para>When using <para>When using
@ -1171,15 +1171,16 @@ The deinstallation will free 229 kB
</important> </important>
<sect3 xml:id="ports-upgrading-tools"> <sect3 xml:id="ports-upgrading-tools">
<title>Tools To Upgrade And Manage Ports</title> <title>Tools to Upgrade and Manage Ports</title>
<indexterm> <indexterm>
<primary>ports</primary> <primary>ports</primary>
<secondary>upgrading-tools</secondary> <secondary>upgrading-tools</secondary>
</indexterm> </indexterm>
<para>The Ports Collection contains several utilities to perform <para>The Ports Collection contains several utilities to
the actual upgrade. Each has its strengths and weaknesses.</para> perform the actual upgrade. Each has its strengths and
weaknesses.</para>
<para>Historically, most installations used either <para>Historically, most installations used either
<application>Portmaster</application> or <application>Portmaster</application> or
@ -1188,9 +1189,10 @@ The deinstallation will free 229 kB
alternative.</para> alternative.</para>
<note> <note>
<para>The choice of which tool is best for a particular system <para>The choice of which tool is best for a particular
is up to the system administrator. It is recommended practice system is up to the system administrator. It is
to back up your data before using any of these tools.</para> recommended practice to back up your data before using any
of these tools.</para>
</note> </note>
</sect3> </sect3>
@ -1297,8 +1299,9 @@ The deinstallation will free 229 kB
<screen>&prompt.root; <userinput>portmaster <replaceable>shells/bash</replaceable></userinput></screen> <screen>&prompt.root; <userinput>portmaster <replaceable>shells/bash</replaceable></userinput></screen>
<para>More information about <package>ports-mgmt/portmaster</package> <para>More information about
may be found in its <filename>pkg-descr</filename>.</para> <package>ports-mgmt/portmaster</package> may be found in its
<filename>pkg-descr</filename>.</para>
</sect3> </sect3>
<sect3 xml:id="portupgrade"> <sect3 xml:id="portupgrade">
@ -1308,11 +1311,11 @@ The deinstallation will free 229 kB
<primary>portupgrade</primary> <primary>portupgrade</primary>
</indexterm> </indexterm>
<para><package>ports-mgmt/portupgrade</package> is <para><package>ports-mgmt/portupgrade</package> is another
another utility that can be used to upgrade ports. It utility that can be used to upgrade ports. It installs a
installs a suite of applications suite of applications which can be used to manage ports.
which can be used to manage ports. However, it is dependent However, it is dependent upon Ruby. To install the
upon Ruby. To install the port:</para> port:</para>
<screen>&prompt.root; <userinput>cd /usr/ports/ports-mgmt/portupgrade</userinput> <screen>&prompt.root; <userinput>cd /usr/ports/ports-mgmt/portupgrade</userinput>
&prompt.root; <userinput>make install clean</userinput></screen> &prompt.root; <userinput>make install clean</userinput></screen>
@ -1358,8 +1361,9 @@ The deinstallation will free 229 kB
information on all of the available switches, refer to the information on all of the available switches, refer to the
manual page for <command>portupgrade</command>.</para> manual page for <command>portupgrade</command>.</para>
<para>More information about <package>ports-mgmt/portupgrade</package> <para>More information about
may be found in its <filename>pkg-descr</filename>.</para> <package>ports-mgmt/portupgrade</package> may be found in
its <filename>pkg-descr</filename>.</para>
</sect3> </sect3>
</sect2> </sect2>
@ -1453,9 +1457,9 @@ The deinstallation will free 229 kB
other configuration values are adequate.</para> other configuration values are adequate.</para>
<para>The number of processor cores detected is used to define how <para>The number of processor cores detected is used to define how
many builds will run in parallel. Supply enough virtual many builds will run in parallel. Supply enough virtual memory,
memory, either with <acronym>RAM</acronym> or swap space. If either with <acronym>RAM</acronym> or swap space. If virtual
virtual memory runs out, the compilation jails will stop and be torn memory runs out, the compilation jails will stop and be torn
down, resulting in weird error messages.</para> down, resulting in weird error messages.</para>
<sect2 xml:id="poudriere-initialization"> <sect2 xml:id="poudriere-initialization">
@ -1701,7 +1705,8 @@ ports-mgmt/pkg
list</link>. Many, but not all, of these addresses look list</link>. Many, but not all, of these addresses look
like <email like <email
role="nolink">freebsd-<replaceable>listname</replaceable>@FreeBSD.org</email>. role="nolink">freebsd-<replaceable>listname</replaceable>@FreeBSD.org</email>.
Please take this into account when sending an email.</para> Please take this into account when sending an
email.</para>
<para>In particular, ports maintained by <para>In particular, ports maintained by
<email role="nolink">ports@FreeBSD.org</email> are not <email role="nolink">ports@FreeBSD.org</email> are not