SF.net SVN: geany:[4540] trunk/doc

[eht16 at users.sourceforge.net]

Revision: 4540
          http://geany.svn.sourceforge.net/geany/?rev=4540&view=rev
Author:   eht16
Date:     2010-01-24 16:17:11 +0000 (Sun, 24 Jan 2010)

Log Message:
-----------
Describe the defined environment variables GEANY_FILETYPE, GEANY_FILENAME and GEANY_FUNCNAME.

Modified Paths:
--------------
    trunk/doc/geany.html
    trunk/doc/geany.txt

Modified: trunk/doc/geany.html
===================================================================
--- trunk/doc/geany.html	2010-01-24 14:52:46 UTC (rev 4539)
+++ trunk/doc/geany.html	2010-01-24 16:17:11 UTC (rev 4540)
@@ -6,7 +6,7 @@
 <meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
 <title>Geany</title>
 <meta name="authors" content="Enrico Tröger  Nick Treleaven  Frank Lanitz" />
-<meta name="date" content="2010-01-02" />
+<meta name="date" content="2010-01-24" />
 <style type="text/css">
 
 /*
@@ -139,7 +139,7 @@
 <br />Nick Treleaven
 <br />Frank Lanitz</td></tr>
 <tr><th class="docinfo-name">Date:</th>
-<td>2010-01-02</td></tr>
+<td>2010-01-24</td></tr>
 <tr><th class="docinfo-name">Version:</th>
 <td>0.19</td></tr>
 </tbody>
@@ -4930,6 +4930,16 @@
 </pre>
 <p>Using this wildcard you can insert nearly any arbitrary text into the
 template.</p>
+<p>In the environment of the executed command the variables
+<tt class="docutils literal">GEANY_FILENAME</tt>, <tt class="docutils literal">GEANY_FILETYPE</tt> and <tt class="docutils literal">GEANY_FUNCNAME</tt> are set.
+The value of these variables is filled in only if Geany knows about it.
+For example, <tt class="docutils literal">GEANY_FUNCNAME</tt> is only filled within the function
+description template. However, these variables are <tt class="docutils literal">always</tt> set,
+just maybe with an empty value.
+You can easily access them e.g. within an executed shell script using:</p>
+<pre class="literal-block">
+$GEANY_FILENAME
+</pre>
 <div class="note">
 <p class="first admonition-title">Note</p>
 <p class="last">If the specified command could not be found or not executed, the wildcard is substituted
@@ -5892,7 +5902,7 @@
 <div class="footer">
 <hr class="footer" />
 <a class="reference external" href="geany.txt">View document source</a>.
-Generated on: 2010-01-24 14:49 UTC.
+Generated on: 2010-01-24 16:15 UTC.
 Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
 
 </div>

Modified: trunk/doc/geany.txt
===================================================================
--- trunk/doc/geany.txt	2010-01-24 14:52:46 UTC (rev 4539)
+++ trunk/doc/geany.txt	2010-01-24 16:17:11 UTC (rev 4540)
@@ -4245,6 +4245,17 @@
 Using this wildcard you can insert nearly any arbitrary text into the
 template.
 
+In the environment of the executed command the variables
+``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
+The value of these variables is filled in only if Geany knows about it.
+For example, ``GEANY_FUNCNAME`` is only filled within the function
+description template. However, these variables are ``always`` set,
+just maybe with an empty value.
+You can easily access them e.g. within an executed shell script using::
+
+    $GEANY_FILENAME
+
+
 .. note::
     If the specified command could not be found or not executed, the wildcard is substituted
     by an empty string. In such cases, you can find the occurred error message on Geany's


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.