svn commit: r42085 - head/en_US.ISO8859-1/books/porters-handbook

[Chris Rees]

Author: crees
Date: Sat Jun 29 14:26:29 2013
New Revision: 42085
URL: http://svnweb.freebsd.org/changeset/doc/42085

Log:
  Document remaining USES values.
  
  Approved by:	gjb (mentor)

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/uses.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/uses.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/uses.xml	Sat Jun 29 13:19:43 2013	(r42084)
+++ head/en_US.ISO8859-1/books/porters-handbook/uses.xml	Sat Jun 29 14:26:29 2013	(r42085)
@@ -17,8 +17,15 @@
 -->
 
 <row>
+  <entry><literal>ada</literal></entry>
+  <entry>(none)</entry>
+  <entry>Depends on an <application>Ada</application>-capable compiler, and
+    sets <makevar>CC</makevar> accordingly.</entry>
+</row>
+
+<row>
   <entry><literal>bison</literal></entry>
-  <entry>none, <literal>build</literal>, <literal>run</literal>,
+  <entry>(none), <literal>build</literal>, <literal>run</literal>,
     <literal>both</literal></entry>
   <entry>Implies that the port uses <filename
       role="package">devel/bison</filename> in one way or another.  By
@@ -30,8 +37,20 @@
 </row>
 
 <row>
+  <entry><literal>charsetfix</literal></entry>
+  <entry>(none)</entry>
+  <entry>Prevents the port from installing <filename>charset.alias</filename>.
+    This should be installed only by
+    <filename role="package">converters/libiconv</filename>.
+    <makevar>CHARSETFIX_MAKEFILEIN</makevar> can be set to a path relative
+    to <makevar>WRKSRC</makevar> if <filename>charset.alias</filename> is
+    not installed by
+    <makevar>WRKSRC</makevar>/<filename>Makefile.in</filename>.</entry>
+</row>
+
+<row>
   <entry><literal>cmake</literal></entry>
-  <entry>none, <literal>outsource</literal></entry>
+  <entry>(none), <literal>outsource</literal></entry>
 
   <entry>The port will use <application>CMake</application> for
     configuring and building.  With the <literal>outsource</literal>
@@ -41,7 +60,7 @@
 
 <row>
   <entry><literal>desktop-file-utils</literal></entry>
-  <entry>none</entry>
+  <entry>(none)</entry>
 
   <entry>Implies that the port uses the
     <application>update-desktop-database</application> from
@@ -55,7 +74,7 @@
 
 <row>
   <entry><literal>fuse</literal></entry>
-  <entry>none</entry>
+  <entry>(none)</entry>
 
   <entry>Implies the port will depend on the FUSE library and handle
     the dependency on the kernel module depending on the version
@@ -64,7 +83,7 @@
 
 <row>
   <entry><literal>gettext</literal></entry>
-  <entry>none, <literal>lib</literal>, <literal>build</literal>,
+  <entry>(none), <literal>lib</literal>, <literal>build</literal>,
     <literal>run</literal></entry>
   <entry>Implies that the port uses <filename
       role="package">devel/gettext</filename> in one way or another.  By
@@ -77,7 +96,7 @@
 
 <row>
   <entry><literal>iconv</literal></entry>
-  <entry>none</entry>
+  <entry>(none)</entry>
   <entry>Implies that the port uses <filename
       role="package">converters/libiconv</filename> as build-time and
     run-time dependency.
@@ -85,8 +104,15 @@
 </row>
 
 <row>
+  <entry><literal>ncurses</literal></entry>
+  <entry>(none), <literal>base</literal>, <literal>port</literal></entry>
+  <entry>Implies that the port uses <application>ncurses</application>, and
+    causes some useful variables to be set.</entry>
+</row>
+
+<row>
   <entry><literal>pathfix</literal></entry>
-  <entry>none</entry>
+  <entry>(none)</entry>
   <entry>Look for the <filename>Makefile.in</filename> and
     <filename>configure</filename> files in the port's associated
     sources and fix common paths to make sure they respect the &os;
@@ -96,7 +122,7 @@
 <row>
   <entry><literal>pkgconfig</literal></entry>
 
-  <entry>none, <literal>build</literal>, <literal>run</literal>,
+  <entry>(none), <literal>build</literal>, <literal>run</literal>,
     <literal>both</literal></entry>
 
   <entry>Implies that the port uses <filename
@@ -110,7 +136,7 @@
 
 <row>
   <entry><literal>qmail</literal></entry>
-  <entry>none, <literal>build</literal>, <literal>run</literal>,
+  <entry>(none), <literal>build</literal>, <literal>run</literal>,
     <literal>both</literal>, <literal>vars</literal></entry>
   <entry>Implies that the port uses <filename
       role="package">mail/qmail</filename> in one way or another.
@@ -123,8 +149,16 @@
 </row>
 
 <row>
+  <entry><literal>readline</literal></entry>
+  <entry>(none), port</entry>
+  <entry>Implies that the port uses <application>readline</application> as
+    library dependency, and sets <makevar>CPPFLAGS</makevar> and
+    <makevar>LDFLAGS</makevar> as necessary.</entry>
+</row>
+
+<row>
   <entry><literal>shared-mime-info</literal></entry>
-  <entry>none</entry>
+  <entry>(none)</entry>
 
   <entry>Implies that the port uses
     <application>update-mime-database</application> from
@@ -138,8 +172,23 @@
 </row>
 
 <row>
+  <entry><literal>shebangfix</literal></entry>
+  <entry>(none)</entry>
+  <entry>A lot of software uses incorrect locations for script interpreters,
+    most notably <filename>/usr/bin/perl</filename> and
+    <filename>/bin/bash</filename>.  This fixes shebang lines in scripts
+    listed in <makevar>SHEBANG_FILES</makevar>.  Currently
+    <application>Perl</application>, <application>Python</application>,
+    <application>Bash</application>, <application>Ruby</application>,
+    and <application>PHP</application> are supported by default.
+    To support another interpreter, set <makevar>SHEBANG_LANG</makevar>
+    (for example <literal><makevar>SHEBANG_LANG</makevar>=lua</literal>), then
+    <makevar>lua_OLD_CMD</makevar> and <makevar>lua_CMD</makevar>.</entry>
+</row>
+
+<row>
   <entry><literal>zenoss</literal></entry>
-  <entry>none</entry>
+  <entry>(none)</entry>
   <entry>Implies the port uses <filename
       role="package">net-mgmt/zenoss</filename> in one way or another,
     but largely is used for building zenoss related zenpack