svn commit: r43774 - head/en_US.ISO8859-1/books/porters-handbook
Mathieu Arnold
mat at FreeBSD.org
Tue Feb 4 20:45:44 UTC 2014
Author: mat (ports committer)
Date: Tue Feb 4 20:45:43 2014
New Revision: 43774
URL: http://svnweb.freebsd.org/changeset/doc/43774
Log:
Remove the pkg_install bits in favor of the pkg ones.
Sponsored by: Absolight
Modified:
head/en_US.ISO8859-1/books/porters-handbook/book.xml
Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/book.xml Tue Feb 4 20:36:22 2014 (r43773)
+++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Tue Feb 4 20:45:43 2014 (r43774)
@@ -261,7 +261,7 @@ lib/X11/oneko/cat2.xpm
lib/X11/oneko/mouse.xpm
@dirrm lib/X11/oneko</programlisting>
- <para>Refer to the &man.pkg.create.1; manual page for details
+ <para>Refer to the &man.pkg-create.8; manual page for details
on the packing list.</para>
<note>
@@ -314,7 +314,7 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<para>The price for this way of listing port's files and
directories is that you cannot use command sequences
- described in &man.pkg.create.1;. Therefore, it is suitable
+ described in &man.pkg-create.8;. Therefore, it is suitable
only for simple ports and makes them even simpler. At the
same time, it has the advantage of reducing the number of
files in the ports collection. Please consider using this
@@ -407,11 +407,7 @@ PLIST_DIRS= lib/X11/oneko</programlistin
</step>
<step>
- <para><command>pkg_add package-name</command></para>
-
- <para>Or, for users of <emphasis>pkg</emphasis>:</para>
-
- <para><command>pkg add package-name</command></para>
+ <para><command>pkg add package-filename</command></para>
</step>
<step>
@@ -975,8 +971,9 @@ DOS2UNIX_GLOB= *.c *.cpp *.h</programlis
every time a new official vendor release is made), and
appended to the package name if non-zero. Changes to
<varname>PORTREVISION</varname> are used by automated
- tools (e.g., &man.pkg.version.1;) to highlight the fact
- that a new package is available.</para>
+ tools (e.g., <command>pkg version</command>, see
+ &man.pkg-version.8;) to highlight the fact that a new
+ package is available.</para>
<para><varname>PORTREVISION</varname> should be increased
each time a change is made to the port that changes the
@@ -1085,16 +1082,9 @@ DOS2UNIX_GLOB= *.c *.cpp *.h</programlis
<tip>
<para>The results of version number comparisons are not
- always obvious. &man.pkg.version.1; can be used to test
- the comparison of two version number strings. The
- <application>pkgng</application> equivalent is
- <command>pkg version -t</command>. For example:</para>
-
- <screen>&prompt.user; <userinput>pkg_version -t 0.031 0.29</userinput>
-></screen>
-
- <para>Or, for <application>pkgng</application>
- users:</para>
+ always obvious. <command>pkg version</command> (see
+ &man.pkg-version.8;) can be used to test the comparison
+ of two version number strings. For example:</para>
<screen>&prompt.user; <userinput>pkg version -t 0.031 0.29</userinput>
></screen>
@@ -3499,9 +3489,9 @@ ALWAYS_KEEP_DISTFILES= yes
<orderedlist>
<listitem>
<para>Try to keep the COMMENT value at no longer than 70
- characters, as this line will be used by the
- &man.pkg.info.1; utility to display a one-line summary
- of the port;</para>
+ characters, as this line will be used by <command>pkg
+ info</command> (see &man.pkg-info.8;) to display a
+ one-line summary of the port;</para>
</listitem>
<listitem>
@@ -3628,8 +3618,9 @@ ALWAYS_KEEP_DISTFILES= yes
<buildtarget>build</buildtarget> target and then from within
the <buildtarget>install</buildtarget> target. Also, the
name of the dependency is put into the package so that
- &man.pkg.add.1; will automatically install it if it is not
- on the user's system.</para>
+ <command>pkg install</command> (see &man.pkg-install.8;)
+ will automatically install it if it is not on the user's
+ system.</para>
</sect2>
<sect2>
@@ -3682,9 +3673,10 @@ ALWAYS_KEEP_DISTFILES= yes
<para>The dependency is checked from within the
<buildtarget>install</buildtarget> target. Also, the name
of the dependency is put into the package so that
- &man.pkg.add.1; will automatically install it if it is not
- on the user's system. The <replaceable>target</replaceable>
- part can be omitted if it is the same as
+ <command>pkg install</command> (see &man.pkg-install.8;)
+ will automatically install it if it is not on the user's
+ system. The <replaceable>target</replaceable> part can be
+ omitted if it is the same as
<varname>DEPENDS_TARGET</varname>.</para>
<para>A quite common situation is when
@@ -10400,10 +10392,10 @@ lib/X11/oneko/sounds/cat.au
<programlisting>@dirrmtry share/doc/gimp</programlisting>
<para>This will neither print any error messages nor cause
- &man.pkg.delete.1; to exit abnormally even if
- <filename>${PREFIX}/share/doc/gimp</filename>
- is not empty due to other ports installing some files in
- there.</para>
+ <command>pkg delete</command> (see &man.pkg-delete.8;) to
+ exit abnormally even if
+ <filename>${PREFIX}/share/doc/gimp</filename> is not empty
+ due to other ports installing some files in there.</para>
</sect2>
<sect2 xml:id="plist-dir-empty">
@@ -10412,11 +10404,12 @@ lib/X11/oneko/sounds/cat.au
<para>Empty directories created during port installation need
special attention. They will not get created when
installing the package, because packages only store the
- files, and &man.pkg.add.1; creates directories for them as
- needed. To make sure the empty directory is created when
- installing the package, add this line to
- <filename>pkg-plist</filename> above the corresponding
- <literal>@dirrm</literal> line:</para>
+ files, and both <command>pkg add</command> and <command>pkg
+ install</command> creates directories for them as needed.
+ To make sure the empty directory is created when installing
+ the package, add this line to <filename>pkg-plist</filename>
+ above the corresponding <literal>@dirrm</literal>
+ line:</para>
<programlisting>@exec mkdir -p %D/share/foo/templates</programlisting>
</sect2>
@@ -10428,9 +10421,9 @@ lib/X11/oneko/sounds/cat.au
<para>If your port installs configuration files to
<filename>PREFIX/etc</filename> (or
elsewhere) do <emphasis>not</emphasis> simply list them in the
- <filename>pkg-plist</filename>. That will cause
- &man.pkg.delete.1; to remove the files carefully edited by
- the user, and a re-installation will wipe them out.</para>
+ <filename>pkg-plist</filename>. That will cause <command>pkg
+ delete</command> to remove the files carefully edited by the
+ user, and a re-installation will wipe them out.</para>
<para>Instead, install sample file(s) with a
<filename>filename.sample</filename>
@@ -10473,7 +10466,7 @@ etc/orbit.conf.sample
<literal>-s</literal> flag to &man.cmp.1; for more
output.</para>
- <para>See &man.pkg.create.1; for more information on
+ <para>See &man.pkg-create.8; for more information on
<literal>%D</literal> and related substitution markers.</para>
<para>If there is a very good reason not to install a working
@@ -10558,8 +10551,8 @@ etc/orbit.conf.sample
<para>If you need to display a message to the installer, you may
place the message in <filename>pkg-message</filename>. This
capability is often useful to display additional installation
- steps to be taken after a &man.pkg.add.1; or to display
- licensing information.</para>
+ steps to be taken after a <command>pkg install</command> or to
+ display licensing information.</para>
<para>When some lines about the build-time knobs or warnings
have to be displayed, use <varname>ECHO_MSG</varname>. The
@@ -10587,18 +10580,18 @@ etc/orbit.conf.sample
<title><filename>pkg-install</filename></title>
<para>If your port needs to execute commands when the binary
- package is installed with &man.pkg.add.1; you can do this via
- the <filename>pkg-install</filename> script. This script will
+ package is installed with <command>pkg add</command> or
+ <command>pkg install</command> you can do this via the
+ <filename>pkg-install</filename> script. This script will
automatically be added to the package, and will be run twice
- by &man.pkg.add.1;: the first time as <literal>${SH}
- pkg-install ${PKGNAME} PRE-INSTALL</literal> and the
- second time as <literal>${SH} pkg-install
- ${PKGNAME} POST-INSTALL</literal>.
- <literal>$2</literal> can be tested to determine which
- mode the script is being run in. The
- <envar>PKG_PREFIX</envar> environmental variable will be set
- to the package installation directory. See &man.pkg.add.1;
- for additional information.</para>
+ by <command>pkg</command> the first time as
+ <literal>${SH} pkg-install ${PKGNAME}
+ PRE-INSTALL</literal> and the second time as
+ <literal>${SH} pkg-install ${PKGNAME}
+ POST-INSTALL</literal>. <literal>$2</literal> can be
+ tested to determine which mode the script is being run in.
+ The <envar>PKG_PREFIX</envar> environmental variable will be
+ set to the package installation directory.</para>
<note>
<para>This script is not run automatically if you install the
@@ -10616,11 +10609,11 @@ etc/orbit.conf.sample
<para>This script executes when a package is removed.</para>
- <para>This script will be run twice by &man.pkg.delete.1;.
- The first time as <literal>${SH} pkg-deinstall
- ${PKGNAME} DEINSTALL</literal> and the second time as
- <literal>${SH} pkg-deinstall ${PKGNAME}
- POST-DEINSTALL</literal>.</para>
+ <para>This script will be run twice by <command>pkg
+ delete</command> The first time as <literal>${SH}
+ pkg-deinstall ${PKGNAME} DEINSTALL</literal> and the
+ second time as <literal>${SH} pkg-deinstall
+ ${PKGNAME} POST-DEINSTALL</literal>.</para>
</sect1>
<sect1 xml:id="pkg-names">
@@ -11061,8 +11054,8 @@ as .putsy.conf and edit it.</programlist
serious fault in the currently committed port, please notify
the &a.portmgr; to request immediate rebuilding and
redistribution of the port's package. Unsuspecting users
- of &man.pkg.add.1; will otherwise continue to install the
- old version via <command>pkg_add -r</command> for several
+ of <command>pkg</command> will otherwise continue to install
+ the old version via <command>pkg install</command> for several
weeks.</para>
</important>
More information about the svn-doc-all
mailing list