Date: Mon, 1 Apr 2002 19:51:05 +0200 (CEST) From: Martin Heinen <martin@sumuk.de> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/36624: [PATCH] Handbook: Fixes for Ports chapter Message-ID: <200204011751.g31Hp4t15064@Moses.earth.sol>
next in thread | raw e-mail | index | archive | help
>Number: 36624
>Category: docs
>Synopsis: [PATCH] Handbook: Fixes for Ports chapter
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Mon Apr 01 10:00:02 PST 2002
>Closed-Date:
>Last-Modified:
>Originator: Martin Heinen
>Release: FreeBSD 4.4-STABLE i386
>Organization:
>Environment:
System: FreeBSD Moses.earth.sol 4.4-STABLE FreeBSD 4.4-STABLE #0: Sat Dec 22 07:35:30 CET 2001 toor@Moses.earth.sol:/usr/obj/usr/src/sys/MOSES i386
>Description:
Changed 'packages' to 'applications' when discussing
compile time options, to distinguish the result of a
build (a package) from the application being built.
Marked up -r as <option>.
Added pkg_version to the index.
Marked up root with <username>.
Wrapped keys into <keycap>.
Added full stops at the end of sentences.
Marked up replaceable items as such.
Changed FreeBSD Power Pak to FreeBSD PowerPak (according
to FreeBSD Mall).
Marked up Makefile with <filename> and MASTER_SITES with <makevar>.
>How-To-Repeat:
Read the chapter 'Installing Applications: Packages and Ports'.
>Fix:
Index: chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/ports/chapter.sgml,v
retrieving revision 1.163
diff -u -r1.163 chapter.sgml
--- chapter.sgml 1 Apr 2002 14:39:26 -0000 1.163
+++ chapter.sgml 1 Apr 2002 17:11:12 -0000
@@ -158,7 +158,7 @@
</listitem>
<listitem>
- <para>Some packages have compile time options relating to what they
+ <para>Some applications have compile time options relating to what they
can and cannot do. For example, <application>Apache</application>
can be configured with a wide variety of different built-in options.
By building from the port you do not have to accept the default
@@ -306,7 +306,7 @@
<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
- -r option to &man.pkg.add.1;. This will cause the utility to
+ <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.
</para>
@@ -376,6 +376,9 @@
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>
+ </indexterm>
<screen>&prompt.root; <userinput>pkg_version</userinput>
cvsup =
docbook =
@@ -460,7 +463,7 @@
install the ports collection.</para>
<step>
- <para>As root, run <command>/stand/sysinstall</command> as
+ <para>As <username>root</username>, run <command>/stand/sysinstall</command> as
shown below:</para>
<screen>&prompt.root; /stand/sysinstall</screen>
@@ -468,22 +471,22 @@
<step>
<para>Scroll down and select <literal>Configure</literal>,
- Press Enter</para>
+ press <keycap>Enter</keycap>.</para>
</step>
<step>
<para>Scroll down and select
- <literal>Distributions</literal>, Press Enter</para>
+ <literal>Distributions</literal>, press <keycap>Enter</keycap>.</para>
</step>
<step>
- <para>Scroll down to <literal>ports</literal>, Press the
- Space key</para>
+ <para>Scroll down to <literal>ports</literal>, press
+ <keycap>Space</keycap>.</para>
</step>
<step>
- <para>Scroll up to <literal>Exit</literal>, Press
- Enter</para>
+ <para>Scroll up to <literal>Exit</literal>, press
+ <keycap>Enter</keycap>.</para>
</step>
<step>
@@ -492,7 +495,7 @@
</step>
<step>
- <para>Follow the menus to Exit <application>sysinstall</application></para>
+ <para>Follow the menus to exit <application>sysinstall</application>.</para>
</step>
</procedure>
@@ -521,18 +524,18 @@
</step>
<step>
- <para>As root, copy
+ <para>As <username>root</username>, copy
<filename>/usr/share/examples/cvsup/ports-supfile</filename>
to a new location, such as <filename>/root</filename> or your
- home directory</para>
+ home directory.</para>
</step>
<step>
- <para>Edit <filename>ports-supfile</filename></para>
+ <para>Edit <filename>ports-supfile</filename>.</para>
</step>
<step>
- <para>Change <literal>CHANGE_THIS.FreeBSD.org</literal> to a
+ <para>Change <replaceable>CHANGE_THIS.FreeBSD.org</replaceable> to a
<application>CVSup</application> near you. See <link
linkend="cvsup-mirrors">CVSup Mirrors</link> (<xref
linkend="cvsup-mirrors">) for a complete listing of mirror
@@ -540,9 +543,9 @@
</step>
<step>
- <para>Run <command>cvsup -g -L 2 <path_to_supfile></command></para>
+ <para>Run <command>cvsup</command>:</para>
- <screen>&prompt.root; cvsup -g -L 2 /root/ports-supfile</screen>
+ <screen>&prompt.root; cvsup -g -L 2 <replaceable>/root/ports-supfile</replaceable></screen>
</step>
<step>
@@ -634,9 +637,9 @@
deciding to install it.</para>
<para>Another method is to use the <command>whereis</command>
- command. To use <command>whereis</command>, simply type
- <quote><command>whereis <program you want to
- install></command></quote> at the prompt, and if it is found on
+ command. Simply type <command>whereis <replaceable>file</replaceable></command>,
+ where <replaceable>file</replaceable> ist the program you want to
+ install. If it is found on
your system, you will be told where it is, like so:</para>
<screen>&prompt.root; <userinput>whereis lsof</userinput>
@@ -650,8 +653,8 @@
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 search name=program-name</command>
- where <quote>program-name</quote> is the name of the program you
+ directory, run <command>make search 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>
@@ -672,8 +675,8 @@
here.</para>
<para>For more in-depth searching you can also use
- <command>make search key=string</command> where
- <quote>string</quote> is some text to search for. This searches
+ <command>make search 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 don't
know the name of the program you are looking for.</para>
@@ -709,7 +712,7 @@
<para>The FreeBSD Project's official CDROM images no longer
include distfiles. They take up a lot of room that is
better used by precompiled packages. CDROM products such as
- the FreeBSD Power Pak do include distfiles, and you can
+ 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
@@ -919,11 +922,11 @@
<para>If you are not sure which version of the application was just
installed, a command like this</para>
- <screen>&prompt.root; <userinput>pkg_info | grep foopackage</userinput></screen>
+ <screen>&prompt.root; <userinput>pkg_info | grep <replaceable>foopackage</replaceable></userinput></screen>
<para>will find all the installed packages that have
- <literal>foopackage</literal> in the package name. Replace
- <literal>foopackage</literal> in your commandline as
+ <replaceable>foopackage</replaceable> in the package name. Replace
+ <replaceable>foopackage</replaceable> in your commandline as
necessary.</para>
</listitem>
@@ -940,7 +943,7 @@
you are not sure of the web site address it may be listed in the
output from</para>
- <screen>&prompt.root; <userinput>pkg_info foopackage-1.0.0</userinput></screen>
+ <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>
@@ -1062,8 +1065,8 @@
<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 MASTER_SITES
- (listed in the Makefile), you can restart the install
+ Once you have downloaded it from any of the <makevar>MASTER_SITES</makevar>
+ (listed in the <filename>Makefile</filename>), you can restart the install
process.</para>
</answer>
</qandaentry>
@@ -1170,7 +1173,7 @@
<para>I know it is probably faster to fetch the tarballs from
one of the FreeBSD mirror sites close by. Is there any way
to tell the port to fetch them from servers other than the
- ones listed in the MASTER_SITES?</para>
+ ones listed in the <makevar>MASTER_SITES</makevar>?</para>
</question>
<answer>
@@ -1201,8 +1204,12 @@
<question>
<para>Is there any way to stop the port from compiling? I
want to do some hacking on the source before I install it,
- but it is a bit tiresome to watch it and hit control-C every
- time.</para>
+ but it is a bit tiresome to watch it and hit
+ <keycombo action="simul">
+ <keycap>Ctrl</keycap>
+ <keycap>C</keycap>
+ </keycombo>
+ every time.</para>
</question>
<answer>
@@ -1361,8 +1368,8 @@
port.</para>
<tip><para>It is possible to achieve the same effect without
- recursively calling each makefile. For example, you
- can delete all of the work subdirectories directly
+ recursively calling each <filename>Makefile</filename>. For example, you
+ can delete all of the <filename>work/</filename> subdirectories directly
with the following command:
<screen>&prompt.root; <userinput>find /usr/ports -depth -name work -exec rm -rf {} \;</userinput></screen></para>
</tip>
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200204011751.g31Hp4t15064>