Changeset 53

Show
Ignore:
Timestamp:
04/13/06 12:24:36 (2 years ago)
Author:
mrook
Message:

Update built-in properties list (closes issue #20)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/2.2/docs/phing_guide/book/chapters/appendixes/AppendixA-FactSheet.html

    r1 r53  
    88<html xmlns="http://www.w3.org/1999/xhtml"> 
    99<head> 
    10         <title> Phing Guide </title>  
     10        <title> Phing Guide </title> 
    1111        <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> 
    1212        <link rel="Stylesheet" rev="Stylesheet" href="../../css/Documentation.css" type="text/css" media="All" charset="iso-8859-1" /> 
    …… 
    1515<h1>Appendix A: Fact Sheet</h1> 
    1616 
    17 <h2><a name="BuiltInProperties"></a>Built-In Properties</h2>  
     17<h2><a name="BuiltInProperties"></a>Built-In Properties</h2> 
    1818 
    1919<table> 
    …… 
    3131</tr> 
    3232<tr> 
     33  <td>env.*</td> 
     34  <td>Environment variables, extracted from <em>$_SERVER</em>.</td> 
     35</tr> 
     36<tr> 
    3337  <td>host.arch</td> 
    34   <td>Name of the host machine. <em>Not available on Windows machines.</em></td> 
     38  <td>System architecture, i.e. <em>i586</em>. 
     39      <em>Not available on Windows machines.</em></td> 
    3540</tr> 
    3641<tr> 
    …… 
    4449</tr> 
    4550<tr> 
    46   <td>host.machine</td> 
    47   <td>System architecture, i.e. <em>i586</em>.  
     51  <td>host.name</td> 
     52  <td>Operating System hostname as returned by <em>posix_uname()</em>. 
    4853      <em>Not available on Windows machines.</em></td> 
    4954</tr> 
    5055<tr> 
    51   <td>host.name</td> 
    52   <td>Operating System name as returned by <em>posix_uname()</em>. 
     56  <td>host.os</td> 
     57  <td>Operating System description as set in <em>PHP_OS</em> variable.</td> 
     58</tr> 
     59<tr> 
     60  <td>host.os.release</td> 
     61  <td>Operating version release, i.e. <em> 2.2.10</em>. 
    5362      <em>Not available on Windows machines.</em></td> 
    5463</tr> 
    5564<tr> 
    56   <td>host.os.release</td> 
    57   <td>Operating version release, i.e. <em> 2.2.10</em>.  
     65  <td>host.os.version</td> 
     66  <td>Operating system version, i.e. <em>#4 Tue Jul 20 17:01:36 MEST 1999</em>. 
    5867      <em>Not available on Windows machines.</em></td> 
    5968</tr> 
    6069<tr> 
    61   <td>host.os.version</td> 
    62   <td>Operating system version, i.e. <em>#4 Tue Jul 20 17:01:36 MEST 1999</em>.  
    63       <em>Not available on Windows machines.</em></td> 
    64 </tr> 
    65 <tr> 
    6670  <td>line.separator</td> 
    67   <td>Character(s) that signal the end of a line, &quot;\n&quot; for Linux,  
     71  <td>Character(s) that signal the end of a line, &quot;\n&quot; for Linux, 
    6872      &quot;\r\n&quot; for Windows system, &quot;\r&quot; for Macintosh.</td> 
    6973</tr> 
     74<tr> 
     75  <td>os.name</td> 
     76  <td>Operating System description as set in <em>PHP_OS</em> variable.</td> 
     77</tr> 
     78 
     79<tr> 
     80  <td>phing.file</td> 
     81  <td>Full path to current buildfile.</td> 
     82</tr> 
     83<tr> 
     84  <td>phing.home</td> 
     85  <td>Phing installation directory, not set in <em>PEAR</em> installations.</td> 
     86</tr> 
     87<tr> 
     88  <td>phing.version</td> 
     89  <td>Current Phing version. This property equals the value of the PHP 
     90      constant <em>PHP_OS</em> (see <a 
     91      href="http://www.php.net/manual/en/reserved.constants.core.php">PHP Manual</a>). 
     92      Possible values are <em>Linux</em>, <em>Win32</em> and <em>WINNT</em>, for 
     93      example.</td> 
     94</tr> 
     95<tr> 
     96  <td>phing.project.name</td> 
     97  <td>Name of the currently processed project.</td> 
     98</tr> 
    7099 
    71100<tr> 
    72101  <td>php.classpath</td> 
    73   <td>The value of the environment variable <em>PHP_CLASSPATH</em></td> 
     102  <td>The value of the environment variable <em>PHP_CLASSPATH</em>.</td> 
    74103</tr> 
    75104<tr> 
    …… 
    81110 
    82111<tr> 
    83   <td>phing.buildfile</td> 
    84   <td>Full path to current buildfile</td> 
    85 </tr> 
    86 <tr> 
    87   <td>phing.id</td> 
    88   <td>ID of hte current phing instance</td> 
    89 </tr> 
    90 <tr> 
    91   <td>phing.version</td> 
    92   <td>Current Phing version. This property equals the value of the PHP 
    93       constant <em>PHP_OS</em> (see <a  
    94       href="http://www.php.net/manual/en/reserved.constants.core.php">PHP Manual</a>. 
    95       Possible values are <em>Linux</em>, <em>Win32</em> and <em>WINNT</em>, for 
    96       example.</td> 
    97 </tr> 
    98  
    99 <tr> 
    100   <td>project.name</td> 
    101   <td>Name of the currently processed project.</td> 
    102 </tr> 
    103 <tr> 
    104112  <td>project.basedir</td> 
    105   <td>The current project basedir</td> 
    106 </tr> 
    107 <tr> 
    108   <td>project.description</td> 
    109   <td>The description of the currently processed project.</td> 
     113  <td>The current project basedir.</td> 
    110114</tr> 
    111115 
    …… 
    169173 
    170174 
    171 <h2><a name="DistributionFileLayout"></a>Distribution File Layout</h2>  
     175<h2><a name="DistributionFileLayout"></a>Distribution File Layout</h2> 
    172176 
    173177<pre title="DistributionFileLayout">$PHING_HOME 
    …… 
    192196</pre> 
    193197 
    194 <h2><a name="ProgramExitCodes"></a>Program Exit Codes</h2>  
    195  
    196 <p>Phing is script-safe - means that you can execute Phing and  
    197 Configure within a automated script context. To check back the  
    198 success of a Phing call it returns an exit code that can be  
    199 captured by your calling script. The following list gives you  
     198<h2><a name="ProgramExitCodes"></a>Program Exit Codes</h2> 
     199 
     200<p>Phing is script-safe - means that you can execute Phing and 
     201Configure within a automated script context. To check back the 
     202success of a Phing call it returns an exit code that can be 
     203captured by your calling script. The following list gives you 
    200204details on the used exit codes and their meaning.</p> 
    201205 
    …… 
    386390writing it).  Whether that is true depends on what the Library does 
    387391and what the program that uses the Library does. 
    388    
     392 
    389393  1. You may copy and distribute verbatim copies of the Library's 
    390394complete source code as you receive it, in any medium, provided that