svn commit: r42794 - head/en_US.ISO8859-1/books/handbook/ports
Dru Lavigne
dru at FreeBSD.org
Tue Oct 1 19:30:27 UTC 2013
Author: dru
Date: Tue Oct 1 19:30:26 2013
New Revision: 42794
URL: http://svnweb.freebsd.org/changeset/doc/42794
Log:
- rename chapter 5.7 to "Post-Installation Considerations"
- rework this chapter to apply to any software installation method
Approved by: bcr (mentor)
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 Oct 1 18:51:15 2013 (r42793)
+++ head/en_US.ISO8859-1/books/handbook/ports/chapter.xml Tue Oct 1 19:30:26 2013 (r42794)
@@ -49,6 +49,11 @@
</listitem>
<listitem>
+ <para>How to find the files installed with the application
+ for post-installation configuration.</para>
+ </listitem>
+
+ <listitem>
<para>What to do if a software installation fails.</para>
</listitem>
</itemizedlist>
@@ -1789,79 +1794,53 @@ ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/
</sect1>
<sect1 id="ports-nextsteps">
- <title>Working With Installed Ports</title>
+ <title>Post-Installation Considerations</title>
- <para>Most third party applications will need some level of
- configuration after they were installed. This may be a simple
- configuration file alteration, or perhaps the application will
- just generate a configuration file. Most applications will
- have documentation installed into
- <filename class="directory">/usr/local/share/doc</filename> and
- manual pages. This documentation should be consulted before
- continuing. Some applications run services which must be added
- to the <filename>/etc/rc.conf</filename> file before
- starting.</para>
-
- <para>The following list contains useful information for
- post-install port management. In several cases, finding
- the location of binaries if they were installed outside
- of the <envar>PATH</envar>. Users of &man.csh.1; should run
- <command>rehash</command> to rebuild the known binary
- list in the shells <envar>PATH</envar>.</para>
+ <para>Regardless of whether the software was installed from a
+ binary package or port, most third-party applications require
+ some level of configuration after installation. The following
+ commands and locations can be used to help determine what was
+ installed with the application.</para>
<itemizedlist>
<listitem>
- <para>The &man.pkg.info.1; command will print all installed
- files and their location. For example, if the FooPackage
- version 1.0.0 was just installed, then the following
- command will show all the files installed with the
- package.</para>
-
- <screen>&prompt.root; <userinput>pkg_info -L <replaceable>foopackage-1.0.0</replaceable> | less</userinput></screen>
-
- <para>Configuration files are always installed in
- <filename class="directory">/usr/local/etc</filename>
- and should definitely be consulted before attempting
- to use the new application.</para>
-
- <para>To determine which version of the application was
- installed:</para>
-
- <screen>&prompt.root; <userinput>pkg_info | grep -i <replaceable>foopackage</replaceable></userinput></screen>
-
- <para>will find all the installed packages that have
- <replaceable>foopackage</replaceable> in the package name.
- Replace <replaceable>foopackage</replaceable> as
- necessary.</para>
+ <para>Most applications install at least one default
+ configuration file in <filename
+ class="directory">/usr/local/etc</filename>. The
+ configuration files should be reviewed and possibly edited
+ to meet the system's needs.</para>
</listitem>
<listitem>
- <para>These commands will also show the names of any manual
- pages installed with the application. This additional
- documentation will now be available to the &man.man.1;
- command.</para>
+ <para>Applications which provide documentation will install
+ it into <filename
+ class="directory">/usr/local/share/doc</filename> and many
+ applications also install manual pages. This documentation
+ should be consulted before continuing.</para>
</listitem>
<listitem>
- <para>If the application has a web site, consult it for
- additional documentation or a frequently asked questions
- page. If the website is unknown, the following command
- will be useful to print out this information if it's
- available.</para>
-
- <screen>&prompt.root; <userinput>pkg_info <replaceable>foopackage-1.0.0</replaceable></userinput></screen>
+ <para>Some applications run services which must be added
+ to <filename class="directory">/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>
- <para>A <literal>WWW:</literal> line, if present, should
- provide a URL for the application's web site.</para>
+ <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>
</listitem>
<listitem>
- <para>Ports that should start at boot time usually install a
- startup script in <filename>/usr/local/etc/rc.d</filename>.
- Review this script for correctness and edit or rename it if
- needed. See <link
- linkend="configtuning-starting-services">Starting
- Services</link> for more information.</para>
+ <para>If the system is running the traditional package system,
+ use &man.pkg.info.1; to determine which files, man pages,
+ and binaries were installed with the application. If the
+ system is running <application>pkgng</application>, instead
+ use <command>pkg info</command>.</para>
</listitem>
</itemizedlist>
</sect1>
More information about the svn-doc-all
mailing list