_____________  ____ ____ ____ ____ ____ ____ ____ ____  ______________  
 ||            |||a |||s |||c |||i |||i |||w |||e |||b |||             || 
 ||____________|||__|||__|||__|||__|||__|||__|||__|||__|||_____________|| 
 |/____________\|/__\|/__\|/__\|/__\|/__\|/__\|/__\|/__\|/_____________\| 
 ::::::::::::::::::::::::::::::Times-Tribune::::::::::::::::::::::::::::: 
.------------------------------------------------------------------------. 
| ASCIIweb Times-Tribune                                 Vol. I Issue I. | 
'------------------------------------------------------------------------' 
.------------.                                                    |. . .|_____
| Welcome to |     ,-. ,-. ,-. ," . ,-. . . ,-. . ,-. ,-.         '-contents--'
| ASCIIweb!  |     |   | | | | |- | | | | | |   | | | | |          intro      |
'------------'     `-' `-' ' ' |  ' `-| `-^ '   ' ' ' `-|          installing |
.------------.  ---------------'-----,|----------------,|--        configuring|
| intro      |                       `'                `'          conf files |
'------------'                                                     editing    |
.------------. There are a number of options in aw.conf that you   security   |
| manual     | should understand.                                  tricks     |
'------------'                                                     staticmode |
.------------. important paths                                     RFKML      |
| license    | ---------------                                     credits    |
'------------'                                                     COPYING    |
.------------. Paths are important to ASCIIweb. The dynamic       .-----------|
| directory  | nature of the display requires that aw is able to  |     .-----'
'------------' determine the context of relative links. To do     |. . .|
.------------. that, it requires certain information.             | . . | 
| changelog  |                                                    |. . .| 
'------------' script is the canonical location of the            | . . | 
.------------. script according to your webserver, i.e.:          |. . .| 
| bugs       |                                                    | . . | 
'------------' http://tastytronic.net/asciiweb/aw.cgi             |. . .| 
.------------.                                                    | . . | 
| wishlist   | wwwroot is the root of the current web, or         |. . .| 
'------------' the top level of the current webserver (or         | . . | 
.------------. VirtualHost) in Apache, i.e.:                      |. . .| 
|  website   |                                                    | . . | 
'------------' http://tastytronic.net/                            |. . .| 
.------------.                                                    | . . | 
| beta v0.90 | localdir is the local directory that aw.cgi        |. . .| 
'------------' resides in. This could probably be ascertained     | . . | 
 \......  . |  from script, but... maybe not.:                    |. . .| 
        |. .|                                                     | . . | 
        | . |  http://tastytronic.net/asciiweb/                   |. . .| 
        |. .|                                                     | . . | 
        | . |  docdir is the highest parent directory that        |. . .| 
        |. .|  aw is allowed to read files from. If asciiweb      | . . | 
        | . |  thinks it can, it will read from the filesystem    |. . .| 
        |. .|  rather than via the webserver. This saves time and | . . | 
        | . |  load. However, you don't want aw reading           |. . .| 
        |. .|  /etc/passwd -- so anything that is not "beneath"   | . . | 
        | . |  this parent directory will not be loaded from the  |. . .| 
        |. .|  filesystem:                                        | . . | 
        | . |                                                     |. . .| 
        |. .|  /var/www/tastytronic.net/                          | . . | 
        | . |                                                     |. . .| 
        |. .|  scriptdir is the directory local to aw.cgi         | . . | 
        | . |  that contains executeables (or symlinks to         |. . .| 
        |. .|  executeables) for aw to include, i.e.:             | . . | 
        | . |                                                     |. . .| 
        |. .|  scriptitos                                         | . . | 
        | . |                                                     |. . .| 
        |. .|  Note: your scriptdir *must* be a subdirectory      | . . | 
        | . |  of your docdir. asciiweb will also not load        |. . .| 
        |. .|  for display any document that is in your           | . . | 
        | . |  scriptdir to keep your module source from          |. . .| 
        |. .|  prying eyes.                                       | . . | 
        | . |                                                     |. . .| 
        |. .|  Likewise, asciiweb will *not* execute scripts      | . . | 
        | . |  from pages retrieved via HTTP.                     |. . .| 
        |. .|                                                     | . . | 
        | . |  These safeguards, along with an appropriate        |. . .| 
        |. .|  .htaccess file, should mitigate the security       | . . | 
        | . |  issues inherent with embedded code. But you        |. . .| 
        |. .|  may wish to turn this feature off completely.      | . . | 
        | . |                                                     |. . .| 
        |. .|  permissions                                        | . . | 
        | . |  -----------                                        |. . .| 
        |. .|                                                     | . . | 
        | . |  allowexecute should be set to 1 if you want        |. . .| 
        |. .|  to allow aw to execute and include output from     | . . | 
        | . |  applications in an asciiweb page. (Default 0)      |. . .| 
        |. .|                                                     | . . | 
        | . |  executepage should be set to 1 if you want         |. . .| 
        |. .|  to allow "full page includes" -- documents         | . . | 
        | . |  completely generated by executeables (such as      |. . .| 
        |. .|  ps, who, etc.), rather than simple embedded        | . . | 
        | . |  goodies (such as figlet or cowsay).                |. . .| 
        |. .|  (Default 0.)                                       | . . | 
        | . |                                                     |. . .| 
        |. .|  dynamic_debugmode should be set to 1 if you        | . . | 
        | . |  want to allow debugging information to be accessed |. . .| 
        |. .|  via the query string parameter debugmode=1. This   | . . | 
        | . |  is nice when you are configuring your system, but  |. . .| 
        |. .|  may allow prying eyes in the know to see more      | . . | 
        | . |  than you'd like.                                   |. . .| 
        |. .|  (Default 0.)                                       | . . | 
        | . |                                                     |. . .| 
        |. .|  debugmode should be set to 1 if you want aw        | . . | 
        | . |  to output debugging information constantly.        |. . .| 
        |. .|  (Default 0.)                                       | . . | 
        | . |                                                     |. . .| 
        |. .|  page elements and geometry                         | . . | 
        | . |  --------------------------                         |. . .| 
        |. .|                                                     | . . | 
        | . |  header, leftmenu, main, footer, leftfill,          |. . .| 
        |. .|  rightfill, rightmenu, and mainfill are the         | . . | 
        | . |  pages that will be loaded by default into those    |. . .| 
        |. .|  areas unless other pages are specified by further  | . . | 
        | . |  confs or through the query string. They should be  |. . .| 
        |. .|  paths relative to aw.cgi:                          | . . | 
        | . |                                                     |. . .| 
        |. .|  leftmenu=src/l_menu.rfk                            | . . | 
        | . |                                                     |. . .| 
        |. .|  bgcolor, test, link, alink, and vlink are          | . . | 
        | . |  the default colors (in hex) for asciiweb.          |. . .| 
        |. .|                                                     | . . | 
        | . |  readcolor is a separate color specifically         |. . .| 
        |. .|  for the "main" document to enhance readability.    | . . | 
        | . |  (Notice this text is white while the window        |. . .| 
        |. .|  dressing is gray.) It allows the main body of      | . . | 
        | . |  text to be a different color from the rest of      |. . .| 
        |. .|  the "text". Commenting it out will make the        | . . | 
        | . |  "main" page be printed with the color specified    |. . .| 
        |. .|  for "text".                                        | . . | 
        | . |                                                     |. . .| 
        |. .|  persistdirconf specifies whether custom            | . . | 
        | . |  directory "confs" persist throughout the           |. . .| 
        |. .|  subdirectory, or just on the top level. See the    | . . | 
        | . |  section on conf files for more information.        |. . .| 
        |. .|                                                     | . . | 
        | . |  lcolwidth, rcolwidth, and ccolwidth are            |. . .| 
        |. .|  numbers that define how wide aw will make the page | . . | 
        | . |  columns. As you define your window dressings, you  |. . .| 
        |. .|  will want to play with these settings to make      | . . | 
        | . |  asciiweb behave the way you want it to.            |. . .| 
        |. .|                                                     | . . | 
        | . |  Back:                                       Next:  |. . .| 
        |. .|  Installing                             Conf Files  | . . | 
        | . |  <--                                           -->  |. . .| 
        |. .|                                                     | . . | 
.------------------------------------------------------------------------. 
| The ASCIIweb Times-Tribune is a Tastytronic Industries newspaper.      | 
'------------------------------------------------------------------------' 
 Generated at: Thu Sep 11 15:22:35 CDT 2025