Bbs2Web Version 1.11

1. An active Maximus V3.XX BBS file base.
   
2. OS/2 V1.3 or above, WARP V4 (Merlin) recommended.
   
3. An HPFS partition for long filename support. Bbs2Web supports the nested Maximus V3.XX file area groups. For nested area output, files with long file names will be generated.
   
4. A configured TCP/IP stack. For OS/2 versions prior to WARP Connect, the additional TCP/IP V2 package would be required.
   
5. An OS/2 HTTP (WEB) server. IBM Internet Connection Server (ICS) is highly recommended.
   
6. A suitable server for file serving. Files can be served by the HTTP server, but you may prefer to install an FTP server for the purpose.
   

• Maximus v3.XX support
  
• Maximus nested file groups
  
• CDROM file areas
  
• Area exclusion by Privilege level
  
• CGI keyword search and new files find
  
• B-TREE indexing for FAST search and find response
  
• Full template driven output
  
• Character mapping support
  

1. The release archive (BBS2WEB.LZH) should be unpacked to a suitable Bbs2Web sub-directory. E.g. C:\BBS2WEB.
   
2. MaxFind.Exe (and optionally RandLink.Exe) should be copied to your web server's cgi-bin sub-directory. E.g. C:\WWW\CGI-BIN.
   
3. *.GIF and *.JPG should be copied to your designated Bbs2Web output directory. E.g. C:\WWW\HTML\BBS.
   
4. Set the BBS2WEB_INI environment variable in CONFIG.SYS, and reboot. BBS2WEB_INI indicates the full path and name of the Bbs2Web.Ini file. E.g. SET BBS2WEB_INI=C:\BBS2WEB\BBS2WEB.INI.
   
5. Configure Bbs2Web.Ini and Scheme*.Ini to suit your system and requirements.
   
6. Configure your Http and Ftp servers appropriately.
   

1. Attempt to access the system BBS2WEB_INI environment variable. If found, attempt to read the referenced INI file. If not successful, continue.
   
2. Attempt to read a file called BBS2WEB.PTR in the executable's directory. Technically the path used for this file is the literal Bbs2Web.Exe path at time of execution. If successful, get the Bbs2Web.Ini path from within the file. The data format is as follows: "BBS2WEB_INI=C:\BBS2WEB\BBS2WEB.INI". If found, attempt to read the referenced INI file. If not successful, continue.
   
3. Attempt to read an INI file named BBS2WEB.INI from the current directory of the current drive. If not successful, exit with error.
   

1. Attempt to access the system BBS2WEB_INI environment variable. If found, attempt to read the referenced INI file. If not successful, continue.
   
2. Attempt to read a file called BBS2WEB.PTR in the cgi-bin directory. Technically the path used for this file is the literal MaxFind.Exe path at time of execution. If successful, get the Bbs2Web.Ini path from within the file. The data format is as follows: "BBS2WEB_INI=C:\BBS2WEB\BBS2WEB.INI". If found, attempt to read the referenced INI file. If not successful, continue.
   
3. Attempt to read an INI file named BBS2WEB.INI from the root directory of the Web server's default drive. If not successful, exit with error.
   

1. File Area Listings. These can be nested to support Maximus file groups (assuming OS long file name support). The master index file as detailed by the configuration file HtmlFile verb, is the head of the tree of these nested area listing pages.
   
2. File Listings. These list each individual file area, supporting multi-page output with 200 files per page.
   
3. Optional Bbs2Web Sites Page. A list of global internet sites running Bbs2Web. The default is a link to the author's master site listing page.
   
