home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1999 February / PCO_0299.ISO / filesbbs / dos / indigo01.exe / INDIGO.DOC < prev    next >
Encoding:
Text File  |  1997-12-14  |  10.0 KB  |  320 lines
  1. ───────────────────────────────────────────────────────────────────
  2.         █▀          █▀ ▄  █       █       █               TM
  3.         █▄▄▄▄ ▄▄▄▄▄ █▄ █▄ █   █   █ ▄▄▄▄▄ █ ▄ ▄ ▄▄▄▄  ▄▄
  4.             █ █   █ █  █  █   █   █ █   █ █ █ █ █▄▄█  █▄▄▄▄
  5.         ▄▄▄▄█ █▄▄▄█ █  █▄ █▄▄▄█▄▄▄█ █▄▄▄█ █ ▀▄▀ █▄▄▄▄ ▄▄▄▄█
  6.       ─     S     O     F     T     W     A     R     E     ─
  7. ───────────────────────────────────────────────────────────────────
  8. Indigo v0.01 - Tool for setting up a point system with Blue Wave
  9.  
  10. Copyright (c) 1997: Peter Karlsson
  11. A Softwolves Software(TM) Release in 1997
  12.  
  13. This program is free software; you can redistribute it and/or modify it
  14. under the terms of the GNU General Public License as published by the Free
  15. Software Foundation; either version 2 of the License, or (at your option)
  16. any later version.
  17.  
  18. This program is distributed in the hope that it will be useful, but WITHOUT
  19. ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  20. FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  21. more details.
  22.  
  23. You should have received a copy of the GNU General Public License along
  24. with this program; if not, write to the Free Software Foundation, Inc., 675
  25. Mass Ave, Cambridge, MA 02139, USA.
  26.  
  27. This product uses the SPAWNO routines by Ralf Brown to minimize memory use
  28. while shelling to DOS and running other programs. This library is not
  29. released under the GNU Public License. According to its licensing terms,
  30. the whole SPAWNO archive is included with this program.
  31.  
  32. If you modify this program, please do send a copy of the modified program
  33. to the original author, so that I can incorporate your changes to the main
  34. version.
  35.  
  36.         Included files
  37.         ──────────────
  38.  
  39. * C++ source files:
  40. AREAS.CPP, CONFIG.CPP, CRC32.CPP, FIDO.CPP, INDIGO.CPP, MSGID.CPP,
  41. SHORTTAG.CPP, UPLINK.CPP
  42.  
  43. * C++ header files:
  44. AREAS.H, BLUEWAVE.H, CONFIG.H, CRC32.H, DATATYP.H, DEBUG.H, FIDO.H,
  45. MSGID.H, PKTHEAD.H, SHORTTAG.H, UPLINK.H, VERSION.H
  46.  
  47. * Other source related files:
  48. MAKEFILE, MAKEFILE.OS2, INDIGO.DEF
  49.  
  50. * Documentation:
  51. INDIGO.DOC, COPYING
  52.  
  53. * Executables:
  54. INDIGO.EXE (DOS), INDIGOP.EXE (OS/2)
  55.  
  56. * SPAWNO libraries:
  57. SPWNO413.RAR
  58.  
  59.         Usage
  60.         ─────
  61.  
  62. To use Indigo, you need to have the following software available:
  63.  
  64. * A Binkley-style Fidonet mailer (BinkleyTerm, Xenia, Terminate, and
  65.   others). Support for ArcMail Attach mailers is not included in this
  66.   release.
  67. * A Blue Wave compatible mail reader, capable of creating UPL files in
  68.   reply packets.
  69. * Archiving and unarchiving software.
  70. * A text editor.
  71.  
  72.  
  73.         Command line format
  74.         ───────────────────
  75.  
  76. indigo [options] {direction} {parameters}
  77.  
  78.     Options
  79.     -------
  80.  
  81. -iconfigfile - Use "configfile" instead of "indigo.cfg"
  82.  
  83.     "In" direction (Blue Wave packet creation)
  84.     ------------------------------------------
  85.  
  86. indigo [options] IN pktfile ...
  87.  
  88. pktfile - *.PKT files to be converted into Blue Wave packets. Wildcards may
  89.           be specified. You can add as many pktfile specifications as you
  90.           wish.
  91.  
  92.     "Out" direction (Blue Wave reply packet handling)
  93.     -------------------------------------------------
  94.  
  95. indigo [options] OUT newfile
  96.  
  97. newfile - *.NEW file to be converted into an outbound PKT file.
  98.  
  99.         Configuration file format
  100.         ─────────────────────────
  101.  
  102. The configuration file is divided into three sections, which are indicated
  103. by the use of a header on the format
  104.  
  105.   [Title]
  106.  
  107. where Title is the name of the section. The sections are: "Global",
  108. "Uplinks" and "Areas". They will be described in detail below.
  109.  
  110. Inside each section, the configuration data is written in this format:
  111.  
  112.   Keyword=Value
  113.  
  114. or, with keywords requiring more than one value:
  115.  
  116.   Keyword=Value1,Value2 {and so on ...}
  117.  
  118. Comments can be written on lines beginning with a semicolon (;). Empty
  119. lines are ignored.
  120.  
  121.     The [Global] section
  122.     --------------------
  123.  
  124. In the section following the [Global] header, the following configuration
  125. keywords can be used:
  126.  
  127.  Outbound (required)
  128.  
  129. Defines the outbound directory used by your mailer and the default zone
  130. number. The two values are separated by commas. There should be no trailing
  131. backslash in the path name.
  132.  
  133.  Origin (optional)
  134.  
  135. Defines the text that is to be used on the Origin line. If you leave it
  136. out, your Origin line will be empty. Do not include your address, it will
  137. be appended automatically.
  138.  
  139.  Name (required)
  140.  
  141. Defines the user name that is to be used for the packet. It is also used to
  142. indicate personal mail.
  143.  
  144.  NetMail (optional)
  145.  
  146. Defines the title for the netmail areas. If you leave it out, they will be
  147. called "NetMail". The addresses for the netmail areas are appended
  148. automatically.
  149.  
  150.  BadMail (optional)
  151.  
  152. Defines the title for the badmail area (the one where messages in
  153. non-defined areas will be saved). If you leave it out, it will be called
  154. "Bad mail".
  155.  
  156.  BaseName (required)
  157.  
  158. Defines the base name that is to be used for the Blue Wave packet. Indigo
  159. will append a three-digit number to this base name.
  160.  
  161.  Compress (required)
  162.  
  163. This defines the name of the archiving software that will be used to
  164. compress the Blue Wave packet. The program needs two parameters, the mail
  165. packet name and the files to be included, and to provide for them, you have
  166. to add two "%s" tokens (without the quotes) to the command line. The first
  167. "%s" will be changed into the mail packet name, and the second into the
  168. source files.
  169.  
  170. Here are some examples:
  171.  
  172. Info-Zip Zip: zip -j9 %s %s
  173. PkZip 2.04g (DOS): pkzip -ex %s %s
  174. PkZip 2.50 (OS/2): pkzip /add /max %s %s
  175. ARJ: arj -jm a %s %s
  176. LHA (DOS): lha a %s %s
  177. LH2 (OS/2): lh2 a %s %s
  178. RAR: rar a %s %s
  179.  
  180.  Decompress (required)
  181.  
  182. This defines the name of the unarchiving software that will be used to
  183. decompress the Blue Wave reply packet. The program needs two parameters,
  184. the reply packet name and the destination directory, and to provide for
  185. them, you have to add two "%s" tokens (without the quotes) to the command
  186. line. The first "%s" will be changed into the reply packet name, and the
  187. second into the destionation directory.
  188.  
  189. Here are some examples:
  190.  
  191. Info-Zip UnZip: unzip %s -d %s
  192. PkUnZip 2.04g (DOS): pkunzip %s %s
  193. PkZip 2.50 (OS/2): pkzip /ext %s %s
  194. ARJ: arj e %s %s
  195. LHA (DOS): lha e %s %s\
  196. LH2 (OS/2): lh2 e %s %s
  197. RAR: rar e %s %s
  198.  
  199. Please note that earlier versions of Info-Zip's UnZip lack the -d
  200. (destination directory) option. These version cannot be used with Indigo.
  201.  
  202.  TempPath (optional)
  203.  
  204. Defines the temporary directory to be used by the program. If you don't
  205. specify any, the one defined via the TEMP environment variable will be
  206. used. If none such is defined, the current directory will be used.
  207.  
  208.  BWPath (required)
  209.  
  210. Defines the path for the Blue Wave packet that is to be created.
  211.  
  212.     The [Uplinks] section
  213.     ---------------------
  214.  
  215.  Uplinks (required)
  216.  
  217. Specifies how many uplinks are defined. This keyword must be the first one
  218. in this section.
  219.  
  220.  Address (required, one per uplink)
  221.  
  222. This keyword specifies the uplink data. It takes three parameters: Your
  223. address, the uplink address, and the PKT password that is to be used.
  224.  
  225.     The [Areas] section
  226.     -------------------
  227.  
  228.  Areas (required)
  229.  
  230. Specifies how many areas are defined. This keyword must be the first one in
  231. this section.
  232.  
  233.  {area tag} (required, one per area)
  234.  
  235. Here you specify the areas that you download. The keyword in this section
  236. is the echo tag, and as it takes three parameters: The address you use for
  237. this echo, the Blue Wave area number (maximum of five characters allowed),
  238. and the title to be shown in the Blue Wave reader.
  239.  
  240.         Sample configuaration
  241.         ─────────────────────
  242.  
  243. [Global]
  244. Outbound=C:\BINKLEY\OUTBOUND,2
  245. Origin=My Point
  246. Name=Peter Karlsson
  247. NetMail=NetMail
  248. BadMail=Bad Mail
  249. BaseName=POINT
  250. Decompress=C:\UNZIP\UNZIP %s -d %s
  251. Compress=C:\ZIP\ZIP -j9 %s %s
  252. TempPath=C:\TEMP
  253. BWPath=C:\BWAVE\DOWN
  254.  
  255. [Uplinks]
  256. Uplinks=1
  257. Address=2:206/221.1,2:206/221.0,PASSWORD
  258.  
  259. [Areas]
  260. Areas=2
  261. BLUEWAVE=2:206/221.1,000,Blue Wave (Int'l)
  262. R20_BWAVE=2:206/221.1,001,Blue Wave (Swe)
  263.  
  264.         Revision history
  265.         ────────────────
  266.  
  267. Version 0.01 (1997-12-14)
  268. * First release
  269.  
  270.         Caveats
  271.         ───────
  272.  
  273. * If you use Blue Wave 2.12 or earlier, do not specify area numbers with
  274.   periods in them, since these versions use the area number as a base for
  275.   the message filenames.
  276. * If you specify the same area number for two areas, strange things will
  277.   occur in your reader (Indigo will not give a warning, or be affected by
  278.   this). Please note that the netmail areas and the badmail area
  279.   automatically get area numbers ("NE###", where ### is a three digit
  280.   number, for netmail areas, and "BAD" for the badmail area.
  281. * If you have a timezone defined (TZ environment variable), make sure the
  282.   same timezone is defined while running your Blue Wave reader as when you
  283.   are running Indigo. Otherwise, the time stamps of your outbound messages
  284.   may get wrong.
  285.  
  286.         To do
  287.         ─────
  288.  
  289. * Remove all the bugs.
  290. * Automatic unarchiving of the incoming mail packets.
  291. * Support for ArcMailAttach style outbound (FrontDoor etc).
  292. * Multiple Origin lines (one per area).
  293. * Character set support (CHRS kludge), both for inbound (conversion) and
  294.   outbound (insertion of CHRS kludge) messages.
  295. * Clean up the code, make it more object-oriented, more generic, and less
  296.   dependent on certain structures in the files.
  297. * Linux/Unix port.
  298.  
  299.         Compilers
  300.         ─────────
  301.  
  302. The source has been compiled with Borland Turbo C++ 1.0 for the DOS
  303. version, and EMX/GNU C++ 0.9c for the OS/2 version.
  304.  
  305.         Contact details
  306.         ───────────────
  307.  
  308. The author of Indigo 0.01 can be reached via these means:
  309.  
  310. Snailmail:      Peter Karlsson
  311.                 Värnsta, Ullersäter
  312.                 SE-718 92  FRÖVI
  313.                 Sweden
  314.  
  315. Fido netmail:   Peter Karlsson, 2:206/221.0
  316. Internet mail:  pk@abc.se
  317. Fax:            +46-(0)21-132367
  318.  
  319. Web page:       http://nafmo.home.ml.org/
  320.