TWiki/TWikiSystemRequirements.mdwn

   1 **_Platform_**
   2
   3 TWiki is written in Perl 5, but it uses also many shell commands. The current implementation runs best on a Unix machine, but it is also possible on Microsoft Windows. RCS (for revision control) must be installed on the system.
   4
   5 **_Directories_**
   6
   7 <table border="1" cellpadding="0" cellspacing="0">
   8   <tr>
   9     <th bgcolor="#99CCCC"><strong> Directory: </strong></th>
  10     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
  11   </tr>
  12   <tr>
  13     <td><code>twiki/bin</code></td>
  14     <td> TWiki Perl scripts </td>
  15   </tr>
  16   <tr>
  17     <td><code>twiki/pub</code></td>
  18     <td> Public files ([[Main/FileAttachments]], images) </td>
  19   </tr>
  20   <tr>
  21     <td><code>twiki/data</code></td>
  22     <td> source text </td>
  23   </tr>
  24   <tr>
  25     <td><code>twiki/templates</code></td>
  26     <td> HTML templates, used by TWiki scripts </td>
  27   </tr>
  28 </table>
  29
  30 **_Files in twiki/bin_**
  31
  32 <table border="1" cellpadding="0" cellspacing="0">
  33   <tr>
  34     <th bgcolor="#99CCCC"><strong> File: </strong></th>
  35     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
  36   </tr>
  37   <tr>
  38     <td><code>.htaccess.txt</code></td>
  39     <td> Authentication. Rename to .htaccess and customize if used </td>
  40   </tr>
  41   <tr>
  42     <td><code>attach</code></td>
  43     <td> Script that shows the attach file page ([[Main/FileAttachment]]) </td>
  44   </tr>
  45   <tr>
  46     <td><code>delete</code></td>
  47     <td> (not used yet) </td>
  48   </tr>
  49   <tr>
  50     <td><code>edit</code></td>
  51     <td> Script to edit a topic </td>
  52   </tr>
  53   <tr>
  54     <td><code>geturl</code></td>
  55     <td> Script to fetch URL data </td>
  56   </tr>
  57   <tr>
  58     <td><code>mailnotify</code></td>
  59     <td> Script called by cron job to notify users of changes </td>
  60   </tr>
  61   <tr>
  62     <td><code>oops</code></td>
  63     <td> Script that shows an OK or oops dialog </td>
  64   </tr>
  65   <tr>
  66     <td><code>preview</code></td>
  67     <td> Script to preview topic after edit </td>
  68   </tr>
  69   <tr>
  70     <td><code>rdiff</code></td>
  71     <td> Script to see differences of topics </td>
  72   </tr>
  73   <tr>
  74     <td><code>register</code></td>
  75     <td> Script to register new users </td>
  76   </tr>
  77   <tr>
  78     <td><code>save</code></td>
  79     <td> Script that saves a topic, called by preview </td>
  80   </tr>
  81   <tr>
  82     <td><code>search</code></td>
  83     <td> Script that displays search results </td>
  84   </tr>
  85   <tr>
  86     <td><code>statistics</code></td>
  87     <td> Script to create statistics topic </td>
  88   </tr>
  89   <tr>
  90     <td><code>testenv</code></td>
  91     <td> Script to test CGI environment variables </td>
  92   </tr>
  93   <tr>
  94     <td><code>upload</code></td>
  95     <td> Script that does file upload ([[Main/FileAttachment]]) </td>
  96   </tr>
  97   <tr>
  98     <td><code>view</code></td>
  99     <td> Script to view a topic ( <strong>the</strong> script ) </td>
 100   </tr>
 101   <tr>
 102     <td><code>viewfile</code></td>
 103     <td> Script to view an file attachment </td>
 104   </tr>
 105   <tr>
 106     <td><code>wiki.pm</code></td>
 107     <td> main TWiki library </td>
 108   </tr>
 109   <tr>
 110     <td><code>wikiaccess.pm</code></td>
 111     <td> access control </td>
 112   </tr>
 113   <tr>
 114     <td><code>wikicfg.pm</code></td>
 115     <td> for initialization and configuration, used by wiki.pm </td>
 116   </tr>
 117   <tr>
 118     <td><code>wikiprefs.pm</code></td>
 119     <td> preferences handling </td>
 120   </tr>
 121   <tr>
 122     <td><code>wikisearch.pm</code></td>
 123     <td> search engine, used by wiki.pm </td>
 124   </tr>
 125   <tr>
 126     <td><code>wikistore.pm</code></td>
 127     <td> back-end storage, <code>*.txt</code> text file and <code>*.txt,v</code> RCS repository file handling </td>
 128   </tr>
 129 </table>
 130
 131 -- [[PeterThoeny]] - 02 Nov 2000 <br />