4. Search and Find CGI Response Pages. These are the response pages returned by MaxFind for Search and Find requests. Multi-page output is supported with 200 files per page.
   

 --GLOBAL--
 %PAGEIMAGEBKGD%        %PAGEIMAGEMAST%         %PAGETITLEMAST%
 %RETURNLINKTITLE%      %RETURNLINKPATH%        %SITESLINKPATH%
 %SITESMAILLINK%        %PAGENAME%              %PAGEDESC%
 %COPYRIGHT%            %SEARCHFORM%            %METAFORM%
 %SYSDATE%              %SYSTIME%               %IFSEARCH%
 %IFNOTSEARCH%          %IFFIND%                %IFNOTFIND%
 %IFSITES%              %IFNOTSITES%            %IFPAGEIMAGEBKGD%
 %IFNOTPAGEIMAGEBKGD%   %IFPAGEIMAGEMAST%       %IFNOTPAGEIMAGEMAST%
 %ENDIF%

 --AREA PAGES--
 %AREANAME%             %AREADESC%              %AREALINK%
 %IFROOT%               %IFNOTROOT%

 --FILE PAGES--
 %FILENAME%             %FILEDESC%              %FILELINK%
%FILESIZE%              %FILEDATE%              %FILETIME%
%FILECOUNT%             %FILEBYTES%             %FILEDNLOAD%
%FILETOTALBYTES%        %FILETOTALCOUNT%        %FILEPAGENUMBER%
%FILEPAGETOTAL%         %FILEMULTIPAGELINK%     %IFFILEMULTIPAGE%
%IFNOTFILEMULTIPAGE%

 --SITES PAGE--
 %SITESNAME%            %SITESLINK%             %SITESTOTALCOUNT%

 --FIND PAGE--
 %FINDMULTIPAGELINK%    %IFFINDMULTIPAGE%       %IFNOTFINDMULTIPAGE%

 CharMap00=000,001,002,003,004,005,006,007,008,009,010,011,012,013,014,015
 CharMap01=016,017,018,019,020,021,022,023,024,025,026,027,028,029,030,031
 CharMap02=032,033,034,035,036,037,038,039,040,041,042,043,044,045,046,047
 CharMap03=048,049,050,051,052,053,054,055,056,057,058,059,060,061,062,063
 CharMap04=064,065,066,067,068,069,070,071,072,073,074,075,076,077,078,079
 CharMap05=080,081,082,083,084,085,086,087,088,089,090,091,092,093,094,095
 CharMap06=096,097,098,099,100,101,102,103,104,105,106,107,108,109.110,111
 CharMap07=112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127
 CharMap08=128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143
 CharMap09=144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159
 CharMap10=160,161,162,163,164,165,166,167,168,169,170,171,172,173,174,175
 CharMap11=176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191
 CharMap12=192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207
 CharMap13=208,209,210,211,212,213,214,215,216,217,218,219,220,221,222,223
 CharMap14=224,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239
 CharMap15=240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255

        Bbs2Web Version 1.10  ----  BBS HTML Page Generator
        (C) Copyright 1996 by CodeLand, All Rights Reserved

            Syntax:  Bbs2Web  [-switch -switch ... ]

                 -I<IniFile> Ini file path & name
                 -A          All areas, no date comparison
                 -Q          Quiet mode
                 -V          Verbose mode
                 -?          Program help screen

• -I<path> BBS2WEB configuration file path and name. This switch allows operating with multiple configurations. e.g. -Ibbs2web.ini
  
• -A Force generation of all output files, disabling update date checking.
  
• -Q Quiet mode. Minimum information is reported during execution.
  
• -V Verbose mode. Maximum information is reported during execution.
  
• -? Displays these command line controls.
  

1. A control VERB.
   
2. An optional assignment operator "=".
   
3. Optional DATA assigned to the VERB.
   

1. VALUE (No spaces allowed, "_" characters converted to spaces)
   
2. VALUE1 VALUE2 (No spaces allowed, "_" characters converted to spaces)
   
3. VALUE (All characters until end of line)
   

[BBS2WEB]

Denotes the start of information within the configuration file. Data is read from the configuration file beginning from the line following the [BBS2WEB] entry, and continues until a token beginning with a '[' character (e.g. [END]).

[END]

Denotes the end of information within the control file. This verb is optional, end of file will also terminate control file data loading.

Include

Denotes an included control file path and name.
E.g. Include=C:\Bbs2Web\Scheme1.Ini

RegName

The registered user name
E.g. RegName=Colin_Wneat

RegCity

The registered location
E.g. RegCity=Kalamunda_WA

