FreeBSD Bugzilla – Attachment 22550 Details for
Bug 39084
Various tweaks to doc/en_US.ISO8859-1/books/handbook/ports/chapter.sgml
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
Remember
[x]
|
Forgot Password
Login:
[x]
[patch]
chapter.sgml.diff
chapter.sgml.diff (text/plain), 26.84 KB, created by
Chris Pepper
on 2002-06-10 05:00:05 UTC
(
hide
)
Description:
chapter.sgml.diff
Filename:
MIME Type:
Creator:
Chris Pepper
Created:
2002-06-10 05:00:05 UTC
Size:
26.84 KB
patch
obsolete
>Index: chapter.sgml >=================================================================== >RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/ports/chapter.sgml,v >retrieving revision 1.167 >diff -u -r1.167 chapter.sgml >--- chapter.sgml 2002/06/09 10:47:41 1.167 >+++ chapter.sgml 2002/06/10 03:10:17 >@@ -57,7 +57,7 @@ > </step> > > <step> >- <para>Locate the documentation (perhaps a <filename>README</filename> >+ <para>Locate the documentation (perhaps an <filename>INSTALL</filename> or <filename>README</filename> > file, or some files in a <filename>doc/</filename> subdirectory) and > read up on how to install the software.</para> > </step> >@@ -79,19 +79,19 @@ > > <para>Should you want to, you can continue to install software the > <quote>traditional</quote> way with FreeBSD. However, FreeBSD >- provides two technologies which can save you a lot of effort; >+ provides two related technologies which can save you a lot of effort: > packages and ports. At the time of writing, over &os.numports; > third party applications have been made available in this > way.</para> > > <para>For any given application, the FreeBSD package for that application >- is a single file which you must download. The package contains >+ is a single file which you may download. The package contains > pre-compiled copies of all the commands for the application, as well as > any configuration files or documentation. A downloaded package file can > be manipulated with FreeBSD package management commands, such as > &man.pkg.add.1;, &man.pkg.delete.1;, &man.pkg.info.1;, and so on.</para> > >- <para>Installing a new application can be carried out with a single >+ <para>Installing a new application can be carried out with a single &man.pkg.add.1; > command.</para> > > <para>A FreeBSD port for an application is a collection of files designed >@@ -99,7 +99,7 @@ > code.</para> > > <para>Remember that there are a number of steps you would normally carry >- out if you compiled a program yourself (unpacking, patching, compiling, >+ out if you compiled a program yourself (downloading, unpacking, patching, compiling, > installing). The files that make up a port contain all the necessary > information to allow the system to do this for you. You run a handful > of simple commands and the source code for the application is >@@ -117,7 +117,7 @@ > the application and the library have been made available as FreeBSD > ports and packages. If you use the <command>pkg_add</command> command > or the ports system to add the application, both will notice that the >- library has not been installed, and the commands will install the >+ library has not been installed, and automatically install the > library first.</para> > > <para>Given that the two technologies are quite similar, you might be >@@ -221,8 +221,8 @@ > <para>The FreeBSD web site maintains an up-to-date searchable list of > all the available applications, at > <ulink url="../../../../ports/index.html">http://www.FreeBSD.org/ports/</ulink>. >- The name space is divided into categories, and you may either >- search for an application by name (if you know it), or you can list >+ 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> > </listitem> > >@@ -232,8 +232,8 @@ > <para>Dan Langille maintains FreshPorts, at > <ulink url="http://www.FreshPorts.org/">http://www.FreshPorts.org/</ulink>. > FreshPorts tracks changes to the applications in the ports tree as >- they happen, and allows you to <quote>watch</quote> one or more >- ports, and will send you an email when they are updated.</para> >+ they happen, allows you to <quote>watch</quote> one or more >+ ports, and can send you email when they are updated.</para> > </listitem> > > <indexterm><primary>FreshMeat</primary></indexterm> >@@ -277,7 +277,7 @@ > the network.</para> > > <example> >- <title>Downloading a Package and then Installing It Locally</title> >+ <title>Downloading a Package Manually and then Installing It Locally</title> > > <screen>&prompt.root; <userinput>ftp -a <replaceable>ftp2.FreeBSD.org</replaceable></userinput> > Connected to ftp2.FreeBSD.org. >@@ -305,10 +305,10 @@ > </example> > > <para>If you do not have a source of local packages (such as a >- FreeBSD CDROM set) then it will probably be easier to use the >+ 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 to fetch and install the package from an FTP site. >+ and then fetch and install the package from an FTP site. > </para> > > <indexterm> >@@ -322,8 +322,8 @@ > find them at <ulink > url="ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/packages/"> > ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/packages/</ulink>, >- or on the FreeBSD CDROM distribution. Every CD on the >- FreeBSD 4-CD set (and PowerPak, etc) contains packages in >+ 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 >@@ -331,30 +331,14 @@ > <filename>All</filename> directory. > </para> > >- <para>The directory structure of the package system is identical >- to that of the ports; they work with each other to form the entire >+ <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> > > </sect2> > > <sect2> >- <title>Deleting a Package</title> >- <indexterm> >- <primary><command>pkg_delete</command></primary> >- </indexterm> >- <indexterm> >- <primary>packages</primary> >- <secondary>deleting</secondary> >- </indexterm> >- <para>To remove a previously installed software package, use the >- &man.pkg.delete.1; utility. >- </para> >- >- <screen>&prompt.root; <userinput>pkg_delete <replaceable>xchat-1.7.1</replaceable></userinput></screen> >- </sect2> >- >- <sect2> > <title>Managing Packages</title> > > <indexterm> >@@ -425,6 +409,22 @@ > </sect2> > > <sect2> >+ <title>Deleting a Package</title> >+ <indexterm> >+ <primary><command>pkg_delete</command></primary> >+ </indexterm> >+ <indexterm> >+ <primary>packages</primary> >+ <secondary>deleting</secondary> >+ </indexterm> >+ <para>To remove a previously installed software package, use the >+ &man.pkg.delete.1; utility. >+ </para> >+ >+ <screen>&prompt.root; <userinput>pkg_delete <replaceable>xchat-1.7.1</replaceable></userinput></screen> >+ </sect2> >+ >+ <sect2> > <title>Miscellaneous</title> > <para>All package information is stored within the > <filename>/var/db/pkg</filename> directory. The installed >@@ -471,27 +471,27 @@ > > <step> > <para>Scroll down and select <literal>Configure</literal>, >- press <keycap>Enter</keycap>.</para> >+ then press <keycap>Enter</keycap>.</para> > </step> > > <step> > <para>Scroll down and select >- <literal>Distributions</literal>, press <keycap>Enter</keycap>.</para> >+ <literal>Distributions</literal>, then press <keycap>Enter</keycap>.</para> > </step> > > <step> >- <para>Scroll down to <literal>ports</literal>, press >+ <para>Scroll down to <literal>ports</literal>, then press > <keycap>Space</keycap>.</para> > </step> > > <step> >- <para>Scroll up to <literal>Exit</literal>, press >+ <para>Scroll up to <literal>Exit</literal>, then press > <keycap>Enter</keycap>.</para> > </step> > > <step> >- <para>Select your desired installation media, such as CDROM, >- FTP, and so on.</para> >+ <para>Select your desired installation media, such as CD-ROM, >+ FTP, or something else.</para> > </step> > > <step> >@@ -506,12 +506,12 @@ > <filename>/usr/share/examples/cvsup/ports-supfile</filename>. > See <link linkend="cvsup">Using CVSup</link> (<xref > linkend="cvsup">) for more information on using >- <application>CVSup</application> and the mentioned file.</para> >+ <application>CVSup</application> and this file.</para> > > <procedure> > <title>CVSup Method</title> > >- <para>This is a quick method to getting the ports collection >+ <para>This is a quick method for getting the ports collection > using <application>CVSup</application>. If you want to keep > your ports tree up to date, or learn more about > <application>CVSup</application>, read the previously >@@ -536,7 +536,7 @@ > > <step> > <para>Change <replaceable>CHANGE_THIS.FreeBSD.org</replaceable> to a >- <application>CVSup</application> near you. See <link >+ <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> >@@ -549,9 +549,9 @@ > </step> > > <step> >- <para>Running this consequent times at later dates will >- download all the recent changes to your ports >- collection.</para> >+ <para>Running this 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> > </sect2> >@@ -580,7 +580,7 @@ > <listitem> > <para>A <filename>distinfo</filename> file. This file contains > information about the files that must be downloaded to build the >- port, and checksums, to ensure that those files have not been >+ port and their checksums, to verify that files have not been > corrupted during the download.</para> > </listitem> > >@@ -594,7 +594,7 @@ > known as <quote>diffs</quote> because they are generated by the > <application>diff</application> program.</para> > >- <para>This directory may also contain other files used in building >+ <para>This directory may also contain other files used to build > the port.</para> > </listitem> > >@@ -627,7 +627,7 @@ > first port. There are two ways this can be done, and each is > explained below.</para> > >- <para>Before we get into that however, you will need to choose a >+ <para>Before we get into that, however, you will need to choose a > port to install. There are a few ways to do this, with the > easiest method being the <ulink > url="../../../../ports/index.html">ports listing on the FreeBSD >@@ -640,7 +640,7 @@ > 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, like so:</para> >+ your system, you will be told where it is, as follows:</para> > > <screen>&prompt.root; <userinput>whereis lsof</userinput> > lsof: /usr/ports/sysutils/lsof</screen> >@@ -649,7 +649,7 @@ > can be found in the > <filename>/usr/ports/sysutils/lsof</filename> directory.</para> > >- <para>Yet another way of finding a particular port is by using the >+ <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 >@@ -670,8 +670,8 @@ > > <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 it. The other information provided is not needed in order >- to install the port directly, so it will not be covered >+ 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 >@@ -686,39 +686,39 @@ > searching for <quote>lsof</quote>.</para> > > <note> >- <para>You must be the <username>root</username> user to install >+ <para>You must be logged in as <username>root</username> to install > ports.</para> > </note> > > <para>Now that you have found a port you would like to install, > you are ready to do the actual installation. The port >- includes instructions on how to build source code, but no >- actual source code. You can get the source code from a CDROM >+ includes instructions on how to build source code, but not 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>. You can get the distfile from a >- CDROM or from the Internet.</para> >+ CD-ROM or from the Internet.</para> > > <sect3 id="ports-cd"> >- <title>Installing Ports from a CDROM</title> >+ <title>Installing Ports from a CD-ROM</title> > > <indexterm> > <primary>ports</primary> >- <secondary>installing from CDROM</secondary> >+ <secondary>installing from CD-ROM</secondary> > </indexterm> >- <para>The FreeBSD Project's official CDROM images no longer >+ <para>The FreeBSD Project's official CD-ROM images no longer > include distfiles. They take up a lot of room that is >- better used by precompiled packages. CDROM products such as >+ better used for precompiled packages. CD-ROM products such as > the FreeBSD PowerPak do include distfiles, and you can > order these sets from a vendor such as the <ulink > url="http://www.freebsdmall.com/">FreeBSD Mall</ulink>. >- This section assumes you have such a FreeBSD CDROM >+ This section assumes you have such a FreeBSD CD-ROM > set.</para> > >- <para>Place your FreeBSD CDROM in the drive. Mount it on >+ <para>Place your FreeBSD CD-ROM in the drive. Mount it on > <filename>/cdrom</filename>. (If you use a different mount > point, the install will not work.) To begin, change to the > directory for the port you want to install:</para> >@@ -727,7 +727,7 @@ > > <para>Once inside the <filename>lsof</filename> directory, > you will see the port >- skeleton. The next step is to compile (also called build) the >+ 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> >@@ -752,7 +752,7 @@ > ... > &prompt.root;</screen> > >- <para>Take notice that once the compile is complete you are >+ <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 >@@ -787,11 +787,11 @@ > > <note> > <para>Please be aware that the licenses of a few ports do not >- allow for inclusion on the CDROM. This could be because a >+ allow for inclusion on the CD-ROM. This could be because a > registration form needs >- to be filled out before downloading, redistribution is not >- allowed, and so on. If you wish to install a port not >- included on the CDROM, you will need to be online in order to >+ to be filled out before downloading or redistribution is not >+ allowed, or for another reason. If you wish to install a port not >+ included on the CD-ROM, you will need to be online in order to > do so (see the <link linkend="ports-inet">next > section</link>).</para> > </note> >@@ -802,14 +802,14 @@ > > <para>As with the last section, this section makes an assumption > that you have a working Internet connection. If you do not, >- you will need to perform the <link linkend="ports-cd">CDROM >- installation</link>.</para> >+ you will need to perform the <link linkend="ports-cd">CD-ROM >+ installation</link>, or put a copy of the distfile into <filename>/usr/ports/distfiles</filename> manually.</para> > > <para>Installing a port from the Internet is done exactly the same >- way as it would be if you were installing from a CDROM. The >- only difference between the two is that the port distfile >- is downloaded from the Internet instead of pulled from the >- CDROM.</para> >+ way as it would be if you were installing from a CD-ROM. The >+ only difference between the two is that the distfile >+ is downloaded from the Internet instead of read from the >+ CD-ROM.</para> > > <para>The steps involved are identical:</para> > >@@ -863,7 +863,7 @@ > </indexterm> > <para>Now that you know how to install ports, you are probably > wondering how to remove them, just in case you install one and >- later on you decide that you installed the wrong port. >+ later on decide that you installed the wrong port. > We will remove our previous example (which was > <command>lsof</command> for > those of you not paying attention). As with installing ports, >@@ -908,7 +908,7 @@ > <itemizedlist> > <listitem> > <para>Use &man.pkg.info.1; to find out which files were installed, >- and where they were installed to. For example, if you have just >+ and where. For example, if you have just > installed FooPackage version 1.0.0, then this command</para> > > <screen>&prompt.root; <userinput>pkg_info -L foopackage-1.0.0 | less</userinput></screen> >@@ -926,7 +926,7 @@ > > <para>will find all the installed packages that have > <replaceable>foopackage</replaceable> in the package name. Replace >- <replaceable>foopackage</replaceable> in your commandline as >+ <replaceable>foopackage</replaceable> in your command line as > necessary.</para> > </listitem> > >@@ -939,14 +939,14 @@ > > <listitem> > <para>If the application has a web site, check it for additional >- documentation, frequently asked question files, and so forth. If >+ documentation, frequently asked questions, and so forth. If > you are not sure of the web site address it may be listed in the > output from</para> > > <screen>&prompt.root; <userinput>pkg_info <replaceable>foopackage-1.0.0</replaceable></userinput></screen> > >- <para>will often include a <literal>WWW:</literal> line with the URL >- of the application's web site.</para> >+ <para>A <literal>WWW:</literal> line, if present, should provide a URL >+ for the application's web site.</para> > </listitem> > </itemizedlist> > </sect1> >@@ -973,7 +973,7 @@ > <para>Ah, you must be thinking of the serial ports on the back > of your computer. We are using <quote>port</quote> here to > mean the result of <quote>porting</quote> a program from one >- version of Unix to another.</para> >+ operating system to another.</para> > </answer> > </qandaentry> > >@@ -986,7 +986,7 @@ > <para>A patch is a small file that specifies how to go from > one version of a file to another. It contains plain text, > and basically says things like <quote>delete line 23</quote>, >- <quote>add these two lines after line 468</quote>, or >+ <quote>add these two lines after line 468</quote>, and > <quote>change line 197 to this</quote>. They are also known > as diffs because they are generated by the > <application>diff</application> program.</para> >@@ -1001,21 +1001,20 @@ > </question> > > <answer> >- <para>It is a file ending in <filename>.tar</filename>, or >- with variations such as <filename>.tar.gz</filename>, >+ <para>A tarball is a file, with a name generally ending in <filename>.tar</filename>, <filename>.tar.gz</filename>, > <filename>.tar.Z</filename>, <filename>.tar.bz2</filename>, >- and even <filename>.tgz</filename>.</para> >+ or even <filename>.tgz</filename>.</para> > >- <para>Basically, it is a directory tree that has been archived >+ <para>Basically, a tarball is a directory tree that has been archived > into a single file (<filename>.tar</filename>) and >- optionally compressed (<filename>.gz</filename>). This >+ optionally compressed (<filename>.gz</filename>, <filename>.Z</filename>, or <filename>.bz2</filename>). This > technique was originally used for <emphasis>T</emphasis>ape > <emphasis>AR</emphasis>chives (hence the name >- <command>tar</command>), but it is a widely used way of >+ <command>tar</command>), but it is a common way of > distributing program source code around the Internet.</para> > >- <para>You can see what files are in them, or even extract >- them yourself by using the standard Unix >+ <para>You can see what files are in tarballs, or even extract >+ the contents yourself, by using the standard Unix > <command>tar</command> program, which comes with the base > FreeBSD system, like this:</para> > >@@ -1029,7 +1028,7 @@ > <indexterm><primary>checksum</primary></indexterm> > <qandaentry> > <question> >- <para id="ports-checksum">And a checksum?</para> >+ <para id="ports-checksum">And checksums?</para> > </question> > > <answer> >@@ -1038,12 +1037,18 @@ > change, the checksum will no longer be equal to the total, > so a simple comparison will allow you to spot the > difference.</para> >+ >+ <para>If a stored checksum matches the checksum calculated >+ for a file, such as a tarball, the file matches the >+ original for which the checksum was calculated. If there's >+ a discrepancy, there's a problem, such as file corruption; >+ removing the tarball and redownloading may fix the problem.</para> > </answer> > </qandaentry> > > <qandaentry> > <question> >- <para>I did what you said for compiling ports from a CDROM and >+ <para>I did what you said for compiling ports from a CD-ROM and > it worked great until I tried to install the kermit > port.</para> > >@@ -1051,21 +1056,21 @@ > >> cku190.tar.gz doesn't seem to exist on this system. > >> Attempting to fetch from ftp://kermit.columbia.edu/kermit/archives/.</screen> > >- <para>Why can it not be found? Have I got a dud CDROM?</para> >+ <para>Why can it not be found? Have I got a dud CD-ROM?</para> > </question> > > <answer> > <para>As explained in the <link >- linkend="ports-cd">compiling ports from CDROM</link> >- section, some ports cannot be put on the CDROM set >+ linkend="ports-cd">compiling ports from CD-ROM</link> >+ section, some distfiles cannot be put on the CD-ROM set > due to licensing restrictions. Kermit is an example of > that. The licensing terms for kermit do not allow us to put >- the tarball for it on the CDROM, so you will have to fetch >+ the tarball for it on the CD-ROM, so you will have to fetch > it by hand—sorry!</para> > > <para>The reason why you got all those error messages was > because you were not connected to the Internet at the time. >- Once you have downloaded it from any of the <makevar>MASTER_SITES</makevar> >+ Once you have downloaded the distfile from any of the <makevar>MASTER_SITES</makevar> > (listed in the <filename>Makefile</filename>), you can restart the install > process.</para> > </answer> >@@ -1082,7 +1087,7 @@ > <para>The ports mechanism will download distribution > tarballs into <filename>/usr/ports/distfiles</filename>, > but many system administrators will symlink this directory >- to a remote file server or local read-only CDROM media. >+ to a remote file server or local read-only CD-ROM media. > If this is the case, then you should specify a different > directory to be used for storing distfiles with the > following command:</para> >@@ -1136,7 +1141,7 @@ > job.</para> > > <para>If you do not fancy typing all that in every time you >- install a port, it is a good idea to put these variables >+ install a port, you can put these variables > into your environment. Read the manual page for your shell for > instructions on doing so.</para> > </answer> >@@ -1144,7 +1149,7 @@ > > <qandaentry> > <question> >- <para>I do not have a FreeBSD CDROM, but I would like to have >+ <para>I do not have a FreeBSD CD-ROM, but I would like to have > all the tarballs handy on my system so I do not have to wait > for a download every time I install a port. Is there any > way to get them all at once?</para> >@@ -1248,7 +1253,7 @@ > unless you used the <option>-fno-strength-reduce</option> > option as well. (Most of the ports do not use > <option>-O2</option>). You <emphasis>should</emphasis> be >- able to specify the compiler options used by something >+ able to specify compiler options with something > like:</para> > > <screen>&prompt.root; <userinput>make CFLAGS='-O2 -fno-strength-reduce' install</userinput></screen> >@@ -1258,7 +1263,7 @@ > is to do <command>make configure</command>, then go into > the source directory and inspect the Makefiles by hand, but > this can get tedious if the source has lots of >- sub-directories, each with their own Makefiles.</para> >+ sub-directories, each with its own Makefile.</para> > > <para>The default FreeBSD compiler options are quite conservative, > so if you have not changed them you should not have any >@@ -1287,7 +1292,7 @@ > > <qandaentry> > <question> >- <para>I went to install the <literal>foo</literal> port but >+ <para>I tried to install the <literal>foo</literal> port but > the system suddenly stopped compiling it and starting > compiling the <literal>bar</literal> port. What is going > on?</para> >@@ -1300,7 +1305,7 @@ > <literal>bar</literal> might have a library with useful > graphics processing routines. Or <literal>bar</literal> > might be a tool that is needed to compile the >- <literal>foo</literal> port.</para> >+ <literal>foo</literal> port. Once <literal>bar</literal> is finished, your system should automatically resume building <literal>foo</literal>.</para> > </answer> > </qandaentry> > >@@ -1340,7 +1345,7 @@ > grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up > arcade game.</screen> > >- <para>The version number can also be found using the >+ <para>The version number can also be found using > <command>pkg_info</command> or by typing: > <command>ls /var/db/pkg</command></para> > >@@ -1349,7 +1354,7 @@ > > <qandaentry> > <question> >- <para>Talking of disk space, the ports directory seems to be >+ <para>Speaking of disk space, the ports directory seems to be > taking up an awful lot of room. Is it safe to go in there > and delete things?</para> > </question>
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
Attachments on
bug 39084
: 22550