home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / utils / golded / v_240 / addn_241.doc next >
Encoding:
Text File  |  1993-03-07  |  42.6 KB  |  962 lines

  1. ----------------------------------------------------------------------
  2. ADDEN241.DOC                          Addendum to the v2.40 GOLDED.DOC
  3. ----------------------------------------------------------------------
  4.  
  5.  
  6. ----------------------------------------------------------------------
  7. --- INTRODUCTION
  8. ---
  9.  
  10. This document is a GoldED 2.41 addendum to the GoldED 2.40 manual.
  11.  
  12. The original 2.40 manual was written in WordPerfect 5.1 and converted
  13. to ascii text format with a text-only printer driver. For version
  14. 2.41, it was my intention to just update the original WP document and
  15. go through the same procedure. However, this turned out to be not a
  16. simple task, because WP started acting really wierd and (among other
  17. unfunny things) cut out parts of the manual. Clearly I could not go on
  18. working with WP.
  19.  
  20. So until another solution can be found, I am leaving the original 2.40
  21. manual as it is and have included it untouched (except for the file
  22. date) in this archive.
  23.  
  24. This addendum lists the new keywords and describes most of the new
  25. features added since 2.40. There is no table of contents, index, page
  26. numbers or formfeeds. Sorry.
  27.  
  28. The information in this addendum has been adapted from the original
  29. technical notes files (NOTEmmdd.DOC) since 2.40. That is a huge amount
  30. of information, and so I cannot guarantee that all relevant info has
  31. been included in this addendum. As mentioned in GOLDED.DOC, writing
  32. manuals is not my favorite passtime.
  33.  
  34. If you are upgrading from 2.40 or a later patch update, I strongly
  35. suggest that you read the NEWS_241.DOC file, which contains a
  36. shorthand list of the fixes, changes and new features since 2.40. You
  37. are also recommended to read the NOTE_241.DOC file, which contains a
  38. detailed and often highly technical list of the fixes etc. The
  39. NOTE_241.DOC file contains many hints and insights into the workings
  40. of GoldED. Many details are not documented in the manual, partly
  41. because of laziness/too busy and partly because it is hard to remember
  42. it all, not to mention organize it in a useful way.
  43.  
  44.  
  45. ----------------------------------------------------------------------
  46. --- EZYCOM MSGBASE SUPPORT
  47. ---
  48.  
  49. New in GoldED 2.41 is the support for the new Ezycom msgbase format.
  50. This section tells you of special considerations about it.
  51.  
  52. ... The Ezycom msgbase support in GoldED is based on structures
  53.     and documents for version 1.02 and has been tested with this
  54.     version.
  55.  
  56. ... Due to the way the Ezycom msgbase is currently designed, it is not
  57.     practically possible to exclude deleted msgs when scanning and
  58.     reading msgs. This means that you will always see the deleted msgs
  59.     (they will have the DEL attribute set in the header display and
  60.     the msg body is replaced with a dummy). To be able to exclude
  61.     deleted msgs within the current Ezycom msgbase design, GoldED
  62.     would have to read through the entire MSGHxxxx.BBS file to look at
  63.     one single DELETED bit in each msg header. This would take way too
  64.     long on most systems. I have discussed this problem with the
  65.     Ezycom author, and he has agreed to implement a simple solution
  66.     for the next Ezycom release (and beta). I will implement my
  67.     support for that solution in a future version of GoldED.
  68.  
  69. ... GoldED does not add to or create the Ezycom userbase. If a user is
  70.     not found in the Ezycom USERS.BBS, the user is assigned the first
  71.     set of lastreads. No warning is issued about this. You should add
  72.     new users by logging on locally with EZY -L.
  73.  
  74. ... Ezycom userbase lookups have not yet been implemented.
  75.  
  76. ... For manual setup of Ezycom areas, the <msgbase> parameter of the
  77.     AREA keyword must be 'E' and the <loc> parameter must be the board
  78.     number of the area. For the new AREADEF keyword the <msgbase>
  79.     parameter must be 'Ezycom' and <path/board> paraneter must be the
  80.     board number. Examples:
  81.  
  82.     AREA EZYCOM "Ezycom support" EE 1
  83.     AREADEF EZYCOM "Ezycom support" 0 Echo Ezycom 1 2:231/77 (Loc)
  84.  
  85.  
  86. ----------------------------------------------------------------------
  87. --- NEW COMMANDLINE PARAMETERS
  88. ---
  89.  
  90. -F    (*Changed*) Force compile of most configs, but not all (does not
  91.       recompile the .CHS files).
  92.  
  93. -FF   Force-Force compile. Forces compile of *all* configs.
  94.  
  95. -M    Mute. Disables all sounds in GoldED.
  96.  
  97. -V    (*Changed*) Verbose output now also displays the name of the
  98.       multitasker, if detected.
  99.  
  100.       NOTE: It only detects the multitasker set with TIMESLICE.
  101.  
  102. -W    If used, GoldED will create/overwrite the file GOLDAREA.INC,
  103.       which will contain all areas in the new AREADEF form, sorted by
  104.       your AREALISTSORT specification. This is very useful for
  105.       converting your AREAFILE's to a form you can edit with your
  106.       favorite text editor and use in GoldED. It is also useful if you
  107.       have used the new AREADESC keyword or the new AREAFILE EchoList
  108.       reader.
  109.  
  110.       The GOLDAREA.INC file (created in the GOLDPATH) can be used by
  111.       adding "INCLUDE GOLDAREA.INC" to your GOLDED.CFG or
  112.       GOLDAREA.CFG.
  113.  
  114.       When creating the file, GoldED will use '.' if an aka is the
  115.       same as the main aka, and leave out the optional origin if it's
  116.       the same as the first ORIGIN in your GOLDED.CFG. This makes it
  117.       easier to share the same GOLDAREA.INC between different setups.
  118.  
  119.  
  120. ----------------------------------------------------------------------
  121. --- NEW CONFIGURATION KEYWORDS (for golded.cfg)
  122. ---
  123.  
  124.  
  125. See GOLDED.DOC for a list of the symbols used in this reference.
  126.  
  127.  
  128. ADDRESSMACRO (*changed*)
  129. ----------------------------------------------------------------------
  130.     The address macros can now also specify attributes to add to the
  131.     message. The new syntax of the ADDRESSMACRO keyword is:
  132.  
  133.       ADDRESSMACRO <macro>,<name>,<address>[,"subject"][,attribs]
  134.  
  135.     If (and ONLY if) the subject is enclosed in quotes ("" or ''),
  136.     GoldED will look for the attributes after the subject. Attributes
  137.     are specified in the usual way: K/S, PVT etc. You cannot have
  138.     quotes within quotes (not the same type anyway).
  139.  
  140.     The attribues are *added* to the ones already there, they do *not*
  141.     replace them.
  142.  
  143.     Example of use:
  144.  
  145.       ADDRESSMACRO af50,AreaFix,2:231/50,"mypwd -q -l",K/S
  146.  
  147.     This new feature works equally well with the ADDRESSMACRO keyword
  148.     and the external NAMESFILE, but you should only use it with the
  149.     ADDRESSMACRO keyword, because FrontDoor and other programs do not
  150.     understand this new syntax and will treat the attributes as part
  151.     of the subject.
  152.     
  153. AREAAUTOFREQ <echoid>
  154. ----------------------------------------------------------------------
  155.     Sets the default area for the filerequest function. You should set
  156.     this to the netmail area where you normally put the filerequest
  157.     messages.
  158.  
  159. AREADEF <setup>
  160. ----------------------------------------------------------------------
  161.     This is a new version of the "AREA" keyword, with new and more
  162.     verbose parameters.
  163.  
  164.     The full syntax is:    (must be all on one line of course)
  165.  
  166.     AREADEF <echoid> <"desc"> <group> <type> <msgbase> <path/board>
  167.             <aka> <(attrs)> ["origin"]
  168.  
  169.     <echoid>      The echoid.
  170.     <"desc">      Area description in quotes.
  171.     <group>       Groupid letter (A-Z), or 0 if not in a group.
  172.     <type>        Net, Echo or Local.
  173.     <msgbase>     FIDO, FTSC, HUDSON, SQUISH or EZYCOM.
  174.     <path/board>  Area path, boardnumber or base filename.
  175.     <aka>         Aka address for the area, or '.' for main aka.
  176.     <(attrs)>     Default attributes in brackets ().
  177.     ["origin"]    Optional default origin in quotes.
  178.  
  179.     As you can see, it looks a lot like the old AREA keyword. New
  180.     stuff is the <group>, the verbose <type> and <msgbase>, the fully
  181.     specified <aka> address, the brackets for the attributes and the
  182.     optional origin.
  183.  
  184.     Note the possibility of using '.' to specify the main aka. This,
  185.     and the optional default origin, makes it simpler to create a
  186.     common INCLUDE'able area configuration for several setups with
  187.     different addresses, for example two people sharing the same
  188.     msgbase.
  189.  
  190. AREADESC <echoid> <"desc"> [group] [aka] [(attrs)] ["origin"]
  191. ----------------------------------------------------------------------
  192.     Adds a description and optionally a group letter, aka, attributes
  193.     and origin to an _existing_ area. This is useful if you use an
  194.     AREAFILE that does not contain descriptions, groups, akas,
  195.     attributes or origins.
  196.  
  197.     <echoid>      The echoid.
  198.     <"desc">      Area description in quotes.
  199.     [group]       Optional groupid letter (A-Z), or 0 if not in a
  200.                   group, or '-' to keep the existing group letter.
  201.     [aka]         Optional aka address for the area, or '.' for main
  202.                   aka, or '-' to keep the existing aka.
  203.     [(attrs)]     Optional default attributes in brackets (), '-' to
  204.                   keep the existing attributes. Note that if they are
  205.                   specified, they are _added_ to the default
  206.                   net/echo/local attributes.
  207.     ["origin"]    Optional default origin in quotes.
  208.  
  209.     NOTE: You cannot skip one of the middle optional parts, even if
  210.           you only want to set, say, an origin. Use '-' to keep the
  211.           existing value for the parts you skip.
  212.  
  213. AREALISTECHOMAX <size>  (0)
  214. ----------------------------------------------------------------------
  215.     Allows you to specify a fixed width of the EchoID column in the
  216.     arealist, or make it dynamically sized (see below). If a negative
  217.     value is specified, the width will be the that of the widest
  218.     echoid in the arealist plus the negative value. This might be
  219.     useful if some long-name echoes have uninteresting ends, such as
  220.     "VERYLONGECHOID_R23.PUB" (could benefit from a <size> of -7).
  221.     There is currently no provision for long echoids with common
  222.     beginning.
  223.  
  224.     The arealist can dynamically resize the EchoID and Description
  225.     columns, so that long echoids are not cut off. The sizing of the
  226.     EchoID column is done against the Description column, which
  227.     thereby looses or gains width. Previously the EchoID column width
  228.     was fixed at 13 chars on 80 column displays.
  229.  
  230. AREAREADONLY <soft/hard>  (soft)
  231. ----------------------------------------------------------------------
  232.     If this keyword is set to "hard", it is no longer possible to
  233.     enter/reply/change messages in areas marked read-only with the R/O
  234.     area attribute. The "soft" setting uses a menu to ask permission
  235.     as in the previous versions. This option is designed for those who
  236.     setup a system for "green" computer users who might be confused
  237.     enough to enter a message in a read-only area despite the warning
  238.     menu.
  239.  
  240. AREASCANEXCL <echoid or wildcards>
  241. ----------------------------------------------------------------------
  242.     With this keyword you can prevent areas from being scanned with
  243.     AREASCAN on startup. Useful if you always use "AREASCAN *", but
  244.     have a few big areas which slows it down.
  245.  
  246. AREASCANINCL <echoid or wildcards>
  247. ----------------------------------------------------------------------
  248.     Here you can specify areas to be scanned with AREASCAN even if
  249.     they were excluded with AREASCANEXCL. Useful for partial reversal
  250.     of wildcard specs in the excludes.
  251.  
  252. ATTRIBSFRQ <attributes>
  253. ----------------------------------------------------------------------
  254.     Defines the attributes to use for messages generated with the file
  255.     request function. Suggested attributes are: PVT K/S CRA. The FRQ
  256.     and LOC attributes are added automatically.
  257.  
  258. COOKIEFILE <[path]<file>>
  259. ----------------------------------------------------------------------
  260.     Defines any number of "cookie" files, which will be automatically
  261.     indexed if needed. The cookie (or "random") files are those which
  262.     can be used in the templates, using the "@random" token.
  263.  
  264.     The [path] defaults to the GOLDPATH.
  265.  
  266.     NOTE: This feature only works for REGISTERED users, and replaces
  267.           the external utility "GoldRAND" which was distributed in the
  268.           GRAND101.ARJ archive.
  269.  
  270. COOKIEPATH <path>  (defaults to the GOLDPATH)
  271. ----------------------------------------------------------------------
  272.     Defines the default path for the COOKIEFILE keyword and the
  273.     @random template token.
  274.  
  275. DISPAREANO <yes/no/always>  (yes)
  276. ----------------------------------------------------------------------
  277.     This keyword specifies if GoldED should display the area number on
  278.     the top line in the reader.
  279.  
  280.       YES       Display it only if non-zero.
  281.       NO        Never display it.
  282.       ALWAYS    Duh... Guess what... Always display the area number.
  283.  
  284.     The area number is the same as that displayed in the leftmost
  285.     column in the arealist. This also means that the number displayed
  286.     can be either the "real" area number (QBBS/Ezycom board) or the
  287.     standard sequential number (toggleable with Alt-B in the
  288.     arealist).
  289.  
  290.     The number is displayed in square brackets to the left of the area
  291.     description. I am not sure that is the best place for it - things
  292.     are getting kinda crowded up there... Suggestions are welcome.
  293.  
  294. DISPATTACHSIZE <bytes/kbytes/no>  (kbytes)
  295. ----------------------------------------------------------------------
  296.     Controls how the size of attached files is displayed in the
  297.     header. Either the exact byte size, the rounded kbyte size, or not
  298.     displayed at all. If the kbytes setting is chosen, the value is
  299.     rounded according to the following formula: kbytes = (bytes + 512)
  300.     / 1024. So a 600 bytes file is rounded up to "1k", but a 500 bytes
  301.     file is rounded down to "0k".
  302.  
  303. DISPHDRDATESET <pos> <len>  (-20 20)
  304. ----------------------------------------------------------------------
  305.     Specfies the position and length of the date field in the header
  306.     display. If a negative value is specified, that value is _added_
  307.     to the current display width.
  308.  
  309. DISPHDRNAMESET <pos> <len>  (8 36)
  310. ----------------------------------------------------------------------
  311.     Specfies the position and length of the from/to name field in the
  312.     header display. If a negative value is specified, that value is
  313.     _added_ to the current display width.
  314.  
  315. DISPHDRNODESET <pos> <len>  (44 16)
  316. ----------------------------------------------------------------------
  317.     Specfies the position and length of the from/to node address field
  318.     in the header display. If a negative value is specified, that
  319.     value is _added_ to the current display width.
  320.  
  321.     NOTE: The attributes display moves along with the DISPHDRNODESET
  322.           values.
  323.  
  324. DISPSTATUSLINE <yes/no>  (yes)
  325. ----------------------------------------------------------------------
  326.     If set to NO, the statusline with memory meter, clock etc. will be
  327.     disabled. This option has been implemented as a temporary help for
  328.     visually impaired users. More extensive help may be implemented in
  329.     future versions.
  330.  
  331. EDITHDRNAMESET <pos> <len>  (8 36)
  332. ----------------------------------------------------------------------
  333.     Specfies the position and length of the from/to name field in the
  334.     header edit display. If a negative value is specified, that value
  335.     is _added_ to the current display width.
  336.  
  337. EDITHDRNODESET <pos> <len>  (44 36)
  338. ----------------------------------------------------------------------
  339.     Specfies the position and length of the from/to node address field
  340.     in the header edit display. If a negative value is specified, that
  341.     value is _added_ to the current display width.
  342.  
  343. EVENT <eventtype> <eventcommand [parameters]>
  344. ----------------------------------------------------------------------
  345.     This keyword allows you to specify which soundfile to play when a
  346.     specfic event occurs. The following <eventtype>'s are defined for
  347.     this release:
  348.  
  349.       Arealist            JobFailed
  350.       AskYesNo            MsgDeleting
  351.       Attention           MsgFromYou
  352.       DosShell            MsgIsLocal
  353.       EditComment         MsgIsTwit
  354.       EndOfMsgs           MsgToYou
  355.       ErrorFatal          SearchFailed
  356.       Exit                SearchSuccess
  357.       JobDone             Startup
  358.  
  359.     There is only one <eventcommand> defined in this release: PLAY.
  360.  
  361.     The standard config files in this release contains a set of
  362.     default assignments. You will need the GOLD_VOC.ARJ archive with
  363.     the "authorized" set of VOC's if you want to try these default
  364.     assignments.
  365.  
  366.     Example usages:
  367.  
  368.       EVENT MsgToYou  PLAY HIMAN.VOC            (Bart Simpson :-)
  369.       EVENT MsgIsTwit PLAY SHOTGUN.VOC
  370.  
  371.     As I found out(!), you have to select the sounds carefully and
  372.     probably with a lot of experimentation, unless you want to turn
  373.     your mailreader into a honking, wailing and farting monster and
  374.     drive your poor family nuts with a cacophony of noises...
  375.  
  376.     The "authorized" set is under no delusion of being well balanced,
  377.     but it's fun to use - for a while anyway.
  378.  
  379. EZYCOMMSGBASEPATH <path>
  380. ----------------------------------------------------------------------
  381.     Defines the base path for the Ezycom msgbase. If not set, AREAFILE
  382.     Ezycom will set it.
  383.  
  384. EZYCOMUSERBASEPATH <path>
  385. ----------------------------------------------------------------------
  386.     Defines the base path for the Ezycom userbase. If not set,
  387.     AREAFILE Ezycom will set it.
  388.  
  389. FIDONULLFIX <yes/no>  (no)
  390. ----------------------------------------------------------------------
  391.     If set to YES, GoldED will replace NUL chars with LF chars in the
  392.     msg body when reading a Fido *.MSG file. This is slower of course,
  393.     but not noticably on fast machines.
  394.  
  395.     This option was created to enable GoldED users to read msgs that
  396.     were created/handled by brain-dead programs (I don't have names,
  397.     sorry) which are not obeying our primary technical standard:
  398.     FTS-0001. FTS-1 states that a NUL terminates the msg body. But
  399.     sometimes msgs are encountered which have a NUL as the first char
  400.     in the msg body or perhaps in other places, thereby causing GoldED
  401.     to show a blank or cut-off msg. In some Pascal-based readers, such
  402.     as FM, these msgs can be read anyway, because in Pascal a NUL does
  403.     not terminate a string like in C/C++.
  404.  
  405.     NOTE: Even if the new FIDONULLFIX keyword is disabled, GoldED will
  406.           still fix a NUL if it is the _first_ character in the msg
  407.           body. This probably fixes most of these buggy msgs without
  408.           the overhead of checking the entire msg.
  409.  
  410. FRQEXT <.ext>
  411. ----------------------------------------------------------------------
  412.     With this keyword you can add extra known filename extensions for
  413.     the filerequest function. The following extensions are already
  414.     known by default, and need not be defined (but dups are ignored so
  415.     it won't hurt):
  416.  
  417.       .ARC .ARJ .COM .EXE .LHA .LZH .PAK .RUN .SDA .SDN .ZIP .ZOO
  418.       .DOC .TXT .GIF
  419.  
  420.     Each extension _must_ have the leading dot. Example: FRQEXT .XYZ
  421.  
  422. KLUDGECHRS <yes/no>  (no)
  423. ----------------------------------------------------------------------
  424.     If set to YES, GoldED uses the "^aCHRS" kludge instead of the
  425.     "^aCHARSET" kludge when appropriate.
  426.  
  427. MOUSE
  428. ----------------------------------------------------------------------
  429.     All mouse support has been removed in 2.41, so this keyword is not
  430.     functional and is ignored.
  431.  
  432. NODELISTWARN <yes/no>  (yes)
  433. ----------------------------------------------------------------------
  434.     If set to YES, GoldED will warn you during startup if one or more
  435.     nodelists are missing. Use NO to disable the warning if it bothers
  436.     you or you delete/pack your nodelists when the nodelists are
  437.     compiled.
  438.  
  439.     NOTE: GoldED can work fine with lookups etc. without nodelists as
  440.           long as it can access its own indexes (GOLDNODE.?IX). Only
  441.           the extra details will be missing.
  442.  
  443. PLAY <soundfile>
  444. ----------------------------------------------------------------------
  445.     If used in GOLDED.CFG, it defines the default sound to play when
  446.     entering an area. If used in GOLDRAND.CFG, it defines the sound to
  447.     play when entering an area or group of areas. If more than one
  448.     PLAY is used in a group in GOLDRAND.CFG, one will be chosen at
  449.     random.
  450.  
  451.     The only soundfile supported in this release is the Creative
  452.     Technology Voice format - the *.VOC files. When a VOC is played
  453.     with GoldED, it is first loaded complete into memory (so don't use
  454.     big ones...) and then the CT-VOICE driver plays it. It is possible
  455.     (in most situations) to do other things while the VOC is playing,
  456.     but beware that you may run out of memory. Keep an eye on the
  457.     memory meter in the statusline. The VOC will be automatically
  458.     unloaded when it stops playing.
  459.  
  460.     NOTE: It is important to supply the .VOC file extension. This is
  461.           the only way GoldED knows what kind of soundfile it is.
  462.           Later versions might add support for .WAV and other types.
  463.  
  464. QBBSREBUILD
  465. ----------------------------------------------------------------------
  466.     This keyword is no longer functional and is ignored.
  467.  
  468. QBBSSCAN <old/rescan>  (old)
  469. ----------------------------------------------------------------------
  470.     The "rescan" setting turns off the full area scan for the QBBS
  471.     msgbase, and instead makes it scan each area separately, just like
  472.     it is for Squish, *.MSG and Ezycom areas. This is slower, but has
  473.     the advantage that GoldED no longer have to hold indexes of all
  474.     the areas in memory. This saves a lot of memory if you have many
  475.     and/or large areas, thereby elimininating many of the "out of
  476.     memory" errors you might have encountered.
  477.  
  478. QUOTEBUFFILE <filename>
  479. ----------------------------------------------------------------------
  480.     This keyword can be used in both the GOLDED.CFG *and* the Random
  481.     System GOLDRAND.CFG. If used, it sets the default filename for the
  482.     quotebuffer, either globally (in GOLDED.CFG) or by group/area
  483.     (GOLDRAND.CFG). If no path is specified, the GOLDPATH is used.
  484.  
  485.     NOTE: If this keyword is used in GOLDED.CFG, it effectively
  486.           disables the automatically named quotebuffers, as described
  487.           in the section about the QUOTEBUFMODE keyword.
  488.  
  489. QUOTEBUFMODE <ask/append/overwrite>  (ask)
  490. ----------------------------------------------------------------------
  491.     Specifies what GoldED should do, if the quotebuffer file exists
  492.     already.
  493.  
  494.       ASK         A menu asks you to select append/overwrite/skip.
  495.       APPEND      Always append, no asking.
  496.       OVERWRITE   Always overwrite, no asking.
  497.  
  498.     The "always overwrite" mode is not very useful I guess, but it's
  499.     there if you need it.
  500.  
  501.     The quotebuffer feature automatically creates special filenames
  502.     for the buffer file, using these guidelines:
  503.  
  504.     QBBS:   GOLDQxxx.QBF, placed in the QBBSPATH. xxx = board num.
  505.     *.MSG:  GOLDED.QBF, placed in the directory with the *.MSG's.
  506.     Squish: filename.QBF, placed where the Squish area is.
  507.     Ezycom: GOLDxxxx.QBF, placed in the EZYCOMMSGPATH. xxxx=board num.
  508.  
  509.     Note that they all have extension .QBF, so that you can easily
  510.     find them. Useful for a quick global kill of all quotebuffers.
  511.  
  512. ROBOTNAME (*changed*)
  513. ----------------------------------------------------------------------
  514.     The following ROBOTNAME's are now defined by default:
  515.  
  516.       AreaFix, AreaMgr, FileFix, AreaLink, Raid, AllFix, GEcho.
  517.  
  518.     This is to help those who are using the simple setup, and have not
  519.     found the ROBOTNAME keyword in the manual yet. If you have these
  520.     names defined in your advanced setup, don't worry: Duplicates are
  521.     ignored.
  522.  
  523.     See the ROBOTNAME keyword in GOLDED.DOC for more details.
  524.  
  525. SOUNDDEVICE <device> [parameters]
  526. ----------------------------------------------------------------------
  527.     Default is no device, and only the standard set of beeping
  528.     effects. Valid <device>'es are:
  529.  
  530.       SB      Enable Sound Blaster support.
  531.       SBPRO   Same as SB. This version doesn't know the difference.
  532.  
  533.     If SB or SBPRO was chosen and the card is setup with the factory
  534.     defaults, you don't have to supply parameters. If no parameters
  535.     are specified, GoldED uses the SOUND and BLASTER environment
  536.     variables to get the parameters or just uses the factory defaults.
  537.  
  538.     The valid parameters for SB/SBPRO are:
  539.  
  540.       -A<ioport>    (optional)
  541.       -I<intnum>    (optional)
  542.       <full path and name of the CT-VOICE.DRV file>  (optional)
  543.  
  544.     Example: SOUNDDEVICE SBPRO -A220 -I7 C:\SBPRO\DRV\CT-VOICE.DRV
  545.  
  546.     The SB support is done by loading the CT-VOICE.DRV driver into
  547.     memory and handing it the VOC's to play with.
  548.  
  549.     Although it is not tested by me, GoldED should be able to work
  550.     with any Sound Blaster compatible sound card that comes with a
  551.     CT-VOICE.DRV compatible driver.
  552.  
  553.     NOTE: If you don't get any sound, try (re-)installing the
  554.           CT-VOICE.DRV file with the correct parameters using the
  555.           INST-DRV utility (Run "INST-DRV DRV" in your SB/SBPRO
  556.           directory).
  557.  
  558. SOUNDPATH <path>  (defaults to the GOLDPATH)
  559. ----------------------------------------------------------------------
  560.     Tells GoldED where to find the sound files for the PLAY and EVENT
  561.     keywords.
  562.  
  563. TEMPLATEPATH <path>  (defaults to the GOLDPATH)
  564. ----------------------------------------------------------------------
  565.     Defines the default path for msg templates. Use this if your
  566.     templates are not in the GOLDPATH.
  567.  
  568. TIMEOUTSAVEMSG <yes/no>  (yes)
  569. ----------------------------------------------------------------------
  570.     If set to YES, GoldED behaves as usual: It saves the (perhaps
  571.     partially written) msg text in the internal editor to the msgbase
  572.     and exits. If set to NO, GoldED will save the msg text in
  573.     GOLDED.MSG just as if EDITAUTOSAVE function was in use and the
  574.     power went out. Next time you started GoldED and entered a msg, it
  575.     would detect the "lost" msg and ask you if it should be continued.
  576.  
  577.  
  578. ----------------------------------------------------------------------
  579. --- COMPLETE CONFIGURATION KEYWORD LIST FOR 2.41
  580. ---
  581.  
  582. The following are all the keywords GoldED can recognize in GOLDED.CFG
  583. and INCLUDE'd .CFG's:
  584.  
  585. ADDRESS                DOSSWAP                   OVERLAY
  586. ADDRESSMACRO           EDITAUTOATTACH            PLAY
  587. AKA                    EDITAUTOSAVE              PRINTDEVICE
  588. AKAMATCHECHO           EDITCHANGEDATE            PRINTFORMFEED
  589. AKAMATCHLOCAL          EDITCOMMENT               PRINTINIT
  590. AKAMATCHNET            EDITCRLFTERM              PRINTLENGTH
  591. AREA                   EDITFIELDCLEAR            PRINTMARGIN
  592. AREAAUTOFREQ           EDITHARDLINE              PRINTRESET
  593. AREAAUTONEXT           EDITHARDLINES             QBBSINCRESCAN
  594. AREADEF                EDITHDRNAMESET            QBBSPATH
  595. AREADESC               EDITHDRNODESET            QBBSREBUILD
  596. AREAEXCL               EDITINTERNAL              QBBSSCAN
  597. AREAFILEGROUPS         EDITMENU                  QUOTEBLANK
  598. AREAINCL               EDITMIXCASE               QUOTEBUFFILE
  599. AREALISTECHOMAX        EDITMSGSIZE               QUOTEBUFMODE
  600. AREALISTNOS            EDITOR                    QUOTEMARGIN
  601. AREALISTSORT           EDITORFILE                QUOTESPACING
  602. AREALISTTYPE           EDITREPLYRE               QUOTESTRING
  603. AREAPATH               EDITSAVEMENU              REGISTERKEY
  604. AREAREADONLY           EDITSPELLCHECK            REGISTERNAME
  605. AREARENAME             EDITUNDELETE              ROBOTNAME
  606. AREASCAN               EMPTYTEARLINE             SCREENBLANKER
  607. AREASCANEXCL           EVENT                     SCREENELIMSNOW
  608. AREASCANINCL           EXCLUDENODES              SCREENMAXCOL
  609. AREASTART              EZYCOMMSGBASE             SCREENMAXROW
  610. ASKDELORIG             EZYCOMUSERBASE            SCREENSHADOWS
  611. ATTRIBSCC              FIDOHWMARKS               SCREENSIZE
  612. ATTRIBSCFM             FIDOLASTREAD              SCREENUSEBIOS
  613. ATTRIBSECHO            FIDOLASTREADNO            SEMAPHORE
  614. ATTRIBSFRQ             FIDONULLFIX               SHAREMODE
  615. ATTRIBSLOCAL           FIDOSCAN                  SOUNDDEVICE
  616. ATTRIBSNET             FILEALIAS                 SOUNDPATH
  617. BEEPCOMMENT            FREETEAR                  SQUISHSCAN
  618. BEEPFACTOR             FRQEXT                    SQUISHUSERNO
  619. BEEPLOCALMSG           GOLDHELP                  SQUISHUSERPATH
  620. BEEPNOISES             GOLDKEYS                  SWAPPATH
  621. BEEPYOURMAIL           GOLDLANG                  TEARLINE
  622. CARBONCOPYLIST         GOLDPATH                  TEMPLATE
  623. COLOR                  GOLDRAND                  TEMPLATEPATH
  624. COLORSET               GOLDXLAT                  TEMPPATH
  625. CONFIRMFILE            INBOUNDPATH               TIMEOUT
  626. COOKIEFILE             INCLUDENODES              TIMEOUTSAVEMSG
  627. COOKIEPATH             INTENSECOLORS             TIMESLICE
  628. CROSSPOSTLIST          INVALIDATE                TWITMODE
  629. CTRLINFOECHO           KEYBCLEAR                 TWITNAME
  630. CTRLINFOLOCAL          KEYBEXT                   TWITSUBJ
  631. CTRLINFONET            KEYBSTACK                 USEFLAGS
  632. DISPAREANO             KLUDGECHRS                USEINTL
  633. DISPATTACHSIZE         LOGFILE                   USEMSGID
  634. DISPAUTONEXT           LOOKUPECHO                USERLIST
  635. DISPHDRDATESET         LOOKUPLOCAL               USERLISTFILE
  636. DISPHDRNAMESET         LOOKUPNET                 USERNAME
  637. DISPHDRNODESET         MAPDRIVE                  VIEWHIDDEN
  638. DISPLISTWRAP           MOUSE                     VIEWKLUDGE
  639. DISPLOCALHIGH          NAMESFILE                 WHOTO
  640. DISPMARGIN             NETNAME                   XLATCHARSET
  641. DISPPAGEBAR            NODELIST                  XLATESCSET
  642. DISPREALMSGNO          NODELISTWARN              XLATEXPORT
  643. DISPREPLIESMODE        NODEPATH                  XLATIMPORT
  644. DISPSTATUSLINE         ORIGIN                    XLATPATH
  645. DISPTABSIZE            OUTBOUNDPATH              ZONEGATING
  646. DOSPROMPT              OUTPUTFILE
  647.  
  648. NOTE: Some keywords may be non-functional, and some may even be
  649.       undocumented (and unimplemented).
  650.  
  651.  
  652. ----------------------------------------------------------------------
  653. --- NEW AREAFILE's
  654. ---
  655.  
  656. EchoList      Reads a simple ascii-text file containing an echolist in
  657.               this form:
  658.  
  659.                 <echoid> <description>
  660.  
  661.               This feature adds descriptions to already existing areas
  662.               in GoldED. A common use for this feature might be:
  663.  
  664.                 AREAFILE AreasBBS AREAS.BBS
  665.                 AREAFILE EchoList ECHOLIST.TXT
  666.  
  667.               Descriptions for unknown echoids are ignored. Blank
  668.               lines and lines beginning with characters which are
  669.               illegal in echoids (such as ';' are also ignored.
  670.  
  671. Ezycom        Reads CONFIG.EZY and MESSAGES.EZY to get the area setup.
  672.               Currently compatible with Ezycom 1.02, but not 1.01.
  673.  
  674. FMail         Reads FMAIL.CFG and FMAIL.AR. The FMail support has only
  675.               been tested with 0.90, but it was built with structures
  676.               for 0.92.
  677.  
  678. GEcho         (*Changed*) Support for older versions discontinued. The
  679.               current GEcho support is based on the structures in the
  680.               GEDEV100 archive by the GEcho author. It should however
  681.               work okay with any version which uses the SETUP.GE and
  682.               new AREAFILE.GE files.
  683.  
  684. IMail         (*Changed*) Now supports IMail 1.30 and later.
  685.  
  686. QuickBBS      (*Changed*) Now supports version 2.75 (and later) area
  687.               config files.
  688.  
  689. RemoteAccess  (*Changed*) Now also supports RA 2.00 (gamma).
  690.  
  691. Squish        (*Changed*) The filename of SQUISH.CFG can now be
  692.               defined with the new parameter -C<name of squish.cfg>.
  693.  
  694. SuperBBS      Reads CONFIG.BBS, SCONFIG.BBS and BOARDS.BBS.
  695.  
  696. Userdefined   (*Removed*) In my opinion it gave more confusion and
  697.               problems than it was worth. There were a couple of the
  698.               regular AREAFILE's which used the userdefined stuff
  699.               internally, including RemoteAccess and D'Bridge. These
  700.               now use real old-style code instead to read the areas.
  701.               In the case of RemoteAccess, this should also fix a few
  702.               bugs..
  703.  
  704.  
  705. ----------------------------------------------------------------------
  706. --- NEW RANDOM SYSTEM KEYWORDS (for goldrand.cfg)
  707. ---
  708.  
  709. FORCETEMPLATE <yes/no>  (no)
  710. ----------------------------------------------------------------------
  711.     This keyword can be used instead of (or together with) the
  712.     TEMPLATE keyword in Random System GROUP's. If used, GoldED will
  713.     popup the template selection menu when you start writing a new msg
  714.     or reply. If you have TEMPLATE's as well as FORCETEMPLATE, you can
  715.     use the (random) TEMPLATE's by hitting ESC instead of selecting
  716.     from the menu.
  717.  
  718. PLAY <soundfile>
  719. ----------------------------------------------------------------------
  720.     See description above in the CONFIGURATION KEYWORD REFERENCE (for
  721.     golded.cfg).
  722.  
  723.  
  724. ----------------------------------------------------------------------
  725. --- NEW TOKENS (for templates etc.)
  726. ---
  727.  
  728. @longpid      Replacement token. It gives "GoldED" for the DOS version
  729.               and "GoldED/2" for the OS/2 version. Mostly for use in
  730.               tearlines. The internal default tearline uses "@longpid
  731.               @version".
  732.  
  733. @os2slash     Replacement token. Is replaced with "/2" in the OS/2
  734.               version and "" (empty string) in the DOS version.
  735.               Example usage in a template:
  736.  
  737.                 @cfname@os2slash
  738.  
  739.               In my case, this would sign my msgs with "Odinn/2" in
  740.               OS/2 and "Odinn" in DOS. Cute, eh? :-)
  741.  
  742. @pid          Replacement token. It gives "GED" for the DOS version
  743.               and "GED/2" for the OS/2 version. Mostly for use in
  744.               tearlines.
  745.  
  746. @quotebuf     Insert token. Added to aid costumization of the
  747.               attribution ("In a msg of...") used for the quotebuffer
  748.               quotes. It works similar to the @reply, @comment and
  749.               @quoted tokens.
  750.  
  751.  
  752. ----------------------------------------------------------------------
  753. --- NEW KEYBOARD COMMANDS (for goldkeys.cfg)
  754. ---
  755.  
  756. AREAjumpnextmatch     Standard assignments in GOLDKEYS.CFG: <Tab> and
  757.                       <Ctrl-Enter>. When this key is hit, the
  758.                       selection bar will jump to the next area (if
  759.                       any) that matches the "fuzzy" quick-search
  760.                       string. This is useful when two areas that match
  761.                       are wide apart in the arealist.
  762.  
  763. EDITcleardeletebuf    Standard assignment in GOLDKEYS.CFG: <Alt-F5>.
  764.                       Clears all lines in the undelete buffer and
  765.                       frees the memory used. Successful operation is
  766.                       indicated with a noise.
  767.  
  768. EDITclearpastebuf     Standard assignment in GOLDKEYS.CFG: <Alt-F6>.
  769.                       Clears all lines in the paste buffer and frees
  770.                       the memory used. Successful operation is
  771.                       indicated with a noise.
  772.  
  773. EDITimportquotebuf    Standard assignment in GOLDKEYS.CFG: <Alt-Q>. A
  774.                       specialized version of EDITimporttext, this
  775.                       defaults to the current quotebuffer filename.
  776.  
  777. READmovecommentmsg    Standard assignments in GOLDKEYS.CFG: <Alt-B>
  778.                       and <B>. This keycommand does for READcommentmsg
  779.                       what READmovequotemsg does for READquotemsg. It
  780.                       allows you to write a reply to the TO: person in
  781.                       another area.
  782.  
  783. READquotebuf          Standard assignment in GOLDKEYS.CFG: <Ctrl-W>.
  784.                       If pressed, the current message is quoted
  785.                       internally and the result is appended to the
  786.                       current quotebuffer file. When you wish to use
  787.                       this "quotebuffer" in a message, you just import
  788.                       the file using the READimportquotebuf keyboard
  789.                       command in the internal editor and edit/delete
  790.                       it suitably. The only visual indication of
  791.                       successful operation is that GoldED displays a
  792.                       popup of the filename, but a noise is emitted
  793.                       when it is done. The noise is the same as the
  794.                       "search found" noise.
  795.  
  796. READtouchnetscan      Standard assignment in GOLDKEYS.CFG: <Ctrl-Z>.
  797.                       If this key is pressed, the SEMAPHORE NETSCAN
  798.                       file (typically FDRESCAN.NOW or DBRIDGE.RSN) is
  799.                       touched. This will normally cause the mailer
  800.                       netmail area to be re-scanned. The only visual
  801.                       indication of successful operation is that
  802.                       GoldED displays a popup of the filename, but a
  803.                       noise is emitted when it is done. The noise is
  804.                       the same as the "search found" noise.
  805.  
  806.  
  807. ----------------------------------------------------------------------
  808. --- NEW LANGUAGE ITEMS (for goldlang.cfg etc.)
  809. ---
  810.  
  811. Please see the standard GOLDLANG.CFG for a complete list of these
  812. keywords.
  813.  
  814. In this release there may be some which are not yet redefinable.
  815.  
  816.  
  817. ----------------------------------------------------------------------
  818. --- OS/2 VERSION
  819. ---
  820.  
  821. GoldED 2.41 is now available (or will be soon) in both DOS and OS/2
  822. versions. This section will tell you about some special considerations
  823. regarding the current implementation of GoldED/2.
  824.  
  825. ... If you have registered GoldED before, your key will only work for
  826.     the DOS version. The OS/2 version must be registered separately.
  827.     For a moderate price, you can update your key to work with the
  828.     OS/2 version. See the orderforms for details and pricing.
  829.  
  830. ... GoldED/2 looks first for a GED2.CFG, and then if not found it
  831.     looks for GOLDED.CFG. This way you can have separate setups in the
  832.     same directory.
  833.  
  834. ... The Sound Blaster support is currently disabled in the OS/2
  835.     version. Later versions may support special SB drivers or the
  836.     MultiMedia extensions (MMPM/2). The standard beeping effects have
  837.     been ported to the degree it was possible. The "gwynk" noise when
  838.     msgs to you are found sounds a bit different. The BEEPFACTOR is
  839.     currently not functional.
  840.  
  841. ... Some configuration keywords are not functional in the OS/2
  842.     version. I don't have a list of them right now, but it is mainly
  843.     keywords associated with hardware.
  844.  
  845. ... Ctrl-Break and Ctrl-C will terminate GoldED/2 immediately, without
  846.     warning, and without saving anything before terminating. Be
  847.     careful. I have tried hard to trap this brutal termination and do
  848.     a controlled shutdown instead, but it was too difficult. So beware
  849.     of those keys!
  850.  
  851. ... The statusline does not have a memory meter in the OS/2 version.
  852.  
  853. ... It is currently not possible to use the SCREENSIZE keyword to
  854.     switch to 43/50 lines mode. You have to do it manually with the
  855.     OS/2 MODE command.
  856.  
  857. ... When running in a window on the WPS, the screen update may seem
  858.     very sluggish. This is at least partly due to the fact that CXL
  859.     (the user interface library I'm using in GoldED) often writes a
  860.     character at time, instead of complete lines. I'll try to improve
  861.     performance in later versions.
  862.  
  863. ... The GoldED/2 icon (GED2.ICO) is designed by myself, but the G.E.D
  864.     letters are based on some nice GoldED Windows icons made by
  865.     Karsten Palmvig (2:231/78.76). I have taken the liberty of
  866.     recoloring them to yellow/gold shades and made them shorter to fit
  867.     the OS/2 text under it. There is currently no icon for GoldNODE/2.
  868.  
  869.     If YOU have some nice icons for GoldED and/or GoldNODE, in either
  870.     OS/2 or Windows format, please send them to me or the nearest
  871.     reg.site.
  872.  
  873. ... GoldED/2 and GoldNODE/2 are compiled with TopSpeed C++ 3.02.
  874.     TopSpeed only generates 16-bit applications which are compatible
  875.     with OS/2 1.2, but I have enabled 386 code generation so the speed
  876.     should be fairly satifactory.
  877.  
  878. It is likely that you will occasional General Protection errors (the
  879. equivalent of Exception 13's in DOS/QEMM/etc. The OS/2 version has not
  880. been though a very long beta period, and there are many places in
  881. GoldED, where things are done in ways that OS/2 may choke on. Please
  882. report it if it happens to you, and include a detailed description of
  883. what you did.
  884.  
  885.  
  886. ----------------------------------------------------------------------
  887. --- FUTURE PLANS
  888. ---
  889.  
  890. As mentioned in the 2.40 docs and many times in the GoldED echoes,
  891. GoldED has become a very large and complex program. It is so that
  892. almost no matter what I do to add, fix or change a feature, something
  893. else breaks. That is not good, and it is extremely frustrating to work
  894. on GoldED under those conditions.
  895.  
  896. So (again, as mentioned before) I am going to continue the major
  897. rewriting/reimplementation of GoldED in the future after this release.
  898. There may appear some patch updates to fix various bugs in this
  899. release, but you should not expect this version series to continue. It
  900. is simply too hard to work with. I will instead concentrate all I can
  901. on getting the new version (3.xx) series started and on doing a really
  902. good job with it.
  903.  
  904. I cannot promise anything about release dates or features for the
  905. future versions at this time, but I am confident that it will be worth
  906. the wait.
  907.  
  908. Please do not expect to see much of me in the GoldED echoes, because
  909. writing msgs takes a lot of time away from the really important work,
  910. which is to make better new versions. I will try to keep up with
  911. (read) the huge amounts of mail (net and echo), but don't expect many
  912. replies from me. I'm sorry, but I'm just one small guy with a very big
  913. program.
  914.  
  915. Thanks for understanding, and hopefully for supporting my efforts.
  916.  
  917. Odinn Sorensen.
  918.  
  919.  
  920. ----------------------------------------------------------------------
  921. --- THE AUTHOR
  922. ---
  923.  
  924. Name:
  925.     Odinn Sorensen
  926.  
  927. Birthdate:
  928.     17 February 1969, born in Iceland, now lives in Denmark.
  929.  
  930. Occupation:
  931.     Self-taught C/C++ programmer. Has been running his own one-man
  932.     company, Goldware International, since december 1991. Now working
  933.     full-time on GoldED, but not as much as he'd like, because of a
  934.     lot of tiresome administration and other stuff (such as writing
  935.     this doc ;-).
  936.  
  937. Personality:
  938.     Quiet, all-round nice guy.
  939.  
  940.  
  941. ----------------------------------------------------------------------
  942. --- AUTHOR CONTACT INFORMATION
  943. ---
  944.  
  945. Address:
  946.  
  947. Goldware International
  948. Odinn Sorensen
  949. Kajerod Vaenge 33
  950. DK-3460 Birkerod
  951. Denmark
  952.  
  953.  
  954. Phones and FidoNet address:
  955.  
  956. Voice   +45-45820536
  957. Fax     +45-45826332
  958. BBS#1   +45-45821325    HST/V32B 14.4k bps         (FidoNet 2:231/77)
  959. BBS#2   +45-45829094    2400 baud                  (FidoNet 2:231/477)
  960.  
  961. ----------------------------------------------------------------------
  962.