RegCode

The registration code

MaxPath

The Maximus directory. The AreaDatFile (normally Farea.Dat) is assumed to exist in this directory.
E.g. MaxPath=C:\Max

AreaDatFile

The name of the Maximus V3.xx file area data file, usually found in the Maximus directory. Bbs2Web will look for this file in the directory denoted by the MaxPath verb.
E.g. AreaDatFile=Farea.Dat

IncludeCdrom

A flag to control the including or excluding of CDROM file areas for the output pages. Accepted values are "Yes" and "No".
E.g. IncludeCdrom=No

ListPrivBelow

File areas will only be included in the output pages when holding a privilege less than the ListPrivBelow setting. File area privilege levels are set in your Maximus Filearea.Ctl control file. Note that Bbs2Web currently has NO support for override locks and levels.
E.g. ListPrivBelow=Extra

ListKeyAreas

Bbs2Web supports only the standard Maximus privilege levels, and does not support extended privileges. "Normal" is a valid privilege verb, "Normal/1" (note the Key extension) is not. Unknown privilege strings are assigned a "Hidden" (65535) privilege value so that such areas will not appear in the generated output. ListKeyAreas=No is the default operation. ListKeyAreas=Yes instructs Bbs2Web to trim "/" extensions from privilege strings prior to further processing. This would for example convert "Normal/1" to "Normal" thus allowing areas thus marked to appear in the output listings. The effect is to ignore Key extensions in your file areas.
E.g. ListKeyAreas=No

MapDrive

Multiple MapDrive verbs can be listed, to a maximum of 64. Bbs2Web will convert a MapDrive listed drive letter or initial path to the supplied path, for the output page links. This feature can be used to map multiple file download physical drive paths to a single path tree for the output pages. This could be used in conjunction with virtual download path trees created by an ftp server or utility such as TVFS.
E.g. MapDrive=j: /hobbes1/

HtmlPath

The path for the generated Web page files. You should create a sub-directory for this purpose. On the author's system, the Bbs2Web output Web pages total 157 files and 5.7 Megabytes of text/html data files.
E.g. HtmlPath=e:\c600\bbs2web\bbs\

HtmlFile

The name of the generated master Web page. All other pages are linked from this page, or from pages linked from this page, recursively. This file name does NOT include a file extension. The file extension denoted by the HtmlExtension verb will be appended to this file name.
E.g. HtmlFile=Index

HtmlExtension

The file extension to be used for all generated HTML output pages. Note that if using a FAT partition to hold the output files there can be no long file name support (and no Maximus Group support). Thus a DOS 8.3 file naming scheme should be used in that circumstance (HtmlExtension=Htm).
E.g. HtmlExtension=Html

HtmlLinkPath

The Web server path to the generated output files. This is the network or virtual path for the physical directory denoted by the HtmlPath verb.
E.g. HtmlLinkPath=http://bbs.ami.com.au/bbs/

FileLinkPath

The Web or Ftp server file download link path. Bbs file paths and names will be appended to this entry, for creation of the on page download link. You can send the files to the user via various servers, including httpd, and ftpd. Note that you'll need to setup your server to allow direct access to the file base. Bbs2Web can filter out drive names from the Maximus supplied file download paths, see the MapDrive command.
E.g. FileLinkPath=ftp://bbs.ami.com.au/pub/

CgiSrvrPath

The CGI search/find engine full URL path and name.
E.g. CgiSrvrPath=http://www.ami.com.au/cgi-bin/maxfind.exe

BackGroundImage

An optional page background image, assigned to the %PAGEIMAGEBKGD% template token.
E.g. BackGroundImage=Bbs2Web.Gif

HtmlMast

An optional page title image, assigned to the %PAGEIMAGEMAST% template token.
E.g. HtmlMast=MastBbs.Gif

HtmlTitle

The Web page system title, assigned to the %PAGETITLEMAST% template token. Underscore characters are converted to space characters.
E.g. HtmlTitle=The_Library_Network_BBS

HtmlHeading

