From owner-svn-doc-head@freebsd.org  Thu Apr 21 13:12:23 2016
Return-Path: <owner-svn-doc-head@freebsd.org>
Delivered-To: svn-doc-head@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 85DD8B166F1;
 Thu, 21 Apr 2016 13:12:23 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org (repo.freebsd.org
 [IPv6:2610:1c1:1:6068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 4533E1747;
 Thu, 21 Apr 2016 13:12:23 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org ([127.0.1.37])
 by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id u3LDCMJC082586;
 Thu, 21 Apr 2016 13:12:22 GMT (envelope-from mat@FreeBSD.org)
Received: (from mat@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id u3LDCMmE082585;
 Thu, 21 Apr 2016 13:12:22 GMT (envelope-from mat@FreeBSD.org)
Message-Id: <201604211312.u3LDCMmE082585@repo.freebsd.org>
X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org
 using -f
From: Mathieu Arnold <mat@FreeBSD.org>
Date: Thu, 21 Apr 2016 13:12:22 +0000 (UTC)
To: doc-committers@freebsd.org, svn-doc-all@freebsd.org,
 svn-doc-head@freebsd.org
Subject: svn commit: r48696 - head/en_US.ISO8859-1/books/porters-handbook/uses
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.21
Precedence: list
List-Id: SVN commit messages for the doc tree for head
 <svn-doc-head.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/svn-doc-head>,
 <mailto:svn-doc-head-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-doc-head/>
List-Post: <mailto:svn-doc-head@freebsd.org>
List-Help: <mailto:svn-doc-head-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/svn-doc-head>,
 <mailto:svn-doc-head-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 21 Apr 2016 13:12:23 -0000

Author: mat
Date: Thu Apr 21 13:12:22 2016
New Revision: 48696
URL: https://svnweb.freebsd.org/changeset/doc/48696

Log:
  Improve USES=shebangfix's documentation.
  
  Reviewed by:	wblock
  Sponsored by:	Absolight
  Differential Revision:	https://reviews.freebsd.org/D5949

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

Modified: head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml	Thu Apr 21 09:36:38 2016	(r48695)
+++ head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml	Thu Apr 21 13:12:22 2016	(r48696)
@@ -1167,16 +1167,51 @@ SHEBANG_FILES=	scripts/foobar.pl scripts
       <application>Perl</application>, <application>PHP</application>,
       <application>Python</application>,
       <application>Ruby</application>, <application>Tcl</application>,
-      and <application>Tk</application> are supported by default.  To
-      support another interpreter, set
-      <varname>SHEBANG_LANG</varname>,
-      <varname><replaceable>interp</replaceable>_OLD_CMD</varname> and
-      <varname><replaceable>interp</replaceable>_CMD</varname>.  For
-      example:</para>
-
-    <programlisting>SHEBANG_LANG=	lua
-lua_OLD_CMD=	/usr/bin/lua
-lua_CMD=	${LOCALBASE}/bin/lua</programlisting>
+      and <application>Tk</application> are supported by
+      default.</para>
+
+    <para>There are three configuration variables:</para>
+
+    <variablelist>
+      <varlistentry>
+	<term><varname>SHEBANG_LANG</varname></term>
+
+	<listitem>
+	  <para>The list of supported interpreters.</para>
+	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><varname><replaceable>interp</replaceable>_CMD</varname></term>
+
+	<listitem>
+	  <para>The path to the command interpreter on &os;.  The
+	    default value is
+	    <literal>${LOCALBASE}/bin/<replaceable>interp</replaceable></literal>.</para>
+	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><varname><replaceable>interp</replaceable>_OLD_CMD</varname></term>
+	<listitem>
+	  <para>The list of wrong invocations of interpreters.  These
+	    are typically obsolete paths, or paths used on other
+	    operating systems that are incorrect on &os;.  They
+	    will be replaced by the correct path in
+	    <varname><replaceable>interp</replaceable>_CMD</varname>.
+	    This list will always be part of
+	    <varname><replaceable>interp</replaceable>_OLD_CMD</varname>:
+	    <literal>"/usr/bin/env <replaceable>interp</replaceable>"
+	      /bin/<replaceable>interp</replaceable>
+	      /usr/bin/<replaceable>interp</replaceable></literal>.</para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>To add another interpreter, set
+      <varname>SHEBANG_LANG</varname>.  For example:</para>
+
+    <programlisting>SHEBANG_LANG=	lua</programlisting>
 
     <para><literal><replaceable>interp</replaceable>_OLD_CMD</literal>
       will contain multiple values.  Any entry with spaces must be