Date: Wed, 3 Oct 2012 21:41:00 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r39650 - head/en_US.ISO8859-1/books/handbook/ports Message-ID: <201210032141.q93Lf08P097233@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Wed Oct 3 21:41:00 2012 New Revision: 39650 URL: http://svn.freebsd.org/changeset/doc/39650 Log: Whitespace-only cleanup. Translators, please ignore. 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 Wed Oct 3 12:18:42 2012 (r39649) +++ head/en_US.ISO8859-1/books/handbook/ports/chapter.xml Wed Oct 3 21:41:00 2012 (r39650) @@ -18,32 +18,39 @@ do before needing to install an additional third-party application to get real work done. FreeBSD provides two complementary technologies for installing third-party software - on your system: the FreeBSD Ports Collection (for installing from - source), and packages (for installing from pre-built binaries). - Either method may be used to install the - newest version of your favorite applications from local media or + on your system: the FreeBSD Ports Collection (for installing + from source), and packages (for installing from pre-built + binaries). Either method may be used to install the newest + version of your favorite applications from local media or straight off the network.</para> <para>After reading this chapter, you will know:</para> <itemizedlist> <listitem> - <para>How to install third-party binary software packages.</para> + <para>How to install third-party binary software + packages.</para> </listitem> + <listitem> - <para>How to build third-party software from source by using the ports - collection.</para> + <para>How to build third-party software from source by using + the ports collection.</para> </listitem> + <listitem> - <para>How to remove previously installed packages or ports.</para> + <para>How to remove previously installed packages or + ports.</para> </listitem> + <listitem> <para>How to override the default values that the ports collection uses.</para> </listitem> + <listitem> <para>How to find the appropriate software package.</para> </listitem> + <listitem> <para>How to upgrade your applications.</para> </listitem> @@ -124,10 +131,10 @@ automatically downloaded, extracted, patched, compiled, and installed for you.</para> - <para>In fact, the ports system can also be used to generate packages - which can later be manipulated with <command>pkg_add</command> - and the other package management commands that will be introduced - shortly.</para> + <para>In fact, the ports system can also be used to generate + packages which can later be manipulated with + <command>pkg_add</command> and the other package management + commands that will be introduced shortly.</para> <para>Both packages and ports understand <emphasis>dependencies</emphasis>. Suppose you want to install @@ -171,11 +178,11 @@ <title>Ports Benefits</title> <listitem> - <para>Packages are normally compiled with conservative options, - because they have to run on the maximum number of systems. By - installing from the port, you can tweak the compilation options to - (for example) generate code that is specific to a Pentium - 4 or Athlon processor.</para> + <para>Packages are normally compiled with conservative + options, because they have to run on the maximum number of + systems. By installing from the port, you can tweak the + compilation options to (for example) generate code that is + specific to a Pentium 4 or Athlon processor.</para> </listitem> <listitem> @@ -198,9 +205,9 @@ </listitem> <listitem> - <para>The licensing conditions of some software distributions forbid - binary distribution. They must be distributed as source - code.</para> + <para>The licensing conditions of some software distributions + forbid binary distribution. They must be distributed as + source code.</para> </listitem> <listitem> @@ -210,8 +217,8 @@ </listitem> <listitem> - <para>If you have local patches, you will need the source in order to - apply them.</para> + <para>If you have local patches, you will need the source in + order to apply them.</para> </listitem> <listitem> @@ -226,16 +233,16 @@ <warning> <para>Before installing any application, you should check <ulink - url="http://vuxml.freebsd.org/"></ulink>; for security issues + url="http://vuxml.freebsd.org/"></ulink>; for security issues related to your application.</para> - <para>You can also install <filename - role="package">ports-mgmt/portaudit</filename> which will - automatically check all installed applications for known - vulnerabilities; a check will be also performed before any port - build. Meanwhile, you can use the command <command>portaudit - -F -a</command> after you have installed some - packages.</para> + <para>You can also install + <filename role="package">ports-mgmt/portaudit</filename> + which will automatically check all installed applications for + known vulnerabilities; a check will be also performed before + any port build. Meanwhile, you can use the command + <command>portaudit -F -a</command> after you have installed + some packages.</para> </warning> <para>The remainder of this chapter will explain how to use @@ -246,8 +253,8 @@ <sect1 id="ports-finding-applications"> <title>Finding Your Application</title> - <para>Before you can install any applications you need to know what you - want, and what the application is called.</para> + <para>Before you can install any applications you need to know + what you want, and what the application is called.</para> <para>FreeBSD's list of available applications is growing all the time. Fortunately, there are a number of ways to find what you @@ -257,7 +264,7 @@ <listitem> <para>The FreeBSD 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>. + url="&url.base;/ports/index.html">http://www.FreeBSD.org/ports/</ulink>. The ports are divided into categories, and you may either search for an application by name (if you know it), or see all the applications available in a category.</para> @@ -267,65 +274,66 @@ <indexterm><primary>FreshPorts</primary></indexterm> <para>Dan Langille maintains FreshPorts, at <ulink - url="http://www.FreshPorts.org/"></ulink>. FreshPorts + url="http://www.FreshPorts.org/"></ulink>. FreshPorts tracks changes to the applications in the ports tree as they happen, allows you to <quote>watch</quote> one or more ports, and can send you email when they are updated.</para> </listitem> <listitem> - <indexterm><primary>Freecode</primary></indexterm> + <indexterm><primary>Freecode</primary></indexterm> <para>If you do not know the name of the application you want, try using a site like Freecode (<ulink - url="http://www.freecode.com/"></ulink>) to find an + url="http://www.freecode.com/"></ulink>) to find an application, then check back at the FreeBSD site to see if the application has been ported yet.</para> </listitem> <listitem> <para>If you know the exact name of the port, but just need to - find out which category it is in, you can use the - &man.whereis.1; command. - Simply type <command>whereis - <replaceable>file</replaceable></command>, where - <replaceable>file</replaceable> is the program you want to - install. If it is found on your system, you will be told - where it is, as follows:</para> + find out which category it is in, you can use the + &man.whereis.1; command. Simply type + <command>whereis <replaceable>file</replaceable></command>, + where <replaceable>file</replaceable> is the program you + want to install. If it is found on your system, you will be + told where it is, as follows:</para> - <screen>&prompt.root; <userinput>whereis lsof</userinput> + <screen>&prompt.root; <userinput>whereis lsof</userinput> lsof: /usr/ports/sysutils/lsof</screen> - <para>This tells us that <command>lsof</command> (a system - utility) can be found in the - <filename>/usr/ports/sysutils/lsof</filename> - directory.</para></listitem> + <para>This tells us that <command>lsof</command> (a system + utility) can be found in the + <filename>/usr/ports/sysutils/lsof</filename> + directory.</para> + </listitem> <listitem> - <para>Additionally, you can use a simple &man.echo.1; statement - to find where a port exists in the ports tree. For - example:</para> + <para>Additionally, you can use a simple &man.echo.1; + statement to find where a port exists in the ports tree. + For example:</para> <screen>&prompt.root; <userinput>echo /usr/ports/*/*lsof*</userinput> /usr/ports/sysutils/lsof</screen> - <para>Note that this will return any matched files downloaded into the - <filename class="directory">/usr/ports/distfiles</filename> + <para>Note that this will return any matched files downloaded + into the <filename + class="directory">/usr/ports/distfiles</filename> directory.</para> </listitem> <listitem> - <para>Yet another way to find a particular port is by using the - Ports Collection's built-in search mechanism. To use the - search feature, you will need to be in the - <filename>/usr/ports</filename> directory. Once in that - directory, run <command>make <maketarget>search</maketarget> - name=<replaceable>program-name</replaceable></command> where - <replaceable>program-name</replaceable> is the name of the - program you want to find. For example, if you were looking - for <command>lsof</command>:</para> + <para>Yet another way to find a particular port is by using + the Ports Collection's built-in search mechanism. To use + the search feature, you will need to be in the + <filename>/usr/ports</filename> directory. Once in that + directory, run <command>make <maketarget>search</maketarget> + name=<replaceable>program-name</replaceable></command> where + <replaceable>program-name</replaceable> is the name of the + program you want to find. For example, if you were looking + for <command>lsof</command>:</para> - <screen>&prompt.root; <userinput>cd /usr/ports</userinput> + <screen>&prompt.root; <userinput>cd /usr/ports</userinput> &prompt.root; <userinput>make search name=lsof</userinput> Port: lsof-4.56.4 Path: /usr/ports/sysutils/lsof @@ -335,36 +343,37 @@ Index: sysutils B-deps: R-deps: </screen> - <para>The part of the output you want to pay particular - attention to is the <quote>Path:</quote> line, since that - tells you where to find the port. The other information - provided is not needed in order to install the port, so it - will not be covered here.</para> - - <para>For more in-depth searching you can also use <command>make - <maketarget>search</maketarget> key=<replaceable>string</replaceable></command> - where <replaceable>string</replaceable> is some text to search for. - This searches port names, comments, descriptions and - dependencies and can be used to find ports which relate to a - particular subject if you do not know the name of the program - you are looking for.</para> - - <para>In both of these cases, the search string is case-insensitive. - Searching for <quote>LSOF</quote> will yield the same results as - searching for <quote>lsof</quote>.</para> + <para>The part of the output you want to pay particular + attention to is the <quote>Path:</quote> line, since that + tells you where to find the port. The other information + provided is not needed in order to install the port, so it + will not be covered here.</para> + + <para>For more in-depth searching you can also use + <command>make <maketarget>search</maketarget> + key=<replaceable>string</replaceable></command> where + <replaceable>string</replaceable> is some text to search + for. This searches port names, comments, descriptions and + dependencies and can be used to find ports which relate to a + particular subject if you do not know the name of the + program you are looking for.</para> + + <para>In both of these cases, the search string is + case-insensitive. Searching for <quote>LSOF</quote> will + yield the same results as searching for + <quote>lsof</quote>.</para> </listitem> - </itemizedlist> </sect1> <sect1 id="packages-using"> <sect1info> <authorgroup> - <author> - <firstname>Chern</firstname> + <author> + <firstname>Chern</firstname> <surname>Lee</surname> <contrib>Contributed by </contrib> - </author> + </author> </authorgroup> <!-- 30 Mar 2001 --> </sect1info> @@ -375,30 +384,37 @@ R-deps: </screen> FreeBSD:</para> <itemizedlist> - <listitem><para>The <command>sysinstall</command> utility can be invoked on a - running system to install, delete, and list available and - installed packages. For more information, see <xref - linkend="packages"/>.</para></listitem> - <listitem><para>The package management command line tools, which are - the subject of the rest of this section.</para></listitem> + <listitem> + <para>The <command>sysinstall</command> utility can be invoked + on a running system to install, delete, and list available + and installed packages. For more information, see + <xref linkend="packages"/>.</para> + </listitem> + + <listitem> + <para>The package management command line tools, which are + the subject of the rest of this section.</para> + </listitem> </itemizedlist> <sect2> <title>Installing a Package</title> + <indexterm> - <primary>packages</primary> - <secondary>installing</secondary> + <primary>packages</primary> + <secondary>installing</secondary> </indexterm> <indexterm> - <primary><command>pkg_add</command></primary> + <primary><command>pkg_add</command></primary> </indexterm> <para>You can use the &man.pkg.add.1; utility to install a FreeBSD software package from a local file or from a server on the network.</para> <example> - <title>Downloading a Package Manually and Installing It Locally</title> + <title>Downloading a Package Manually and Installing It + Locally</title> <screen>&prompt.root; <userinput>ftp -a <replaceable>ftp2.FreeBSD.org</replaceable></userinput> Connected to ftp2.FreeBSD.org. @@ -426,35 +442,34 @@ local: lsof-4.56.4.tgz remote: lsof-4.56 </example> <para>If you do not have a source of local packages (such as a - FreeBSD CD-ROM set) then it will probably be easier to use the - <option>-r</option> option to &man.pkg.add.1;. This will - cause the utility to automatically determine the correct - object format and release and then fetch and install the - package from an FTP site. - </para> + FreeBSD CD-ROM set) then it will probably be easier to use the + <option>-r</option> option to &man.pkg.add.1;. This will + cause the utility to automatically determine the correct + object format and release and then fetch and install the + package from an FTP site.</para> <indexterm> - <primary><command>pkg_add</command></primary></indexterm> + <primary><command>pkg_add</command></primary> + </indexterm> <screen>&prompt.root; <userinput>pkg_add -r <replaceable>lsof</replaceable></userinput></screen> <para>The example above would download the correct package and - add it without any further user intervention. - If you want to specify an alternative &os; Packages Mirror, - instead of the main distribution site, you have to set the - <envar>PACKAGESITE</envar> environment variable accordingly, to - override the default settings. &man.pkg.add.1; - uses &man.fetch.3; to download the files, which honors various + add it without any further user intervention. If you want to + specify an alternative &os; Packages Mirror, instead of the + main distribution site, you have to set the + <envar>PACKAGESITE</envar> environment variable accordingly, + to override the default settings. &man.pkg.add.1; uses + &man.fetch.3; to download the files, which honors various environment variables, including <envar>FTP_PASSIVE_MODE</envar>, <envar>FTP_PROXY</envar>, and <envar>FTP_PASSWORD</envar>. You may need to set one or more of these if you are behind a firewall, or need to use an FTP/HTTP proxy. See &man.fetch.3; for the complete list. - Note that in the example above - <literal>lsof</literal> is used instead of - <literal>lsof-4.56.4</literal>. When the remote fetching - feature is used, the version number of the package must be - removed. &man.pkg.add.1; will automatically fetch the latest - version of the application.</para> + Note that in the example above <literal>lsof</literal> is used + instead of <literal>lsof-4.56.4</literal>. When the remote + fetching feature is used, the version number of the package + must be removed. &man.pkg.add.1; will automatically fetch the + latest version of the application.</para> <note> <para>&man.pkg.add.1; will download the latest version of @@ -470,118 +485,132 @@ local: lsof-4.56.4.tgz remote: lsof-4.56 If you want to force &man.pkg.add.1; to download &os; 8-STABLE packages, set <envar>PACKAGESITE</envar> to - <literal>ftp://ftp.freebsd.org/pub/FreeBSD/ports/i386/packages-8-stable/Latest/</literal>. - </para> + <literal>ftp://ftp.freebsd.org/pub/FreeBSD/ports/i386/packages-8-stable/Latest/</literal>.</para>; </note> <para>Package files are distributed in <filename>.tgz</filename> - and <filename>.tbz</filename> formats. You can find them at <ulink - url="ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/packages/"></ulink>, - or on the FreeBSD CD-ROM distribution. Every CD on the - FreeBSD 4-CD set (and the PowerPak, etc.) contains packages - in the <filename>/packages</filename> directory. The layout - of the packages is 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>All</filename> directory. - </para> + and <filename>.tbz</filename> formats. You can find them at + <ulink + url="ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/packages/"></ulink>, + or on the FreeBSD CD-ROM distribution. Every CD on the + FreeBSD 4-CD set (and the PowerPak, etc.) contains packages in + the <filename>/packages</filename> directory. The layout of + the packages is 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>All</filename> directory.</para> <para>The directory structure of the package system matches the - ports layout; they work with each other to form the entire - package/port system. - </para> - + ports layout; they work with each other to form the entire + package/port system.</para> </sect2> <sect2> <title>Managing Packages</title> <indexterm> - <primary>packages</primary> - <secondary>managing</secondary> + <primary>packages</primary> + <secondary>managing</secondary> </indexterm> + <para>&man.pkg.info.1; is a utility that lists and describes - the various packages installed. - </para> + the various packages installed.</para> <indexterm> - <primary><command>pkg_info</command></primary> + <primary><command>pkg_info</command></primary> </indexterm> + <screen>&prompt.root; <userinput>pkg_info</userinput> cvsup-16.1 A general network file distribution system optimized for CV docbook-1.2 Meta-port for the different versions of the DocBook DTD ...</screen> + <para>&man.pkg.version.1; is a utility that summarizes the - versions of all installed packages. It compares the package - version to the current version found in the ports tree. - </para> + versions of all installed packages. It compares the package + version to the current version found in the ports tree.</para> + <indexterm> - <primary><command>pkg_version</command></primary> + <primary><command>pkg_version</command></primary> </indexterm> - <screen>&prompt.root; <userinput>pkg_version</userinput> + <screen>&prompt.root; <userinput>pkg_version</userinput> cvsup = docbook = ...</screen> <para>The symbols in the second column indicate the relative age - of the installed version and the version available in the - local ports tree.</para> + of the installed version and the version available in the + local ports tree.</para> <informaltable frame="none" pgwide="1"> - <tgroup cols="2"> + <tgroup cols="2"> <thead> - <row> - <entry>Symbol</entry> - <entry>Meaning</entry> - </row> - </thead> - - <tbody> - <row> - <entry>=</entry> <entry>The version of the - installed package matches the one found in the - local ports tree.</entry> - </row> - - <row><entry><</entry> - <entry>The installed version is older than the one available - in the ports tree.</entry> - </row> - - <row><entry>></entry><entry>The installed version is newer - than the one found in the local ports tree. (The local ports - tree is probably out of date.)</entry></row> - - <row><entry>?</entry><entry>The installed package cannot be - found in the ports index. (This can happen, for instance, if an - installed port is removed from the Ports Collection or - renamed.)</entry></row> - - <row><entry>*</entry><entry>There are multiple versions of the - package.</entry></row> - - <row><entry>!</entry><entry>The installed package exists in the - index but for some reason, <command>pkg_version</command> was - unable to compare the version number of the installed package - with the corresponding entry in the index.</entry></row> - - </tbody> + <row> + <entry>Symbol</entry> + <entry>Meaning</entry> + </row> + </thead> + + <tbody> + <row> + <entry>=</entry> + <entry>The version of the installed package matches the + one found in the local ports tree.</entry> + </row> + + <row> + <entry><</entry> + <entry>The installed version is older than the one + available in the ports tree.</entry> + </row> + + <row> + <entry>></entry><entry>The installed version is newer + than the one found in the local ports tree. (The + local ports tree is probably out of + date.)</entry> + </row> + + <row> + <entry>?</entry> + <entry>The installed package cannot be found in the + ports index. (This can happen, for instance, if an + installed port is removed from the Ports Collection or + renamed.)</entry> + </row> + + <row> + <entry>*</entry> + <entry>There are multiple versions of the + package.</entry> + </row> + + <row> + <entry>!</entry> + + <entry>The installed package exists in the index but for + some reason, <command>pkg_version</command> was unable + to compare the version number of the installed package + with the corresponding entry in the index.</entry> + </row> + </tbody> </tgroup> - </informaltable> + </informaltable> </sect2> <sect2> <title>Deleting a Package</title> + <indexterm> - <primary><command>pkg_delete</command></primary> + <primary><command>pkg_delete</command></primary> </indexterm> + <indexterm> - <primary>packages</primary> - <secondary>deleting</secondary> + <primary>packages</primary> + <secondary>deleting</secondary> </indexterm> + <para>To remove a previously installed software package, use the - &man.pkg.delete.1; utility. - </para> + &man.pkg.delete.1; utility.</para> <screen>&prompt.root; <userinput>pkg_delete <replaceable>xchat-1.7.1</replaceable></userinput></screen> @@ -590,7 +619,8 @@ docbook = <replaceable>xchat</replaceable> was given instead of <replaceable>xchat-1.7.1</replaceable>. It is, however, easy to use &man.pkg.version.1; to find the version of the - installed package. You could instead simply use a wildcard:</para> + installed package. You could instead simply use a + wildcard:</para> <screen>&prompt.root; <userinput>pkg_delete <replaceable>xchat\*</replaceable></userinput></screen> @@ -600,21 +630,22 @@ docbook = <sect2> <title>Miscellaneous</title> + <para>All package information is stored within the - <filename>/var/db/pkg</filename> directory. The installed + <filename>/var/db/pkg</filename> directory. The installed file list and descriptions of each package can be found within - files in this directory. - </para> + files in this directory.</para> </sect2> </sect1> <sect1 id="ports-using"> <title>Using the Ports Collection</title> - <para>The following sections provide basic instructions on using the - Ports Collection to install or remove programs from your - system. The detailed description of available <command>make</command> - targets and environment variables is available in &man.ports.7;.</para> + <para>The following sections provide basic instructions on using + the Ports Collection to install or remove programs from your + system. The detailed description of available + <command>make</command> targets and environment variables is + available in &man.ports.7;.</para> <warning> <para>As of late 2012, the &os; Ports Project is in the @@ -703,7 +734,7 @@ docbook = <screen>&prompt.root; <userinput>pkg_add -r subversion</userinput></screen> <para>If <application>pkgng</application> is being used to - manage packages, <application>Subversion</application> can + manage packages, <application>Subversion</application> can be installed with it instead:</para> <screen>&prompt.root; <userinput>pkg install subversion</userinput></screen> @@ -745,23 +776,25 @@ docbook = 2013.</para> </warning> - <para>This is a quick method for getting and keeping your copy of the - Ports Collection up to date using <application>CVSup</application> - protocol. If you want to learn more about - <application>CVSup</application>, see <link - linkend="cvsup">Using CVSup</link>.</para> + <para>This is a quick method for getting and keeping your copy + of the Ports Collection up to date using + <application>CVSup</application> protocol. If you want to + learn more about <application>CVSup</application>, see + <link linkend="cvsup">Using CVSup</link>.</para> <note> - <para>The implementation of <application>CVSup</application> protocol - included with the &os; system is called + <para>The implementation of <application>CVSup</application> + protocol included with the &os; system is called <application>csup</application>.</para> </note> - <para>Make sure <filename class="directory">/usr/ports</filename> - is empty before you run <application>csup</application> for - the first time! If you already have the Ports Collection present, - obtained from another source, <application>csup</application> - will not prune removed patch files.</para> + <para>Make sure + <filename class="directory">/usr/ports</filename> is empty + before you run <application>csup</application> for the first + time! If you already have the Ports Collection present, + obtained from another source, + <application>csup</application> will not prune removed patch + files.</para> <step> <para>Run <command>csup</command>:</para> @@ -771,9 +804,9 @@ docbook = <para>Change <replaceable>cvsup.FreeBSD.org</replaceable> to a <application>CVSup</application> server near you. See - <link linkend="cvsup-mirrors">CVSup Mirrors</link> (<xref - linkend="cvsup-mirrors"/>) for a complete listing of mirror - sites.</para> + <link linkend="cvsup-mirrors">CVSup Mirrors</link> + (<xref linkend="cvsup-mirrors"/>) for a complete listing + of mirror sites.</para> <note> <para>One may want to use his own @@ -814,20 +847,22 @@ docbook = </step> <step> - <para>Running the &man.csup.1; command later will download and apply - all the recent changes to your Ports Collection, except - actually rebuilding the ports for your own system.</para> + <para>Running the &man.csup.1; command later will download + and apply all the recent changes to your Ports Collection, + except actually rebuilding the ports for your own + system.</para> </step> </procedure> <procedure> <title>Sysinstall Method</title> - <para>This method involves using <application>sysinstall</application> - to install the Ports Collection from the installation media. Note - that the old copy of Ports Collection from the date of the release - will be installed. If you have Internet access, you should always - use one of the methods mentioned above.</para> + <para>This method involves using + <application>sysinstall</application> to install the Ports + Collection from the installation media. Note that the old + copy of Ports Collection from the date of the release will + be installed. If you have Internet access, you should + always use one of the methods mentioned above.</para> <step> <para>As <username>root</username>, run @@ -837,8 +872,9 @@ docbook = </step> <step> - <para>Scroll down and select <guimenuitem>Configure</guimenuitem>, - press <keycap>Enter</keycap>.</para> + <para>Scroll down and select + <guimenuitem>Configure</guimenuitem>, press + <keycap>Enter</keycap>.</para> </step> <step> @@ -878,15 +914,16 @@ docbook = <title>Installing Ports</title> <indexterm> - <primary>ports</primary> - <secondary>installing</secondary> + <primary>ports</primary> + <secondary>installing</secondary> </indexterm> + <para>The first thing that should be explained when it comes to - the Ports Collection is what is actually meant by a - <quote>skeleton</quote>. In a nutshell, a port skeleton is a - minimal set of files that tell your FreeBSD system how to - cleanly compile and install a program. Each port skeleton - includes:</para> + the Ports Collection is what is actually meant by a + <quote>skeleton</quote>. In a nutshell, a port skeleton is a + minimal set of files that tell your FreeBSD system how to + cleanly compile and install a program. Each port skeleton + includes:</para> <itemizedlist> <listitem> @@ -916,13 +953,14 @@ docbook = <quote>diffs</quote> because they are generated by the &man.diff.1; program.</para> - <para>This directory may also contain other files used to build - the port.</para> + <para>This directory may also contain other files used to + build the port.</para> </listitem> <listitem> <para>A <filename>pkg-descr</filename> file. This is a more - detailed, often multiple-line, description of the program.</para> + detailed, often multiple-line, description of the + program.</para> </listitem> <listitem> @@ -934,32 +972,32 @@ docbook = </itemizedlist> <para>Some ports have other files, such as - <filename>pkg-message</filename>. The ports system uses these - files to handle special situations. If you want more details - on these files, and on ports in general, check out the <ulink - url="&url.books.porters-handbook;/index.html">FreeBSD Porter's - Handbook</ulink>.</para> + <filename>pkg-message</filename>. The ports system uses these + files to handle special situations. If you want more details + on these files, and on ports in general, check out the + <ulink url="&url.books.porters-handbook;/index.html">FreeBSD + Porter's Handbook</ulink>.</para> <para>The port includes instructions on how to build source - code, but does not include the actual source code. You can - get the source code from a CD-ROM or from the Internet. - Source code is distributed in whatever manner the software - author desires. Frequently this is a tarred and gzipped file, - but it might be compressed with some other tool or even - uncompressed. The program source code, whatever form it comes - in, is called a <quote>distfile</quote>. The two methods for - installing a &os; port are described below.</para> + code, but does not include the actual source code. You can + get the source code from a CD-ROM or from the Internet. + Source code is distributed in whatever manner the software + author desires. Frequently this is a tarred and gzipped file, + but it might be compressed with some other tool or even + uncompressed. The program source code, whatever form it comes + in, is called a <quote>distfile</quote>. The two methods for + installing a &os; port are described below.</para> <note> - <para>You must be logged in as <username>root</username> to - install ports.</para> + <para>You must be logged in as <username>root</username> to + install ports.</para> </note> <warning> <para>Before installing any port, you should be sure to have - an up-to-date Ports Collection and you should check <ulink - url="http://vuxml.freebsd.org/"></ulink>; for security issues - related to your port.</para> + an up-to-date Ports Collection and you should check + <ulink url="http://vuxml.freebsd.org/"></ulink>; for security + issues related to your port.</para> <para>A security vulnerabilities check can be automatically done by <application>portaudit</application> before any new @@ -974,23 +1012,23 @@ docbook = manual pages.</para> </warning> - <para>The Ports Collection makes an assumption that you have a working - Internet connection. If you do not, you will need to put a copy of the - distfile into <filename>/usr/ports/distfiles</filename> - manually.</para> - - <para>To begin, change to the directory for the port you want to - install:</para> - - <screen>&prompt.root; <userinput>cd /usr/ports/sysutils/lsof</userinput></screen> - - <para>Once inside the <filename>lsof</filename> directory, you - will see the port skeleton. The next step is to compile, or - <quote>build</quote>, the port. This is done by simply - typing <command>make</command> at the prompt. Once you have - done so, you should see something like this:</para> + <para>The Ports Collection makes an assumption that you have a + working Internet connection. If you do not, you will need to + put a copy of the distfile into + <filename>/usr/ports/distfiles</filename> manually.</para> + + <para>To begin, change to the directory for the port you want + to install:</para> + + <screen>&prompt.root; <userinput>cd /usr/ports/sysutils/lsof</userinput></screen> + + <para>Once inside the <filename>lsof</filename> directory, you + will see the port skeleton. The next step is to compile, or + <quote>build</quote>, the port. This is done by simply + typing <command>make</command> at the prompt. Once you have + done so, you should see something like this:</para> - <screen>&prompt.root; <userinput>make</userinput> + <screen>&prompt.root; <userinput>make</userinput> >> lsof_4.57D.freebsd.tar.gz doesn't seem to exist in /usr/ports/distfiles/. >> Attempting to fetch from ftp://lsof.itap.purdue.edu/pub/tools/unix/lsof/. ===> Extracting for lsof-4.57 @@ -1010,13 +1048,13 @@ docbook = ... &prompt.root;</screen> - <para>Notice that once the compile is complete you are - returned to your prompt. The next step is to install the - port. In order to install it, you simply need to tack one word - onto the <command>make</command> command, and that word is - <maketarget>install</maketarget>:</para> + <para>Notice that once the compile is complete you are + returned to your prompt. The next step is to install the + port. In order to install it, you simply need to tack one + word onto the <command>make</command> command, and that word + is <maketarget>install</maketarget>:</para> - <screen>&prompt.root; <userinput>make install</userinput> + <screen>&prompt.root; <userinput>make install</userinput> ===> Installing for lsof-4.57 ... [installation output snipped] @@ -1029,159 +1067,164 @@ docbook = increased privileges. &prompt.root;</screen> - <para>Once you are returned to your prompt, you should be able to - run the application you just installed. Since - <command>lsof</command> is a - program that runs with increased privileges, a security - warning is shown. During the building and installation of - ports, you should take heed of any other warnings that - may appear.</para> - - <para>It is a good idea to delete the working subdirectory, - which contains all the temporary files used during compilation. - Not only does it consume valuable disk space, but it would also - cause problems later when upgrading to the newer version of the - port.</para> + <para>Once you are returned to your prompt, you should be able + to run the application you just installed. Since + <command>lsof</command> is a program that runs with + increased privileges, a security warning is shown. During + the building and installation of ports, you should take heed + of any other warnings that may appear.</para> + + <para>It is a good idea to delete the working subdirectory, + which contains all the temporary files used during + compilation. Not only does it consume valuable disk space, + but it would also cause problems later when upgrading to the + newer version of the port.</para> - <screen>&prompt.root; <userinput>make clean</userinput> + <screen>&prompt.root; <userinput>make clean</userinput> ===> Cleaning for lsof-4.57 &prompt.root;</screen> - <note> - <para>You can save two extra steps by just running <command>make - <maketarget>install clean</maketarget></command> instead of - <command>make</command>, - <command>make <maketarget>install</maketarget></command> and - <command>make <maketarget>clean</maketarget></command> - as three separate steps.</para> - </note> + <note> + <para>You can save two extra steps by just running + <command>make + <maketarget>install clean</maketarget></command> + instead of <command>make</command>, + <command>make <maketarget>install</maketarget></command> + and <command>make <maketarget>clean</maketarget></command> + as three separate steps.</para> + </note> - <note> - <para>When installing a port, using only <command>make - <maketarget>install</maketarget></command> from the - beginning means there will potentially be many waiting - periods between user interaction as the default behaviour - is to prompt the user for options. When there are many - dependencies, this sometimes makes building a single port - a huge hassle. To avoid this, first run <command>make - <maketarget>config-recursive</maketarget></command> to - do the configuration in one batch. Then run - <command>make <maketarget>install - [clean]</maketarget></command> afterwards.</para> - </note> + <note> + <para>When installing a port, using only + <command>make <maketarget>install</maketarget></command> + from the beginning means there will potentially be many + waiting periods between user interaction as the default + behaviour is to prompt the user for options. When there are + many dependencies, this sometimes makes building a single + port a huge hassle. To avoid this, first run <command>make + <maketarget>config-recursive</maketarget></command> to do + the configuration in one batch. Then run <command>make + <maketarget>install [clean]</maketarget></command> + afterwards.</para> + </note> - <tip> - <para>When using <maketarget>config-recursive</maketarget>, - the list of ports to configure are gathered by the - <maketarget>all-depends-list</maketarget> &man.make.1; - target. It is often recommended to run <command>make - <maketarget>config-recursive</maketarget></command> - until all dependent ports options have been defined, and - ports options &man.dialog.1; screens no longer - appear, to be certain all ports options have been - configured as intended.</para> - </tip> *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201210032141.q93Lf08P097233>