The Web page sub-heading, assigned to the %PAGEDESC% template token for the master index page. Underscore characters are converted to space characters.
E.g. HtmlHeading=BBS_File_Areas

ReturnLinkTitle

The title for a link pointing the browsing user back to your site home page or equivalent. Underscore characters are converted to space characters.
E.g. ReturnLinkTitle=The_Library_Network

ReturnLinkPath

A link entry for the master Web page, pointing the browsing user back to your site home page or equivalent.
E.g. ReturnLinkPath=http://bbs.ami.com.au/

SearchEnable

A flag to enable or disable the keyword search feature.
E.g. SearchEnable=Yes

SearchIndexFile

The file name of the search index file, generated by Bbs2Web and used by MaxFind. The default file name is B2WSRCH.IDX. This keyword does not appear in the INI file by default.
E.g. SearchIndexFile=b2wsrch.idx

FindEnable

A flag to enable or disable the newfiles find feature.
E.g. FindEnable=Yes

FindIndexFile

The file name of the find index file, generated by Bbs2Web and used by MaxFind. The default file name is B2WFIND.IDX. This keyword does not appear in the INI file by default.
E.g. FindIndexFile=b2wfind.idx

CharAllowHiBit

A flag to enable or disable the output of hi-bit characters from the BBS file listings. Setting CharAllowHiBit=No will instruct Bbs2Web to ignore all hi-bit characters within the file listings.
E.g. CharAllowHiBit=No

The following configuration verbs can be used to declare a set of 256 character mappings. There are sixteen verbs in total, with each verb responsible for a set of sixteen characters. Thus the first verb CharMap00 is used to declare character mapping for characters decimal 0 to 15 inclusive. Verb CharMap01 declares character mapping for character codes decimal 16 - 31 inclusive.

CharMap00      CharMap01       CharMap02       CharMap03
CharMap04      CharMap05       CharMap06       CharMap07
CharMap08      CharMap09       CharMap10       CharMap11
CharMap12      CharMap13       CharMap14       CharMap15

The format of the sixteen values per configuration verb, is one word without whitespace. Each number is delimited with a "," character.
E.g. CharMap00=000,001,002,003,004,005,006,007,008,009,010,011,012,013,014,015

SitesEnable

A flag to enable or disable the Bbs2Web sites listing feature.
E.g. SitesEnable=Yes

SitesLocalSupport

A flag to activate local operation of a sites listing page. The default is to list the URL of the author's master sites listing page.
E.g. SitesLocalSupport=No

SitesFile

For sites local support (SitesLocalSupport=Yes), the file name (without file extension) of the local sites listing page.
E.g. SitesFile=Sites

Site

For sites local support (SitesLocalSupport=Yes), one site listing for inclusion on the local sites listing page. 512 sites can be listed within the configuration files. The data format is "Site=URL Site_Name".
E.g. Site=http://bbs.ami.com.au/bbs/ The_Library_Network_-_Home_of_Bbs2Web

The following configuration file verbs declare "template" output controls for BBS2WEB:

FILE AREA LISTINGS          : TemplateAreaHdr TemplateAreaItm TemplateAreaFtr
FILE LISTINGS               : TemplateFileHdr TemplateFileItm TemplateFileFtr
SITES LISTING               : TemplateSiteHdr TemplateSiteItm TemplateSiteFtr
SEARCH AND FIND RESPONSES   : TemplateFindHdr TemplateFindItm TemplateFindFtr

Bbs2Web supports up to 64 occurrences of each of the above verbs.
Usage format is "Verb=Text data including tokens until end of line".
E.g. TemplateAreaHdr=<HTML>

TemplateVar

Declares a custom template token. Note that all template token names, including custom tokens, must begin and end with the "%" character. Up to 64 custom tokens can be defined in the configuration files. Usage format is "TemplateVar=%VAR_NAME% Var_Value".
E.g. TemplateVar=%VARPAGEBKGD% #FFFFFF

 Internet E-Mail:       bbs2web@ami.com.au

 Surface Mail:          CodeLand Australia
                        P.O.Box 351
                        Kalamunda WA 6076
                        AUSTRALIA