diff options
author | Gabor Kovesdan <gabor@FreeBSD.org> | 2013-11-07 15:39:28 +0000 |
---|---|---|
committer | Gabor Kovesdan <gabor@FreeBSD.org> | 2013-11-07 15:39:28 +0000 |
commit | 24d129e8d1984a0b46a543bc523b63d216813bb0 (patch) | |
tree | 7dd0501c857c6f2139f4a71191c93bf19136412a /en_US.ISO8859-1/books/handbook/ports | |
parent | 35f1d6c78be90eb13320d655cd68f94333a0ab26 (diff) | |
download | doc-24d129e8d1984a0b46a543bc523b63d216813bb0.tar.gz doc-24d129e8d1984a0b46a543bc523b63d216813bb0.zip |
- Definitively upgrade to DocBook 5.0
Notes
Notes:
svn path=/projects/db5/; revision=43125
Diffstat (limited to 'en_US.ISO8859-1/books/handbook/ports')
-rw-r--r-- | en_US.ISO8859-1/books/handbook/ports/chapter.xml | 341 |
1 files changed, 146 insertions, 195 deletions
diff --git a/en_US.ISO8859-1/books/handbook/ports/chapter.xml b/en_US.ISO8859-1/books/handbook/ports/chapter.xml index 77621e5ff0..39a2a0a0ea 100644 --- a/en_US.ISO8859-1/books/handbook/ports/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/ports/chapter.xml @@ -4,11 +4,10 @@ $FreeBSD$ --> - -<chapter id="ports"> +<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="ports"> <title>Installing Applications: Packages and Ports</title> - <sect1 id="ports-synopsis"> + <sect1 xml:id="ports-synopsis"> <title>Synopsis</title> <indexterm><primary>ports</primary></indexterm> @@ -59,7 +58,7 @@ </itemizedlist> </sect1> - <sect1 id="ports-overview"> + <sect1 xml:id="ports-overview"> <title>Overview of Software Installation</title> <para>The typical steps for installing third-party software on a @@ -205,10 +204,8 @@ &a.ports; and the &a.ports-bugs;.</para> <warning> - <para>Before installing any application, check <ulink - url="http://vuxml.freebsd.org/"></ulink> for security issues - related to the application or install <filename - role="package">ports-mgmt/portaudit</filename>. Once + <para>Before installing any application, check <uri xlink:href="http://vuxml.freebsd.org/">http://vuxml.freebsd.org/</uri> for security issues + related to the application or install <package>ports-mgmt/portaudit</package>. Once installed, type <command>portaudit -F -a</command> to check all installed applications for known vulnerabilities.</para> </warning> @@ -218,7 +215,7 @@ &os;.</para> </sect1> - <sect1 id="ports-finding-applications"> + <sect1 xml:id="ports-finding-applications"> <title>Finding Software</title> <para>&os;'s list of available applications is growing all the @@ -228,8 +225,7 @@ <itemizedlist> <listitem> <para>The &os; web site maintains an up-to-date searchable - list of all the available applications, at <ulink - url="&url.base;/ports/index.html">http://www.FreeBSD.org/ports/</ulink>. + list of all the available applications, at <link xlink:href="&url.base;/ports/index.html">http://www.FreeBSD.org/ports/</link>. The ports can be searched by application name or by software category.</para> </listitem> @@ -237,8 +233,7 @@ <listitem> <indexterm><primary>FreshPorts</primary></indexterm> - <para>Dan Langille maintains <ulink - url="http://www.FreshPorts.org/">FreshPorts.org</ulink> + <para>Dan Langille maintains <link xlink:href="http://www.FreshPorts.org/">FreshPorts.org</link> which provides a comprehensive search utility and also tracks changes to the applications in the Ports Collection. Registered users can create a customized watch list in order @@ -250,8 +245,7 @@ <indexterm><primary>Freecode</primary></indexterm> <para>If you do not know the name of an application, try - using a site like <ulink - url="http://www.freecode.com/">Freecode.com</ulink> to + using a site like <link xlink:href="http://www.freecode.com/">Freecode.com</link> to find an application, then check back at the &os; site to see if the application has been ported yet.</para> </listitem> @@ -260,7 +254,7 @@ <para>If the Ports Collection is already installed, there are several methods to query the local version of the ports tree. To find out which category a port is in, type - <command>whereis <replaceable>file</replaceable></command>, + <command>whereis file</command>, where <replaceable>file</replaceable> is the program to be installed:</para> @@ -274,18 +268,16 @@ lsof: /usr/ports/sysutils/lsof</screen> /usr/ports/sysutils/lsof</screen> <para>Note that this will also return any matched files - downloaded into the <filename - class="directory">/usr/ports/distfiles</filename> + downloaded into the <filename>/usr/ports/distfiles</filename> directory.</para> </listitem> <listitem> <para>Another way to find software is by using the Ports Collection's built-in search mechanism. To use the search - feature, <application>cd</application> to <filename - class="directory">/usr/ports</filename> then run - <command>make <maketarget>search</maketarget> - name=<replaceable>program-name</replaceable></command> + feature, <application>cd</application> to <filename>/usr/ports</filename> then run + <command>make search + name=program-name</command> where <replaceable>program-name</replaceable> is the name of the software. For example, to search for <command>lsof</command>:</para> @@ -323,18 +315,18 @@ Path: /usr/ports/sysutils/lsof Info: Lists information about open files (similar to fstat(1))</screen> <para>For more in-depth searching, use - <command>make <maketarget>search</maketarget> - key=<replaceable>string</replaceable></command> or - <command>make <maketarget>quicksearch</maketarget> - key=<replaceable>string</replaceable></command>, where + <command>make search + key=string</command> or + <command>make quicksearch + key=string</command>, where <replaceable>string</replaceable> is some text to search for. The text can be in comments, descriptions, or dependencies in order to find ports which relate to a particular subject when the name of the program is unknown.</para> - <para>When using <maketarget>search</maketarget> or - <maketarget>quicksearch</maketarget>, the search string + <para>When using <buildtarget>search</buildtarget> or + <buildtarget>quicksearch</buildtarget>, the search string is case-insensitive. Searching for <quote>LSOF</quote> will yield the same results as searching for <quote>lsof</quote>.</para> @@ -343,7 +335,7 @@ Info: Lists information about open files (similar to fstat(1))</screen> </sect1> - <sect1 id="packages-using"> + <sect1 xml:id="packages-using"> <!-- <sect1info> <authorgroup> @@ -368,7 +360,7 @@ Info: Lists information about open files (similar to fstat(1))</screen> <application>pkgng</application> format.</para> <para>This method of package management uses a package database - directory, <filename class="directory">/var/db/pkg</filename>, + directory, <filename>/var/db/pkg</filename>, to track installed software versions and the files installed with each application. Several utilities interact with the database directory and are used to manage binary packages. @@ -405,7 +397,7 @@ Info: Lists information about open files (similar to fstat(1))</screen> <indexterm> <primary><command>pkg_add</command></primary> </indexterm> - <screen>&prompt.root; <userinput>pkg_add -r <replaceable>lsof</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>pkg_add -r lsof</userinput></screen> <para>In this example, <literal>lsof</literal> is used without specifying a version number as the version is not included @@ -437,15 +429,12 @@ Info: Lists information about open files (similar to fstat(1))</screen> <para>Package files are distributed in the <filename>.tbz</filename> format. Packages are available - from <ulink - url="ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/packages/"></ulink> + from <uri xlink:href="ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/packages/">ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/packages/</uri> or the <filename>/packages</filename> directory of the &os; DVD distribution. The layout of the packages directory is - similar to that of the <filename - class="directory">/usr/ports</filename> tree. Each + similar to that of the <filename>/usr/ports</filename> tree. Each category has its own directory, and every package can be - found within the <filename - class="directory">All</filename> directory.</para> + found within the <filename>All</filename> directory.</para> </sect2> <sect2> @@ -557,7 +546,7 @@ docbook = <para>To remove a previously installed software package, use &man.pkg.delete.1;:</para> - <screen>&prompt.root; <userinput>pkg_delete <replaceable>xchat-2.8.8_1</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>pkg_delete xchat-2.8.8_1</userinput></screen> <para>Note that &man.pkg.delete.1; requires the full package name and number and that the above command would not work if @@ -566,14 +555,14 @@ docbook = &man.pkg.version.1; to find the version of the installed package, or use a wildcard:</para> - <screen>&prompt.root; <userinput>pkg_delete <replaceable>xchat\*</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>pkg_delete xchat\*</userinput></screen> <para>in this case, all packages whose names start with <literal>xchat</literal> will be deleted.</para> </sect2> </sect1> - <sect1 id="pkgng-intro"> + <sect1 xml:id="pkgng-intro"> <title>Using <application>pkgng</application> for Binary Package Management</title> @@ -583,15 +572,13 @@ docbook = faster and easier.</para> <para><application>pkgng</application> is not a replacement for - port management tools like <filename - role="package">ports-mgmt/portmaster</filename> or <filename - role="package">ports-mgmt/portupgrade</filename>. These + port management tools like <package>ports-mgmt/portmaster</package> or <package>ports-mgmt/portupgrade</package>. These tools can be used to install third-party software from both binary packages and the Ports Collection, while <application>pkgng</application> installs only binary packages.</para> - <sect2 id="pkgng-initial-setup"> + <sect2 xml:id="pkgng-initial-setup"> <title>Getting Started with <application>pkgng</application></title> @@ -682,7 +669,7 @@ docbook = examples.</para> </sect2> - <sect2 id="pkgng-pkg-info"> + <sect2 xml:id="pkgng-pkg-info"> <title>Obtaining Information About Installed Packages</title> <para>Information about the packages installed on a system @@ -698,14 +685,14 @@ docbook = pkg-1.1.4_1</screen> </sect2> - <sect2 id="pkgng-installing-deinstalling"> + <sect2 xml:id="pkgng-installing-deinstalling"> <title>Installing and Removing Packages</title> <para>To install a binary package use the following command, where <replaceable>packagename</replaceable> is the name of the package to install:</para> - <screen>&prompt.root; <userinput>pkg install <replaceable>packagename</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>pkg install packagename</userinput></screen> <para>This command uses repository data to determine which version of the software to install and if it has any @@ -757,7 +744,7 @@ Proceed with deleting packages [y/N]: <userinput>y</userinput> [1/1] Deleting curl-7.31.0_1... done</screen> </sect2> - <sect2 id="pkgng-upgrading"> + <sect2 xml:id="pkgng-upgrading"> <title>Upgrading Installed Packages</title> <para>Packages that are outdated can be found with @@ -775,7 +762,7 @@ Proceed with deleting packages [y/N]: <userinput>y</userinput> <userinput>n</userinput> to cancel the upgrade.</para> </sect2> - <sect2 id="pkgng-auditing"> + <sect2 xml:id="pkgng-auditing"> <title>Auditing Installed Packages</title> <para>Occasionally, software vulnerabilities may be discovered @@ -788,7 +775,7 @@ Proceed with deleting packages [y/N]: <userinput>y</userinput> <screen>&prompt.root; <userinput>pkg audit -F</userinput></screen> </sect2> - <sect2 id="pkgng-autoremove"> + <sect2 xml:id="pkgng-autoremove"> <title>Automatically Removing Leaf Dependencies</title> <para>Removing a package may leave behind dependencies which @@ -806,7 +793,7 @@ Proceed with autoremoval of packages [y/N]: <userinput>y</userinput> Deinstalling ca_root_nss-3.15.1_1... done</screen> </sect2> - <sect2 id="pkgng-backup"> + <sect2 xml:id="pkgng-backup"> <title>Backing Up the Package Database</title> <para>Unlike the traditional package management system, @@ -816,7 +803,7 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <replaceable>pkgng.db</replaceable> with a suitable file name:</para> - <screen>&prompt.root; <userinput>pkg backup -d <replaceable>pkgng.db</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>pkg backup -d pkgng.db</userinput></screen> <para>Additionally, <application>pkgng</application> includes a &man.periodic.8; script to automatically perform a daily @@ -834,10 +821,10 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <para>To restore the contents of a previous package database backup, run:</para> - <screen>&prompt.root; <userinput>pkg backup -r <replaceable>/path/to/pkgng.db</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>pkg backup -r /path/to/pkgng.db</userinput></screen> </sect2> - <sect2 id="pkgng-clean"> + <sect2 xml:id="pkgng-clean"> <title>Removing Stale Packages</title> <para>By default, <application>pkgng</application> stores @@ -851,16 +838,16 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <screen>&prompt.root; <userinput>pkg clean</userinput></screen> </sect2> - <sect2 id="pkgng-set"> + <sect2 xml:id="pkgng-set"> <title>Modifying Package Metadata</title> <para>Software within the &os; Ports Collection can undergo major version number changes. To address this, <application>pkgng</application> has a built-in command to update package origins. This can be useful, for example, if - <filename role="package">lang/php5</filename> is renamed to - <filename role="package">lang/php53</filename> so that - <filename role="package">lang/php5</filename> can now + <package>lang/php5</package> is renamed to + <package>lang/php53</package> so that + <package>lang/php5</package> can now represent version <literal>5.4</literal>.</para> <para>To change the package origin for the above example, @@ -868,16 +855,12 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <screen>&prompt.root; <userinput>pkg set -o lang/php5:lang/php53</userinput></screen> - <para>As another example, to update <filename - role="package">lang/ruby18</filename> to <filename - role="package">lang/ruby19</filename>, run:</para> + <para>As another example, to update <package>lang/ruby18</package> to <package>lang/ruby19</package>, run:</para> <screen>&prompt.root; <userinput>pkg set -o lang/ruby18:lang/ruby19</userinput></screen> <para>As a final example, to change the origin of the - <filename>libglut</filename> shared libraries from <filename - role="package">graphics/libglut</filename> to <filename - role="package">graphics/freeglut</filename>, run:</para> + <filename>libglut</filename> shared libraries from <package>graphics/libglut</package> to <package>graphics/freeglut</package>, run:</para> <screen>&prompt.root; <userinput>pkg set -o graphics/libglut:graphics/freeglut</userinput></screen> @@ -887,17 +870,17 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> the modified origin. To force a reinstallation of dependent packages, run:</para> - <screen>&prompt.root; <userinput>pkg install -Rf <replaceable>graphics/freeglut</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>pkg install -Rf graphics/freeglut</userinput></screen> </note> </sect2> </sect1> - <sect1 id="ports-using"> + <sect1 xml:id="ports-using"> <title>Using the Ports Collection</title> <para>The Ports Collection is a set of <filename>Makefiles</filename>, patches, and description files - stored in <filename class="directory">/usr/ports</filename>. + stored in <filename>/usr/ports</filename>. This set of files is used to compile and install applications on &os;. Before an application can be compiled using a port, the Ports Collection must first be installed. If it was not @@ -909,22 +892,19 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <para><application>Portsnap</application> is a fast and user-friendly tool for retrieving the Ports Collection and - is the recommended choice for most users. See <xref - linkend="updating-upgrading-portsnap"/> for a detailed + is the recommended choice for most users. See <xref linkend="updating-upgrading-portsnap"/> for a detailed description of <application>Portsnap</application>.</para> <step> <para>Download a compressed snapshot of the Ports Collection - into <filename - class="directory">/var/db/portsnap</filename>.</para> + into <filename>/var/db/portsnap</filename>.</para> <screen>&prompt.root; <userinput>portsnap fetch</userinput></screen> </step> <step> <para>When running <application>Portsnap</application> for - the first time, extract the snapshot into <filename - class="directory">/usr/ports</filename>:</para> + the first time, extract the snapshot into <filename>/usr/ports</filename>:</para> <screen>&prompt.root; <userinput>portsnap extract</userinput></screen> </step> @@ -932,8 +912,7 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <step> <para>After the first use of <application>Portsnap</application> has been completed as - shown above, <filename - class="directory">/usr/ports</filename> can be updated as + shown above, <filename>/usr/ports</filename> can be updated as needed by running:</para> <screen>&prompt.root; <userinput>portsnap fetch</userinput> @@ -947,9 +926,8 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <para>If more control over the ports tree is needed or if local changes need to be maintained, <application>Subversion</application> can be used to - obtain the Ports Collection. Refer to <ulink - url="&url.articles.committers-guide;/subversion-primer.html">the - Subversion Primer</ulink> for a detailed description of + obtain the Ports Collection. Refer to <link xlink:href="&url.articles.committers-guide;/subversion-primer.html">the + Subversion Primer</link> for a detailed description of <application>Subversion</application>.</para> <step> @@ -979,16 +957,14 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <para>Check out a copy of the ports tree. For better performance, replace <replaceable>svn0.us-east.FreeBSD.org</replaceable> with a - <ulink - url="&url.books.handbook;/svn-mirrors.html">Subversion - mirror</ulink> close to your geographic location:</para> + <link xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion + mirror</link> close to your geographic location:</para> - <screen>&prompt.root; <userinput>svn checkout https://<replaceable>svn0.us-east.FreeBSD.org</replaceable>/ports/head /usr/ports</userinput></screen> + <screen>&prompt.root; <userinput>svn checkout https://svn0.us-east.FreeBSD.org/ports/head /usr/ports</userinput></screen> </step> <step> - <para>As needed, update <filename - class="directory">/usr/ports</filename> after the initial + <para>As needed, update <filename>/usr/ports</filename> after the initial <application>Subversion</application> checkout:</para> <screen>&prompt.root; <userinput>svn update /usr/ports</userinput></screen> @@ -1037,17 +1013,15 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <para>Some ports include <filename>pkg-message</filename> or other files to handle special situations. For more details - on these files, and on ports in general, refer to the <ulink - url="&url.books.porters-handbook;/index.html">&os; Porter's - Handbook</ulink>.</para> + on these files, and on ports in general, refer to the <link xlink:href="&url.books.porters-handbook;/index.html">&os; Porter's + Handbook</link>.</para> <para>The port does not include the actual source code, also known as a <filename>distfile</filename>. The extract portion of building a port will automatically save the downloaded - source to <filename - class="directory">/usr/ports/distfiles</filename>.</para> + source to <filename>/usr/ports/distfiles</filename>.</para> - <sect2 id="ports-skeleton"> + <sect2 xml:id="ports-skeleton"> <title>Installing Ports</title> <indexterm> @@ -1065,9 +1039,9 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> Collection as described in the previous section. Since the installation of any third-party software can introduce security vulnerabilities, it is recommended to first check - <ulink url="http://vuxml.freebsd.org/"></ulink> for known + <uri xlink:href="http://vuxml.freebsd.org/">http://vuxml.freebsd.org/</uri> for known security issues related to the port. Alternately, if - <filename role="package">ports-mgmt/portaudit</filename> + <package>ports-mgmt/portaudit</package> is installed, run <command>portaudit -F</command> before installing a new port. This command can be configured to automatically perform a security audit and an update of @@ -1081,12 +1055,10 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> connection. It also requires superuser privilege.</para> <para>Some third-party DVD products such as the &os; Toolkit - from <ulink - url="http://www.freebsdmall.com/">freebsdmall.com</ulink> + from <link xlink:href="http://www.freebsdmall.com/">freebsdmall.com</link> contain distfiles which can be used to install ports without - an Internet connection. Mount the DVD on <filename - class="directory">/cdrom</filename>. If you use a different - mount point, set the <makevar>CD_MOUNTPTS</makevar> make + an Internet connection. Mount the DVD on <filename>/cdrom</filename>. If you use a different + mount point, set the <varname>CD_MOUNTPTS</varname> make variable. The needed distfiles will be automatically used if they are present on the disk. However, the licenses of a few ports do not allow their inclusion on the DVD. This @@ -1161,7 +1133,7 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <note> <para>To save this extra step, instead use <command>make - <maketarget>install clean</maketarget></command> when + install clean</command> when compiling the port.</para> </note> @@ -1171,25 +1143,25 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <para>Some ports provide build options which can be used to enable or disable application components, provide security options, or allow for other customizations. Examples - include <filename role="package">www/firefox</filename>, - <filename role="package">security/gpgme</filename>, and - <filename role="package">mail/sylpheed-claws</filename>. + include <package>www/firefox</package>, + <package>security/gpgme</package>, and + <package>mail/sylpheed-claws</package>. If the port depends upon other ports which have configurable options, it may pause several times for user interaction as the default behavior is to prompt the user to select options from a menu. To avoid this, run <command>make - <maketarget>config-recursive</maketarget></command> + config-recursive</command> within the port skeleton to do this configuration in one batch. Then, run <command>make - <maketarget>install [clean]</maketarget></command> to + install [clean]</command> to compile and install the port.</para> <tip> - <para>When using <maketarget>config-recursive</maketarget>, + <para>When using <buildtarget>config-recursive</buildtarget>, the list of ports to configure are gathered by the - <maketarget>all-depends-list</maketarget> target. It is + <buildtarget>all-depends-list</buildtarget> target. It is recommended to run <command>make - <maketarget>config-recursive</maketarget></command> + config-recursive</command> until all dependent ports options have been defined, and ports options screens no longer appear, to be certain that all dependency options have been configured.</para> @@ -1200,11 +1172,11 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> a port has been built. One method is to <command>cd</command> into the directory containing the port and type <command>make - <maketarget>config</maketarget></command>. Another + config</command>. Another option is to use <command>make - <maketarget>showconfig</maketarget></command>. Another + showconfig</command>. Another option is to execute <command>make - <maketarget>rmconfig</maketarget></command> which will + rmconfig</command> which will remove all selected options and allow you to start over. All of these options, and others, are explained in great detail in &man.ports.7;.</para> @@ -1219,46 +1191,42 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> <para>For users who cannot be connected to the Internet all the time, <command>make - <maketarget>fetch</maketarget></command> can be run - within <filename class="directory">/usr/ports</filename>, + fetch</command> can be run + within <filename>/usr/ports</filename>, to fetch all distfiles, or within a category, such as - <filename class="directory">/usr/ports/net</filename>, or + <filename>/usr/ports/net</filename>, or within the specific port skeleton. Note that if a port has any dependencies, running this command in a category or ports skeleton will <emphasis>not</emphasis> fetch the distfiles of ports from another category. Instead, use <command>make - <maketarget>fetch-recursive</maketarget></command> to + fetch-recursive</command> to also fetch the distfiles for all the dependencies of a port.</para> <para>In rare cases, such as when an organization has a local - distfiles repository, the <makevar>MASTER_SITES</makevar> + distfiles repository, the <varname>MASTER_SITES</varname> variable can be used to override the download locations specified in the <filename>Makefile</filename>. When using, specify the alternate location:</para> - <screen>&prompt.root; <userinput>cd /usr/ports/<replaceable>directory</replaceable></userinput> + <screen>&prompt.root; <userinput>cd /usr/ports/directory</userinput> &prompt.root; <userinput>make MASTER_SITE_OVERRIDE= \ -<replaceable>ftp://ftp.organization.org/pub/FreeBSD/ports/distfiles/</replaceable> fetch</userinput></screen> +ftp://ftp.organization.org/pub/FreeBSD/ports/distfiles/ fetch</userinput></screen> - <para>The <makevar>WRKDIRPREFIX</makevar> and - <makevar>PREFIX</makevar> variables can override the default + <para>The <varname>WRKDIRPREFIX</varname> and + <varname>PREFIX</varname> variables can override the default working and target directories. For example:</para> <screen>&prompt.root; <userinput>make WRKDIRPREFIX=/usr/home/example/ports install</userinput></screen> - <para>will compile the port in <filename - class="directory">/usr/home/example/ports</filename> and - install everything under <filename - class="directory">/usr/local</filename>.</para> + <para>will compile the port in <filename>/usr/home/example/ports</filename> and + install everything under <filename>/usr/local</filename>.</para> <screen>&prompt.root; <userinput>make PREFIX=/usr/home/example/local install</userinput></screen> - <para>will compile the port in <filename - class="directory">/usr/ports</filename> and install it - in <filename - class="directory">/usr/home/example/local</filename>. + <para>will compile the port in <filename>/usr/ports</filename> and install it + in <filename>/usr/home/example/local</filename>. And:</para> <screen>&prompt.root; <userinput>make WRKDIRPREFIX=../ports PREFIX=../local install</userinput></screen> @@ -1272,7 +1240,7 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> </sect3> </sect2> - <sect2 id="ports-removing"> + <sect2 xml:id="ports-removing"> <title>Removing Installed Ports</title> <indexterm> @@ -1284,17 +1252,15 @@ Deinstalling ca_root_nss-3.15.1_1... done</screen> &man.pkg.delete.1;. Alternately, if the &os; system has been configured to use <application>pkg</application>, a port can be uninstalled using <command>pkg delete</command>. Examples - for using these commands can be found in <xref - linkend="packages-using"/> and <xref - linkend="pkgng-intro"/></para> + for using these commands can be found in <xref linkend="packages-using"/> and <xref linkend="pkgng-intro"/></para> <para>Alternately, <command>make deinstall</command> can be run in the port's directory:</para> <screen>&prompt.root; <userinput>cd /usr/ports/sysutils/lsof</userinput> <userinput>make deinstall</userinput> -===> Deinstalling for sysutils/lsof -===> Deinstalling +===> Deinstalling for sysutils/lsof +===> Deinstalling Deinstallation has been requested for the following 1 packages: lsof-4.88.d,8 @@ -1310,7 +1276,7 @@ The deinstallation will free 229 kB dependencies.</para> </sect2> - <sect2 id="ports-upgrading"> + <sect2 xml:id="ports-upgrading"> <title>Upgrading Ports</title> <indexterm> @@ -1352,7 +1318,7 @@ The deinstallation will free 229 kB <application>Portmaster</application> or <application>Portupgrade</application>.</para> - <sect3 id="portmaster"> + <sect3 xml:id="portmaster"> <title>Upgrading Ports Using <application>Portmaster</application></title> @@ -1360,13 +1326,11 @@ The deinstallation will free 229 kB <primary>portmaster</primary> </indexterm> - <para>The <filename - role="package">ports-mgmt/portmaster</filename> + <para>The <package>ports-mgmt/portmaster</package> package or port is the recommended tool for upgrading installed ports as it is designed to use the tools installed with &os; without depending upon other ports. It uses the - information in <filename - class="directory">/var/db/pkg/</filename> to determine + information in <filename>/var/db/pkg/</filename> to determine which ports to upgrade. To install this utility as a port:</para> @@ -1401,26 +1365,26 @@ The deinstallation will free 229 kB <para>To list these categories and search for updates:</para> <screen>&prompt.root; <userinput>portmaster -L</userinput> -===>>> Root ports (No dependencies, not depended on) -===>>> ispell-3.2.06_18 -===>>> screen-4.0.3 - ===>>> New version available: screen-4.0.3_1 -===>>> tcpflow-0.21_1 -===>>> 7 root ports +===>>> Root ports (No dependencies, not depended on) +===>>> ispell-3.2.06_18 +===>>> screen-4.0.3 + ===>>> New version available: screen-4.0.3_1 +===>>> tcpflow-0.21_1 +===>>> 7 root ports ... -===>>> Branch ports (Have dependencies, are depended on) -===>>> apache22-2.2.3 - ===>>> New version available: apache22-2.2.8 +===>>> Branch ports (Have dependencies, are depended on) +===>>> apache22-2.2.3 + ===>>> New version available: apache22-2.2.8 ... -===>>> Leaf ports (Have dependencies, not depended on) -===>>> automake-1.9.6_2 -===>>> bash-3.1.17 - ===>>> New version available: bash-3.2.33 +===>>> Leaf ports (Have dependencies, not depended on) +===>>> automake-1.9.6_2 +===>>> bash-3.1.17 + ===>>> New version available: bash-3.2.33 ... -===>>> 32 leaf ports +===>>> 32 leaf ports -===>>> 137 total installed ports - ===>>> 83 have new versions available</screen> +===>>> 137 total installed ports + ===>>> 83 have new versions available</screen> <para>This command is used to upgrade all outdated ports:</para> @@ -1454,10 +1418,10 @@ The deinstallation will free 229 kB port. To use this function, specify the location of the port in the Ports Collection:</para> - <screen>&prompt.root; <userinput>portmaster <replaceable>shells/bash</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>portmaster shells/bash</userinput></screen> </sect3> - <sect3 id="portupgrade"> + <sect3 xml:id="portupgrade"> <title>Upgrading Ports Using Portupgrade</title> <indexterm> @@ -1466,8 +1430,7 @@ The deinstallation will free 229 kB <para>Another utility that can be used to upgrade ports is <application>Portupgrade</application>, which is - available as the <filename - role="package">ports-mgmt/portupgrade</filename> package + available as the <package>ports-mgmt/portupgrade</package> package or port. This utility installs a suite of applications which can be used to manage ports. However, it is dependent upon Ruby. To install the port:</para> @@ -1489,7 +1452,7 @@ The deinstallation will free 229 kB <para>To upgrade only a specified application instead of all available ports, use <command>portupgrade - <replaceable>pkgname</replaceable></command>. It is + pkgname</command>. It is very important to include <option>-R</option> to first upgrade all the ports required by the given application:</para> @@ -1519,7 +1482,7 @@ The deinstallation will free 229 kB </sect3> </sect2> - <sect2 id="ports-disk-space"> + <sect2 xml:id="ports-disk-space"> <title>Ports and Disk Space</title> <indexterm> @@ -1529,22 +1492,20 @@ The deinstallation will free 229 kB <para>Using the Ports Collection will use up disk space over time. After building and installing a port, running - <command>make <maketarget>clean</maketarget></command> + <command>make clean</command> within the ports skeleton will clean up the temporary - <filename class="directory">work</filename> directory. If + <filename>work</filename> directory. If <application>Portmaster</application> is used to install a port, it will automatically remove this directory unless <option>-K</option> is specified. If <application>Portupgrade</application> is installed, this - command will remove all <filename - class="directory">work</filename> directories found within + command will remove all <filename>work</filename> directories found within the local copy of the Ports Collection:</para> <screen>&prompt.root; <userinput>portsclean -C</userinput></screen> <para>In addition, a lot of out-dated source distribution files - will collect in <filename - class="directory">/usr/ports/distfiles</filename> over time. + will collect in <filename>/usr/ports/distfiles</filename> over time. If <application>Portupgrade</application> is installed, this command will delete all the distfiles that are no longer referenced by any ports:</para> @@ -1565,14 +1526,13 @@ The deinstallation will free 229 kB <para>By default, this command is interactive and will prompt the user to confirm if a distfile should be deleted.</para> - <para>In addition to these commands, the <filename - role="package">ports-mgmt/pkg_cutleaves</filename> package + <para>In addition to these commands, the <package>ports-mgmt/pkg_cutleaves</package> package or port automates the task of removing installed ports that are no longer needed.</para> </sect2> </sect1> - <sect1 id="ports-nextsteps"> + <sect1 xml:id="ports-nextsteps"> <title>Post-Installation Considerations</title> <para>Regardless of whether the software was installed from a @@ -1584,27 +1544,24 @@ The deinstallation will free 229 kB <itemizedlist> <listitem> <para>Most applications install at least one default - configuration file in <filename - class="directory">/usr/local/etc</filename>. The + configuration file in <filename>/usr/local/etc</filename>. The configuration files should be reviewed and possibly edited to meet the system's needs.</para> </listitem> <listitem> <para>Applications which provide documentation will install - it into <filename - class="directory">/usr/local/share/doc</filename> and many + it into <filename>/usr/local/share/doc</filename> and many applications also install manual pages. This documentation should be consulted before continuing.</para> </listitem> <listitem> <para>Some applications run services which must be added - to <filename class="directory">/etc/rc.conf</filename> + to <filename>/etc/rc.conf</filename> before starting the application. These applications usually install a startup script in - <filename>/usr/local/etc/rc.d</filename>. See <link - linkend="configtuning-starting-services">Starting + <filename>/usr/local/etc/rc.d</filename>. See <link linkend="configtuning-starting-services">Starting Services</link> for more information.</para> </listitem> @@ -1624,7 +1581,7 @@ The deinstallation will free 229 kB </itemizedlist> </sect1> - <sect1 id="ports-broken"> + <sect1 xml:id="ports-broken"> <title>Dealing with Broken Ports</title> <para>When a port does not build or @@ -1633,14 +1590,14 @@ The deinstallation will free 229 kB <orderedlist> <listitem> <para>Search to see if there is a fix pending for the port in - the <ulink url="&url.base;/support.html#gnats">Problem - Report database</ulink>. If so, implementing the proposed + the <link xlink:href="&url.base;/support.html#gnats">Problem + Report database</link>. If so, implementing the proposed fix may fix the issue.</para> </listitem> <listitem> <para>Ask the maintainer of the port for help. Type - <command>make <maketarget>maintainer</maketarget></command> + <command>make maintainer</command> in the ports skeleton or read the port's <filename>Makefile</filename> to find the maintainer's email address. Remember to include the @@ -1650,15 +1607,12 @@ The deinstallation will free 229 kB <note> <para>Some ports are not maintained by an individual but - instead by a <ulink - url="&url.articles.mailing-list-faq;/article.html">mailing - list</ulink>. Many, but not all, of these addresses - look like <email - role="nolink">freebsd-listname@FreeBSD.org</email>. + instead by a <link xlink:href="&url.articles.mailing-list-faq;/article.html">mailing + list</link>. Many, but not all, of these addresses + look like <email role="nolink">freebsd-listname@FreeBSD.org</email>. Take this into account when sending an email.</para> - <para>In particular, ports shown as maintained by <email - role="nolink">ports@FreeBSD.org</email> are not + <para>In particular, ports shown as maintained by <email role="nolink">ports@FreeBSD.org</email> are not maintained by a specific individual. Instead, any fixes and support come from the general community who subscribe to that mailing list. More volunteers are always @@ -1667,23 +1621,20 @@ The deinstallation will free 229 kB <para>If there is no response to the email, use &man.send-pr.1; to submit a bug report using the - instructions in <ulink - url="&url.articles.problem-reports;/article.html">Writing - &os; Problem Reports</ulink>.</para> + instructions in <link xlink:href="&url.articles.problem-reports;/article.html">Writing + &os; Problem Reports</link>.</para> </listitem> <listitem> - <para>Fix it! The <ulink - url="&url.books.porters-handbook;/index.html">Porter's - Handbook</ulink> includes detailed information on the + <para>Fix it! The <link xlink:href="&url.books.porters-handbook;/index.html">Porter's + Handbook</link> includes detailed information on the ports infrastructure so that you can fix the occasional broken port or even submit your own!</para> </listitem> <listitem> <para>Install the package instead of the port using the - instructions in <xref linkend="packages-using"/> or <xref - linkend="pkgng-intro"/>.</para> + instructions in <xref linkend="packages-using"/> or <xref linkend="pkgng-intro"/>.</para> </listitem> </orderedlist> </sect1> |