Date: Tue, 4 Feb 2014 14:21:24 +0000 (UTC) From: Dru Lavigne <dru@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r43751 - head/en_US.ISO8859-1/books/handbook/ports Message-ID: <201402041421.s14ELOEt096009@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: dru Date: Tue Feb 4 14:21:24 2014 New Revision: 43751 URL: http://svnweb.freebsd.org/changeset/doc/43751 Log: White space fix only. Translators can ignore. Sponsored by: iXsystems Modified: head/en_US.ISO8859-1/books/handbook/ports/chapter.xml Modified: head/en_US.ISO8859-1/books/handbook/ports/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/handbook/ports/chapter.xml Tue Feb 4 14:11:48 2014 (r43750) +++ head/en_US.ISO8859-1/books/handbook/ports/chapter.xml Tue Feb 4 14:21:24 2014 (r43751) @@ -194,10 +194,12 @@ &a.ports; and the &a.ports-bugs;.</para> <warning> - <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> + <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> <para>The remainder of this chapter explains how to use packages @@ -215,7 +217,8 @@ <itemizedlist> <listitem> <para>The &os; web site maintains an up-to-date searchable - list of all the available applications, at <link xlink:href="&url.base;/ports/index.html">http://www.FreeBSD.org/ports/</link>. + 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> @@ -223,7 +226,8 @@ <listitem> <indexterm><primary>FreshPorts</primary></indexterm> - <para>Dan Langille maintains <link xlink:href="http://www.FreshPorts.org/">FreshPorts.org</link> + <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 @@ -235,8 +239,9 @@ <indexterm><primary>Freecode</primary></indexterm> <para>If you do not know the name of an application, try - 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 + 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> @@ -258,18 +263,18 @@ 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>/usr/ports/distfiles</filename> - directory.</para> + 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>/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 + 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> <screen>&prompt.root; <userinput>cd /usr/ports</userinput> @@ -561,9 +566,11 @@ docbook = faster and easier.</para> <para><application>pkgng</application> is not a replacement for - 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 + 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> @@ -844,12 +851,16 @@ Deinstalling ca_root_nss-3.15.1_1... don <screen>&prompt.root; <userinput>pkg set -o lang/php5:lang/php53</userinput></screen> - <para>As another example, to update <package>lang/ruby18</package> to <package>lang/ruby19</package>, 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 <package>graphics/libglut</package> to <package>graphics/freeglut</package>, 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> @@ -881,7 +892,8 @@ Deinstalling ca_root_nss-3.15.1_1... don <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> @@ -893,7 +905,8 @@ Deinstalling ca_root_nss-3.15.1_1... don <step> <para>When running <application>Portsnap</application> for - the first time, extract the snapshot into <filename>/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> @@ -901,8 +914,8 @@ Deinstalling ca_root_nss-3.15.1_1... don <step> <para>After the first use of <application>Portsnap</application> has been completed as - shown above, <filename>/usr/ports</filename> can be updated as - needed by running:</para> + shown above, <filename>/usr/ports</filename> can be updated + as needed by running:</para> <screen>&prompt.root; <userinput>portsnap fetch</userinput> &prompt.root; <userinput>portsnap update</userinput></screen> @@ -915,7 +928,8 @@ Deinstalling ca_root_nss-3.15.1_1... don <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 <link xlink:href="&url.articles.committers-guide;/subversion-primer.html">the + 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> @@ -946,15 +960,17 @@ Deinstalling ca_root_nss-3.15.1_1... don <para>Check out a copy of the ports tree. For better performance, replace <replaceable>svn0.us-east.FreeBSD.org</replaceable> with a - <link xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion + <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://svn0.us-east.FreeBSD.org/ports/head /usr/ports</userinput></screen> </step> <step> - <para>As needed, update <filename>/usr/ports</filename> after the initial - <application>Subversion</application> checkout:</para> + <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> </step> @@ -1002,8 +1018,9 @@ Deinstalling ca_root_nss-3.15.1_1... don <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 <link xlink:href="&url.books.porters-handbook;/index.html">&os; Porter's - Handbook</link>.</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 @@ -1028,14 +1045,15 @@ Deinstalling ca_root_nss-3.15.1_1... don 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 - <uri xlink:href="http://vuxml.freebsd.org/">http://vuxml.freebsd.org/</uri> for known - security issues related to the port. Alternately, if - <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 - the vulnerability database during the daily security system - check. For more information, refer to the manual page for + <uri + xlink:href="http://vuxml.freebsd.org/">http://vuxml.freebsd.org/</uri> + for known security issues related to the port. Alternately, + if <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 the vulnerability + database during the daily security system check. For more + information, refer to the manual page for <application>portaudit</application> and &man.periodic.8;.</para> </warning> @@ -1044,17 +1062,19 @@ Deinstalling ca_root_nss-3.15.1_1... don connection. It also requires superuser privilege.</para> <para>Some third-party DVD products such as the &os; Toolkit - from <link xlink:href="http://www.freebsdmall.com/">freebsdmall.com</link> + 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>/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 - could be because a registration form needs to be filled out - before downloading or redistribution is not allowed. In - order to install a port not included on the DVD, a connection - to the Internet will still be required.</para> + 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 could be because a + registration form needs to be filled out before downloading or + redistribution is not allowed. In order to install a port not + included on the DVD, a connection to the Internet will still + be required.</para> <para>To compile and install the port, change to the directory of the port to be installed, then type <command>make @@ -1146,8 +1166,9 @@ Deinstalling ca_root_nss-3.15.1_1... don compile and install the port.</para> <tip> - <para>When using <buildtarget>config-recursive</buildtarget>, - the list of ports to configure are gathered by the + <para>When using + <buildtarget>config-recursive</buildtarget>, the list of + ports to configure are gathered by the <buildtarget>all-depends-list</buildtarget> target. It is recommended to run <command>make config-recursive</command> @@ -1160,11 +1181,9 @@ Deinstalling ca_root_nss-3.15.1_1... don menu in order to add, remove, or change these options after a port has been built. One method is to <command>cd</command> into the directory containing the - port and type <command>make - config</command>. Another - option is to use <command>make - showconfig</command>. Another - option is to execute <command>make + port and type <command>make config</command>. Another + option is to use <command>make showconfig</command>. + Another option is to execute <command>make rmconfig</command> which will remove all selected options and allow you to start over. All of these options, and others, are explained in great @@ -1179,16 +1198,14 @@ Deinstalling ca_root_nss-3.15.1_1... don complete list of supported variables.</para> <para>For users who cannot be connected to the Internet all - the time, <command>make - fetch</command> can be run - within <filename>/usr/ports</filename>, - to fetch all distfiles, or within a category, such as - <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 + the time, <command>make fetch</command> can be run + within <filename>/usr/ports</filename>, to fetch all + distfiles, or within a category, such as + <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 fetch-recursive</command> to also fetch the distfiles for all the dependencies of a port.</para> @@ -1209,14 +1226,15 @@ ftp://ftp.organization.org/pub/FreeBSD/p <screen>&prompt.root; <userinput>make WRKDIRPREFIX=/usr/home/example/ports install</userinput></screen> - <para>will compile the port in <filename>/usr/home/example/ports</filename> and - install everything under <filename>/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>/usr/ports</filename> and install it - in <filename>/usr/home/example/local</filename>. - And:</para> + <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> @@ -1238,8 +1256,8 @@ ftp://ftp.organization.org/pub/FreeBSD/p </indexterm> <para>Installed ports can be uninstalled using - <command>pkg delete</command>. Examples - for using is command can be found in <xref linkend="pkgng-intro"/></para> + <command>pkg delete</command>. Examples for using is command + can be found in <xref linkend="pkgng-intro"/></para> <para>Alternately, <command>make deinstall</command> can be run in the port's directory:</para> @@ -1313,13 +1331,13 @@ The deinstallation will free 229 kB <primary>portmaster</primary> </indexterm> - <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>/var/db/pkg/</filename> to determine - which ports to upgrade. To install this utility as a - port:</para> + <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>/var/db/pkg/</filename> to + determine which ports to upgrade. To install this utility + as a port:</para> <screen>&prompt.root; <userinput>cd /usr/ports/ports-mgmt/portmaster</userinput> &prompt.root; <userinput>make install clean</userinput></screen> @@ -1416,8 +1434,8 @@ The deinstallation will free 229 kB </indexterm> <para>Another utility that can be used to upgrade ports is - <application>Portupgrade</application>, which is - available as the <package>ports-mgmt/portupgrade</package> package + <application>Portupgrade</application>, which is 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> @@ -1439,10 +1457,9 @@ The deinstallation will free 229 kB <para>To upgrade only a specified application instead of all available ports, use <command>portupgrade - pkgname</command>. It is - very important to include <option>-R</option> to first - upgrade all the ports required by the given - application:</para> + pkgname</command>. It is very important to include + <option>-R</option> to first upgrade all the ports required + by the given application:</para> <screen>&prompt.root; <userinput>portupgrade -R firefox</userinput></screen> @@ -1479,22 +1496,21 @@ 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 clean</command> - within the ports skeleton will clean up the temporary - <filename>work</filename> directory. If - <application>Portmaster</application> is used to install a + <command>make clean</command> within the ports skeleton will + clean up the temporary <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>work</filename> directories found within - the local copy of the Ports Collection:</para> + 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>/usr/ports/distfiles</filename> over time. - If <application>Portupgrade</application> is installed, this - command will delete all the distfiles that are no longer + 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> <screen>&prompt.root; <userinput>portsclean -D</userinput></screen> @@ -1513,9 +1529,10 @@ 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 <package>ports-mgmt/pkg_cutleaves</package> package - or port automates the task of removing installed ports that - are no longer needed.</para> + <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> @@ -1531,9 +1548,9 @@ The deinstallation will free 229 kB <itemizedlist> <listitem> <para>Most applications install at least one default - configuration file in <filename>/usr/local/etc</filename>. The - configuration files should be reviewed and possibly edited - to meet the system's needs.</para> + 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> @@ -1545,23 +1562,24 @@ The deinstallation will free 229 kB <listitem> <para>Some applications run services which must be added - 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 + 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 Services</link> for more information.</para> </listitem> <listitem> <para>Users of &man.csh.1; should run - <command>rehash</command> to rebuild the known binary - list in the shells <envar>PATH</envar>.</para> + <command>rehash</command> to rebuild the known binary list + in the shells <envar>PATH</envar>.</para> </listitem> <listitem> <para>Use - use <command>pkg info</command> to determine which files, man pages, - and binaries were installed with the application.</para> + use <command>pkg info</command> to determine which files, + man pages, and binaries were installed with the + application.</para> </listitem> </itemizedlist> </sect1> @@ -1592,12 +1610,15 @@ The deinstallation will free 229 kB <note> <para>Some ports are not maintained by an individual but - 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>. + 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 @@ -1606,15 +1627,17 @@ 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 <link xlink:href="&url.articles.problem-reports;/article.html">Writing + instructions in <link + xlink:href="&url.articles.problem-reports;/article.html">Writing &os; Problem Reports</link>.</para> </listitem> <listitem> - <para>Fix it! The <link xlink:href="&url.books.porters-handbook;/index.html">Porter's + <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> + ports infrastructure so that you can fix the occasional + broken port or even submit your own!</para> </listitem> <listitem>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201402041421.s14ELOEt096009>