From owner-svn-doc-head@FreeBSD.ORG Tue Oct 1 19:30:27 2013 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTP id 9A542570; Tue, 1 Oct 2013 19:30:27 +0000 (UTC) (envelope-from dru@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id 7842922B6; Tue, 1 Oct 2013 19:30:27 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r91JURbF057024; Tue, 1 Oct 2013 19:30:27 GMT (envelope-from dru@svn.freebsd.org) Received: (from dru@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r91JURCT057023; Tue, 1 Oct 2013 19:30:27 GMT (envelope-from dru@svn.freebsd.org) Message-Id: <201310011930.r91JURCT057023@svn.freebsd.org> From: Dru Lavigne Date: Tue, 1 Oct 2013 19:30:27 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42794 - head/en_US.ISO8859-1/books/handbook/ports X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 01 Oct 2013 19:30:27 -0000 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 @@ + How to find the files installed with the application + for post-installation configuration. + + + What to do if a software installation fails. @@ -1789,79 +1794,53 @@ ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/ - Working With Installed Ports + Post-Installation Considerations - 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 - /usr/local/share/doc and - manual pages. This documentation should be consulted before - continuing. Some applications run services which must be added - to the /etc/rc.conf file before - starting. - - 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 PATH. Users of &man.csh.1; should run - rehash to rebuild the known binary - list in the shells PATH. + 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. - 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. - - &prompt.root; pkg_info -L foopackage-1.0.0 | less - - Configuration files are always installed in - /usr/local/etc - and should definitely be consulted before attempting - to use the new application. - - To determine which version of the application was - installed: - - &prompt.root; pkg_info | grep -i foopackage - - will find all the installed packages that have - foopackage in the package name. - Replace foopackage as - necessary. + Most applications install at least one default + configuration file in /usr/local/etc. The + configuration files should be reviewed and possibly edited + to meet the system's needs. - 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. + Applications which provide documentation will install + it into /usr/local/share/doc and many + applications also install manual pages. This documentation + should be consulted before continuing. - 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. - - &prompt.root; pkg_info foopackage-1.0.0 + Some applications run services which must be added + to /etc/rc.conf + before starting the application. These applications usually + install a startup script in + /usr/local/etc/rc.d. See Starting + Services for more information. + - A WWW: line, if present, should - provide a URL for the application's web site. + + Users of &man.csh.1; should run + rehash to rebuild the known binary + list in the shells PATH. - Ports that should start at boot time usually install a - startup script in /usr/local/etc/rc.d. - Review this script for correctness and edit or rename it if - needed. See Starting - Services for more information. + 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 pkgng, instead + use pkg info.