home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / 035 / geob1006.zip / GOLDBETA.DOC < prev    next >
Text File  |  1994-10-06  |  207KB  |  5,628 lines
  1. ______________________________________________________________________
  2.  
  3.                        GoldED 2.50.Beta Manual
  4.                        Updated 6. october 1994
  5. ______________________________________________________________________
  6.  
  7.  
  8.  
  9. ______________________________________________________________________
  10.  
  11.                        Notes About This Manual
  12. ______________________________________________________________________
  13.  
  14.  
  15. This is the first "complete" manual since version 2.40 and it is long
  16. overdue, sorry. Well here it is at last - better late than never :-)
  17.  
  18. It is currently written using a plain text editor (QEdit) with a 70
  19. char margin and does not have page breaks, page numbers, table of
  20. contents, index etc. That will come in a later edition. Does anyone
  21. know of a simple-to-use Shareware/PD "manual compiler" which can make
  22. page header/footers with page numbers, toc's and allows editing with a
  23. text editor?
  24.  
  25. This edition is partly based on the old 2.40 manual plus later
  26. addendums. It has been brought up-to-date in the configuration keyword
  27. reference and edited here and there in other parts. Some chapters have
  28. been removed entirely and will either be rewritten or incorporated
  29. into other chapters. It is quite possible that there are still places
  30. where the manual is not 100% up-to-date or correct, and there are
  31. certainly many features that should be documented. Many features are
  32. still only documented (one might almost say "buried" :-) in the
  33. NOTE*.DOC file.
  34.  
  35. If you find spelling, grammatical or factual errors, please let me
  36. know as soon as possible.
  37.  
  38. If you think the wording is bad or confusing in some parts, please
  39. send me your improved version.
  40.  
  41. If you would like to write entirely new chapters (especially "users
  42. guide" type chapters), please do and send them to me. Screen shots may
  43. be included, but should be edited to fit a 70 char wide page.
  44.  
  45. I have limited time and would be very grateful for any help which can
  46. improve the quality and usefulness of the manual.
  47.  
  48. Thanks for reading. Enjoy!
  49.  
  50. Odinn Sorensen, The GoldED Author.
  51.  
  52.  
  53. ______________________________________________________________________
  54.  
  55.                              Legal Notes
  56. ______________________________________________________________________
  57.  
  58.  
  59. GoldED is provided as is, with no warranty of any kind, either
  60. expressed or implied. GoldED is only guaranteed to occupy disk space.
  61. You are free to copy and distribute the GoldED archive freely,
  62. provided no changes or additions are made to the package.
  63.  
  64. Odinn Sorensen (The Author) shall in no event be held liable to you or
  65. anyone else for any damages of ANY kind, incidental or consequential,
  66. arising from the use or inability to use this program.
  67.  
  68. All products by Odinn Sorensen are trademarks and are Copyright by
  69. Odinn Sorensen. Other products and brand names may be trademarks and
  70. Copyright by the respective holders.
  71.  
  72.  
  73. ______________________________________________________________________
  74.  
  75.                         Commandline Reference
  76. ______________________________________________________________________
  77.  
  78.  
  79. Commandline syntax: GOLDED/GED386/GED2 [options] [keystacking]
  80.  
  81.  
  82. Available options:
  83.  
  84. -C<configname>
  85.  
  86.     Specifies another configuration file than the default GOLDED.CFG.
  87.  
  88.  
  89. -D
  90.  
  91.     Disable old configuration keywords. For backward compatibility,
  92.     GoldED still supports a number of old names for some configuration
  93.     keywords. I recommend that you use -D sometimes and rename the
  94.     keywords that are reported as unknown.
  95.  
  96.  
  97. -E<echoid>
  98.  
  99.     If specified, GoldED starts directly in the specified echo,
  100.     bypassing the arealist screen. See the AREASTART configuration
  101.     keyword for more info.
  102.  
  103.  
  104. -F
  105.  
  106.     Force recompile of most configuration files, but not all. Does not
  107.     recompile the .CHS files.
  108.  
  109.  
  110. -FF
  111.  
  112.     Force complete recompile of all configuration files, regardless of
  113.     whether they are up-to-date or not. This is equivalent to deleting
  114.     all the *.GE? files.
  115.  
  116.  
  117. -M
  118.  
  119.     Mute. Disables all sounds in GoldED.
  120.  
  121.  
  122. -N
  123.  
  124.     No share. If used, this prevents GoldED from using SHARE
  125.     compatible file-open calls, which are used by default. Works only
  126.     until the SHAREMODE keyword is used in GOLDED.CFG. This keyword is
  127.     normally not useful, but may be used to debug your setup or
  128.     something.
  129.  
  130.  
  131. -O<ovlsize>
  132.  
  133.     Specifies the overlay size for GoldED (the default is
  134.     approximately 64K). Higher values (up to about 300K) causes GoldED
  135.     to run faster and use more memory. Lower values (down to about
  136.     32K) makes it run slower, but use less memory. Check the "memory
  137.     meter" on the right side of the statusline to see how much memory
  138.     is free at any given time. The memory meter value should be
  139.     *minimum* 50-100k or more for best performance and insurance
  140.     against "out of memory" errors. The lower memory meter value, the
  141.     higher risk of out of memory errors...
  142.  
  143.     This option is ignored by the 386 and OS/2 versions.
  144.  
  145. -Q
  146.  
  147.     Quiet. Turns off verbose config compile. On by default. This could
  148.     be used on the commandline to disable a -V(erbose) option in the
  149.     GEDCMD environment variable.
  150.  
  151.  
  152. -S<sortspec>
  153.  
  154.     Sort all areas according to <sortspec>. See the AREALISTSORT
  155.     config keyword for details.
  156.  
  157.  
  158. -T<seconds>
  159.  
  160.     Set the timeout value. A value of zero (0) means never timeout.
  161.     See the TIMEOUT config keyword for details.
  162.  
  163.     NOTE: This options is currently not functional.
  164.  
  165.  
  166. -V
  167.  
  168.     Turns on verbose config compile. When used, GoldED will display
  169.     the full filename of each main config file it compiles. It also
  170.     displays the name of the detected multitasker, if any. This can be
  171.     useful for debugging your setup, and see if GoldED accesses the
  172.     files (especially the AREAFILE's) it is supposed to.
  173.  
  174.  
  175. -VV
  176.  
  177.     Same as -V, but also displays all the active lines while
  178.     compiling. This could be used to find the exact spot if it crashes
  179.     or stops while compiling.
  180.  
  181.  
  182. -W
  183.  
  184.     If used, GoldED will create (and overwrite if existing) the file
  185.     GOLDAREA.INC, which will then contain all areas in the AREADEF
  186.     form, sorted by your AREALISTSORT specification. This is very
  187.     useful for converting your AREAFILE's to a form you can edit with
  188.     your favorite text editor and use in GoldED. It is also useful if
  189.     you have used the new AREADESC keyword or the AREAFILE EchoList
  190.     reader. The GOLDAREA.INC file (created in the GOLDPATH) can be
  191.     used by adding "INCLUDE GOLDAREA.INC" to your GOLDED.CFG or
  192.     GOLDAREA.CFG. When creating the file, GoldED will use '.' if an
  193.     aka is the same as the main aka, and leave out the optional origin
  194.     if it's the same as the first ORIGIN in your GOLDED.CFG. This
  195.     makes it easier to share the same GOLDAREA.INC between different
  196.     setups.
  197.  
  198.  
  199. Commandline keystacking
  200.  
  201. Any non-option characters on the commandline are stuffed into the
  202. keyboard buffer. See the chapter on keyboard definition and the
  203. KEYBSTACK keyword for more info.
  204.  
  205. Example: GOLDED @S A
  206.  
  207. Makes GoldED go to the area scanning menu <Alt-S>, and select
  208. scanning of <A> all areas.
  209.  
  210. See the Macros and Keystacking chapter for more info.
  211.  
  212.  
  213. ______________________________________________________________________
  214.  
  215.                         Environment Variables
  216. ______________________________________________________________________
  217.  
  218.  
  219. These are the GoldED specific environment variables:
  220.  
  221.  
  222. GOLDED
  223.  
  224.     Path to the GOLDED.CFG file. It is recommended to set this
  225.     variable, but don't forget to change it if you move your GoldED
  226.     setup to a different directory!
  227.  
  228.  
  229. GEDCMD
  230.  
  231.     Specifies additional commandline options. Use this if you want to
  232.     specify options, but need to run GoldED without them (for example
  233.     when renaming GOLDED.EXE to DBEDIT.EXE in older versions of
  234.     D'Bridge). You can override the environment options with
  235.     commandline options.
  236.  
  237.  
  238. GOLDNODE
  239.  
  240.     The path where GoldNODE can find a GOLDED.CFG to use.
  241.  
  242.  
  243. When the using AREAFILE feature to read external area configuration
  244. from other programs, the individual AREAFILE's may use specific
  245. environment variables to find the files. Please read the Area
  246. Configuration chapter for specific details of each supported AREAFILE.
  247.                                                                       
  248.  
  249. ______________________________________________________________________
  250.  
  251.                         Batchfile Errorlevels
  252. ______________________________________________________________________
  253.  
  254.  
  255. For operation in batch files, GoldED has a set of errorlevel values:
  256.  
  257.   032 or higher   Error exit (check the logfile for details).
  258.   004             Echomail entered.
  259.   002             Netmail entered.
  260.   001             Local mail entered.
  261.   000             No errors. No mail entered.
  262.  
  263. Add values together to find the combined error levels. For example,
  264. error level 6 is returned if netmail and echomail (2+4) was entered.
  265.  
  266. Example RUNGOLD.BAT or RUNGOLD.CMD file:
  267.  
  268. === Cut ===
  269. @echo off
  270. golded.exe
  271. rem ged386.exe
  272. rem ged2.exe
  273. if errorlevel 008 goto error
  274. if errorlevel 007 goto e_n_l
  275. if errorlevel 006 goto e_n__
  276. if errorlevel 005 goto e___l
  277. if errorlevel 004 goto e____
  278. if errorlevel 003 goto __n_l
  279. if errorlevel 002 goto __n__
  280. if errorlevel 001 goto ____l
  281. goto nomail
  282. :error
  283.   echo golded error exit!
  284.   goto end
  285. :e_n_l
  286.   echo **** New echo, net and local mail entered.
  287.   goto end
  288. :e_n__
  289.   echo **** New echo and netmail entered.
  290.   goto end
  291. :e___l
  292.   echo **** New echo and local mail entered.
  293.   goto end
  294. :e____
  295.   echo **** New echomail entered.
  296.   goto end
  297. :__n_l
  298.   echo **** New net and local mail entered.
  299.   goto end
  300. :__n__
  301.   echo **** New netmail entered.
  302.   goto end
  303. :____l
  304.   echo **** New local mail entered.
  305.   goto end
  306. :nomail
  307.   echo **** No new mail entered.
  308. :end
  309.   echo.
  310.   echo Thank you for using GoldED! :-)
  311. === Cut ===
  312.  
  313.  
  314. ______________________________________________________________________
  315.  
  316.                     Nodelist and Userlist Support
  317. ______________________________________________________________________
  318.  
  319.  
  320. In order to enable nodelist/userlist lookup and browsing, GoldED needs
  321. to use a set of special nodelist index files, created by the GoldNODE
  322. nodelist compiler.
  323.  
  324. None of the existing types of nodelist indexes were sufficiently
  325. useful or documented, so I had to create my own format, and a compiler
  326. for it. My index is "moderately" sized, a bit smaller than the
  327. nodelist itself and smaller than most other indexes. We can only hope
  328. that some day there will be a binary nodelist format or index which
  329. can be used by most or all of the FidoNet developers, but that day has
  330. yet to come.
  331.  
  332. GoldED normally uses and displays information from the nodelist when
  333. browsing, but it doesn't really need the nodelist for anything. The
  334. index files contains sufficient information for lookup and browsing of
  335. names or addresses. This means that you can delete or pack away the
  336. nodelists and/or userlists after compiling with GoldNODE, if you want
  337. to save space and you don't need them for anything else.
  338.  
  339.  
  340. Command line syntax: GOLDNODE/GN386/GN2 [-options] [configfile]
  341.  
  342. Available options:
  343.  
  344.   -C            Conditional compile.
  345.   -D            Remove duplicate nodes from index.
  346.   -F            Forced compile.
  347.   -M<nodes>     Compile max <nodes> nodes (maximum is 32767).
  348.   -NE           Disable the use of EMS memory.
  349.   -NX           Disable the use of XMS memory.
  350.   -S<size>      Set the max size of names. Normally not used.
  351.   -U<file>      Create sorted FIDOUSER.LST userlist file.
  352.  
  353. The [configfile] is the path AND filename of the GOLDED.CFG
  354. configuration file to read. If no filename is given, the path
  355. specified with the GOLDNODE or GOLDED environment variables are used.
  356.  
  357. The nodelist index files are named GOLDNODE.GX? are are placed in the
  358. path pointed to by the NODEPATH keyword.
  359.  
  360.  
  361. ______________________________________________________________________
  362.  
  363.                    Configuration Keyword Reference
  364. ______________________________________________________________________
  365.  
  366.  
  367. This is an alphabetical list of all the configuration keywords that
  368. can be used in the main GoldED configuration file (GOLDED.CFG and any
  369. file included from it). It also lists and documents the keywords that
  370. are specific to the Random System groups.
  371.  
  372. The following special symbols are used in the keyword parameter lists:
  373.  
  374.     ()        Default value.
  375.     []        Optional parameter.
  376.     <>        Required parameter, not optional.
  377.     ""        Parameter must be inclosed in quotes ("").
  378.     /         Separates mutually exclusive values.
  379.     ,         Separates possible values for the keyword.
  380.  
  381.  
  382. Here is the complete keyword list:
  383.  
  384.  
  385. ADDRESS <zone:net/node[.point][@domain][, pointnet]>
  386.  
  387.     Your network address, FidoNet-style. More than one address can be
  388.     specified if you are member of more than one network. The keywords
  389.     ADDRESS and AKA can be used interchangeably.
  390.  
  391.     If a pointnet is specified with a point address, GoldED will use
  392.     the so-called "3D" addressing method in netmail msgs, otherwise
  393.     the "4D" method is used. The 3D method works by putting the
  394.     address ZONE:POINTNET/POINT.0 in the msg header, instead of the 4D
  395.     format ZONE:NET/NODE.POINT. Most modern mailers and mail
  396.     processors now supports the 4D format, but if you are a point, you
  397.     should always consult your Boss about which format to use.
  398.  
  399.     The optional @domain part can be used to specify a "fifth"
  400.     dimension to the 4D address. It is normally not necessary to
  401.     specify a domain. Domains are never shown in the header and are
  402.     not put in the origin line. The only place the domain is
  403.     used/added by GoldED is in the MSGID kludge.
  404.  
  405.     Examples:
  406.  
  407.       Address 2:236/77              ; Node address
  408.       Address 2:236/77.1            ; Point address (4D)
  409.       Address 2:236/77.1, 16077     ; Point address (3D)
  410.       Address 2:236/77@fidonet      ; Node address with domain
  411.  
  412.  
  413. ADDRESSMACRO <macro>,<name>,<address>[,"subject"][,attribs]
  414.  
  415.     Defines a short name for often used addresses. Typical uses are
  416.     for AreaFix/AreaMgr, your uplink, boss, points or others you write
  417.     to often. To use a defined address macro, you just type it in the
  418.     To: name field.
  419.  
  420.     If (and ONLY if) the subject is enclosed in quotes ("" or ''),
  421.     GoldED will look for message attributes after the subject. See the
  422.     Message Attributes Reference for a valid attribute. You cannot
  423.     have quotes within quotes (not the same type anyway).
  424.  
  425.     The attribues are *added* to the ones already there, they do *not*
  426.     replace them.
  427.  
  428.     Examples:
  429.  
  430.       afup,AreaFix,2:236/512,"password -q -l",K/S
  431.       ffup,FileFix,2:236/512,password
  432.       odin,Odinn Sorensen,2:236/77,GoldED - What else? :-)
  433.  
  434.     A special format is supported for UUCP or INTERNET gateways. The
  435.     special format is indicated with a (@) as the first character in
  436.     the <name>.
  437.  
  438.       jfu,@fallesen@diku.dk,2:310/33
  439.       dn,@INTERNET/david@csource.oz.au,2:241/999
  440.  
  441.     In the first example, GoldED will put "UUCP" (the default gateway
  442.     name) in the TO: msg header field and "To: fallesen@diku.dk" on
  443.     the first line of the message text.
  444.  
  445.     In the second example, GoldED will put "INTERNET" in the TO:
  446.     field, and "To: david@csource.oz.au" in the message. The forward
  447.     slash (/) separates the gateway name from the receiver address.
  448.     Any gateway name may be used.
  449.  
  450.     The address macros can also be specified in an external file, like
  451.     the NAMES.FD file supported by the FrontDoor mailer/editor and
  452.     Maximus BBS. See the keyword NAMESFILE for details. However, you
  453.     should not use the syntax with the attributes in the NAMES.FD
  454.     file, because FrontDoor and Maximus do not know this syntax.
  455.  
  456.  
  457. AKA <zone:net/node[.point][@domain][, pointnet]>
  458.  
  459.     AKA (Also Known As) is an alias for the ADDRESS keyword.
  460.  
  461.  
  462. AKAMATCHECHO <yes/no>  (no)
  463.  
  464.     If enabled, GoldED will attempt to match one of your akas to the
  465.     address of the person you are replying to in echomail areas.
  466.  
  467.     Normally it is not desirable to enable aka matching in echomail,
  468.     because some echoes may be restricted to members of one particular
  469.     network, and an accidental wrong aka matching may attract unwanted
  470.     attention from the moderator or the compulsive flamers :-)
  471.  
  472.  
  473. AKAMATCHLOCAL <yes/no>  (no)
  474.  
  475.     If enabled, GoldED will attempt to match one of your akas to the
  476.     address of the person you are replying to in local areas.
  477.  
  478.     It doesn't really make sense to do aka matching in local areas.
  479.     The keyword is just there for completeness.
  480.  
  481.  
  482. AKAMATCHNET <yes/no>  (yes)
  483.  
  484.     If enabled, GoldED will attempt to match one of your akas to the
  485.     address of the person you are replying to in netmail areas. This
  486.     is especially useful if you are a member in more than one network,
  487.     and therefore have more than one address.
  488.  
  489.  
  490. AREA <echoid> <"desc"> <msgbase>[type] <loc> [akano] [attrs]
  491.  
  492.     This keyword defines a mail area in GoldED. You need to define at
  493.     least one mail area to run GoldED, or use the AREAFILE keyword to
  494.     read the area setup of your mailer, mail processor or BBS.
  495.  
  496.     <echoid>    Mail area identifier.
  497.     <"desc">    Area description in ("") quotes.
  498.     <msgbase>   O(Opus *.MSG), F(Fido *.MSG), S(FTS-0001 *.MSG),
  499.                 Q(QuickBBS), R(RemoteAccess), H(Hudson), M(Squish),
  500.                 J(JAM), G(Goldbase), P(PCBoard).
  501.     [type]      N(Netmail), E(Echomail), L(Local).
  502.     <location>  Directory path/file or Hudson board number.
  503.     [aka]       AKA number (starting from 0)
  504.     [attrs]     R/O(Read-Only), and/or other attributes.
  505.  
  506.     "O(Opus)" and "F(Fido)" are synonyms (*.MSG files).
  507.     "S(FTS-0001)" are *.MSG files, but with zone/point header fields.
  508.     "Q(QuickBBS)", "R(RemoteAccess)" and "H(Hudson) are synonyms.
  509.     "M(Squish)" is the Squish format.
  510.     "J(JAM) is the JAM format.
  511.     "G(Goldbase)" is the Goldbase format.
  512.     "P(PCBoard) is the PCBoard format.
  513.  
  514.     It is recommended to use the newer AREADEF keyword, which allows
  515.     more detailed mail area setup.
  516.  
  517.  
  518. AREAAUTOFREQ <echoid>
  519.  
  520.     Obsolete keyword name. Replaced by AREAFREQTO.
  521.  
  522.  
  523. AREAAUTONEXT <yes/no> (yes)
  524.  
  525.     If enabled, GoldED will automatically jump to the first marked
  526.     area in the arealist on startup, and the next marked area after
  527.     exiting from an area you have been reading.
  528.  
  529.  
  530. AREACOPYTO <echoid>
  531.  
  532.     Sets the default area for the Copy/Move functions. Typically you
  533.     could set it to a "safe/permanent storage" type of area, for
  534.     example a JOKES2KEEP or THE_SAFE area. Note that the Forward
  535.     function uses the AREAREPLYTO area instead.
  536.  
  537.     This keyword can be used globally and in a Random System group.
  538.  
  539.     Related keywords: AREAFREQTO, AREAREPLYTO.
  540.  
  541.  
  542. AREADEF <setup>
  543.  
  544.     This is newer version of the "AREA" keyword, with more detailed
  545.     parameters.
  546.  
  547.     The full syntax is: (must be all on one line)
  548.  
  549.     AREADEF <echoid> <"desc"> <group> <type> <msgbase> <path/board>
  550.             <aka> <(attrs)> ["origin"]
  551.  
  552.     <echoid>      The echoid.
  553.     <"desc">      Area description in quotes.
  554.     <group>       Groupid letter (A-Z), or 0 if not in a group.
  555.     <type>        Net, Echo or Local.
  556.     <msgbase>     Opus, FTSC, Hudson, Squish, Ezycom, JAM, Goldbase or
  557.                   PCBoard.
  558.     <path/board>  Area path, boardnumber or base filename.
  559.     <aka>         Aka address for the area, or '.' for main aka.
  560.     <(attrs)>     Default attributes in brackets ().
  561.     ["origin"]    Optional default origin in quotes.
  562.  
  563.     This looks a lot like the AREA keyword. Additional parameters are
  564.     the <group>, the verbose <type> and <msgbase>, the fully specified
  565.     <aka> address, the brackets for the attributes and the optional
  566.     origin.
  567.  
  568.     Note the possibility of using '.' to specify the main aka. This,
  569.     and the optional default origin, makes it simpler to create a
  570.     common INCLUDE'able area configuration for several setups with
  571.     different addresses, for example two people sharing the same
  572.     msgbase.
  573.  
  574.  
  575. AREADESC <echoid> <"desc"> [group] [aka] [(attrs)] ["origin"]
  576.  
  577.     Adds a description and optionally a group letter, aka, attributes
  578.     and origin to an _existing_ (previously defined) area. This is
  579.     useful if you use an AREAFILE that does not contain descriptions,
  580.     groups, akas, attributes or origins.
  581.  
  582.     <echoid>    The echoid.
  583.     <"desc">    Area description in quotes.
  584.     [group]     Optional groupid letter (A-Z) or 0 if not in a group
  585.                 or '-' to keep the existing group letter.
  586.     [aka]       Optional aka address for the area, or '.' for main
  587.                 aka, or '-' to keep the existing aka.
  588.     [(attrs)]   Optional default attributes in brackets (), '-' to
  589.                 keep the existing attributes. Note that if they are
  590.                 specified, they are _added_ to the default
  591.                 net/echo/local attributes.
  592.     ["origin"]  Optional default origin in quotes.
  593.  
  594.     NOTE: You cannot skip any of the optional parts in the middle,
  595.     even if you only want to set, say, an origin. Use '-' to keep the
  596.     existing value for the parts you skip.
  597.  
  598.  
  599. AREAEXCL <echoid mask>
  600.  
  601.     With this keyword, you can define the echoids of areas which
  602.     should be ignored by GoldED (thereby leaving them out of the
  603.     arealist). This is normally used in connection with AREAFILE, to
  604.     exclude areas you are not interested in reading. DOS/4DOS-style
  605.     wildcards (* and ?) can be used in the echoid mask.
  606.  
  607.     Examples:
  608.  
  609.       AREAEXCL *        Excludes all areas.
  610.       AREAEXCL *INTER*  Excludes all areas containing "INTER" anywhere
  611.                         in the echoid.
  612.       AREAEXCL INT*.*   Excludes all areas beginning with "INT" and
  613.                         containing a '.' anywhere in the echoid.
  614.  
  615.     You can use the AREAINCL keyword to re-include areas which have
  616.     been excluded with AREAEXCL.
  617.  
  618.  
  619. AREAFILE <type> [path/file] [switches]
  620.  
  621.     GoldED can read the area setup of many popular mailers, mail
  622.     processors and BBS'es, thereby making it much easier and simpler
  623.     to configure GoldED for the mail areas you receive, by eliminating
  624.     the need to write AREA lines for all or most of your areas.
  625.  
  626.     <type>        Name of the program.
  627.     [path/file]   Filename or path to the area setup files.
  628.     [switches]    Msgbase specific switches.
  629.  
  630.     For most programs, GoldED can automatically find the path or
  631.     filename using environment variables. By default, GoldED will look
  632.     for the area setup files in the AREAPATH.
  633.  
  634.     There are switches for sorting the areas, and for turning off an
  635.     update-check when GoldED starts up.
  636.  
  637.     This keyword is explained in greater detail in the Area
  638.     Configuration chapter.
  639.  
  640.  
  641. AREAFILEGROUPS <yes/no>  (no)
  642.  
  643.     In some AREAFILE setups, you can groups the areas using single
  644.     letters (A-Z). If this keyword is enabled, GoldED will use the
  645.     area groupid letter instead of the area echoid when gathering area
  646.     specific information from the Random System.
  647.  
  648.     If this keyword is enabled, you should setup matching GROUP's in
  649.     GOLDRAND.CFG. See the Random System chapter for details.
  650.  
  651.  
  652. AREAFREQTO <echoid>
  653.  
  654.     Sets the default area for the filerequest function. You should set
  655.     this to the netmail area where you normally put the filerequest
  656.     messages.
  657.  
  658.     This keyword can be used globally and in a Random System group.
  659.  
  660.     Related keywords: AREACOPYTO, AREAREPLYTO.
  661.  
  662.  
  663. AREAINCL <echoid mask>
  664.  
  665.     With this keyword, you can define the echoids of areas which
  666.     should be re-included by GoldED, if they have been excluded with
  667.     the AREAEXCL keyword. DOS/4DOS-style wildcards (* and ?) can be
  668.     used in the echoid mask.
  669.  
  670.     Examples:
  671.  
  672.       AREAINCL *        Includes all areas.
  673.       AREAINCL *INTER*  Includes all areas containing "INTER" anywhere
  674.                         in the echoid.
  675.       AREAINCL INT*.*   Includes all areas beginning with "INT" and
  676.                         containing a '.' anywhere in the echoid.
  677.  
  678.     You can use the AREAINCL keyword to re-include areas which have
  679.     been excluded with AREAEXCL.
  680.  
  681.  
  682. AREAKEEPLAST <yes/no>  (yes)
  683.  
  684.     If enabled, GoldED will write the file GOLDLAST.LST in the
  685.     GOLDPATH at exit and read it back when run next time. The contents
  686.     of the file is a list of lastread information for each area as it
  687.     was at last scan.
  688.  
  689.     This new feature is helpful when you know that there have not been
  690.     tossed new mail and don't want to wait for a full msgbase scan.
  691.     Now you can just hit ESC at the startup screen to abort the area
  692.     scan and GoldED will put up the lastread info from the previous
  693.     session.
  694.  
  695.     It also makes the "new mail since last scan" feature even better,
  696.     because the new mail marker now shows which areas that have new
  697.     mail since last session even when scanning areas at startup.
  698.  
  699.  
  700. AREALISTECHOMAX <size>  (0)
  701.  
  702.     Allows you to specify a fixed or dynamically sized width of the
  703.     EchoID column in the arealist.
  704.  
  705.     If a negative value is specified, the width will be the that of
  706.     the widest echoid in the arealist plus the negative value. This
  707.     might be useful if some long-name echoes have uninteresting ends,
  708.     such as "VERYLONGECHOID_R23.PUB" (could benefit from a <size> of
  709.     -7). There is currently no provision for long echoids with common
  710.     beginning.
  711.  
  712.     The arealist can dynamically resize the EchoID and Description
  713.     columns, so that long echoids are not cut off. The sizing of the
  714.     EchoID column is done against the Description column, which
  715.     thereby looses or gains width. In version 2.41 and earlier, the
  716.     EchoID column width was fixed at 13 chars on 80 column displays.
  717.  
  718.  
  719. AREALISTNOS <yes/no>  (no)
  720.  
  721.     If enabled, GoldED will display the board numbers of Hudson areas
  722.     in the arealist instead of the default sequential numbers.
  723.  
  724.  
  725. AREALISTSORT <sortspec>
  726.  
  727.     This keyword defines how the area list should be sorted. You can
  728.     override the default setting from the commandline with the -S
  729.     switch.
  730.  
  731.     The <sortspec> can be composed of the following types:
  732.  
  733.       A   Sort by aka.
  734.       B   Sort by board number.
  735.       D   Sort by description.
  736.       E   Sort by echoid.
  737.       F   Sorts all "fuzzy search" matches first.
  738.       G   Sort by group (if any).
  739.       M   Sorts all marked areas first.
  740.       O   Sort by original order.
  741.       T   Sort by type (in the order net, echo, local).
  742.       U   Sort by unread messages (try it!).
  743.       Y   Sorts all areas with "new" mail first.
  744.       -   Descending sort (largest first).
  745.       +   Ascending sort (smallest first) (default).
  746.  
  747.     In practice 'M' and 'Y' will usually give the same result, because
  748.     GoldED automatically marks scanned areas if they contain new mail.
  749.  
  750.     Example:
  751.  
  752.       AREALISTSORT T-U+E
  753.  
  754.     This sorts ascending by Type, descending by Unread (that is, areas
  755.     with the most unread messages comes first) and ascending by Echoid
  756.     (in case two areas have the same number of unread msgs).
  757.  
  758.     By default no sorting is done, and all areas are listed in the
  759.     order they were found (unless sorting was specified with an
  760.     AREAFILE keyword). However, the configuration examples all make
  761.     use of the Unread sorting type. This is a very useful way of
  762.     sorting areas, because it keeps all the areas with mail together.
  763.  
  764.     Personally I now sort my areas like this: "AREALISTSORT FYTUE".
  765.     This puts all areas with new mail first, then sorts these into
  766.     type (net/echo/local), then into number of new msgs and finally
  767.     into echoid. The 'F' at the start enables fuzzy match sorting,
  768.     which is very handy when looking for an echoid containing a
  769.     particular word. Let's say I want a list of all GOLDED echoes. I
  770.     can now simply type "GOLDED" and then the arealist automagically
  771.     sorts itself so that all echoes with an echoid containing "GOLDED"
  772.     comes first :-)
  773.  
  774.  
  775. AREALISTTYPE <new/last>  (new)
  776.  
  777.     Defines the contents of the 4th column (the one after the "Total"
  778.     column).
  779.  
  780.       New   Displays the amount of new (unread) msgs.
  781.       Last  Displays the number of the last msg read.
  782.  
  783.  
  784. AREAPATH <path>
  785.  
  786.     If you use the AREAFILE keyword, GoldED might need to know where
  787.     the area setup files are located. This keyword specifies where
  788.     they are found, if not current directory.
  789.  
  790.     NOTE: Most AREAFILE types can find the path using the environment
  791.     variable(s) specific for the program(s). Such environment
  792.     variables (or a path specified with the AREAFILE definition)
  793.     always overrides the AREAPATH.
  794.  
  795.  
  796. AREAREADONLY <soft/hard>  (soft)
  797.  
  798.     If this keyword is set to "hard", it is no longer possible to
  799.     enter/reply/change messages in areas marked read-only with the R/O
  800.     area attribute. The "soft" setting uses a menu to ask permission
  801.     as in the previous versions. This option is designed for those who
  802.     setup a system for new computer users who might be confused enough
  803.     to enter a message in a read-only area despite the warning menu.
  804.  
  805.  
  806. AREARENAME <from echoid> <to echoid>
  807.  
  808.     Renames one echoid to another. The feature is meant to be used in
  809.     connection with AREAFILE, where some types do not store echoids
  810.     with the areas (and GoldED then automatically gives them unique
  811.     echoids).
  812.  
  813.     Examples:
  814.  
  815.       AREARENAME NET001 NETMAIL
  816.       AREARENAME ECHO001 BAD_MSGS
  817.       AREARENAME LOCAL001 BBS.USERS
  818.  
  819.  
  820. AREAREPLYTO <echoid>  (first netmail area)
  821.  
  822.     Sets the default area for the READmovequotemsg, READmovecommentmsg
  823.     and Forward functions. The default area is the first netmail area
  824.     found in your setup. You should check if GoldED found the correct
  825.     one if you have more than one. If you find yourself often
  826.     forwarding or quoting from one area to another, it might be a good
  827.     idea to setup a Random System group and put in this keyword.
  828.     Example:
  829.  
  830.       Group GOLDED
  831.         AreaReplyto GOLDED.BETA
  832.       EndGroup
  833.  
  834.     This keyword can be used globally and in a Random System group.
  835.  
  836.     Related keywords: AREACOPYTO, AREAFREQTO.
  837.  
  838.  
  839. AREASCAN <echoid mask>
  840.  
  841.     This keyword defines areas which will be automatically scanned
  842.     when starting GoldED. DOS/4DOS-style wildcards (* and ?) can be
  843.     used in the echoid mask.
  844.  
  845.     Examples:
  846.  
  847.       AREASCAN *        Scan all areas.
  848.       AREASCAN *INTER*  Scan all areas containing "INTER" anywhere in
  849.                         the echoid.
  850.       AREASCAN INT*.*   Scan all areas beginning with "INT" and
  851.                         containing a '.' anywhere in the echoid.
  852.  
  853.     It is recommended to have an "AREASCAN *" to scan all areas at
  854.     startup. If you don't want to wait for the scan to complete, you
  855.     can abort the scan by pressing ESC during startup.
  856.  
  857.  
  858. AREASCANEXCL <echoid or wildcards>
  859.  
  860.     With this keyword you can prevent areas from being scanned with
  861.     AREASCAN on startup. This is good if you use "AREASCAN *", but
  862.     have some big areas which slows it down.
  863.  
  864.  
  865. AREASCANINCL <echoid or wildcards>
  866.  
  867.     Here you can specify areas to be scanned with AREASCAN even if
  868.     they were excluded with AREASCANEXCL. Useful for partial reversal
  869.     of wildcard specs in the excludes.
  870.  
  871.  
  872. AREASTART <echoid>
  873.  
  874.     Normally GoldED starts by displaying the arealist, to let you
  875.     select which area you want to read. If this keyword is defined,
  876.     the arealist is bypassed and GoldED starts directly in the
  877.     configured area. You can override AREASTART with the -E
  878.     commandline switch.
  879.  
  880.  
  881. ASKDELORIG <yes/no>  (yes)
  882.  
  883.     If enabled, you will be asked if the message you just replied to
  884.     should be deleted. Otherwise it is left untouched.
  885.  
  886.     This keyword is only functional in netmail and local areas.
  887.  
  888.  
  889. ASSIGNTO <echoid> [echoid] [..]
  890.  
  891.     Obsolete alias of the MEMBER keyword. ASSIGNTO is used in Random
  892.     System GROUP's.
  893.  
  894.  
  895. ATTRIBSATTACH <attributes>
  896.  
  897.     Defines the attributes that are *added* to the existing attributes
  898.     of a message when the file attach attribute is toggled on.
  899.  
  900.  
  901. ATTRIBSCC <attributes>
  902.  
  903.     Defines the default attributes of Carbon Copy messages. CC
  904.     attributes are *added* to the existing attributes of the original
  905.     message. Usually used to add the Kill/Sent attribute.
  906.  
  907.  
  908. ATTRIBSCFM <attributes>
  909.  
  910.     Defines the default attributes of the Confirmation Receipt
  911.     message.
  912.  
  913.  
  914. ATTRIBSECHO <attributes>
  915.  
  916.     Defines the default attributes of messages entered in echomail
  917.     areas.
  918.  
  919.  
  920. ATTRIBSFRQ <attributes>
  921.  
  922.     Defines the attributes to use for messages generated with the file
  923.     request function. Suggested attributes are: PVT K/S CRA. The FRQ
  924.     and LOC attributes are added automatically.
  925.  
  926.  
  927. ATTRIBSLOCAL <attributes>
  928.  
  929.     Defines the default attributes of messages entered in local areas.
  930.  
  931.  
  932. ATTRIBSNET <attributes>
  933.  
  934.     Defines the default attributes of messages entered in netmail
  935.     areas.
  936.  
  937.  
  938. ATTRIBUTES <attributes>
  939.  
  940.     Defines the default attributes for area members of the current
  941.     Random System group.
  942.  
  943.  
  944. BEEPCOMMENT <yes/no>  (yes)
  945.  
  946.     If enabled, GoldED will make a noise when the cursor in the
  947.     internal editor is moved across a word defined with the
  948.     EDITCOMMENT keyword.
  949.  
  950.  
  951. BEEPFACTOR <value>  (5)
  952.  
  953.     The value changes the noise made by the BEEPCOMMENT, BEEPLOCALMSG
  954.     and BEEPYOURMAIL keywords.
  955.  
  956.     The noise is dependent on speed of the computer, to a low value is
  957.     best for XT's and AT's, while larger values may be better for
  958.     386's and 486's. Experiment with different values until you find a
  959.     good one.
  960.  
  961.  
  962. BEEPLOCALMSG <yes/no>  (yes)
  963.  
  964.     If enabled, GoldED will make a noise if it finds a msg with the
  965.     "Local" (LOC) attributes set. This can be useful for the sysop who
  966.     wants to monitor the msgs entered by users on his/her BBS.
  967.  
  968.     A related keyword is DISPLOCALHIGH.
  969.  
  970.  
  971. BEEPNOISES <yes/no>  (yes)
  972.  
  973.     If enabled, GoldED makes noises when it wants attention.
  974.  
  975.     NOTE: This is the "master switch" for all noises in GoldED.
  976.  
  977.  
  978. BEEPYOURMAIL <yes/no/always>  (yes)
  979.  
  980.     If set to "yes", GoldED will make a noise if it finds a
  981.     non-received message to one of your USERNAME's. If set to
  982.     "always", GoldED will make the noise even if it has already been
  983.     marked as received.
  984.  
  985.  
  986. CARBONCOPYLIST <listspec>  (Names)
  987.  
  988.     This specifies the format of the Carbon Copy list, as it will look
  989.     after processing. You can also change the format in the CC menu
  990.     before processing.
  991.  
  992.     The <listspec> can be one of the following:
  993.  
  994.       Keep      Keep the list as entered.
  995.       Names     Convert list to "CC: Name, Name, Name.." format.
  996.       Visible   Convert list to "CC: Name Address" format.
  997.       Hidden    Convert list to "^aCC: Name Address" format.
  998.       Remove    Remove the list completely.
  999.  
  1000.     More details can be found in the Carbon Copy and Crossposting chapter.
  1001.  
  1002.  
  1003. COLOR <colorspec>
  1004.  
  1005.     Using this keyword you can define or redefine all the colors used
  1006.     in GoldED. See the Color Configuration chapter for details.
  1007.  
  1008.     A complete color setup consists of a quite a lot of COLOR
  1009.     keywords, and it is normal practice to put them in a separate .CFG
  1010.     file and use the INCLUDE keyword to let GoldED read it. The COLORS
  1011.     archive contains a number of example color/mono setups. Try them
  1012.     out if you think the default colors stink :-)
  1013.  
  1014.  
  1015. COLORSET <Normal/Intense/Mono>  (Normal or Mono)
  1016.  
  1017.     Three color setups are built-in, and can be selected with this
  1018.     keyword.
  1019.  
  1020.     The Normal set is the default when a color display adapter is
  1021.     detected. The Normal set has all black background, with bright
  1022.     neon-like colors for the window frames. Some hate it, some love
  1023.     it. :-)
  1024.  
  1025.     The Intense set switches off the "blink" attribute, thereby
  1026.     enabling the use of intense (bright) colors for the background
  1027.     ("paper") colors as well as the foreground ("ink") colors. This is
  1028.     used in the Intense set to make a bright white background, sort of
  1029.     like the standard Windows 3.0 setup.
  1030.  
  1031.     The Mono set is the default when a monochrome adapter is detected.
  1032.  
  1033.  
  1034. CONFIRMFILE <filename>  (GOLDED.CFM)
  1035.  
  1036.     GoldED supports the Confirmation Receipt attribute, as used in
  1037.     FrontDoor 2.xx with the FLAGS CFM kludge. If GoldED finds an
  1038.     unreceived message to one of your USERNAME's with the CFM (or the
  1039.     RRQ Return Receipt Request) attribute set, it generates an
  1040.     automatic response message from the content of the CONFIRMFILE. In
  1041.     the file you can use many of the template tokens to personalize
  1042.     the automatic message. You can specify the default attributes for
  1043.     the message with the ATTRIBSCFM keyword.
  1044.  
  1045.     Template tokens are explained in the Message Template chapter.
  1046.  
  1047.  
  1048. COOKIEFILE <[path]<file>>
  1049.  
  1050.     Defines any number of "cookie" files, which will be automatically
  1051.     indexed if needed. The cookie (or "random") files are those which
  1052.     can be used in the templates, using the "@random" token.
  1053.  
  1054.     The [path] defaults to the GOLDPATH.
  1055.  
  1056.     NOTE: This feature only works for REGISTERED users, and replaces
  1057.     the old external utility "GoldRAND" which was distributed in the
  1058.     GRAND101 archive.
  1059.  
  1060.  
  1061. COOKIEPATH <path>  (defaults to the GOLDPATH)
  1062.  
  1063.     Defines the default path for the COOKIEFILE keyword and the
  1064.     @random template token.
  1065.  
  1066.  
  1067. CROSSPOSTLIST <listspec>  (Verbose)
  1068.  
  1069.     This specifies the format of the Crosspost list, as it will look
  1070.     after processing.
  1071.  
  1072.     The <listspec> can be one of the following:
  1073.  
  1074.       None      Crosspost without a list in the msgs.
  1075.       Verbose   Change the list to lines of "* Crossposted in ..."
  1076.       Raw       Keep the crosspost list as you entered it.
  1077.  
  1078.     More details can be found in the Carbon Copy and Crossposting
  1079.     chapter.
  1080.  
  1081.  
  1082. CTRLINFOECHO <Tearline,Origin,yes/no>  (Tearline Origin)
  1083.  
  1084.     Specifies if you want tearline and origin in your echomail
  1085.     messages. They will be added by your echomail processor if you
  1086.     disable them here.
  1087.  
  1088.     Examples:
  1089.  
  1090.       CTRLINFOECHO Tearline Origin  ; Add both tearline and origin.
  1091.       CTRLINFOECHO Tearline         ; Add only a tearline.
  1092.       CTRLINFOECHO Origin           ; Add only an origin.
  1093.  
  1094.     NOTE: If you use the last example, your mail processor may get
  1095.     confused. However, most modern mail processors *can* handle msgs
  1096.     without a tearline.
  1097.  
  1098.  
  1099. CTRLINFOLOCAL <Tearline,Origin,yes/no>  (Tearline Origin)
  1100.  
  1101.     Specifies if you want tearline and origin in your messages in
  1102.     local areas. In local areas, the tearline and origin is normally
  1103.     never required but can be used for cosmetic purposes.
  1104.  
  1105.     Examples:
  1106.  
  1107.       CTRLINFOLOCAL Tearline Origin  ; Add both tearline and origin.
  1108.       CTRLINFOLOCAL Tearline         ; Add only a tearline.
  1109.       CTRLINFOLOCAL Origin           ; Add only an origin.
  1110.  
  1111.  
  1112. CTRLINFONET <Tearline,Origin,yes/no>  (Tearline)
  1113.  
  1114.     Specifies if you want tearline and origin in your netmail
  1115.     messages. In netmail areas, the tearline and origin is normally
  1116.     never required but can be used for cosmetic purposes.
  1117.  
  1118.     Examples:
  1119.  
  1120.       CTRLINFONET Tearline Origin  ; Add both tearline and origin.
  1121.       CTRLINFONET Tearline         ; Add only a tearline.
  1122.       CTRLINFONET Origin           ; Add only an origin.
  1123.  
  1124.  
  1125. DISPAREANO <yes/no/always>  (yes)
  1126.  
  1127.     This keyword specifies if GoldED should display the area number on
  1128.     the top line in the reader.
  1129.  
  1130.       Yes     Display it only if non-zero.
  1131.       No      Never display it.
  1132.       Always  Always display the area number.
  1133.  
  1134.     The area number is the same as that displayed in the leftmost
  1135.     column in the arealist. This also means that the number displayed
  1136.     can be either the "real" area number (Hudson/Goldbase/Ezycom
  1137.     board) or the standard sequential number (toggleable with Alt-B in
  1138.     the arealist).
  1139.  
  1140.     The number is displayed in square brackets to the left of the area
  1141.     description. I am not sure that is the best place for it - things
  1142.     are getting kinda crowded up there... Suggestions are welcome.
  1143.  
  1144.  
  1145. DISPATTACHSIZE <bytes/kbytes/no>  (kbytes)
  1146.  
  1147.     Controls how the size of attached files is displayed in the
  1148.     header. Either the exact byte size, the rounded kbyte size, or not
  1149.     displayed at all. If the kbytes setting is chosen, the value is
  1150.     rounded according to the following formula: kbytes = (bytes + 512)
  1151.     / 1024. So a 600 bytes file is rounded up to "1k", but a 500 bytes
  1152.     file is rounded down to "0k".
  1153.  
  1154.  
  1155. DISPAUTONEXT <yes/no>  (yes)
  1156.  
  1157.     If enabled, GoldED will automatically jump to the next message
  1158.     when entering an area.
  1159.  
  1160.  
  1161. DISPHDRDATESET <pos> <len>  (-20 20)
  1162.  
  1163.     Specifies the position and length of the date field in the header
  1164.     display. If a negative value is specified, that value is added to
  1165.     the current display width.
  1166.  
  1167.  
  1168. DISPHDRNAMESET <pos> <len>  (8 36)
  1169.  
  1170.     Specifies the position and length of the from/to name field in the
  1171.     header display. If a negative value is specified, that value is
  1172.     added to the current display width.
  1173.  
  1174.  
  1175. DISPHDRNODESET <pos> <len>  (44 16)
  1176.  
  1177.     Specfies the position and length of the from/to node address field
  1178.     in the header display. If a negative value is specified, that
  1179.     value is added to the current display width.
  1180.  
  1181.     NOTE: The attributes display moves along with the DISPHDRNODESET
  1182.     values.
  1183.  
  1184.  
  1185. DISPLISTWRAP <yes/no>  (yes)
  1186.  
  1187.     Enables/disables wrap-round when the selection bar in the main
  1188.     list/browser windows reaches the top or bottom.
  1189.  
  1190.  
  1191. DISPLOCALHIGH <yes/no>  (yes)
  1192.  
  1193.     If enabled, GoldED will display the FROM name with the highlight
  1194.     color, if a message has the Local (LOC) attribute set.
  1195.  
  1196.     A related keyword is BEEPLOCALMSG.
  1197.  
  1198.  
  1199. DISPMARGIN <width>  (0)
  1200.  
  1201.     This is the right margin (display width) used for message display.
  1202.     If the value is 0 (zero), GoldED will default to the current
  1203.     screen width. If a negative value is specified, that value will be
  1204.     added to the current screen width (thereby decreasing the display
  1205.     width relative to the screen width).
  1206.  
  1207.     If the DISPPAGEBAR keyword is enabled, the right margin is
  1208.     automatically decreased by one char.
  1209.  
  1210.  
  1211. DISPMSGLIST <yes/no>  (no)
  1212.  
  1213.     If enabled, GoldED automatically starts the message lister when
  1214.     entering an area.
  1215.  
  1216.     This keyword can be used globally and in Random System groups.
  1217.  
  1218.  
  1219. DISPMSGSIZE <bytes/kbytes/no>  (bytes)
  1220.  
  1221.     When enabled, this keyword displays the msgbody size in the lower
  1222.     left side of the header. The size displayed is for the message
  1223.     body text only, the header and nul-terminator (and anything that
  1224.     may lurk beyond it) is excluded from the calculation.
  1225.  
  1226.     NOTE: This feature currently only works when _reading_ msgs. While
  1227.     editing a msg in the internal editor, this feature is disabled -
  1228.     however, the size will be displayed when you are in the Save msg
  1229.     menu (if EDITSAVEMENU is enabled).
  1230.  
  1231.  
  1232. DISPPAGEBAR <yes/no>  (yes)
  1233.  
  1234.     If enabled, a "pagebar" (similar to the scrollbar in GUI's) will
  1235.     appear on the right margin, telling you about the relative size
  1236.     and position in the message you are reading. It is only displayed
  1237.     if a message is longer than a screenful.
  1238.  
  1239.     The pagebar automatically decreases the DISPMARGIN by one char.
  1240.  
  1241.  
  1242. DISPREALMSGNO <yes/no>  (no)
  1243.  
  1244.     GoldED can display the message numbers in two ways:
  1245.  
  1246.     1.   As the actual (real) msg numbers.
  1247.     2.   As "relative" numbers, which are always sequential from msg
  1248.          number 1.
  1249.  
  1250.     Normally the relative numbers are best, because they reflect the
  1251.     actual number of msgs in the system.
  1252.  
  1253.  
  1254. DISPSOFTCR <yes/no>  (no)
  1255.  
  1256.     If enabled, GoldED will treat the so-called Soft-CR character
  1257.     (ASCII 141, HEX 8D) just like any other displayable character,
  1258.     instead of ignoring it like linefeed chars (LF). Note that by
  1259.     enabling this feature, you _disable_ the character translation
  1260.     feature that uses the Soft-CR as an escape character. This feature
  1261.     was added to help users in countries which use the Soft-CR
  1262.     character for other purposes like 2-byte characters in Japan.
  1263.  
  1264.     NOTE: The Ezycom msgbase format requires the Soft-CR to terminate
  1265.     each line. Therefore this feature is unlikely to be useful to
  1266.     Ezycom sysops.
  1267.  
  1268.  
  1269. DISPSTATUSLINE <yes/no>  (yes)
  1270.  
  1271.     If set to NO, the statusline with memory meter, clock etc. will be
  1272.     disabled. This option has been implemented as a temporary help for
  1273.     visually impaired users. More extensive help may be implemented in
  1274.     future versions.
  1275.  
  1276.  
  1277. DISPTABSIZE <chars>  (8)
  1278.  
  1279.     The tab size (number of spaces) used when displaying the tab
  1280.     (ASCII 9) character, and when pressing <Tab> in the internal
  1281.     editor.
  1282.  
  1283.     If you use an external editor, you should switch it to create
  1284.     spaces instead of tabs, because tabs are technically not allowed
  1285.     in FidoNet technology messages.
  1286.  
  1287.  
  1288. DOSPROMPT (yes/no)  (yes)
  1289.  
  1290.     If enabled, GoldED will add a message about itself to the DOS
  1291.     prompt when shelling out.
  1292.  
  1293.  
  1294. DOSSWAP <yes/no,xms,ems,disk,hide,checknet,noprealloc>  (no)
  1295.  
  1296.     With this keyword you can specify what storage devices the DOS
  1297.     shell swapper should try or use, and what order to try them in.
  1298.  
  1299.     It is only relevant for the standard 16-bit DOS version. The 386
  1300.     and OS/2 versions will ignore this keyword.
  1301.  
  1302.     The YES parameter tells the swapper to try XMS, EMS, DISK in that
  1303.     order, and NO tells it not to swap at all (this will leave the
  1304.     main part of GoldED in memory, and give you little room in the DOS
  1305.     shell).
  1306.  
  1307.     You can specify your own order, such as "DOSSWAP EMS, XMS, DISK",
  1308.     which makes it try it in that order, or "DOSSWAP EMS, DISK", which
  1309.     makes it ignore XMS.
  1310.  
  1311.     If disk swapping is used, the swap file will be placed in the
  1312.     SWAPPATH.
  1313.  
  1314.     These parameters modify the disk swapping behaviour:
  1315.  
  1316.       HIDE        Hides the swapfile, if diskswapping is used.
  1317.       CHECKNET    For some reason, disk swapping is slower if running
  1318.                   on a (Novell) network without this.
  1319.       NOPREALLOC  Use this if you are always running on a network
  1320.                   (instead of enabling CHECKNET).
  1321.  
  1322.     IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT
  1323.  
  1324.     Some programs use extended memory in ways that may conflict with
  1325.     the XMS extended memory driver, causing inexplicable crashes. If
  1326.     you have problems, you should first try turning off the OVERLAY
  1327.     keyword, and if it still fails, turn off DOSSWAP (or stop using
  1328.     those other programs :-)
  1329.  
  1330.  
  1331. EDITAUTOATTACH <yes/no>  (yes)
  1332.  
  1333.     If enabled, and you use drivespec (C:, D:, etc.) in the subject in
  1334.     a netmail message, GoldED will automatically turn on the file
  1335.     attach attribute. Autoattaching only works if the subject has been
  1336.     edited, so that subject files will not automatically be
  1337.     re-attached in replies.
  1338.  
  1339.  
  1340. EDITAUTOSAVE <seconds>  (30)
  1341.  
  1342.     If a non-zero value is given, the internal editor will
  1343.     automatically execute the EDITsavefile function with intervals of
  1344.     <seconds>. Good for keeping automatic backup of the message you
  1345.     are writing. The saved file can be restored with the EDITloadfile
  1346.     command. The name of the saved file is defined with the EDITORFILE
  1347.     keyword.
  1348.  
  1349.     If disaster strikes (power blackout, etc.) while you are writing a
  1350.     message in the internal editor, this feature lets you continue
  1351.     from the last autosaved message, which will popup automatically
  1352.     when you enter the internal editor again.
  1353.  
  1354.     NOTE: This feature is currently not functional, but will soon be
  1355.     re-implemented.
  1356.  
  1357.  
  1358. EDITCHANGEDATE <yes/no>  (yes)
  1359.  
  1360.     If enabled, GoldED will always "touch" the message date in the
  1361.     header, if you change a message after saving it.
  1362.  
  1363.  
  1364. EDITCHARPARA [']<char>[']  (' ')
  1365.  
  1366.     This keyword defines the character GoldED displays at the end of
  1367.     paragraphs in the internal editor. This is where the CR character
  1368.     will be placed once the msg is saved.
  1369.  
  1370.  
  1371. EDITCHARSPACE [']<char>[']  (' ')
  1372.  
  1373.     This keyword defines the character GoldED displays when it should
  1374.     display a space character in the internal editor. See also the
  1375.     description of the EDITCHARPARA keyword.
  1376.  
  1377.     The keywords EDITCHARPARA and EDITCHARSPACE were added to aid me
  1378.     while rewriting and debugging the new internal editor. By
  1379.     redefining them to visible characters instead of spaces, I could
  1380.     see if strange things were happening while inserting or deleting
  1381.     characters. This was a great help. Personally I now always use
  1382.     redefinitions to ASCII 20 (a paragraph sign) and CP437 250 (a
  1383.     small dot).
  1384.  
  1385.  
  1386. EDITCOMMENT <"word"> <"comment">
  1387.  
  1388.     This feature is mostly for fun :-)
  1389.  
  1390.     It allows you to define words which causes GoldED to display a
  1391.     comment in the statusline, when you place the cursor on the word
  1392.     in the internal editor.
  1393.  
  1394.     Example:
  1395.  
  1396.       EDITCOMMENT ":-("     "Don't worry, be happy!"
  1397.       EDITCOMMENT ":-)"     "Are we having fun yet?"
  1398.       EDITCOMMENT ";-)"     "Wink wink, nudge nugde..."
  1399.       EDITCOMMENT "!!!"     "Flame Warning!"
  1400.       EDITCOMMENT "GoldED"  "Great program, isn't it?"
  1401.       EDITCOMMENT "Odin"    "One more 'n' please."
  1402.       EDITCOMMENT "Odinn"   "That's right :-)"
  1403.  
  1404.     Have fun with it!
  1405.  
  1406.  
  1407. EDITCRLFTERM <yes/no>  (no)
  1408.  
  1409.     If enabled, all text paragraphs in your messages will be
  1410.     terminated with a CR/LF combination. If disabled, only a single CR
  1411.     is used. This option was created to fix a problem with an older
  1412.     version of the Dutchie mail processor, that apparently needed the
  1413.     CR/LF termination of kludge lines.
  1414.  
  1415.  
  1416. EDITFIELDCLEAR <yes/no>  (yes)
  1417.  
  1418.     If enabled, the input-fields will be automatically cleared for new
  1419.     entry, if a non-edit key is the first key pressed.
  1420.  
  1421.  
  1422. EDITHARDLINE <string>  ("<<")
  1423.  
  1424.     The string is needed if you use an external editor that terminates
  1425.     all lines with a CR or CR/LF. The hardline string acts as a text
  1426.     paragraph terminator, and the normal CR's are ignored.
  1427.  
  1428.     The concept of "hardlines" is explained in the Hardline Feature
  1429.     chapter.
  1430.  
  1431.  
  1432. EDITHARDLINES <yes/no>  (yes)
  1433.  
  1434.     This keyword enables the "hardline" feature. If disabled, the
  1435.     EDITHARDLINE string is never written to the editor message file,
  1436.     and the editor message file is read back exactly as entered,
  1437.     including terminating CR's on all lines.
  1438.  
  1439.  
  1440. EDITHDRNAMESET <pos> <len>  (8 36)
  1441.  
  1442.     Specfies the position and length of the from/to name field in the
  1443.     header edit display. If a negative value is specified, that value
  1444.     is added to the current display width.
  1445.  
  1446.  
  1447. EDITHDRNODESET <pos> <len>  (44 36)
  1448.  
  1449.     Specfies the position and length of the from/to node address field
  1450.     in the header edit display. If a negative value is specified, that
  1451.     value is added to the current display width.
  1452.  
  1453.  
  1454. EDITINTERNAL <yes/no>  (yes)
  1455.  
  1456.     Specifies if the internal editor should be the default, even if an
  1457.     external editor is defined. You can always change the setting in
  1458.     the editor menu (if EDITMENU is enabled) before you start writing
  1459.     your message.
  1460.  
  1461.  
  1462. EDITMENU <yes/no>  (yes)
  1463.  
  1464.     This keyword enables or disables the "Edit menu" that pops up
  1465.     right after you have edited the message header. If you disable the
  1466.     menu, you will go to the internal or external editor immediately
  1467.     and save a keystroke, but you will of course lose the features
  1468.     available from the menu, such as selection of template etc.
  1469.  
  1470.  
  1471. EDITMIXCASE <yes/no>  (no)
  1472.  
  1473.     If this keyword is enabled, GoldED will automatically format the
  1474.     name with uppercase the first letter in words and lowercase the
  1475.     rest, when entering names in the header.
  1476.  
  1477.     Examples:
  1478.  
  1479.       "odinn sorensen"  or  "ODINN SORENSEN"
  1480.  
  1481.     These would be re-cased to "Odinn Sorensen".
  1482.  
  1483.  
  1484. EDITMSGSIZE <bytes>  (65000)
  1485.  
  1486.     This lets you limit the size of loaded msgs. GoldED currently
  1487.     cannot handle msgs larger than 64k in the DOS version (the 386 and
  1488.     OS/2 versions do not have this limit). This keyword ensures that
  1489.     the system will not get confused and possibly crash or exit, if a
  1490.     message was encountered that was larger than 64k.
  1491.  
  1492.  
  1493. EDITOR <commandline> [@file] [@line]
  1494.  
  1495.     With GoldED it is possible to use your favorite text editor or
  1496.     even word processor to write messages. With this keyword you
  1497.     specify the commandline for the editor.
  1498.  
  1499.     If you use a word processor, be sure to make it export clean ASCII
  1500.     text files without control codes. You may also need to enable the
  1501.     DOSSWAP keyword, if the editor or word processor requires a lot of
  1502.     free memory to run.
  1503.  
  1504.       <commandline>   Program commandline.
  1505.       @file           Token which is replaced by the editor message
  1506.                       filename.
  1507.       @line           Token which is replaced by the @Position
  1508.                       template line number.
  1509.  
  1510.  
  1511. EDITORFILE <file>  (GOLDED.MSG)
  1512.  
  1513.     Defines the name of the temporary editor message file. This file
  1514.     is written by GoldED when swapping to the external editor, or when
  1515.     using the EDITsavefile command in the internal editor.
  1516.  
  1517.     The file is written in the TEMPPATH if there is no explicit path.
  1518.  
  1519.  
  1520. EDITORVERSION <version>  (2)
  1521.  
  1522.     Obsolete and no longer used. There were once two different
  1523.     versions of the internal editor included in GoldED, but now the
  1524.     new editor is stable enough (IMHO) to allow me to throw out the
  1525.     old editor.
  1526.  
  1527.  
  1528. EDITQUOTEMARGIN <margin>  (80)
  1529.  
  1530.     Sets the right margin for quoted lines in the internal editor. You
  1531.     could set this to the same value as QUOTEMARGIN (default 65), but
  1532.     then you won't be able to edit quotes as freely as might be
  1533.     desirable.
  1534.  
  1535.  
  1536. EDITREPLYRE <yes/no>  (no)
  1537.  
  1538.     If enabled, GoldED inserts the "RE:" string in front of the
  1539.     subject when you reply to a message. If not enabled, GoldED will
  1540.     strip any leading "RE:" when you reply to a msg.
  1541.  
  1542.     The "RE:" string in subjects is an obsolete practice, and today it
  1543.     only slows down modern replylinking software. Do yourself and
  1544.     others a favor and let GoldED strip the RE: in your replies.
  1545.  
  1546.  
  1547. EDITSAVEMENU <yes/no>  (yes)
  1548.  
  1549.     This keyword enables or disables the "Save menu" that pops up
  1550.     after you have edited your message in the internal or external
  1551.     editor. If you disable the menu, your message will be saved (or
  1552.     discarded if not edited) immediately and save you a keystroke, but
  1553.     you will also lose the features available from the menu.
  1554.  
  1555.  
  1556. EDITSAVEUTIL <utilno> <"L menu text">
  1557.  
  1558.     Defines the external utilities that will be added to the
  1559.     EDITSAVEMENU (if enabled). The menu text is inserted in the menu.
  1560.     The first two characters of the menu text are the "hotkey" letter
  1561.     that will be highlighted in the menu text, plus a space. Example:
  1562.  
  1563.       EDITSAVEUTIL 1 "S PGP Sign the msg"
  1564.       EDITSAVEUTIL 2 "E PGP Encode the msg"
  1565.       EDITSAVEUTIL 3 "D PGP Decode the msg"
  1566.  
  1567.     If you have changed the default language in this menu (in
  1568.     GOLDLANG.CFG), then make sure the highlight letters don't clash.
  1569.  
  1570.     With EDITSAVEUTIL definitions and EDITSAVEMENU enabled, you can
  1571.     directly call an external utility to do things like encoding or
  1572.     encrypting msgs before saving them.
  1573.  
  1574.  
  1575. EDITSOFTCRXLAT <char>
  1576.  
  1577.     If a translation char is defined, GoldED will translate the
  1578.     soft-cr character (ASCII 141, HEX 8D) while importing a file in
  1579.     the internal editor. Example:
  1580.  
  1581.       EDITSOFTCRXLAT H
  1582.  
  1583.     This example for Russians translates the soft-cr to an 'H'.
  1584.  
  1585.  
  1586. EDITSPELLCHECK <commandline> [@file]
  1587.  
  1588.     While in the internal editor, you can use the EDITspellcheck
  1589.     command to save your message to a file and shell to external
  1590.     spellchecking software. When the check is completed, the corrected
  1591.     file is read back and you can continue editing your message. The
  1592.     EDITspellcheck command internally uses the EDITsavefile and
  1593.     EDITloadfile commands.
  1594.  
  1595.       <commandline>   Spellchecker program commandline.
  1596.       [@file]         Token which is replaced by the message filename
  1597.                       (defined by the EDITORFILE keyword).
  1598.  
  1599.  
  1600. EDITUNDELETE <lines>  (50)
  1601.  
  1602.     This keyword defines the number of lines to keep in the undelete
  1603.     buffer between messages.
  1604.  
  1605.  
  1606. EMPTYTEARLINE <yes,no>  (no)
  1607.  
  1608.     With this keyword enabled, GoldED will always strip the tearline
  1609.     down to just the three dashes, "---", and instead inserts the PID
  1610.     (Product IDentification) kludge line, which contains the same
  1611.     information, but in a safer form in a safer place. The PID kludge
  1612.     is proposed in FidoNet document FSC-0046.
  1613.  
  1614.  
  1615. ENDGROUP
  1616.  
  1617.     Ends a Random System GROUP definition.
  1618.  
  1619.  
  1620. EVENT <eventtype> <eventcommand [parameters]>
  1621.  
  1622.     This keyword allows you to specify which soundfile to play when a
  1623.     specfic event occurs. The following <eventtype>'s are defined for
  1624.     this release:
  1625.  
  1626.       EVENTTYPE       TRIGGER:
  1627.  
  1628.       Arealist        When the arealist shows.
  1629.       AskYesNo        Any Yes/No type prompt.
  1630.       Attention       Warnings or information popup messages.
  1631.       DosShell        When entering a DOS or OS/2 shell.
  1632.       EditComment     When an editcomment is found.
  1633.       EndOfMsgs       When there are no more msgs in the area.
  1634.       ErrorFatal      Fatal error exit.
  1635.       Exit            Exit from GoldED.
  1636.       JobDone         Successful completion of a job.
  1637.       JobFailed       Unsuccessful completion of a job.
  1638.       MsgDeleting     When deleting a msg.
  1639.       MsgFromYou      When a msg from you is found.
  1640.       MsgIsLocal      When a msg marked Local is found.
  1641.       MsgIsTwit       When a msg from a Twit is found.
  1642.       MsgToYou        When a msg to you is found.
  1643.       SearchFailed    Search operation failed.
  1644.       SearchSuccess   Search operation was successful.
  1645.       Startup         When the GoldED startup screen shows.
  1646.  
  1647.     There is only one <eventcommand> defined in this release: PLAY.
  1648.  
  1649.     The standard config files in this release contains a set of
  1650.     default assignments. You will need the GOLD_VOC archive with the
  1651.     "authorized" set of VOC's if you want to try these default
  1652.     assignments.
  1653.  
  1654.     Example usages:
  1655.  
  1656.       EVENT MsgToYou  PLAY HIMAN.VOC            (Bart Simpson :-)
  1657.       EVENT MsgIsTwit PLAY SHOTGUN.VOC
  1658.  
  1659.     As I found out(!), you have to select the sounds carefully and
  1660.     probably with a lot of experimentation, unless you want to turn
  1661.     your mailreader into a honking, wailing and farting monster and
  1662.     drive your poor family nuts with a cacophony of noises...
  1663.  
  1664.     The "authorized" set is under no delusion of being well balanced,
  1665.     but it's fun to use - for a while anyway.
  1666.  
  1667.     NOTE: The sound card support feature is currently disabled.
  1668.  
  1669.  
  1670. EXCLUDENODES <addressmask>
  1671.  
  1672.     You can define up to 50 different addressmasks to be excluded from
  1673.     the compiled nodelists. Use this if you are short of space, or the
  1674.     nodelist compile takes very long on your system. This keyword is
  1675.     used by GoldNODE, and must be present in the main GOLDED.CFG file
  1676.     (not in INCLUDE'ed .CFG's).
  1677.  
  1678.     Excluded nodes can be re-included with the INCLUDENODES keyword.
  1679.  
  1680.  
  1681.  
  1682. EXTERNOPTIONS <-options>
  1683.  
  1684.     Defines the default options for the EXTERNUTIL's. Valid options:
  1685.  
  1686.       -Cls            * Clear screen.
  1687.       -Swap           * Swap GoldED out of memory before shelling.
  1688.       -Cursor         * Cursor in shell.
  1689.       -Reload         * Reload the message file (@file).
  1690.       -Pause            Pause for keypress before returning to GoldED.
  1691.       -PauseOnError   * Pause only if utility errorlevel is nonzero.
  1692.  
  1693.     Plus the reverse options with a "No" prefix, for example -NoCls.
  1694.     The default options are marked with an asterisk (*).
  1695.  
  1696.  
  1697. EXTERNUTIL <utilno> [-options] <commandline>
  1698.  
  1699.     This new feature can be used to "filter" msgs, for example calling
  1700.     PGP or other encryption utilities.
  1701.  
  1702.     The <utilno> must be in the range 1 to 24 for utilities that will
  1703.     be called with key definitions (see below). Higher numbers can be
  1704.     used for utilities that are called from the EDITSAVEMENU (if
  1705.     enabled). See the EDITSAVEUTIL keyword for details.
  1706.  
  1707.     The default options are those specified with the EXTERNOPTIONS
  1708.     keyword. With [-options], you can change the those options locally
  1709.     for specific utils. See the EXTERNOPTIONS keyword for a list of
  1710.     valid options.
  1711.  
  1712.     The <commandline> specfies the DOS or OS/2 commandline you want to
  1713.     execute. This works in the same way as for the external editor and
  1714.     spellchecker. See the manual for details about this, especially if
  1715.     you want to execute batchfiles. In the <commandline> you can use
  1716.     @tokens to transfer information from the msg to the commandline.
  1717.     The @tokens are the same as for templates, and in addition you can
  1718.     use two other @tokens:
  1719.  
  1720.       @path   The GOLDPATH, including a trailing backslash.
  1721.       @file   The full filename of the message file (GOLDED.MSG) that
  1722.               will be written to disk before the utility is called.
  1723.  
  1724.     Examples:
  1725.  
  1726.       EXTERNUTIL 1 c:\4dos\4dos.com /c c:\crypt\encrypt.bat @file
  1727.       EXTERNUTIL 2 c:\4dos\4dos.com /c c:\crypt\decrypt.bat @file
  1728.  
  1729.     To call a defined external utility, you must assign a key to it.
  1730.     There are 24 new keyboard commands you can use in GOLDKEYS.CFG for
  1731.     this purpose:
  1732.  
  1733.       ExternUtilNN
  1734.  
  1735.     Where NN is in the range 01 to 24 _with_ leading zero. Examples:
  1736.  
  1737.       F11 ExternUtil01
  1738.       F12 ExternUtil02
  1739.  
  1740.     Then if you press F11, you would call external utility number 1
  1741.     and so on. The ExternUtilNN keywords ONLY work in reader mode, not
  1742.     in the internal editor or any other place.
  1743.  
  1744.     HOW IT WORKS:
  1745.  
  1746.     1.  Just before the external utility is called, GoldED writes the
  1747.         current message text to the GOLDED.MSG file in the GOLDPATH.
  1748.         The file is written as a textfile with each line CR-LF
  1749.         terminated. The content is exactly as you see it on the
  1750.         screen, which means that kludges are only included if you have
  1751.         enabled kludge viewing.
  1752.  
  1753.     2.  GoldED clears the screen and then calls the utility after
  1754.         swapping itself out of memory (if swapping is enabled or
  1755.         relevant for the version).
  1756.  
  1757.     3.  The utility can now load and process the @file, or do anything
  1758.         else you want. It doesn't have to have anything to do with the
  1759.         current msg. You could call a spreadsheet, a game, whatever.
  1760.         But I think this feature will mainly be used for utilities
  1761.         that process the @file. If the utility processes the @file, it
  1762.         could write the changes back to the @file.
  1763.  
  1764.     4.  After returning from the utility, GoldED reloads the @file and
  1765.         displays it just as if it was the current message. For
  1766.         example, if your utility was a decrypter and the msg was
  1767.         encrypted, you would now see the decrypted msg. Neat eh? :-)
  1768.  
  1769.     5.  If you want to make the reloaded text permanent (save it in
  1770.         the msg), you can use the Change Msg function and immediately
  1771.         choose "Save Message" from the Editing menu (if enabled with
  1772.         EDITMENU Yes). This is in fact the method you could use if you
  1773.         wanted to EN-crypt a msg (however, it is easier to use the
  1774.         method which involves the EDITSAVEUTIL keyword).
  1775.  
  1776.     The QUOTESPACING feature can interfere with encoded msgs that
  1777.     include the '>' character at the beginning of lines (often seen in
  1778.     uuencoded msgs), by automatically inserting blank lines before and
  1779.     after the lines with '>'. I have therefore changed the
  1780.     quotespacing default from YES to NO. Be sure to check if you have
  1781.     a different setting if you are using an older edition of the
  1782.     advanced configuration files.
  1783.  
  1784.     See the "Using PGP as an External Utility" chapter for batchfile
  1785.     examples and instructions on how to use this new feature with PGP.
  1786.  
  1787.     !!! IMPORTANT !!!  From FidoNet Policy 4.07 (chapter 2.1.4):
  1788.  
  1789.       "[..] Therefore, encrypted and/or commercial traffic that is
  1790.       routed without the express permission of all the links in the
  1791.       delivery system constitutes annoying behavior."
  1792.  
  1793.     So be careful with this feature!
  1794.  
  1795.     TIP: You can use the EXTERNUTIL feature to setup keys to view or
  1796.     print an attached fax. Use something like this in GOLDED.CFG:
  1797.  
  1798.       EXTERNUTIL 11 c:\zfax\zfax.com pf @subject     ; print fax
  1799.       EXTERNUTIL 12 c:\zfax\zfax.com vf @subject     ; view fax
  1800.  
  1801.     And this in GOLDKEYS.CFG:
  1802.  
  1803.       @F11  ExternUtil11    ; Press Alt-F11 to print the fax
  1804.       @F12  ExternUtil12    ; Press Alt-F12 to view the fax
  1805.  
  1806.     Or choose your own key assignments and fax view/print utils.
  1807.  
  1808.     Note that this assumes that the fax file is listed in the subject
  1809.     line like an attached file.
  1810.  
  1811.  
  1812. EZYCOMMSGBASE <path>
  1813.  
  1814.     Defines the base path for the Ezycom msgbase. If not set, AREAFILE
  1815.     Ezycom will set it.
  1816.  
  1817.  
  1818. EZYCOMUSERBASE <path>
  1819.  
  1820.     Defines the base path for the Ezycom userbase. If not set,
  1821.     AREAFILE Ezycom will set it.
  1822.  
  1823.  
  1824. FIDOHWMARKS <yes/no>  (no)
  1825.  
  1826.     If enabled, GoldED will use the echomail "highwater mark" (1.MSG)
  1827.     to determine if a message is "sent" or "unsent" in *.MSG areas.
  1828.  
  1829.     NOTE: Some older echomail processors do not update the highwater
  1830.     mark in a way that GoldED can recognize. If all messages appear to
  1831.     marked "Uns", even after the mail has been scanned out, try
  1832.     turning off this keyword.
  1833.  
  1834.  
  1835. FIDOLASTREAD <file>  (LASTREAD.)
  1836.  
  1837.     Defines the filename of the *.MSG lastread files. DO NOT specify a
  1838.     path.
  1839.  
  1840.  
  1841. FIDOLASTREADNO <userno>  (0)
  1842.  
  1843.     This is an index into the FIDOLASTREAD file. Each user occupies 2
  1844.     bytes in the lastread file.
  1845.  
  1846.  
  1847. FIDOMSGTYPE <Opus/FTSC>  (Opus)
  1848.  
  1849.     keyword defines the default format of Fido *.MSG files. It is only
  1850.     used by some AREAFILE's when reading external area configuration
  1851.     files, where the preferred format is unknown.
  1852.  
  1853.     The FTSC (FTS-0001.012 and later) format uses zone/point fields,
  1854.     where the Opus format uses date/time stamps. When set to Opus
  1855.     format, GoldED interprets the date/time stamps as DOS-style
  1856.     bitmapped date/time.
  1857.  
  1858.  
  1859. FIDONULLFIX <yes/no>  (no)
  1860.  
  1861.     If set to YES, GoldED will replace NUL chars with LF chars in the
  1862.     msg body when reading a Fido *.MSG file. This is slower of course,
  1863.     but not noticably on fast machines.
  1864.  
  1865.     This option was created to enable GoldED users to read msgs that
  1866.     were created/handled by brain-dead programs (I don't have names,
  1867.     sorry) which are not obeying our primary technical standard:
  1868.     FTS-0001. FTS-1 states that a NUL terminates the msg body. But
  1869.     sometimes msgs are encountered which have a NUL as the first char
  1870.     in the msg body or perhaps in other places, thereby causing GoldED
  1871.     to show a blank or cut-off msg. In some Pascal-based readers, such
  1872.     as FM, these msgs can be read anyway, because in Pascal a NUL does
  1873.     not terminate a string like in C/C++.
  1874.  
  1875.     NOTE: Even if the new FIDONULLFIX keyword is disabled, GoldED will
  1876.     still fix a NUL if it is the _first_ character in the msg body.
  1877.     This probably fixes most of these buggy msgs without the overhead
  1878.     of checking the entire msg.
  1879.  
  1880.  
  1881. FILEALIAS <alias> <filename>
  1882.  
  1883.     Used to define short alias names for filenames. If you regularly
  1884.     write msgs to different files in different paths, this feature is
  1885.     very useful, and reduces the risk of typing wrong.
  1886.  
  1887.     Example:
  1888.  
  1889.       FILEALIAS DKB R:\DKBBS\DKBBS
  1890.  
  1891.     With this file alias, you can simply write "DKB" at the filename
  1892.     prompt, and the long filename will be used.
  1893.  
  1894.  
  1895. FORCETEMPLATE <yes/no>  (no)
  1896.  
  1897.     If enabled, GoldED will popup a template selection menu when you
  1898.     start writing a new msg or reply. If you have both TEMPLATE(s) and
  1899.     FORCETEMPLATE in a Random System group, you can tell GoldED to use
  1900.     the random template(s) by hitting ESC instead of selecting from
  1901.     the menu.
  1902.  
  1903.     This keyword can be used globally and in Random System groups.
  1904.  
  1905.  
  1906. FREETEAR <echoid>  (MAGNA)
  1907.  
  1908.     This keyword only works for UN-registered users. It defines one
  1909.     area in which you are allowed to have a userdefined (with the
  1910.     TEARLINE keyword) or a random tearline (using the Random System).
  1911.  
  1912.  
  1913. FRQEXT <.ext>
  1914.  
  1915.     With this keyword you can add extra known filename extensions for
  1916.     the filerequest function. The following extensions are already
  1917.     known by default, and need not be defined (duplicate definitions
  1918.     are ignored):
  1919.  
  1920.       .ARC .ARJ .COM .DOC .EXE .GIF .LHA .LZH .PAK .RAR .RUN .SDA .SDN
  1921.       .TXT .ZIP .ZOO
  1922.  
  1923.     Each extension _must_ have the leading dot.
  1924.  
  1925.     Example: FRQEXT .XYZ
  1926.  
  1927.  
  1928. GOLDBASEPATH <path>
  1929.  
  1930.     Specifies the directory where GoldED can find the Goldbase msgbase
  1931.     files.
  1932.  
  1933.  
  1934. GOLDPATH <path>
  1935.  
  1936.     This is the path where GoldED finds all it's control files. It is
  1937.     not necessary to define this, unless you have special needs. The
  1938.     GOLDPATH defaults to directory where the GOLDED.CFG file was
  1939.     found.
  1940.  
  1941.  
  1942. GROUP <groupname>
  1943.  
  1944.     Starts a Random System group. See the Random System chapter for
  1945.     details.
  1946.  
  1947.  
  1948. HUDSONPATH <path>
  1949.  
  1950.     Specifies the directory where GoldED can find the Hudson msgbase
  1951.     files.
  1952.  
  1953.  
  1954. IGNORE
  1955.  
  1956.     This tells the configuration file reader to ignore all subsequent
  1957.     lines until another IGNORE keyword is encountered. Useful for
  1958.     testing and quickly switching portions of configuration.
  1959.  
  1960.     However it is probably more useful to use the IF/ELSE/ENDIF
  1961.     control keywords.
  1962.  
  1963.  
  1964. INBOUNDPATH <path>  (defaults to GOLDPATH)
  1965.  
  1966.     The inbound path is currently only used with the file request
  1967.     feature (the READfilerequest command, <Ctrl-F>). If you use this
  1968.     feature, GoldED will put the file descriptions into a FILES.BBS in
  1969.     the inbound path, ready for when the requested files are moved to
  1970.     the correct file areas.
  1971.  
  1972.  
  1973. INCLUDE <file>
  1974.  
  1975.     This tells the configuration file reader to stop reading the
  1976.     current .CFG file, and start reading the <file> as an extra
  1977.     configuration file, then resume reading the previous .CFG. The
  1978.     INCLUDE filenames are stored and their timestamps are checked when
  1979.     GoldED is started. INCLUDE files can be nested without limit.
  1980.  
  1981.  
  1982. INCLUDENODES <addressmask>
  1983.  
  1984.     You can define up to 50 different addressmasks to be included from
  1985.     the compiled nodelists. This is only used in conjunction with the
  1986.     EXCLUDENODES keyword to include otherwise EXcluded nodes. This
  1987.     keyword is only used by GoldNODE, and must be present in the main
  1988.     .CFG file (not in INCLUDE'ed .CFG's).
  1989.  
  1990.  
  1991.  
  1992. INPUTFILE <filename>  (*.*)
  1993.  
  1994.     Defines the default name in the internal editor file import
  1995.     function.
  1996.  
  1997.     This keyword can be used globally and in Random System groups.
  1998.  
  1999.  
  2000. INTENSECOLORS <yes/no>  (no)
  2001.  
  2002.     GoldED is capable of switching off the "blink" color, and thereby
  2003.     enabling the use of bright background (paper) colors. Enable this
  2004.     keyword, and try out one of the intense color setup examples.
  2005.  
  2006.  
  2007. INVALIDATE <type> <"findstring"> <"replacestring">
  2008.  
  2009.     This is used to invalidate (change) certain control strings in
  2010.     quoted text. Use this in conjunction with D'Bridge or other
  2011.     software that chokes on control strings in quoted text. As an
  2012.     added bonus feature, if the tearline or origin is invalidated to a
  2013.     null string (""), they will not be quoted at all.
  2014.  
  2015.     The <type> can be one of the following:
  2016.  
  2017.       Tearline  Invalidate tearline ("---").
  2018.       Origin    Invalidate origin (" * Origin: ").
  2019.       Seenby    Invalidate SEEN-BY's.
  2020.  
  2021.     By default, the following invalidations are used:
  2022.  
  2023.       "---"              "-+-"
  2024.       " * Origin: "      " + Origin: "
  2025.       "SEEN-BY"          "SEEN+BY"
  2026.  
  2027.  
  2028. INTERNETGATE [gatename<,>]<address>
  2029.  
  2030.     Defines the local internet gate you use when sending netmail to
  2031.     internet users. This option is activated when you write an
  2032.     internet address in the TO: field in the header display. GoldED
  2033.     detects the internet address by looking for the '@' character. If
  2034.     detected, GoldED puts the gate address from INTERNETGATE in the
  2035.     TO: address field. If you have defined the optional gate name
  2036.     (typically UUCP), GoldED also replaces the typed internet address
  2037.     with the gate name and puts the internet address in a TO: line in
  2038.     the message body. Some gate software accepts the internet address
  2039.     directly in the header, while other software may need the special
  2040.     (UUCP) name and a separate TO: line. Examples:
  2041.  
  2042.       INTERNETGATE UUCP, 1:105/42     ; Standard, with gate name
  2043.       INTERNETGATE 2:230/9316         ; My uplink runs GIGO software
  2044.  
  2045.     This keyword can be used globally in GOLDED.CFG, if you only ever
  2046.     use one gate, or in GROUP's for specific areas in GOLDRAND.CFG if
  2047.     you have multiple netmail areas and regularly use more than one
  2048.     gate.
  2049.  
  2050.  
  2051. INTERNETLOOKUP <yes/no>  (no)
  2052.  
  2053.     If set to Yes, GoldED will check the systemname in the nodelist
  2054.     when doing a lookup and if the systemname looks like an Internet
  2055.     address (contains an '@' char), the msg will be addressed to that
  2056.     Internet address using the INTERNETGATE name/address if defined.
  2057.  
  2058.     For example, let's say there was something like this in the
  2059.     nodelist:
  2060.  
  2061.       ,999,somebody@somewhere,Whereever,Some_Body,...
  2062.  
  2063.     And this in my GOLDED.CFG:
  2064.  
  2065.       INTERNETLOOKUP Yes
  2066.       INTERNETGATE 2:230/9316
  2067.  
  2068.     Then if I did a lookup of "Some Body" and selected the entry with
  2069.     the Internet address, GoldED would make a msg looking like this:
  2070.  
  2071.       --------------------------------------
  2072.       From : odinn@winboss.dk     2:236/77
  2073.       To   : somebody@somewhere   2:230/9316
  2074.       Subj : whatever
  2075.       --------------------------------------
  2076.  
  2077.     Or if my gate was defined as "INTERNETGATE UUCP 2:230/9316":
  2078.  
  2079.       --------------------------------------
  2080.       From : odinn@winboss.dk     2:236/77
  2081.       To   : UUCP                 2:230/9316
  2082.       Subj : whatever
  2083.       --------------------------------------
  2084.       To: somebody@somewhere
  2085.  
  2086.     So what's the use of all this?  It allows you to make a
  2087.     nodelist-style list of users with Internet addresses and use it
  2088.     with GoldED so that you can do a lookup of normal names instead of
  2089.     trying to remember strange Internet addresses. Of course something
  2090.     similar could be done using the ADDRESSMACRO's, but with the
  2091.     nodelist approach, you could build a "network" of users which have
  2092.     offline Internet access via FTN-gate software and distribute the
  2093.     nodelist for automatic processing.
  2094.  
  2095.  
  2096. INTERNETREPLY <yes/no>  (yes)
  2097.  
  2098.     When INTERNETREPLY is enabled, GoldED always uses the FSC-35
  2099.     REPLYADDR/REPLYTO kludges to gate replies to msgs from internet
  2100.     correctly. If disabled, GoldED only uses the FSC-35 method if the
  2101.     internet address is too large to fit in the max-35-character TO:
  2102.     header field. Some gate software requires that the FSC-35 method
  2103.     is used, while other software accepts internet addresses directly
  2104.     in the header.
  2105.  
  2106.  
  2107. JAMHARDDELETE <yes/no>  (no)
  2108.  
  2109.     The default setting makes GoldED conform to the JAMAPI specs when
  2110.     deleting msgs in JAM msgbases. This means that deleted msgs are
  2111.     only marked as such in the message header, not in the index. As a
  2112.     result, GoldED will find and display the deleted msgs until you
  2113.     run a message pack utility to physically remove the deleted msgs.
  2114.  
  2115.     If JAMHARDDELETE is set to Yes, GoldED will zap the reference to
  2116.     the message in the index when deleting msgs. This way the deleted
  2117.     msgs will not show up again later. The drawback of this approach
  2118.     is that it is hard to undelete msgs, and may break other software
  2119.     which assume 100% to-the-letter conformance to the specs. Note
  2120.     however, that the hard-delete method is transparent to normal use
  2121.     of JAM msgbases. Probably the only software that might break are
  2122.     undelete utilities.
  2123.  
  2124.     For the techies and programmers, the hard-delete method is simply
  2125.     setting both UserCRC and HdrOffset in the index to 0xFFFFFFFF
  2126.     instead of only the UserCRC. According to the JAMAPI specs, a
  2127.     value of 0xFFFFFFFF in HdrOffset means that "there is no
  2128.     corresponding message header". Sounds remarkably like a deleted
  2129.     msg, right? :-)
  2130.  
  2131.  
  2132. JAMPATH <path>  (defaults to the HUDSONPATH)
  2133.  
  2134.     Defines the path where GoldED can access the NETMAIL/ECHOMAIL.JAM
  2135.     files, which are used by mail processors to find and scan out mail
  2136.     written by users.
  2137.  
  2138.  
  2139. KEYBCLEAR <yes/no>  (no)
  2140.  
  2141.     Tells GoldED whether or not to clear the keyboard buffer on
  2142.     startup. This also clears KEYBSTACK or commandline key stuffing.
  2143.     In older versions of GoldED, it was necessary to enable this
  2144.     keyword if you had renamed GOLDED.EXE to DBEDIT.EXE. This version
  2145.     detects the .EXE renaming and automatically enables KEYBCLEAR,
  2146.     regardless of the configuration setting.
  2147.  
  2148.  
  2149. KEYBEXT <yes/no>  (no)
  2150.  
  2151.     If enabled, GoldED will use extended bios calls to read the
  2152.     keyboard. With the extended keyboard, you can use keys like
  2153.     <Alt-Left>, <Alt-Home> and other extended keys. If you don't have
  2154.     an extended keyboard, don't despair - using a few neat tricks, I
  2155.     have made it possible to use some of the extended keys even with a
  2156.     non-extended keyboard.
  2157.  
  2158.  
  2159. KEYBSTACK <keystring>
  2160.  
  2161.     With this keyword, you can "stack" keys in the keyboard buffer.
  2162.     The KEYBSTACK can be overridden by commandline keystacking, which
  2163.     uses the same syntax.
  2164.  
  2165.     The <keystring> can be a mixture of the following:
  2166.  
  2167.       ^Char     Ctrl-key (^Letter).
  2168.       ~Char     Ctrl-key (~Letter). (Use this with 4DOS!).
  2169.       @Key      Alt-key (@Number or @Letter).
  2170.       Char      Literal character.
  2171.       "String"  String, enclosed in double quotes.
  2172.       'String'  String, enclosed in single quotes.
  2173.       Number    Keyboard scan code (decimal).
  2174.       !         Clear keyboard buffer.
  2175.  
  2176.     Whitespace (space and tab) is ignored, except in quoted strings.
  2177.  
  2178.     See the Macros and Keystacking chapter for more info.
  2179.  
  2180.  
  2181. KLUDGE <kludge-definition>
  2182.  
  2183.     The definition may optionally be enclosed in quotes. A definition
  2184.     must be enclosed in quotes if it contains leading or trailing
  2185.     spaces. The KLUDGE tells GoldED which kludges it should consider
  2186.     as "known" in addition to the built-in known kludges.
  2187.  
  2188.     Here are a bunch of examples, most of which are kludges generated
  2189.     by the GIGO internet gateway software:
  2190.  
  2191.       KLUDGE "  "                 ; For wrapped kludges
  2192.       KLUDGE "Content-Type:"
  2193.       KLUDGE "Date:"
  2194.       KLUDGE "From:"
  2195.       KLUDGE "In-Reply-To:"
  2196.       KLUDGE "Message-Id:"
  2197.       KLUDGE "Mime-Version:"
  2198.       KLUDGE "Organization:"
  2199.       KLUDGE "Newsgroups:"
  2200.       KLUDGE "Received:"
  2201.       KLUDGE "Reply-To:"
  2202.       KLUDGE "Sender:"
  2203.       KLUDGE "Subject:"
  2204.       KLUDGE "To:"
  2205.       KLUDGE "Errors-To:"
  2206.       KLUDGE "X-FTN-From:"
  2207.       KLUDGE "ORIGREF:"           ; Gatebau?
  2208.       KLUDGE "ORIGID:"            ; Gatebau?
  2209.       KLUDGE "RFC-"               ; Seen in NET_DEV
  2210.  
  2211.     The kludges defined with KLUDGE are not case-sensitive, but when
  2212.     GoldED looks for the kludges, it matches to the exact length. This
  2213.     means that for example "RFC-" will match all kludges beginning
  2214.     with that string.
  2215.  
  2216.     The ASCII 1 kludge char should not be included in the definition
  2217.     string, but GoldED can handle it if you do.
  2218.  
  2219.  
  2220. KLUDGECHRS <yes/no>  (yes)
  2221.  
  2222.     If set to YES, GoldED uses the "^aCHRS" kludge instead of the
  2223.     "^aCHARSET" kludge when appropriate.
  2224.  
  2225.  
  2226. LOADLANGUAGE <file>
  2227.  
  2228.     If defined, this keyword will load a language definition file.
  2229.  
  2230.     This feature can be used to load a small set of national language
  2231.     definitions in national areas, an english set in international
  2232.     areas, etc. Typically this would be used to load the definitions
  2233.     of the date/time strings for use in the template and the
  2234.     Msg/From/To/Subj strings in the header display.
  2235.  
  2236.     In the ADVANCED archive, a set of GEDLNG*.CFG files are provided,
  2237.     which are designed for use with LOADLANGUAGE. Please note that
  2238.     there is also a @loadlanguage template token. This way you can
  2239.     choose to load a language file from the template, or by using the
  2240.     Random System. The template token takes precedence over the
  2241.     LOADLANGUAGE in the Random System, but if both are defined, both
  2242.     will be loaded.
  2243.  
  2244.     This keyword can be used globally and in Random System groups, but
  2245.     it is probably not very useful when used globally.
  2246.  
  2247.  
  2248. LOGFILE <file>  (GOLDED.LOG or GED386.LOG or GED2.LOG)
  2249.  
  2250.     Defines the name of the GoldED logfile. You should not change the
  2251.     default.
  2252.  
  2253.  
  2254. LOGFORMAT <fd,max,bink,qbbs,db>  (fd)
  2255.  
  2256.     Defines the log format GoldED should use when writing to the
  2257.     logfile.
  2258.  
  2259.  
  2260. LOOKUPECHO <yes/no>  (no)
  2261.  
  2262.     If enabled, GoldED will use nodelist lookup when entering the TO:
  2263.     name in msgs in echomail areas.
  2264.  
  2265.  
  2266. LOOKUPLOCAL <yes/no>  (no)
  2267.  
  2268.     If enabled, GoldED will use nodelist lookup when entering the TO:
  2269.     name in msgs in local areas.
  2270.  
  2271.  
  2272. LOOKUPNET <yes/no>  (yes)
  2273.  
  2274.     If enabled, GoldED will use nodelist lookup when entering the TO:
  2275.     name in msgs in netmail areas.
  2276.  
  2277.  
  2278. MAPDRIVE <server driveletter> <local driveletter>
  2279.  
  2280.     If your system is running on a network, you might have your
  2281.     mailer, mail processor and other software running on the server,
  2282.     while GoldED is running locally on another machine on the network.
  2283.     In such a case, the drive specification (C: etc) on the server
  2284.     will probably not match those of the local machine (i.e. C: on the
  2285.     server might be H: on the workstation). If you are file attaching
  2286.     or reading area config from the mailer or mail processor on the
  2287.     server with AREAFILE, the drives would be all wrong. This problem
  2288.     is solved by using MAPDRIVE to remap the drive letters in GoldED.
  2289.  
  2290.     NOTE: This keyword ONLY works in AREAFILE's to convert remote
  2291.     driveletters.
  2292.  
  2293.  
  2294. MEMBER <echoid>
  2295.  
  2296.     Defines Random System group members. See the Random System chapter
  2297.     for details.
  2298.  
  2299.  
  2300. MENUDROPMSG <yes/no>  (no)
  2301.  
  2302.     Defines the default selection in the "Drop This Msg?" menu.
  2303.  
  2304.  
  2305. MOUSE <yes/no>  (no)
  2306.  
  2307.     The mouse support in GoldED is currently not functional.
  2308.  
  2309.  
  2310. NAMESFILE <file>  (NAMES.FD)
  2311.  
  2312.     GoldED supports the "address macro" file supported by FrontDoor
  2313.     and Maximus. If no path is specified, the file is first searched
  2314.     for in the path from the "FD" environment variable and then the
  2315.     GOLDPATH, if the FD variable failed.
  2316.  
  2317.     The address macros are added *after* those defined with the
  2318.     ADDRESSMACRO keyword (if any) (see this for details on the
  2319.     format).
  2320.  
  2321.  
  2322. NETNAME <"string">
  2323.  
  2324.     This is the "netname" that is placed in the originline, in front
  2325.     of the address.
  2326.  
  2327.     Example:
  2328.  
  2329.       NETNAME "FidoNet"
  2330.  
  2331.     Produces:
  2332.  
  2333.       * Origin: Whatever (FidoNet 2:236/77)
  2334.  
  2335.     This keyword can be used globally and in a Random System group.
  2336.  
  2337.     NOTE: The netname is a non-standard practice with no technical
  2338.     merit and should not be used. It is provided for cosmetical
  2339.     purposes and backward compatibility only.
  2340.  
  2341.  
  2342. NODELIST <file> [zone/addr]
  2343.  
  2344.     Here you define the nodelists that are used by GoldED and the
  2345.     companion nodelist compiler GoldNODE. The nodelists must generally
  2346.     be in the standard "St.Louis" nodelist format, but they can also
  2347.     contain FrontDoor/Version7 style Boss/Point extensions. The
  2348.     default zone is defined by the first ADDRESS or AKA, but can be
  2349.     overridden by adding the zone number or a full address after the
  2350.     filename. GoldED currently needs it's own special index files to
  2351.     use the nodelists. These index files are created by GoldNODE.
  2352.  
  2353.       <file>        Nodelist file. If the extension is numeric or a
  2354.                     wildcard (".*"), the newest file with a numeric
  2355.                     extension is used.
  2356.       [zone/addr]   Default zone or address for the nodelist (if no
  2357.                     zone info is present in the list itself).
  2358.  
  2359.     See also the USERLIST keyword, and the Nodelist Browsing chapter.
  2360.  
  2361.     NOTE: If you have nodelists with duplicate some of each others
  2362.     nodes, the nodelist with the newest or most correct entries should
  2363.     be placed LAST, and you should use the -D (remove duplicates)
  2364.     option with GoldNODE.
  2365.  
  2366.  
  2367. NODELISTWARN <yes/no>  (yes)
  2368.  
  2369.     If set to YES, GoldED will warn you during startup if one or more
  2370.     nodelists are missing. Use NO to disable the warning if it bothers
  2371.     you or you delete/pack your nodelists when the nodelists are
  2372.     compiled.
  2373.  
  2374.     NOTE: GoldED can work fine with lookups etc. without nodelists as
  2375.     long as it can access its own indexes (GOLDNODE.GX?). Only the
  2376.     extra details will be missing.
  2377.  
  2378.  
  2379. NODEPATH <path>
  2380.  
  2381.     This is where GoldED and GoldNODE finds the nodelist files and
  2382.     indexes.
  2383.  
  2384.  
  2385. ORIGIN <"string">
  2386.  
  2387.     You can define many different origins for use in GoldED. You can
  2388.     select one of the defined origins from the Origin selection menu
  2389.     (the READchangeorigin keyword), which is also available from the
  2390.     EDITMENU and the EDITSAVEMENU.
  2391.  
  2392.     Leading and/or trailing spaces can be added by enclosing the
  2393.     origin string in quotes.
  2394.  
  2395.     This keyword can be used globally and in a Random System group.
  2396.  
  2397.     NOTE: Origins defined in the Random System will always override
  2398.     the global origins defined with this keyword, except when they are
  2399.     selected from the EDITSAVEMENU.
  2400.  
  2401.  
  2402. OUTPUTFILE <file>
  2403.  
  2404.     This is the default name of the file written using the
  2405.     READwritemsg command.
  2406.  
  2407.     This keyword can be used globally and in a Random System group.
  2408.  
  2409.  
  2410. OVERLAY <ems/ext/disk>  (disk)
  2411.  
  2412.     This keyword controls where GoldED places the overlay swap blocks.
  2413.     GoldED (the standard DOS version) uses the Borland VROOMM dynamic
  2414.     overlays to decrease the resident executable code.
  2415.  
  2416.     See the DOSSWAP keyword for a warning note!
  2417.  
  2418.     Ignored by the 386 and OS/2 versions.
  2419.  
  2420.  
  2421. PCBOARDPATH <path>
  2422.  
  2423.     Defines the default path where GoldED should look for the PCBoard
  2424.     setup files if it can't find the PCBOARD environment variable.
  2425.  
  2426.  
  2427. PLAY <soundfile>
  2428.  
  2429.     If used in GOLDED.CFG, it defines the default sound to play when
  2430.     entering an area. If used in GOLDRAND.CFG, it defines the sound to
  2431.     play when entering an area or group of areas. If more than one
  2432.     PLAY is used in a group in GOLDRAND.CFG, one will be chosen at
  2433.     random.
  2434.  
  2435.     The only soundfile supported in this release is the Creative
  2436.     Technology Voice format - the *.VOC files. When a VOC is played
  2437.     with GoldED, it is first loaded complete into memory (so don't use
  2438.     big ones...) and then the CT-VOICE driver plays it. It is possible
  2439.     (in most situations) to do other things while the VOC is playing,
  2440.     but beware that you may run out of memory. Keep an eye on the
  2441.     memory meter in the statusline. The VOC will be automatically
  2442.     unloaded when it stops playing.
  2443.  
  2444.     It is important to supply the .VOC file extension. This is the
  2445.     only way GoldED knows what kind of soundfile it is. Later versions
  2446.     might add support for .WAV and other types.
  2447.  
  2448.     This keyword can be used globally and in a Random System group.
  2449.  
  2450.     NOTE: The sound card support is currently disabled.
  2451.  
  2452.  
  2453. PRINTDEVICE <devicename>  (PRN)
  2454.  
  2455.     Defines the name of the device used for printing. PRN is the
  2456.     default, but LPTx can also be used. Printers on COMx ports may
  2457.     also work, but this has not been tested.
  2458.  
  2459.     Devices are opened in Write-Only text mode. The function has been
  2460.     successfully tested to work with two popular peer-to-peer network
  2461.     packages.
  2462.  
  2463.     You should NOT use a filename as devicename. Use the filename
  2464.     option in the Write menu instead.
  2465.  
  2466.  
  2467. PRINTFORMFEED <yes/no>  (yes)
  2468.  
  2469.     Used when printing messages. If enabled, it prints a Form Feed
  2470.     (12d) character after each message.
  2471.  
  2472.  
  2473. PRINTINIT <printstring>
  2474.  
  2475.     This keyword defines the command string sent to your printer to
  2476.     initialize it before the actual printing.
  2477.  
  2478.     The <printstring> can contain items like these:
  2479.  
  2480.       $Hex          A hexadecimal string.
  2481.       #Decimal      A decimal (integer) number.
  2482.       "String"      Text string, enclosed in double quotes.
  2483.       'String'      Text string, enclosed in single quotes.
  2484.       Other chars   Ignored.
  2485.  
  2486.  
  2487. PRINTLENGTH <lines>  (65)
  2488.  
  2489.     Defines the number of lines per page for printing. A formfeed is
  2490.     printed when every time PRINTLENGTH lines have been printed.
  2491.  
  2492.  
  2493. PRINTMARGIN <characters>  (80)
  2494.  
  2495.     The right margin to use in printed messages.
  2496.  
  2497.  
  2498. PRINTRESET <printstring>
  2499.  
  2500.     This keyword defines the command string sent to your printer to
  2501.     reset it after printing.
  2502.  
  2503.       <printstring>  See the PRINTINIT keyword.
  2504.  
  2505.  
  2506. QUOTEBLANK <yes/no>  (no)
  2507.  
  2508.     If enabled, GoldED will put the QUOTESTRING on blank lines in the
  2509.     quote. Otherwise blank lines are left blank in quotes.
  2510.  
  2511.  
  2512. QUOTEBUFFILE <filename>
  2513.  
  2514.     If used, it sets the default filename for the quotebuffer. If no
  2515.     path is specified, the GOLDPATH is used.
  2516.  
  2517.     This keyword can be used globally and in Random System groups.
  2518.  
  2519.     NOTE: If this keyword is used in globally (in GOLDED.CFG), it
  2520.     effectively disables the automatically named quotebuffers, as
  2521.     described in the chapter about the QUOTEBUFMODE keyword.
  2522.  
  2523.  
  2524. QUOTEBUFMODE <ask/append/overwrite>  (ask)
  2525.  
  2526.     Specifies what GoldED should do, if the quotebuffer file exists
  2527.     already.
  2528.  
  2529.       Ask         A menu asks you to select append/overwrite/skip.
  2530.       Append      Always append, no asking.
  2531.       Overwrite   Always overwrite, no asking.
  2532.  
  2533.     The "always overwrite" mode is not very useful I guess, but it's
  2534.     there if you need it.
  2535.  
  2536.     The quotebuffer feature automatically creates special filenames
  2537.     for the buffer file, using these guidelines:
  2538.  
  2539.       FORMAT    FILENAME      LOCATION
  2540.       Fido      GOLDED.QBF    In the directory with the *.MSG's.
  2541.       Hudson    GOLDHxxx.QBF  In the HUDSONPATH.
  2542.       Squish    filename.QBF  Where the Squish area is.
  2543.       Ezycom    GLDxxxxx.QBF  In the EZYCOMMSGPATH.
  2544.       JAM       filename.QBF  Where the JAM area is.
  2545.       Goldbase  GOLDGxxx.QBF  In the GOLDBASEPATH.
  2546.       PCBoard   filename.QBF  Where the PCBoard area is.
  2547.  
  2548.     Note that they all have extension .QBF so that you can easily find
  2549.     them.
  2550.  
  2551.  
  2552. QUOTECHARS ["]<chars>["]
  2553.  
  2554.     Defines up to 10 chars to recognize in addition to '>' as quote
  2555.     string chars. This is most useful in gated internet newsgroups,
  2556.     where chars such as '|', ':' and ';' are sometimes used instead of
  2557.     the '>'.
  2558.  
  2559.     This keyword can be used globally and in Random System groups.
  2560.  
  2561.     Example:
  2562.  
  2563.       Group Internet:
  2564.         Member alt.*, comp.*, net.email
  2565.         Attributes Dir
  2566.         Quotechars "|:;"
  2567.         Username odinn@winboss.dk
  2568.       EndGroup
  2569.  
  2570.     The example is similar to the one I use myself (net.email is a
  2571.     local netmail area where I import my gated e-mail from
  2572.     winboss.dk). The username is my actual internet address.
  2573.  
  2574.     Note that using additional quotechars such as '|' and ':' may
  2575.     cause odd results when quoting in the cases when they are actually
  2576.     NOT used in a message as quotechars. Consider for example quoting
  2577.     a smiley :-)
  2578.  
  2579.  
  2580. QUOTEMARGIN <chars>  (65)
  2581.  
  2582.     The margin to which quotes are wrapped. A negative value means
  2583.     that the negative value is added to the DISPMARGIN (not
  2584.     recommended).
  2585.  
  2586.  
  2587. QUOTESPACING <yes/no>  (no)
  2588.  
  2589.     If enabled, GoldED will automatically add blank lines before and
  2590.     after a block of quoted text, if none are present already. This
  2591.     improves the readability of some messages.
  2592.  
  2593.  
  2594. QUOTESTRING <quotespec>  (" FML> ")
  2595.  
  2596.     With this keyword you define how you want the quotestring to look
  2597.     in your quoted replies.
  2598.  
  2599.     The <quotespec> can contain these characters:
  2600.  
  2601.       F       Replaced with the first letter of the first name.
  2602.       M       Replaced with the letters of the middle names.
  2603.       L       Replaced with the first letter of the last name.
  2604.       >       Required quote-char.
  2605.       Spaces  Cosmetics.
  2606.  
  2607.     Other characters are allowed but *not* recommended.
  2608.  
  2609.  
  2610. RA2USERSBBS <yes/no>  (no)
  2611.  
  2612.     Use this keyword to *force* GoldED to use a RemoteAccess 2.xx
  2613.     (RA2) compatible USERS.BBS file, even if RA2 is not detected. If
  2614.     used, this keyword should be placed in the configuration file
  2615.     _after_ any AREAFILE keyword.
  2616.  
  2617.  
  2618. REGISTERKEY <keycode>
  2619. REGISTERNAME <keyname>
  2620.  
  2621.     These keywords are only used in registered setups.
  2622.  
  2623.  
  2624. REPLYLINK <chain/direct>  (direct for JAM, chain for everything else)
  2625.  
  2626.     If set to "direct", GoldED will link your reply directly to the
  2627.     original message. If set to "chain", it will link to the last
  2628.     message in the reply chain. The default ("chain") is how GoldED
  2629.     has done it in all previous versions.
  2630.  
  2631.     The advantage of the "direct" linking method is that you can
  2632.     easily find the the original message the reply was for. Unless of
  2633.     course you have later re-linked using a chain-linking replylinker
  2634.     utility. I can recommend the utility SQLINK by David L. Nugent.
  2635.     SQLINK links Squish areas using the MSGID/REPLY kludges and makes
  2636.     direct links instead of chain-linking on the subject line like
  2637.     most other replylinkers do. There are probably also similar
  2638.     replylinkers for other msgbase formats, I just don't know them.
  2639.  
  2640.     NOTE: Direct linking is not always useful or practical. It can be
  2641.     very hard to follow a discussion with more than one participants,
  2642.     because the links become branched trees instead of simple chains.
  2643.     Currently GoldED is not designed to follow the branched direct
  2644.     links.
  2645.  
  2646.  
  2647. ROBOTNAME <name>
  2648.  
  2649.     A "robot" is a program on the Boss or Uplink system which responds
  2650.     automatically to netmail messages. Usually the robot links or
  2651.     unlinks echomail areas or distributed files.
  2652.  
  2653.     The following ROBOTNAME's are defined by default:
  2654.  
  2655.       AreaFix, AreaMgr, FileFix, AreaLink, AllFix, Raid, GEcho.
  2656.  
  2657.     If you write a netmail message where the TO: name is one of the
  2658.     robot names, GoldED will ignore any template definition, and give
  2659.     you a blank msg (possibly with a tearline) to edit.
  2660.  
  2661.  
  2662. SCREENBLANKER <seconds>  (180)
  2663.  
  2664.     If non-zero, GoldED will blank the screen after the defined number
  2665.     of seconds, and put a small moving window up instead. Hitting any
  2666.     key (including shiftkeys) will return the screen to normal. If
  2667.     zero, no blanking is done.
  2668.  
  2669.     NOTE: This feature is currently not functional.
  2670.  
  2671.  
  2672. SCREENELIMSNOW <yes/no>  (no)
  2673.  
  2674.     By default GoldED writes directly to the screen memory, but
  2675.     unfortunately on older CGA display adapters, direct screen writes
  2676.     can produce harmless, but annoying "snow". If you can't live with
  2677.     that, enable this keyword. Note however, that this also slows down
  2678.     the screen updating drastically.
  2679.  
  2680.     This option is ignored in the 386 and OS/2 versions.
  2681.  
  2682.  
  2683. SCREENMAXCOL <columns>  (0)
  2684.  
  2685.     On some systems, GoldED cannot detect the correct display size.
  2686.     With this keyword you can force a specific size. If zero,
  2687.     autodetect is used.
  2688.  
  2689.  
  2690. SCREENMAXROW <rows>  (0)
  2691.  
  2692.     On some systems, GoldED cannot detect the correct display size.
  2693.     With this keyword you can force a specific size. If zero,
  2694.     autodetect is used.
  2695.  
  2696.  
  2697. SCREENPALETTE <reg> <value>  OR  <reg> (red green blue)
  2698.  
  2699.     You can change the color palette used in GoldED. The palette has
  2700.     16 color registers, corresponding to the 16 colors from black (0)
  2701.     to intense white (15). By changing the values in the palette
  2702.     registers, it is possible to make any of the 16 colors a
  2703.     completely different color. You can even make the background
  2704.     colors intense, without using the intense color feature. There are
  2705.     64 different colors to chose from.
  2706.  
  2707.     To configure the palette colors in GoldED, the SCREENPALETTE
  2708.     keyword is used. There are two different syntaxes:
  2709.  
  2710.       SCREENPALETTE <reg> <value>
  2711.       SCREENPALETTE <reg> (red green blue)
  2712.  
  2713.     So you can either compose the color value using separate red,
  2714.     green, blue components, or directly use a precalculated value. The
  2715.     red/green/blue values can only be in the range 0-3.
  2716.  
  2717.     These are the original palette values:
  2718.  
  2719.       SCREENPALETTE    0   (0 0 0)
  2720.       SCREENPALETTE    1   (0 0 2)
  2721.       SCREENPALETTE    2   (0 2 0)
  2722.       SCREENPALETTE    3   (0 2 2)
  2723.       SCREENPALETTE    4   (2 0 0)
  2724.       SCREENPALETTE    5   (2 0 2)
  2725.       SCREENPALETTE    6   (2 2 0)
  2726.       SCREENPALETTE    7   (2 2 2)
  2727.       SCREENPALETTE    8   (0 1 0)
  2728.       SCREENPALETTE    9   (1 1 3)
  2729.       SCREENPALETTE   10   (1 3 1)
  2730.       SCREENPALETTE   11   (1 3 3)
  2731.       SCREENPALETTE   12   (3 1 1)
  2732.       SCREENPALETTE   13   (3 1 3)
  2733.       SCREENPALETTE   14   (3 3 2)
  2734.       SCREENPALETTE   15   (3 3 3)
  2735.  
  2736.     Copy these lines into your GOLDED.CFG and start experimenting! :-)
  2737.  
  2738.     If you have written a program to edit the palette and write a
  2739.     GoldED palette setup file, please don't keep it a secret! :-)
  2740.  
  2741.  
  2742. SCREENSHADOWS <yes/no>  (yes)
  2743.  
  2744.     If enabled, all relevant windows and menus in GoldED will have
  2745.     shadows.
  2746.  
  2747.  
  2748. SCREENSIZE <mode>  (Auto)
  2749.  
  2750.     Use this to force GoldED to use either 25 lines, 43/50 lines on
  2751.     EGA/VGA, or even special videomodes supported by your SuperVGA
  2752.     adapter (modes like 132x44, 100x40 or 80x60).
  2753.  
  2754.     The <mode> can be one of the following:
  2755.  
  2756.       Auto        Use detected size.
  2757.       25          Switch to 25 lines.
  2758.       4350        Switch to 43/50 lines.
  2759.       Mode <NN>   Switch to videomode NN (a hexadecimal value).
  2760.  
  2761.     Please check your video adapter manual carefully before trying out
  2762.     the Mode option. SELECTING A WRONG MODE CAN DAMAGE YOUR MONITOR!!!
  2763.  
  2764.     The Mode option is ignored in the OS/2 version.
  2765.  
  2766.  
  2767. SCREENUSEBIOS <yes/no>  (no)
  2768.  
  2769.     If enabled, GoldED will use standard BIOS calls for screen
  2770.     updates. This is VERY slow, and should only be used if really
  2771.     needed. Normally GoldED uses direct screen writes.
  2772.  
  2773.     This feature is ignored in the OS/2 version.
  2774.  
  2775.  
  2776. SEARCHFOR <string;string;..>
  2777.  
  2778.     Defines a set of search strings, separated by semicolons. The
  2779.     search set defined here is the default when using the Alt-F/Z
  2780.     search functions or the marking system.
  2781.  
  2782.     The semicolon works like an OR operator. That is, the search is
  2783.     successful if one or more of the strings are matched.
  2784.  
  2785.     This keyword can be used globally and in Random System groups.
  2786.  
  2787.  
  2788. SEMAPHORE <type> <file>
  2789.  
  2790.     This keyword defines "semaphore" files, for use with other mailer
  2791.     and/or mail processing software.
  2792.  
  2793.     The <type> can be one of the following:
  2794.  
  2795.       NETSCAN     Empty netmail scan file (for D'Bridge/FD).
  2796.       ECHOSCAN    Empty echomail scan file (for D'Bridge).
  2797.       EXPORTLIST  Echoid-list of your new messages.
  2798.       IMPORTLIST  Echoid-list of new imported messages.
  2799.  
  2800.     The semaphore files are placed in the AREAPATH, if no path is
  2801.     specified.
  2802.  
  2803.     See the example .CFG files for typical semaphore filenames.
  2804.  
  2805.  
  2806. SHAREMODE <yes/no/mode#>  (yes)
  2807.  
  2808.     If enabled, GoldED opens all files in a SHARE.EXE compatible mode.
  2809.  
  2810.     The default share-mode is "Share Deny None", but another may be
  2811.     specified directly if you give the mode number as the keyword
  2812.     parameter (decimal).
  2813.  
  2814.     It is normally not necessary to change the default.
  2815.  
  2816.  
  2817. SOUNDDEVICE <device> [parameters]
  2818.  
  2819.     Default is no device, and only the standard set of beeping
  2820.     effects. Valid <device>'es are:
  2821.  
  2822.       SB or SBPRO   Enable Sound Blaster support.
  2823.  
  2824.     If SB or SBPRO was chosen and the card is setup with the factory
  2825.     defaults, you don't have to supply parameters. If no parameters
  2826.     are specified, GoldED uses the SOUND and BLASTER environment
  2827.     variables to get the parameters or just uses the factory defaults.
  2828.  
  2829.     The valid parameters for SB/SBPRO are:
  2830.  
  2831.       -A<ioport>         (optional)
  2832.       -I<intnum>         (optional)
  2833.       <full path and name of the CT-VOICE.DRV file> (optional)
  2834.  
  2835.     Example: SOUNDDEVICE SBPRO -A220 -I7 C:\SBPRO\DRV\CT-VOICE.DRV
  2836.  
  2837.     The SB support is done by loading the CT-VOICE.DRV driver into
  2838.     memory and handing it the VOC's to play with.
  2839.  
  2840.     Although it is not tested by me, GoldED should be able to work
  2841.     with any Sound Blaster compatible sound card that comes with a
  2842.     CT-VOICE.DRV compatible driver.
  2843.  
  2844.     If you don't get any sound, try (re-)installing the CT-VOICE.DRV
  2845.     file with the correct parameters using the INST-DRV utility (Run
  2846.     "INST-DRV DRV" in your SB/SBPRO directory).
  2847.  
  2848.     NOTE: The sound card support is currently not functional.
  2849.  
  2850.  
  2851. SOUNDPATH <path>  (defaults to the GOLDPATH)
  2852.  
  2853.     Tells GoldED where to find the sound files for the PLAY and EVENT
  2854.     keywords.
  2855.  
  2856.     NOTE: The sound card support is currently not functional.
  2857.  
  2858.  
  2859. SQUISHSCAN <api/quick>  (quick)
  2860.  
  2861.     Specfies whether to use a quick scanning method which only looks
  2862.     in the .SQI files. This will normally work fine, but may fail
  2863.     slightly in obscure cases, especially when used with Squish 1.0x
  2864.     or programs using the old version of the MSGAPI. If you suspect
  2865.     problems, try to set this keyword to "api", which tells GoldED to
  2866.     look in the .SQD file for an exact count of active msgs in the
  2867.     .SQI file.
  2868.  
  2869.     NOTE: GoldED does NOT use the original MSGAPI by Scott Dudley.
  2870.     Since version 2.50, a completely rewritten implementation is used.
  2871.  
  2872.  
  2873. SQUISHUSERNO <index>
  2874.  
  2875.     This sets the lastread index number for the Squish *.SQL lastread
  2876.     files. Lowest number is 0 (zero), highest is (in theory) 65534.
  2877.  
  2878.     If used, this disables the use of USER.BBS to find the index
  2879.     number, and will in effect also stop GoldED from creating USER.BBS
  2880.     or any new entries in it (useful in a single-user point system).
  2881.     If a Squish msgbase is shared between several users, and you don't
  2882.     want to have a USER.BBS (recommended in such a case), each user
  2883.     must have a unique SQUISHUSERNO in their GOLDED/GOLDAREA.CFG.
  2884.  
  2885.  
  2886. SQUISHUSERPATH <path>
  2887.  
  2888.     This keyword defines the path where GoldED can find and use/create
  2889.     your USER.BBS file, which is used in connection with the Squish
  2890.     area lastreads.
  2891.  
  2892.     If this path is not defined, GoldED will instead take the one
  2893.     specified with AREAFILE Squish or AREAFILE Maximus (whichever
  2894.     comes first), or failing that, use the MAXIMUS or SQUISH
  2895.     environment variables. If even that fails, the AREAPATH or
  2896.     GOLDPATH is used.
  2897.  
  2898.  
  2899. STATUSLINECLOCK <yes/no>  (no)
  2900.  
  2901.     In this release, the clock is only updated when the statusline is
  2902.     updated (usually when keys are pressed), and stands still when
  2903.     not. In a later release, I'll add some optional timer trickery so
  2904.     that it will be updated continuously (at the expense of
  2905.     performance under multitaskers). No promises when that will
  2906.     happen.
  2907.  
  2908.  
  2909. STATUSLINEHELP <yes/no>  (no)
  2910.  
  2911.     If enabled, GoldED will replace the "logo" in the left side of the
  2912.     statusline with a text saying "F1 Help". This is for use in "point
  2913.     package" setups where the user may be a complete novice, maybe
  2914.     even to computers, and who needs to be guided to the help screens.
  2915.     The "F1 Help" text is configurable with the ST_STATUSLINEHELP
  2916.     language keyword (put it in GOLDLANG.CFG).
  2917.  
  2918.  
  2919. SWAPPATH <path>  (defaults to TEMPPATH)
  2920.  
  2921.     Defines where the swap file will be placed in case of disk
  2922.     swapping in DOS shells. It is recommended that this points to a
  2923.     RAM disk, if available. GoldED needs 3-500k free disk space for
  2924.     the swapfile, depending on the overlay buffer size specified with
  2925.     the -O commandline switch.
  2926.  
  2927.     This keyword is ignored in the 386 and OS/2 versions.
  2928.  
  2929.  
  2930. TEARLINE <string>  (@longpid @version)
  2931.  
  2932.     Here you can define your default tearline. The tearline can be up
  2933.     to 76 chars long (excluding the leading "--- "), but beware that
  2934.     policies (such as FidoNet ECHOPOL1) may set a significantly lower
  2935.     limit (around 30).
  2936.  
  2937.     This keyword can be used globally and in a Random System group.
  2938.  
  2939.     Tearlines defined in the Random System *always* overrides the
  2940.     default tearline defined with this keyword.
  2941.  
  2942.     If your tearline does not contain at least the string "GoldED" or
  2943.     "GED", GoldED will automatically insert it's PID kludge.
  2944.  
  2945.     NOTE: The tearline redefinition feature is only fully functional
  2946.     for registered users. Unregistered users are only be able to
  2947.     define their own tearline in one area, defined with the FREETEAR
  2948.     keyword.
  2949.  
  2950.  
  2951. TEMPLATE <file> ["desc"]  (GOLDED.TPL)
  2952.  
  2953.     You can define many different template files. The templates can be
  2954.     switched using the READchangetemplate popup menu or the EDITMENU.
  2955.  
  2956.     The optional "desc" can be used to give the templates more
  2957.     meaningful names like "International template" instead of just
  2958.     plain "C:\GOLDED\GOLDED.TPL".
  2959.  
  2960.     This keyword can be used globally and in a Random System group.
  2961.  
  2962.     The Random System always overrides the default templates, except
  2963.     when selected from the EDITMENU.
  2964.  
  2965.  
  2966. TEMPLATEPATH <path>  (defaults to the GOLDPATH)
  2967.  
  2968.     Defines the default path for msg templates. Use this if you want
  2969.     to place templates in a path separate from the GOLDPATH.
  2970.  
  2971.  
  2972. TEMPPATH <path>
  2973.  
  2974.     Defines the directory where temporary files are placed by GoldED
  2975.     and GoldNODE.
  2976.  
  2977.     This path should *NOT* point to a RAM disk or other volatile
  2978.     media!  The editor autosave file is placed here, and will almost
  2979.     certainly be lost if a RAM disk is used...
  2980.  
  2981.     GoldNODE uses this path to store a temporary file which can become
  2982.     as large as the largest index file (GOLDNODE.GXN), so again, don't
  2983.     point it to a small RAM disk. If GoldNODE cannot find a TEMPPATH,
  2984.     it will use the NODEPATH instead.
  2985.  
  2986.  
  2987. TIMEOUT <seconds>  (360)
  2988.  
  2989.     Similar to the screen blanking (SCREENBLANKER) feature, GoldED can
  2990.     auto-exit after a specified period of time. Useful if you are in a
  2991.     hurry (or didn't get enough sleep last night ;-), and run GoldED
  2992.     from your mailer shell. The timeout value can be overridden with
  2993.     the -T commandline option.
  2994.  
  2995.     NOTE: This feature is currently not functional.
  2996.  
  2997.  
  2998. TIMEOUTSAVEMSG <yes/no>  (yes)
  2999.  
  3000.     If set to YES, GoldED behaves as usual: It saves the (perhaps
  3001.     partially written) msg text in the internal editor to the msgbase
  3002.     and exits. If set to NO, GoldED will save the msg text in
  3003.     GOLDED.MSG just as if EDITAUTOSAVE function was in use and the
  3004.     power went out. Next time you started GoldED and entered a msg, it
  3005.     would detect the "lost" msg and ask you if it should be continued.
  3006.  
  3007.     NOTE: This feature is currently not functional.
  3008.  
  3009.  
  3010. TIMESLICE <type>  (none)
  3011.  
  3012.     This keyword is no longer functional and is obsolete. Since
  3013.     version 2.50, GoldED uses a non-polling keyboard handler, so it
  3014.     does not have to worry about timeslicing.
  3015.  
  3016.  
  3017. TWITMODE <mode>  (Show)
  3018.  
  3019.     In GoldED you can define several "Twit" names, addresses or
  3020.     subjects. With this keyword you can specify the action taken when
  3021.     a Twit message is encountered.
  3022.  
  3023.     The <mode> can be one of the following:
  3024.  
  3025.       Show    Show twit messages.
  3026.       Blank   Blank twit messages.
  3027.       Skip    Skip twit messages, unless to your USERNAME's.
  3028.       Ignore  Skip twit messages, always.
  3029.  
  3030.     This keyword can be used globally and in a Random System group.
  3031.  
  3032.  
  3033. TWITNAME <name/address>
  3034.  
  3035.     With this keyword, you can specify "Twit" names and/or addresses.
  3036.     When a Twit name/address is detected, the TWITMODE setting will
  3037.     determine the action taken.
  3038.  
  3039.  
  3040. TWITSUBJ <"string">
  3041.  
  3042.     With this keyword, you can specify "Twit" subjects. When a Twit
  3043.     subject is detected, the TWITMODE setting will determine the
  3044.     action taken. The subject string is searched in the entire subject
  3045.     text, so you can specify a partial twit subject. Twit subjects are
  3046.     limited to maximum 35 characters.
  3047.  
  3048.  
  3049. USEFLAGS <yes/no>  (yes)
  3050.  
  3051.     If enabled, GoldED inserts the FLAGS kludge for certain extended
  3052.     attributes, as defined in FSC-0053 by Joaquim H. Homrighausen, and
  3053.     supported by FrontDoor, D'Bridge, IMail and other modern software.
  3054.     GoldED uses FLAGS to emulate the Hold and Freq attributes which
  3055.     are not defined in the Hudson message format.
  3056.  
  3057.  
  3058. USEINTL <type>  (yes)
  3059.  
  3060.     The INTL kludge is normally only inserted in netmail messages, if
  3061.     the origination zone is different from the destination zone (the
  3062.     "Auto" setting), but on systems with many AKA's in the mailer, it
  3063.     might be useful/necessary to add it ALWAYS (the "Yes" setting).
  3064.     The "No" option should never be used.
  3065.  
  3066.     The <type> can be one of the following:
  3067.  
  3068.       Auto  Only insert in inter-zone netmail.
  3069.       Yes   Always insert. Recommended and default.
  3070.       No    Never insert.
  3071.  
  3072.  
  3073. USEMSGID <yes/no>  (yes)
  3074.  
  3075.     If enabled, the MSGID kludge is inserted in netmail and echomail,
  3076.     and the REPLY kludge is inserted when replying to a msg with a
  3077.     MSGID.
  3078.  
  3079.     The MSGID kludge is defined in FidoNet document FTS-9.
  3080.  
  3081.  
  3082. USERLIST <file> [zone/addr]
  3083.  
  3084.     In addition to normal nodelist support, GoldED also supports the
  3085.     "FIDOUSER.LST" style userlist format. The default zone is defined
  3086.     by the first ADDRESS or AKA, but can be overridden by adding the
  3087.     zone number or a full address after the filename.
  3088.  
  3089.       <file>        Userlist file in FIDOUSER.LST format.
  3090.       [zone/addr]   Default address for the userlist (if no zone info
  3091.                     is present).
  3092.  
  3093.  
  3094. USERLISTFILE <file>  (GOLDED.LST)
  3095.  
  3096.     GoldED can generate a list of all users in the current area. This
  3097.     keyword defines the default name of the FIDOUSER.LST style
  3098.     userlist output file generated with the READmakeuserlist command.
  3099.  
  3100.  
  3101. USERNAME <name>[,address]
  3102.  
  3103.     You can define many different names/aliases. When GoldED finds an
  3104.     un-received message to one of your USERNAME's, it is marked as
  3105.     received. Useful if you use alias names in some conferences. It is
  3106.     possible to change the current name using the READchangeusername
  3107.     popup menu.
  3108.  
  3109.     For msgbase formats with an associated user database, GoldED uses
  3110.     the *first* defined USERNAME to look in the user database for
  3111.     which lastread record to use. If your name is not found, it is
  3112.     added and a new lastread record created.
  3113.  
  3114.     This keyword can be used globally and in a Random System group.
  3115.  
  3116.  
  3117. VIEWHIDDEN <yes/no>  (yes)
  3118.  
  3119.     Hidden lines are "unknown" kludge lines. If enabled, hidden lines
  3120.     will be displayed (in a different color) when reading msgs.
  3121.  
  3122.     A hidden line is defined as a line which has the FidoNet kludge
  3123.     char (^a, ASCII 1) as the first char and is not on the list of
  3124.     internally or user defined known kludges.
  3125.  
  3126.     This keyword can be used globally and in a Random System group.
  3127.  
  3128.     IMPORTANT NOTE:
  3129.  
  3130.     In some conferences the hidden lines are used to give witty
  3131.     comment "between the lines" in the plain text, but generally it is
  3132.     considered a bad practice and should be avoided because it may
  3133.     cause severe technical problems if a witty comment in a hidden
  3134.     line happens to match a (perhaps experimentally) defined kludge
  3135.     somewhere. It should also be noted that hidden lines are not kept
  3136.     in their original places when used in the JAM msgbase. This is due
  3137.     to the way the JAM specification stores FidoNet kludges.
  3138.     
  3139.  
  3140. VIEWKLUDGE <yes/no>  (no)
  3141.  
  3142.     If enabled, known kludge lines will be displayed (in a different
  3143.     color) when reading msgs.
  3144.  
  3145.     Known kludges are those defined internally in GoldED plus those
  3146.     defined with the KLUDGE keyword.
  3147.  
  3148.     This keyword can be used globally and in a Random System group.
  3149.  
  3150.  
  3151. WHOTO <name>
  3152.  
  3153.     This name is inserted in the TO: name field, when entering new
  3154.     messages (not replies) in echomail or local areas.
  3155.  
  3156.     This keyword can be used globally and in a Random System group.
  3157.  
  3158.  
  3159. XLATCHARSET <importid> <exportid> <file>
  3160.  
  3161.     This keyword defines character set translation table files.
  3162.  
  3163.       <importid>    Charset import identifier.
  3164.       <exportid>    Charset export identifier.
  3165.       <file>        Charset translation table file.
  3166.  
  3167.     See the Character Translation chapter for details.
  3168.  
  3169.  
  3170. XLATESCSET <import> <export> <escfile>
  3171.  
  3172.     This keyword defines escape sequence translation table files.
  3173.  
  3174.       <importid>    Escset import identifier.
  3175.       <exportid>    Escset export identifier.
  3176.       <file>        Escape sequence translation table file.
  3177.  
  3178.     See the Character Translation chapter for details.
  3179.  
  3180.  
  3181. XLATEXPORT <charsetid>
  3182.  
  3183.     Defines the export charset for your messages. See the Character
  3184.     Translation chapter for details.
  3185.  
  3186.     This keyword can be used globally and in a Random System group.
  3187.  
  3188.  
  3189. XLATIMPORT <charsetid>  (IBMPC)
  3190.  
  3191.     Defines the local charset for your machine. See the Character
  3192.     Translation chapter for details.
  3193.  
  3194.     This keyword can be used globally and in a Random System group.
  3195.  
  3196.  
  3197. XLATPATH <path>
  3198.  
  3199.     This is the path where GoldED tries to find the XLATCHARSET and
  3200.     XLATESCSET files.
  3201.  
  3202.  
  3203. ZONEGATING <yes/no/ask>  (ask)
  3204.  
  3205.     When writing a netmail message to a destination in another zone,
  3206.     you can either send the message directly (No) or via the local
  3207.     ZoneGate (Yes). You can also be consulted each time (Ask).
  3208.  
  3209.  
  3210. ______________________________________________________________________
  3211.  
  3212.                      Message Attributes Reference
  3213. ______________________________________________________________________
  3214.  
  3215.  
  3216. This is a list and description of all message attributes that are
  3217. supported by GoldED in the keywords that accept attribute settings or
  3218. can be displayed in the header.
  3219.  
  3220. A/S   Archive/sent.
  3221. ARQ   Audit request.
  3222. ATT   File attached.
  3223. CFM   Confirmation receipt requested.
  3224. COV   Fax cover letter.
  3225. CRA   Crash - high priority mail.
  3226. DEL   Deleted.
  3227. DIR   Direct. Don't route this message.
  3228. FAX   Fax image attached.
  3229. FRQ   File request.
  3230. GRP   Group message.
  3231. HIR   Fax hi-resolution image.
  3232. HLD   Hold for pickup.
  3233. HUB   Host- or Hub-route message.
  3234. IMM   Immediate - Send message NOW!
  3235. K/S   Kill/sent. Delete message automatically after it is sent.
  3236. KFS   Kill/file/sent. Delete attached files after they are sent.
  3237. LET   Fax letterhead.
  3238. LOC   Local. Message was written on your system.
  3239. LOK   Lock. Prevents send/delete/purge/editing.
  3240. ORP   Orphan. Could not be sent because destination node is unknown.
  3241. PVT   Private. Message may only be read by the addressee and author.
  3242. R/O   Read only. Used in area definitions to prevent writing.
  3243. RCV   Received. Read by the addressee.
  3244. RRC   Return receipt.
  3245. RRQ   Return receipt requested.
  3246. RSV   FTS-1 reserved (unused) attribute.
  3247. SIG   Fax signature.
  3248. SNT   Sent. Message has been sent or exported from the msgbase.
  3249. TFS   Truncate/file/sent. Truncate files to zero length when sent.
  3250. TRS   Transit. Message passing through, not for you.
  3251. UNS   Unsent message.
  3252. URQ   Update file request.
  3253. XMA   Xmail. Attach does not conform to the ARCmail 0.60 standard.
  3254. ZON   Zonegate. Route through zonegate if possible.
  3255.  
  3256.  
  3257. ______________________________________________________________________
  3258.  
  3259.                           Area Configuration
  3260. ______________________________________________________________________
  3261.  
  3262.  
  3263. GoldED offers a wide variety of methods for defining message areas.
  3264. You can define each area manually in the GOLDED.CFG file (or an
  3265. INCLUDE'ed GOLDAREA.CFG file), or you can tell GoldED to read the area
  3266. setup files of many popular BBS/mailer/mail processor packages.
  3267.  
  3268. For manual definition of areas, use the AREA or AREADEF (recommened)
  3269. keywords.
  3270.  
  3271. For external area configuration, the general syntax for the AREAFILE
  3272. keyword is:
  3273.  
  3274.   AREAFILE <programname> [path or filename(s)] [-options]
  3275.  
  3276. Available options:
  3277.  
  3278. -NoChk
  3279.  
  3280.     Normally GoldED will check the areafile timestamps when starting
  3281.     up, and recompile the configuration if a file was changed. If this
  3282.     option is given for any AREAFILE, those areafiles will not be
  3283.     checked. This can be useful in cases like TosScan, GEcho, IMail
  3284.     and several others which "touch" their files every time they run.
  3285.  
  3286.  
  3287. -S<sortspec>
  3288.  
  3289.     If you are *not* using the global AREALISTSORT keyword for sorting
  3290.     all the areas, you can sort the areas of each AREAFILE separately.
  3291.     See the AREALISTSORT keyword for the definition of <sortspec>.
  3292.  
  3293.  
  3294. If no path is specified, the appropriate environment variable or the
  3295. AREAPATH is used to find the files.
  3296.  
  3297. The <programname> can be one of the following:
  3298.  
  3299. AreasBBS
  3300.  
  3301.     GoldED is can handle a wide variety of AREAS.BBS type files. It
  3302.     can read and distinguish between the old CONFMAIL style with paths
  3303.     for *.MSG areas, the Hudson/Goldbase style with board numbers, the
  3304.     Squish style with "$basename" and the JAM style with "!basename".
  3305.  
  3306.     The disadvantage of using an AREAS.BBS is that there are no area
  3307.     descriptions. The echoid is used as description instead. However,
  3308.     GoldED will use any text behind a semicolon on definition lines as
  3309.     description. This may or may not be compatible with mail
  3310.     processors, so be careful. A better solution may be to use the
  3311.     AREAFILE Echolist to add descriptions from a separate file.
  3312.  
  3313.     One or more AREAS.BBS files may be specified on the same line.
  3314.  
  3315.  
  3316. D'Bridge
  3317.  
  3318.     Reads the DBRIDGE.AA1/.AA2 files (for version 1.30) or the
  3319.     DBRIDGE.ADF of the later versions.
  3320.  
  3321.     Looks for the "DBRIDGE" and "DB" environment variables.
  3322.  
  3323.  
  3324. Dutchie
  3325.  
  3326.     Reads the DUTCHIE.ARE file.
  3327.  
  3328.     Looks for the "DUTCHIE" environment variable.
  3329.  
  3330.  
  3331. Echolist
  3332.  
  3333.     Reads a simple ascii-text file containing an echolist in this
  3334.     format:
  3335.  
  3336.       <echoid> <description>
  3337.  
  3338.     This feature adds descriptions to already existing areas in
  3339.     GoldED. Example:
  3340.  
  3341.       AREAFILE AreasBBS AREAS.BBS
  3342.       AREAFILE EchoList ECHOLIST.TXT
  3343.  
  3344.     Descriptions for unknown echoids are ignored. Blank lines and
  3345.     lines beginning with characters which are illegal in echoids (such
  3346.     as ';') are also ignored.
  3347.  
  3348.  
  3349. Ezycom
  3350.  
  3351.     Reads CONFIG.EZY and MESSAGES.EZY. Supports Ezycom 1.02 and 1.10g,
  3352.     but not 1.01.
  3353.  
  3354.     Looks for the "EZY" and "TASK" environment variables.
  3355.  
  3356.  
  3357. FastEcho
  3358.  
  3359.     Reads the FASTECHO.CFG file. Supports all versions up to 1.41.
  3360.  
  3361.     Looks for the "FASTECHO" environment variable.
  3362.  
  3363.  
  3364. FidoPCB
  3365.  
  3366.     Reads FIDOPCB.CFG Supports version 1.x.
  3367.  
  3368.     Looks for the "FIDOPCB" environment variable.
  3369.  
  3370.  
  3371. FMail
  3372.  
  3373.     Reads FMAIL.CFG and FMAIL.AR. Supports versions 0.92 and 0.98.
  3374.  
  3375.     Looks for the "FMAIL" environment variable.
  3376.  
  3377.  
  3378. FrontDoor
  3379.  
  3380.     Reads the SETUP.FD/FD.SYS and FOLDER.FD/FOLDER.SYS files. If you
  3381.     want the real echoid's attached to the areas, you will also need
  3382.     to supply the filename of the relevant AREAS.BBS file(s). Supports
  3383.     versions 1.99c and 2.xx.
  3384.  
  3385.     Looks for the "FD" environment variable.
  3386.  
  3387.  
  3388. GEcho
  3389.  
  3390.     Reads SETUP.GE and AREAFILE.GE. Supports versions 1.00, 1.02 and
  3391.     1.10.
  3392.  
  3393.     Looks for the "GE" environment variable.
  3394.  
  3395.  
  3396. IMAIL
  3397.  
  3398.     Reads the IMAIL.CF and IMAIL.AR files. Supports all versions up to
  3399.     1.50.
  3400.  
  3401.     Looks for the "IMAIL" environment variable.
  3402.  
  3403.  
  3404. InterMail
  3405.  
  3406.     Reads the FD.SYS and FOLDER.CFG/IMFOLDER.CFG files. Supports
  3407.     version 2.26 and newer.
  3408.  
  3409.     Looks for the "IM" environment variable.
  3410.  
  3411.  
  3412. LoraBBS
  3413.  
  3414.     Reads the CONFIG.DAT and SYSMSG.DAT files. Supports version 2.33
  3415.     and newer.
  3416.  
  3417.     Looks for the "LORA" and "LORABBS" environment variables.
  3418.  
  3419.  
  3420. Maximus
  3421.  
  3422.     Reads the AREA.DAT file. Compatible with both the old (1.xx) and
  3423.     new (2.xx) formats. If your AREA.DAT is named differently, you
  3424.     must supply the correct filename.
  3425.  
  3426.     Looks for the "MAXIMUS" environment variable.
  3427.  
  3428.  
  3429. ME2
  3430.  
  3431.     Reads the old ME2 editor AREADESC.ME2 file and AREAS.BBS file(s).
  3432.     You must supply the names of both files.
  3433.  
  3434.  
  3435. Opus
  3436.  
  3437.     Reads the Opus 1.1x SYSTEM??.DAT files or the Opus 1.7x SYSMSG.DAT
  3438.     file.
  3439.  
  3440.     Looks for the "OPUS" environment variable.
  3441.  
  3442.  
  3443. PCBoard
  3444.  
  3445.     Reads the PCBOARD.DAT, CNAMES.@@@ and CNAMES.ADD files. Supports
  3446.     version 14.x and 15.x. Note that echoid's are not read from this
  3447.     format. The description is used as echoid.
  3448.  
  3449.     Looks for the "PCBOARD" environment variable.
  3450.  
  3451.  
  3452. Portal
  3453.  
  3454.     Reads the PORTAL*.CFG and PORTAL.ARE files.
  3455.  
  3456.     Looks for the "POPCMDLINE" environment variable.
  3457.  
  3458.  
  3459. QuickBBS
  3460.  
  3461.     Reads the CONFIG.BBS or QUICKCFG.DAT+MSGCFG.DAT files. To get the
  3462.     real echoid's, you must also supply the filename of the relevant
  3463.     AREAS.BBS.
  3464.  
  3465.     Looks for the "QUICKBBS" and "QBBS" environment variables.
  3466.  
  3467.  
  3468. RaEcho
  3469.  
  3470.     Reads AREAS.RAE. Supports version 1.00 and 1.01.
  3471.  
  3472.     Looks for the "RAECHO" environment variable.
  3473.  
  3474.  
  3475. RemoteAccess
  3476.  
  3477.     Reads the MESSAGES.RA file. To get the real echoid's, you must
  3478.     also supply the filename of the relevant AREAS.BBS. Supports
  3479.     versions 0.xx, 1.xx and 2.xx.
  3480.  
  3481.     Looks for the "RA" environment variable.
  3482.  
  3483.  
  3484. Squish
  3485.  
  3486.     Reads SQUISH.CFG and AREAS.BBS (if used). Supports version 1.0x
  3487.     and 1.10. The "Include <filename>" feature of Squish 1.10 is also
  3488.     supported.
  3489.  
  3490.     Looks for the "MAXIMUS" environment variable. Note that Squish
  3491.     itself does not use any environment variables (or if it does, it
  3492.     is not documented).
  3493.  
  3494.  
  3495. SuperBBS
  3496.  
  3497.     Reads CONFIG.BBS, SCONFIG.BBS and BOARDS.BBS. Supports version
  3498.     1.16 and 1.17.
  3499.  
  3500.     Looks for the "SUPERBBS" and "SBBS" environment variables.
  3501.  
  3502.  
  3503. TosScan
  3504.  
  3505.     Reads the FD.SYS/SETUP.FD and AREAFILE.FD files. Supports version
  3506.     1.00 and FrontDoor 1.99c and 2.xx.
  3507.  
  3508.     Looks for the "FD" environment variable.
  3509.  
  3510.  
  3511. WMail
  3512.  
  3513.     Reads the WMAIL.PRM and AREAS.PRM files. Supports version 2.2.
  3514.  
  3515.     Looks for the "WMAIL" environment variable.
  3516.  
  3517.  
  3518. XMail
  3519.  
  3520.     Reads the AREAS.XM file. Supports version 1.00.
  3521.  
  3522.     Looks for the "XM" environment variable.
  3523.  
  3524.  
  3525. ______________________________________________________________________
  3526.  
  3527.                          Color Configuration
  3528. ______________________________________________________________________
  3529.  
  3530.  
  3531. Color configuration in GoldED is a bit complicated, and you probably
  3532. have to experiment quite a bit, if you want make your own setup. For
  3533. your convenience, I have added a number of example color setups,
  3534. provided by some of my many good users. I suggest you try them all and
  3535. use the one that suits you best, perhaps tuning it a bit to your
  3536. taste.
  3537.  
  3538. The COLOR keyword uses the following syntax:
  3539.  
  3540. COLOR <window> <part> <colors>.
  3541.  
  3542.   <window>  AREA, ASK, BACKGROUND, BRAG, HEADER, HELP, INFO, MENU,
  3543.             READER, SHADOW, STATUS.
  3544.  
  3545.   <part>    BLOCK, BORDER, BTYPE, EDIT, HIDDEN, HIGHLIGHT, INPUT,
  3546.             KLUDGE, NOSELECT, ORIGIN, QUOTE, SELECTOR, TEARLINE,
  3547.             TITLE, WINDOW.
  3548.  
  3549. The <colors> are composed of [blinking] <ink> [on <paper>].
  3550.  
  3551.   <ink>     Black, Blue, Green, Cyan, Red, Magenta, Brown, LGrey,
  3552.             DGrey, LBlue, LGreen, LCyan, LRed, LMagenta, Yellow,
  3553.             White.
  3554.  
  3555.   <paper>   Black, Blue, Green, Cyan, Red, Magenta, Brown, LGrey.
  3556.  
  3557. For monochrome setups we instead have:
  3558.  
  3559.   <ink>     Normal, Highlight, Reverse, Underline.
  3560.  
  3561. The SHADOW color does not need a <part>, because it is global.
  3562.  
  3563. The paper color always defaults to Black if not specified.
  3564.  
  3565. If <part> is "BTYPE", the <color> is a value in the range 0-3, which
  3566. defines the type of lines used when drawing menus and windows:
  3567.  
  3568. BTYPE 0 is single horizontal and single vertical lines.
  3569. BTYPE 1 is double horizontal and double vertical lines.
  3570. BTYPE 2 is single horizontal and double vertical lines.
  3571. BTYPE 3 is double horizontal and single vertical lines.
  3572.  
  3573. The default border type is always BTYPE 0.
  3574.  
  3575. The following is a description of the different window parts:
  3576.  
  3577. Various general color items
  3578.  
  3579.   SHADOW              Shadow below windows and menus.
  3580.   STATUS WINDOW       Status line at the bottom.
  3581.   BACKGROUND WINDOW   Background for the startup window.
  3582.  
  3583. Startup screen / logo window
  3584.  
  3585.   BRAG WINDOW         The Copyright window.
  3586.   BRAG BORDER         Lines around the Copyright window.
  3587.   BRAG TITLE          The logo text.
  3588.   BRAG HIGHLIGHT      The inner logo lines.
  3589.   BRAG BLOCK          The outer logo lines.
  3590.   BRAG BTYPE          Copyright window border type.
  3591.  
  3592. Area Selection Menu
  3593.  
  3594.   AREA WINDOW         Descriptions, the top line (inc. search).
  3595.   AREA BORDER         Lines.
  3596.   AREA TITLE          Titles on the border.
  3597.   AREA SELECTOR       Selection bar.
  3598.   AREA HIGHLIGHT      The color for the area marks.
  3599.   AREA BTYPE          Window border type.
  3600.  
  3601. Message Header
  3602.  
  3603.   HEADER WINDOW       Header text.
  3604.   HEADER BORDER       Lines.
  3605.   HEADER TITLE        Titles on the border.
  3606.   HEADER INPUT        Message number input field.
  3607.   HEADER EDIT         Header input fields.
  3608.   HEADER HIGHLIGHT    Marks.
  3609.   HEADER BTYPE        Window border type.
  3610.  
  3611. Message Text
  3612.  
  3613.   READER WINDOW       Normal message text.
  3614.   READER BORDER       The Pagebar.
  3615.   READER QUOTE        Quoted lines.
  3616.   READER CURSOR       Character at cursor pos. (int. editor).
  3617.   READER KLUDHIDD     Kludges and hidden lines.
  3618.   READER TEARORIG     Tearline and Origin.
  3619.   READER BLOCK        Block color (internal editor).
  3620.   READER BTYPE        Window border type.
  3621.   READER HIGHLIGHT    Search highlight in the message text.
  3622.  
  3623. Miscellaneous Smaller Menus
  3624.  
  3625.   ASK WINDOW          Menu items.
  3626.   ASK BORDER          Lines.
  3627.   ASK TITLE           Menu title.
  3628.   ASK SELECTOR        Selection bar.
  3629.   ASK NOSELECT        Non-selectable menu items.
  3630.   ASK HIGHLIGHT       Hotkeys.
  3631.   ASK BTYPE           Window border type.
  3632.  
  3633. Miscellaneous Larger Menus (Browser Windows)
  3634.  
  3635.   MENU WINDOW         Menu items.
  3636.   MENU BORDER         Lines.
  3637.   MENU TITLE          Menu title.
  3638.   MENU SELECTOR       Selection bar.
  3639.   MENU NOSELECT       Non-selectable menu items.
  3640.   MENU HIGHLIGHT      Hotkeys/marks.
  3641.  
  3642. Help Screens
  3643.  
  3644.   HELP WINDOW         Help text.
  3645.   HELP BORDER         Lines.
  3646.   HELP SELECTOR       Current keyword.
  3647.   HELP HIGHLIGHT      Other keywords.
  3648.   HELP BTYPE          Window border type.
  3649.  
  3650. Pop Up Information Windows
  3651.  
  3652.   INFO WINDOW         Window text.
  3653.   INFO BORDER         Lines.
  3654.   INFO TITLE          Info title.
  3655.   INFO BTYPE          Window border type.
  3656.  
  3657. See the GEDCOL*.CFG and GEDMON*.CFG files for examples of color
  3658. configuration.
  3659.  
  3660.  
  3661. ______________________________________________________________________
  3662.  
  3663.                           The Random System
  3664. ______________________________________________________________________
  3665.  
  3666.  
  3667. With the Random System, you can define area-specific sets of origins,
  3668. netnames, tearlines, templates, usernames and many other items. If
  3669. more than one item of each type is specified, a random one is picked -
  3670. a Random System. This is a very useful feature when (for example)
  3671. participating in conferences with different languages.
  3672.  
  3673. The Random System is built on the idea of "groups". A group is a
  3674. collection of "items", belonging to the group. You can assign one or
  3675. more echomail areas, designated by their echoid's to a group. Groups
  3676. can also be specified for just a single echo, and DOS/4DOS-style
  3677. wildcards can be used to simplify the assignment of echoes with common
  3678. strings in their name, such as *.DK, SIG.* and so on. In this way, you
  3679. could for example setup one group for all national echoes, another for
  3680. special local echoes, a third for international echoes etc.
  3681.  
  3682.  
  3683. Defining Groups
  3684.  
  3685. The general syntax of a group definition is:
  3686.  
  3687. GROUP <id>[:]
  3688.     ; items go here
  3689.     [Member <id list>]
  3690.  
  3691. The Group <id> can be one of three things:
  3692.  
  3693. 1.  A group letter, matching the group letters used in the AREAFILE's
  3694.     of D'Bridge, GEcho, IMail, TosScan and probably others. To use
  3695.     this feature, you need to enable the AREAFILEGROUPS keyword, and
  3696.     the letter groups must be defined before any other group types.
  3697.  
  3698. 2.  An echoid or echoid mask (wildcards can be used). The items are
  3699.     simply defined below the Group line.
  3700.  
  3701. 3.  A group label, terminated by a colon (:). The group items are
  3702.     defined below the Group line. Echoes are assigned to the group by
  3703.     adding one or more Member statements.
  3704.  
  3705. You can't assign a group to another group. It will not harm, but it
  3706. also won't work :-)
  3707.  
  3708. Groups must defined with the most explicit groups first. GoldED simply
  3709. scans from beginning to end, and stops at the first group with a
  3710. matching <id> or Member list.
  3711.  
  3712.  
  3713. Defining Random Items
  3714.  
  3715. The random items are defined much like in the main GoldED
  3716. configuration file.
  3717.  
  3718. If more than one of each item is defined within a group, those items
  3719. will be picked randomly (hence the name "Random System"), while GoldED
  3720. collects items when entering an area.
  3721.  
  3722.  
  3723. Random System Example
  3724.  
  3725. Below is an example of how a Random System could be setup. Note how
  3726. the letter group 'D' goes first, followed by the explicit group
  3727. definitions for the NERDS and FOO echoes. Then comes the more general
  3728. groups (those with Label:'s), where the echoes are assigned with one
  3729. or more Member statements. At last there is the catch-all "Group *",
  3730. which works as the default group.
  3731.  
  3732.  
  3733. === Cut, GOLDRAND.CFG ===
  3734.  
  3735. Group D               ; Letter D for Danish echoes.
  3736.   Template DANSK.TPL
  3737.  
  3738. Group NERDS           ; For the NERDS echo.
  3739.   Origin "I am a Nerd. Take me to your Loser!"
  3740.  
  3741. Group FOO             ; This group is *only* for the FOO echo.
  3742.   Tearline FooED @rev
  3743.   Origin "Foo-ing my day away"
  3744.  
  3745. Group FooEchoes:
  3746.   Member *FOO*        ; Use wildcards to catch any other foo echo.
  3747.   Tearline FooED @rev
  3748.   Origin "This is a Foo-lish origin"
  3749.  
  3750. Group FidoNet:
  3751.   Member NET_DEV, WORLDPOL, INTERCOOK
  3752.   Member GREEN.029, C_ECHO, C_PLUSPLUS
  3753.   Origin "Fight-O-Net? Good name..."
  3754.   Template FIDONET.TPL
  3755.   Whoto Everyone
  3756.  
  3757. Group SigNet:
  3758.   Member SIG.*         ; The wildcard is VERY handy here ;-)
  3759.   Origin "To SIG or not to SIG..."
  3760.   Template SIGNET.TPL
  3761.  
  3762. Group *                ; This is default group
  3763.   Origin "Yet forgotten echo"
  3764.  
  3765. === Uncut ===
  3766.  
  3767. See the example GOLDRAND.CFG in the ADVANCED archive for a real-life
  3768. setup similar to the one I use myself.
  3769.  
  3770.  
  3771. ______________________________________________________________________
  3772.  
  3773.                          The Message Template
  3774. ______________________________________________________________________
  3775.  
  3776.  
  3777. The message template gives you a ready-made skeleton for writing your
  3778. messages in the editor. The template is one of GoldED's many strong
  3779. features. With this, you can eliminate the tedious typing of greetings
  3780. etc etc. GoldED also provides a number of replacement strings,
  3781. "tokens", to dynamically add message specific information to the
  3782. template.
  3783.  
  3784. As in the configuration file, a semicolon (;) first on the line makes
  3785. the line a comment. Any other line is put into the editor file, after
  3786. token expansion. Tokens are not case sensitive.
  3787.  
  3788. The following is a list of the tokens available:
  3789.  
  3790.  
  3791. Conditional tokens (these are replaced with a null string)
  3792.  
  3793. @changed    Line is only inserted in Changed msgs (from others).
  3794. @comment    Line is only inserted in Reply-Comments.
  3795. @echo       Line is only inserted in Echomail.
  3796. @forward    Line is only inserted in Forwarded messages.
  3797. @local      Line is only inserted in Local messages.
  3798. @moved      Line is only inserted in Reply-Moved messages.
  3799. @net        Line is only inserted in Netmail.
  3800. @new        Line is only inserted in New messages (not replies).
  3801. @position   Specifies the starting line for the editor cursor.
  3802. @quotebuf   Line is only inserted in Quotebuffered msgs.
  3803. @quoted     Line is only inserted in Quoted replies.
  3804. @reply      Line is only inserted in Non-Quoted Replies.
  3805.  
  3806.  
  3807. Insert tokens (anything else on the line is ignored)
  3808.  
  3809. @attrib     <attributes> - Adds specific message attributes.
  3810. @loadlanguage   Loads a partial language config file.
  3811. @message    Inserts the original message (in Forward & Change).
  3812. @quote      Inserts a quote of the original message.
  3813. @random     [random.txt [random.idx]] - Inserts random text.
  3814. @setfrom    <"from"> - Sets the message FROM: field.
  3815. @setsubj    <"subject"> - Sets the message SUBJ: field.
  3816. @setto      <"to"> - Sets the message TO: field.
  3817.  
  3818.  
  3819. Replacement tokens (replaced with message specific data):
  3820.  
  3821. @caddr      Current user address.
  3822. @cdate      Current date.
  3823. @cdesc      Current area description.
  3824. @cecho      Current echoid.
  3825. @cfname     Current user first name.
  3826. @clname     Current user last name.
  3827. @cname      Current user name.
  3828. @ctime      Current time.
  3829. @daddr      Destination address.
  3830. @dfname     Destination first name.
  3831. @dlname     Destination last name.
  3832. @dname      Destination name.
  3833. @longpid    Long program id. "GoldED", "GoldED/2" or "GoldED/386".
  3834. @oaddr      Original address.
  3835. @odate      Original date.
  3836. @odesc      Original area description if moved, else current.
  3837. @oecho      Original echoid if moved, otherwise current.
  3838. @ofname     Original first name.
  3839. @olname     Original last name.
  3840. @oname      Original name.
  3841. @os2slash   "/2" if running GoldED/2. Empty otherwise.
  3842. @otime      Original time.
  3843. @pid        Short program id. "GED", "GED/2" or "GED386".
  3844. @rev        The revision number (in the form mmdd).
  3845. @serialno   For registered users: The registration serialno.
  3846. @subject    The message subject line.
  3847. @taddr      Destination to address.
  3848. @tfname     Destination to first name.
  3849. @tlname     Destination to last name.
  3850. @tname      Destination to name.
  3851. @ver        The simple version number (in the form x.yy)
  3852. @version    The complete release version number of GoldED.
  3853. @_caddr     Current user address (fixed width: 19 chars).
  3854. @_cname     Current user name (fixed width: 34 chars).
  3855. @_daddr     Destination address (fixed width: 19 chars).
  3856. @_dname     Destination name (fixed width: 34 chars).
  3857. @_oaddr     Original address (fixed width: 19 chars).
  3858. @_oname     Original name (fixed width: 34 chars).
  3859. @_taddr     Destination to address (fixed width: 19 chars).
  3860. @_tname     Destination to name (fixed width: 34 chars).
  3861.  
  3862.  
  3863. The template text begins at the first non-comment line.
  3864.  
  3865. See the included GOLDED.TPL for example usage.
  3866.  
  3867.  
  3868. ______________________________________________________________________
  3869.  
  3870.                         The Online Help System
  3871. ______________________________________________________________________
  3872.  
  3873.  
  3874. GoldED has a built-in context sensitive help system, tied to the <F1>
  3875. key (one of the very few keys that cannot be reconfigured). It
  3876. contains a complete keyboard reference and help for most situations.
  3877. It is current not as complete or sophisticated as I'd like it myself,
  3878. but this may be improved in future versions.
  3879.  
  3880. You can completely redefine the help screens if you wish - the
  3881. GOLDHELP.CFG file is a plain ASCII text file which contains all help
  3882. definitions. The help file is split into several help categories. Here
  3883. is an example of a couple of defined help categories:
  3884.  
  3885.     *B 1,Help Category 1
  3886.     help text help text help text
  3887.     help text help text help text
  3888.     *P
  3889.     help text help text help text
  3890.     help text help text help text
  3891.     *E
  3892.  
  3893.     *B 2,Help Category 2
  3894.     help text help text help text
  3895.     help text help text help text
  3896.     *P
  3897.     help text help text help text
  3898.     help text help text help text
  3899.     See also: ^Help Category 1^
  3900.     *E
  3901.  
  3902. The "*B" indicator specifies the beginning of a help category. The
  3903. format is "*B helpcatnumber[,helpcatname]". In GoldED the help
  3904. categories are numbered 1000-9999, split into more or less logical
  3905. groups. See the help file for assignments. There should be only one
  3906. space between the "*B" and the help category number. The help category
  3907. name is only required for cross-references. If there are no
  3908. cross-references to that help category, then you can leave the
  3909. helpcatname parameter out.
  3910.  
  3911. The "*P" indicator specifies a page break and is optional. You may
  3912. have as many page breaks as you'd like. The "*E" indicator specifies
  3913. the end of the help category. The "*B", "*P", and "*E" indicators must
  3914. all begin in the first column. These indicators and the help category
  3915. name are case insensitive (can be in lowercase, uppercase, or mixed).
  3916.  
  3917. In the definition of Help Category 2, you will notice the
  3918. crossreference to Help Category 1. All cross-referencing is done by
  3919. embedding the cross- reference category name (not number) inside
  3920. carats (^). If you need to display a carat inside the help file, use a
  3921. double carat (^^).
  3922.  
  3923. Any text contained outside of the "*B" and "*E" is treated as
  3924. comments. If an "*E" is not found, then the end-of-file will be
  3925. treated as an "*E".
  3926.  
  3927. Not all of the help categories in this help file are actually used in
  3928. the current version of GoldED. The ones not used are empty, except for
  3929. a two-line "header".
  3930.  
  3931. The usable dimensions of the help window are 60 columns by 16 lines.
  3932. In the help file there is a model of the actual window.
  3933.  
  3934.  
  3935. ______________________________________________________________________
  3936.  
  3937.                         Character Translation
  3938. ______________________________________________________________________
  3939.  
  3940.  
  3941. GoldED implements several different proposals for character
  3942. translation in imported and exported messages:
  3943.  
  3944. FSC-0050  "Charset Identifier" Thomas Sundblom (2:201/114).
  3945. FSC-0051  "I51" Thomas Gradin (2:200/108).
  3946. FSC-0054  "CHARSET proposal" Duncan McNutt (2:243/100).
  3947. No FSC    "Composed Characters" Andre van de Wijdeven (2:500/131).
  3948.  
  3949. FSC-0050 is currently known to be implemented in the OPMED 3.xx
  3950. message editor, and in Opus 1.7x. It uses the same identifier as
  3951. FSC-0054 (a ^aCHARSET kludge), but is a lot simpler (but not
  3952. necessarily better).
  3953.  
  3954. The "I51" and "CHARSET" proposals are in the process of being merged
  3955. to one proposal, which should combine the advantages of both. They are
  3956. both based on using the LATIN-1 (also known as ISO 8859-1) character
  3957. set for extended ASCII. The LATIN-1 set is the same set used by
  3958. Windows 3.xx, Amiga and many other non-PC computers. In addition to
  3959. LATIN-1, I51 defines a set of so-called escape sequences for
  3960. characters not found in the LATIN-1 set.
  3961.  
  3962. "Composed Characters" became quite popular in Holland, but the author
  3963. decided to drop his proposal because it relied on escape sequences
  3964. using the so called "soft-cr" (141d, 8Dh) character. GoldED will
  3965. continue to support Composed as long as it seems necessary.
  3966.  
  3967. If you want to know more about the details, I suggest you read the
  3968. proposals or contact the authors.
  3969.  
  3970. GoldED currently supports two types of translation tables, the *.ESC
  3971. files and the *.CHS files.
  3972.  
  3973.  
  3974. The *.ESC files are used for import translation of the escape
  3975. sequences defined in I51 and Composed Characters.
  3976.  
  3977. In the ESC files, the semicolon is used for comments. The *first*
  3978. non-comment line defines the charset the escape code are mapped TO.
  3979. This is normally IBMPC, and should not be changed. Any other
  3980. non-comment line is treated as an escape sequence definition with this
  3981. syntax:
  3982.  
  3983.   <esc1><esc2><space><map chars>[; comment/description]
  3984.  
  3985. Leading spaces are *not* allowed in ESC files. <esc1> and <esc2> are
  3986. the two characters that define the escape sequence. <space> is ignored
  3987. and can be used to make the table look better. <map chars> defines the
  3988. local representation of the escape sequence, up to three characters.
  3989. Normally you would only map to one extended ascii character. The map
  3990. chars can be either the characters themselves, or decimal or
  3991. hexadecimal numbers of the form "\d<dec>" or "\x<hex>" (like in the C
  3992. programming language).
  3993.  
  3994.  
  3995. The *.CHS files are used for import and export translation of the
  3996. CHARSET type character sets, and export of I51 and Composed escape
  3997. sequences.
  3998.  
  3999. The CHS files uses the format of the raw text files provided in the
  4000. CHARSET3.ZIP example implementation of FSC-0054. Study some of the
  4001. files provided if you want to know how to define them.
  4002.  
  4003. The two keywords XLATESCSET and XLATCHARSET are used to define which
  4004. files belong to what import and export set. You can define more than
  4005. one import and export set for each file.
  4006.  
  4007. The keyword XLATIMPORT defines which charset you have on your own
  4008. machine - this would normally be "IBMPC". It can be useful to change
  4009. this (using the Random System) in areas where another character set
  4010. than IBMPC is the dominant (like Amiga or MacIntosh, whatever).
  4011.  
  4012. The keyword XLATEXPORT defines the charset your messages should be
  4013. exported to, if any.
  4014.  
  4015. Confused? Yeah, I know - this is a confusing subject, and my
  4016. implementation and documentation is far from perfect. Normally you
  4017. will not have to worry about it. Turn it off completely if you don't
  4018. understand it.
  4019.  
  4020.  
  4021. ______________________________________________________________________
  4022.  
  4023.                       Keyboard Command Reference
  4024. ______________________________________________________________________
  4025.  
  4026.  
  4027. Most of the GoldED keyboard commands can be reached with just one
  4028. keystroke. To ease operation for experienced users of other message
  4029. editors, GoldED comes with several sets of keys for each of the
  4030. keyboard commands - direct non-shifted keys, Alt/Ctrl-keys and
  4031. function keys. Many of these key assignments will be familiar for
  4032. users of Msged, Msged/Q, ME2 and FM.
  4033.  
  4034. The following is a list of all keyboard commands, sorted by type and
  4035. alphabetically, using the format
  4036.  
  4037.   <command>          <short description>
  4038.  
  4039. This list is also available in the context-sensitive help system on
  4040. the <F1> key.
  4041.  
  4042. It is possible to almost completely redefine the keyboard - this in
  4043. done in the GOLDKEYS.CFG file, which also handles macro definition
  4044. (see later).
  4045.  
  4046.  
  4047. Arealist commands:
  4048.  
  4049. AREAabort               Abort the arealist.
  4050. AREAaskexit             Exit GoldED, prompt for final decision.
  4051. AREAboardnos            Toggle sequential areas vs. board numbers.
  4052. AREAdosshell            Shell to DOS.
  4053. AREAheat                Heat highwatermarks.
  4054. AREAgotofirst           Move selection bar to first area.
  4055. AREAgotolast            Move selection bar to last area.
  4056. AREAgotonext            Move selection bar to next area.
  4057. AREAgotoprev            Move selection bar to previous area.
  4058. AREAjump                Move selection bar to next marked area.
  4059. AREAjumpnextmatch       Move selection bar to next matching area.
  4060. AREAquitnow             Exit immediately, no questions asked.
  4061. AREAscan                Scan areas - all or marked.
  4062. AREAselect              Enter the reader for the selected area.
  4063. AREAtoggle              Toggle mark on the selected area.
  4064. AREAzap                 Zap highwatermarks.
  4065.  
  4066.  
  4067. Internal editor commands:
  4068.  
  4069. EDITabort               Abort editing this message - ask first.
  4070. EDITanchor              Set a block "anchor" on the current line.
  4071. EDITaskexit             Exit from GoldED - ask first.
  4072. EDITcleardeletebuf      Clears the undelete buffer.
  4073. EDITclearpastebuf       Clears the cut'n'paste buffer.
  4074. EDITcut                 Cut the block to the cut'n'paste buffer.
  4075. EDITdelchar             Delete the char at the cursor position.
  4076. EDITdeleteeol           Delete from cursor position to end of line.
  4077. EDITdelleft             Delete the char to the left of the cursor.
  4078. EDITdelline             Delete the current line. (Copied to the
  4079. EDITdelltword           Delete the word to the left of the cursor.
  4080. EDITdelrtword           Delete the word to the right of the cursor.
  4081. EDITdosshell            Shell to DOS.
  4082. EDITdupline             Duplicates the current line.
  4083. EDITexitmsg             Drop this message - NO ASKING! DANGEROUS!
  4084. EDITexporttext          Exports the current block to a file.
  4085. EDITgobegline           Move cursor to beginning of line.
  4086. EDITgobotline           Move cursor to the bottom line in the display.
  4087. EDITgobotmsg            Move cursor to the last line in the message.
  4088. EDITgodown              Move cursor down to next line.
  4089. EDITgoeol               Move cursor to the end of the line.
  4090. EDITgoleft              Move cursor one position left.
  4091. EDITgopgdn              Move cursor one page of lines down.
  4092. EDITgopgup              Move cursor one page of lines up.
  4093. EDITgoright             Move cursor one position right.
  4094. EDITgotopline           Move cursor to the top line in the display.
  4095. EDITgotopmsg            Move cursor to the first line in the message.
  4096. EDITgoup                Move cursor up to the previous line.
  4097. EDITgowordleft          Move cursor to the previous word.
  4098. EDITgowordright         Move cursor to the next word.
  4099. EDITheader              Edit the message header, attributes etc.
  4100. EDITimportquotebuf      Imports the current quote buffer.
  4101. EDITimporttext          Import text file into this message.
  4102. EDITloadfile            Load the message file saved with EDITsavefile.
  4103. EDITlookupcursor        Lookup name/node at cursor position.
  4104. EDITlookupdest          Lookup TO: node.
  4105. EDITlookuporig          Lookup FROM: node.
  4106. EDITnewline             Terminate paragraph and/or add a new line.
  4107. EDITpaste               Paste a previously cut block at the cursor.
  4108. EDITquitnow             Quit GoldED immediately - no asking.
  4109. EDITsavefile            Saves the current message as a file.
  4110. EDITsavemsg             Save this message.
  4111. EDITspellcheck          Calls an external spell checker for the msg.
  4112. EDITtab                 Add spaces to the next tab-stop.
  4113. EDITtogglecase          Toggle the case of the cursor character.
  4114. EDITtoggleinsert        Toggle insert mode.
  4115. EDITtolower             Change the cursor character to lowercase.
  4116. EDITtoupper             Change the cursor character to uppercase.
  4117. EDITundelete            Undelete previously deleted lines.
  4118.  
  4119.  
  4120. File selection commands:
  4121.  
  4122. FILEabort               Abort file selection.
  4123. FILEaskexit             Exit GoldED - ask first.
  4124. FILEdosshell            Shell to DOS.
  4125. FILEgotofirst           Go to first file.
  4126. FILEgotolast            Go to last file.
  4127. FILEgotonext            Go to next file.
  4128. FILEgotoprev            Go to previous file.
  4129. FILEmark                Mark file.
  4130. FILEmarkall             Mark all files.
  4131. FILEquitnow             Quit GoldED immediately.
  4132. FILEselect              Select the marked file(s).
  4133. FILEtogglemark          Toggle file mark.
  4134. FILEunmark              Unmark file.
  4135. FILEunmarkall           Unmark all files.
  4136.  
  4137.  
  4138. Message lister commands:
  4139.  
  4140. LISTabort               Abort message lister.
  4141. LISTaskexit             Exit GoldED - ask first.
  4142. LISTdosshell            Shell to DOS.
  4143. LISTgotobookmark        Go to BookMark message.
  4144. LISTgotofirst           Go to first message.
  4145. LISTgotolast            Go to last message.
  4146. LISTgotonext            Go to next message.
  4147. LISTgotoprev            Go to previous message.
  4148. LISTmarkingoptions      Marking menu.
  4149. LISTquitnow             Quit GoldED immediately.
  4150. LISTselect              Go to reader at the selected message.
  4151. LISTtogglebookmark      Toggle BookMark on the selected message.
  4152. LISTtogglemark          Toggle Mark on the selected message.
  4153.  
  4154.  
  4155. Nodelist browser commands:
  4156.  
  4157. NODEabort               Abort nodelist browsing.
  4158. NODEaskexit             Exit GoldED - ask first.
  4159. NODEdosshell            Shell to DOS.
  4160. NODEgotofirst           Go to first node.
  4161. NODEgotolast            Go to last node.
  4162. NODEgotonext            Go to next node.
  4163. NODEgotoprev            Go to previous node.
  4164. NODEquitnow             Quit GoldED immediately.
  4165. NODEselect              Select node.
  4166.  
  4167.  
  4168. Message reader commands:
  4169.  
  4170. READaskexit             Exit GoldED, prompt for final decision.
  4171. READchangeaka           Change default AKA address for current area.
  4172. READchangeattrs         Change the attributes of the current message.
  4173. READchangemsg           Change current message.
  4174. READchangeorigin        Change default origin for the current area.
  4175. READchangetemplate      Change default template.
  4176. READchangeusername      Change default username.
  4177. READcommentmsg          Comment-Reply to message. (Reply to TO name).
  4178. READcopymoveforward     Enter the Copy/Move/Forward function menu.
  4179. READdecreasemargin      Decrease message margin. For test purposes.
  4180. READdeletemsg           Delete current/marked message(s). Ask first.
  4181. READdosshell            Shell to DOS.
  4182. READfidorenumber        Renumber Fido/Opus *.MSG files.
  4183. READfilerequest         Generate a filerequest from the current msg.
  4184. READfindall             Find string(s) in message header and text.
  4185. READfindheader          Find string(s) in message header.
  4186. READgotobookmark        Go to the "BookMark" message.
  4187. READgotodownlink        Go to the previous message in the replylink.
  4188. READgotofirstmsg        Go to the first message in the area.
  4189. READgotolastmsg         Go to the last message in the area.
  4190. READgotomsgno           Go to a specific message number.
  4191. READgotonextarea        Go directly to the next area.
  4192. READgotonextmsg         Go to the next message.
  4193. READgotoprevarea        Go directly to the previous area.
  4194. READgotoprevmsg         Go to the previous message.
  4195. READgotouplink          Go to the next message in the replylink.
  4196. READincreasemargin      Increase message margin. For test purposes.
  4197. READlookupdest          Lookup TO: node.
  4198. READlookuporig          Lookup FROM: node.
  4199. READmakeuserlist        Generate FIDOUSER.LST of users in the area.
  4200. READmarkingoptions      Enter the marking menu.
  4201. READmessagelist         Enter the message lister.
  4202. READmovecommentmsg      Comment-Reply in another area.
  4203. READmovequotemsg        Quote-Reply in another area.
  4204. READmsgcontinue         Page down or go to next message.
  4205. READmsgend              Display last part of current message.
  4206. READmsghome             Display first part of current message.
  4207. READmsglinedown         Scroll message display.
  4208. READmsglineup           Scroll message display.
  4209. READmsgpgdn             Page message display.
  4210. READmsgpgup             Page message display.
  4211. READnewarea             Enter the area selection screen.
  4212. READnewmsg              Start a new message.
  4213. READquitnow             Exit GoldED immediately, no questions asked.
  4214. READquotebuf            Append quote of the msg to the quotebuffer.
  4215. READquotemsg            Quote-Reply to message. (Reply to FROM name).
  4216. READreplymsg            Reply to the current message, without quoting.
  4217. READtogglebookmark      Toggle a "BookMark" on the current message.
  4218. READtogglehexdump       Toggle hexdump mode. For debugging purposes.
  4219. READtogglehiddklud      Toggle display of Hidden and Kludge lines.
  4220. READtogglehidden        Toggle display of Hidden lines.
  4221. READtogglekludge        Toggle display of Kludge lines.
  4222. READtogglemark          Toggle a message mark on the current message.
  4223. READtogglemarkread      Toggle "Read Marked" mode.
  4224. READtogglepagebar       Toggle the "PageBar" feature.
  4225. READtogglerot13         Toggle ROT13 encryption for the current msg.
  4226. READtogglerealmsgno     Toggle between seq. or real message numbers.
  4227. READtoggletwits         Toggle Twit display - Show/Blank/Skip/Ignore.
  4228. READtouchnetscan        Touches the SEMAPHORE NETSCAN file.
  4229. READwritemsg            Write message(s) to file or printer.
  4230.  
  4231.  
  4232. See the Key Reference below for a list of the key symbols you can use
  4233. in keyboard redefinition.
  4234.  
  4235.  
  4236. ______________________________________________________________________
  4237.  
  4238.                         Macros and Keystacking
  4239. ______________________________________________________________________
  4240.  
  4241.  
  4242. GoldED has a simple keyboard macro facility, which you can use to
  4243. automate certain common operations. In addition, a "keystacking"
  4244. facility allows you to create simple automatic macros on the fly.
  4245.  
  4246.  
  4247. The macro definition syntax is modelled after the syntax used in the
  4248. QEdit text editor:
  4249.  
  4250.   <assignment-key> Macro <commands or keys>
  4251.  
  4252. Macros are defined in the GOLDKEYS.CFG file, where you can also find
  4253. several examples.
  4254.  
  4255. By using the word "Auto" as <assignment-key>, you can even define a
  4256. special macro which will be automatically executed when you start
  4257. GoldED.
  4258.  
  4259.  
  4260. Keystacking is a special form of auto-macros. You simply specify a
  4261. bunch of keys to be "stacked" in the (special internal) keyboard
  4262. buffer for sequential execution.
  4263.  
  4264. You can either specify a default set of keystacking in the .CFG
  4265. configuration file, or override any default keystacking by typing the
  4266. keystack definitions at the GoldED commandline or the GEDCMD
  4267. environment variable.
  4268.  
  4269. See the Key Reference chapter for a list of the key symbols you can
  4270. use in macros and keystacking.
  4271.  
  4272.  
  4273. ______________________________________________________________________
  4274.  
  4275.                             Key Reference
  4276. ______________________________________________________________________
  4277.  
  4278.  
  4279. Below is the list of key symbols recognized by GoldED for
  4280. keyboard/macro definition and keystacking.
  4281.  
  4282. Unshifted function keys
  4283.  
  4284.     F1  F2  F3  F4  F5  F6  F7  F8  F9  F10  F11  F12
  4285.  
  4286. Shift-function keys
  4287.  
  4288.     #F1  #F2  #F3  #F4  #F5  #F6  #F7  #F8  #F9  #F10  #F11  #F12
  4289.  
  4290. Alt-function keys
  4291.  
  4292.     @F1  @F2  @F3  @F4  @F5  @F6  @F7  @F8  @F9  @F10  @F11  @F12
  4293.  
  4294. Ctrl-function keys
  4295.  
  4296.     ^F1  ^F2  ^F3  ^F4  ^F5  ^F6  ^F7  ^F8  ^F9  ^F10  ^F11  ^F12
  4297.  
  4298. Alt-Numbers
  4299.  
  4300.     @0  @1  @2  @3  @4  @5  @6  @7  @8  @9
  4301.  
  4302. Alt-Letters
  4303.  
  4304.     @A  @B  @C  @D  @E  @F  @G  @H  @I  @J  @K  @L  @M
  4305.     @N  @O  @P  @Q  @R  @S  @T  @U  @V  @W  @X  @Y  @Z
  4306.  
  4307. Ctrl-Letters
  4308.  
  4309.     ^A  ^B  ^C  ^D  ^E  ^F  ^G  ^H  ^I  ^J  ^K  ^L  ^M
  4310.     ^N  ^O  ^P  ^Q  ^R  ^S  ^T  ^U  ^V  ^W  ^X  ^Y  ^Z
  4311.  
  4312. Insert/Delete
  4313.  
  4314.     Ins  ^Ins  @Ins
  4315.     Del  ^Del  @Del
  4316.  
  4317. Home/End
  4318.  
  4319.     Home  ^Home  @Home
  4320.     End   ^End   @End
  4321.  
  4322. Page up/down
  4323.  
  4324.     PgUp  ^PgUp  @PgUp
  4325.     PgDn  ^PgDn  @PgDn
  4326.  
  4327. Cursor left/right
  4328.  
  4329.     Left   ^Left   @Left
  4330.     Right  ^Right  @Right
  4331.  
  4332. Cursor up/down
  4333.  
  4334.     Up    ^Up    @Up
  4335.     Down  ^Down  @Down
  4336.  
  4337. Misc other keys
  4338.  
  4339.     Esc  ^Grey*  Key5  Space  Tab  #Tab  @Tab  BackSpace  ^BackSpace
  4340.     @BackSpace  Enter  ^Enter  @Enter
  4341.  
  4342. Note that some of the Alt-keys, especially the cursor-related keys and
  4343. the F11/F12 keys, are "extended" keys normally only available on
  4344. systems with an extended keyboard bios. However, GoldED uses a few
  4345. tricks to make some the extended keys available on non-extended
  4346. systems.
  4347.  
  4348.  
  4349. ______________________________________________________________________
  4350.  
  4351.                          Language Definition
  4352. ______________________________________________________________________
  4353.  
  4354.  
  4355. GoldED allows you to almost completely redefine the language dependent
  4356. text in the program.
  4357.  
  4358. The language dependent text in GoldED is defined in the plain ASCII
  4359. text GOLDLANG.CFG file.
  4360.  
  4361. See the example language file for the actual method and format of
  4362. language redefinition.
  4363.  
  4364. If you are planning to translate the text in GoldED, you should also
  4365. look into the definition of the help screens.
  4366.  
  4367. If you think you have made a good set of translated files, you should
  4368. contact the nearest registration or support site for official
  4369. distribution of your files with future versions and/or with disk
  4370. registrations.
  4371.  
  4372. You do not need permission from the author before announcing or
  4373. distributing your own modified language files.
  4374.  
  4375.  
  4376. *** NOTE ***
  4377.  
  4378.  
  4379. In the continuing development of GoldED, it is impossible to
  4380. completely maintain backward compatibility of the language format or
  4381. the text defined there. New features may add and/or obsolete some
  4382. definitions, or may change the format of others.
  4383.  
  4384. The existing language file may contain definitions which are already
  4385. obsolete, but which I haven't had time to search for and remove, as
  4386. well as there may be some texts in GoldED which are not yet definable.
  4387. All this will of course be corrected in future versions. If you find
  4388. inconsistencies, please report them, because I may have overlooked
  4389. them.
  4390.  
  4391.  
  4392. ______________________________________________________________________
  4393.  
  4394.                      The Message Database Formats
  4395. ______________________________________________________________________
  4396.  
  4397.  
  4398. GoldED supports many different message database formats. The following
  4399. is a list of them all, with notes about their characteristics and what
  4400. special quirks to look out for with each of them.
  4401.  
  4402.  
  4403. Opus/FTSC (*.MSG)
  4404.  
  4405.     These are two variants of the same type of msgbase. It works by
  4406.     using one physical file per message (1.MSG, 2.MSG etc.),
  4407.     collecting them in a directory for each area. Depending on the
  4408.     clustersize on the harddisk, this can be a very wasteful and slow
  4409.     way to store messages. With a clustersize of about 512 bytes, the
  4410.     waste may be acceptable, but the access speed can be dramatically
  4411.     slow if there are many *.MSG files, due to the DOS file system.
  4412.     Caches and BUFFERS adjustments can improve it, but there are
  4413.     limits.
  4414.  
  4415.     In echomail areas, this format has a special quirk: The first
  4416.     message (1.MSG) is normally used to store the so-called
  4417.     "highwatermark". The highwatermark tells the echomail processor
  4418.     where it should start scanning for new messages entered by users.
  4419.     By deleting (Zapping) the highwatermark, you can make the echomail
  4420.     processor re-scan the whole area again. This may cause messages to
  4421.     be sent out as "dupes", so this should be used sparingly and
  4422.     carefully, if at all!  The highwatermark can also be "Heated" -
  4423.     which means that it is set to the last msg in the area. This
  4424.     prevents the echomail processor from finding newly entered
  4425.     unscanned msgs. Use with care.
  4426.  
  4427.     The variants: The "Opus" format originated in the Opus BBS system.
  4428.     It put some Fido undocumented(?) fields to use as date/time
  4429.     stamps. The "FTSC" (defined in FTS-0001, revision 12 and later)
  4430.     format uses the undocumented fields to set the zone/point
  4431.     information for the msg. To the authors knowledge, the Opus
  4432.     variant is the dominant, and the FTSC variant is doomed to
  4433.     oblivion. If in doubt, use the Opus format.
  4434.  
  4435.  
  4436. Hudson
  4437.  
  4438.     This msgbase format was invented by Adam Hudson, and was first
  4439.     used in his QuickBBS package. Later several other BBS'es were
  4440.     cloned from QuickBBS (like RemoteAccess and SuperBBS).
  4441.  
  4442.     The basic format is built around 7 main files:
  4443.  
  4444.       MSGTXT.BBS    This contains the message text of all msgs in all
  4445.                     areas.
  4446.       MSGHDR.BBS    The headers for all the msgs in MSGTXT.BBS.
  4447.       MSGIDX.BBS    Index to MSGHDR.BBS.
  4448.       MSGINFO.BBS   Tells how many msgs there are in each area.
  4449.       MSGTOIDX.BBS  Index that contains all the TO names.
  4450.       LASTREAD.BBS  Lastreads for all areas for each user in USERS.BBS.
  4451.       USERS.BBS     Contains a record for each user. Also the index to
  4452.                     LASTREAD.BBS.
  4453.  
  4454.     The format limits the total size of MSGTXT.BBS to a maximum of
  4455.     16MB, which translates to about 16000 msgs of "average" length.
  4456.     GoldED automatically warns you if the limit is close to being
  4457.     reached, and advises you to pack the msgbase.
  4458.  
  4459.     The first incarnations of QuickBBS did not support "sharing" of
  4460.     the msgbase. This became more and more important in later years as
  4461.     multitaskers and networks got cheaper. RemoteAccess BBS was the
  4462.     first to implement a useful method, and later a better method was
  4463.     evolved (known as "RA 1.01 or RA 1.1x"), which is now the standard
  4464.     for all modern software that supports msgbase sharing. GoldED
  4465.     fully supports the new standard of course.
  4466.  
  4467.     The main virtue of this format is that it is very fast to access
  4468.     the msgbase.
  4469.  
  4470.     The main disadvantage is that it can be very sensitive to disk
  4471.     problems, and it is a common horror story that people loose their
  4472.     entire msgbase because the disk developed bad clusters or some
  4473.     program went berserk and messed up the msgbase files.
  4474.  
  4475.  
  4476. Goldbase
  4477.  
  4478.     This is an enhanced version of the Hudson format, introduced in
  4479.     QuickBBS 2.80 by the QuickBBS group.
  4480.  
  4481.     The Goldbase format removes the 16MB size limit and allows up to
  4482.     500 message areas instead of the 200 in Hudson. The filenames are
  4483.     the same, except that the extension is .DAT instead of .BBS.
  4484.  
  4485.  
  4486. Squish
  4487.  
  4488.     The Squish format is relatively new. It was invented by Maximus
  4489.     BBS author Scott Dudley in 1991, and was first used in Maximus
  4490.     CBCS v2.00. Soon after, GoldED was among the first message editors
  4491.     to support this new format.
  4492.  
  4493.     Squish uses three files per area: A header/message text file
  4494.     (*.SQD), an index file (*.SQI) and a lastread file (*.SQL). The
  4495.     SquishMail echomail processor uses a fourth file (*.SQB) to hold a
  4496.     dup-database.
  4497.  
  4498.     The use of a database for each area - instead of one file per msg,
  4499.     or all msgs in one big database - makes this format fast, very
  4500.     safe and resistant to disk problems. Even if something messed up a
  4501.     Squish area, it can almost always be fixed and recovered, using
  4502.     the SQFIX or SQREIDX utilities that come with the Squish echomail
  4503.     processor.
  4504.  
  4505.     A special feature of Squish areas is that they can be
  4506.     self-maintaining. You can setup a Squish area so that it may only
  4507.     contain a maximum of so-and-so many msgs, and then it will
  4508.     automatically re-use the space used by old msgs when the limit is
  4509.     reached, and so it will practically stop growing. It will still
  4510.     need packing, but not nearly as often as a Hudson msgbase has to.
  4511.  
  4512.  
  4513. Ezycom
  4514.  
  4515.     <to be described>
  4516.  
  4517.  
  4518. JAM
  4519.  
  4520.     <to be described>
  4521.  
  4522.  
  4523. PCBoard
  4524.  
  4525.     <to be described>
  4526.  
  4527.  
  4528. ______________________________________________________________________
  4529.  
  4530.                           Entering Messages
  4531. ______________________________________________________________________
  4532.  
  4533.  
  4534. The process of entering a message deserves some description, because
  4535. there a number of steps that may be a bit hard to figure out directly.
  4536.  
  4537. You start a message by using one the following commands:
  4538.  
  4539.   READnewmsg        Start a blank new message.
  4540.   READquotemsg      Quote-reply the current msg (FROM person).
  4541.   READcommentmsg    Quote-reply the current msg (TO person).
  4542.   READmovequotemsg  Quote-reply in another area.
  4543.   READreplymsg      Reply to current msg, but don't quote.
  4544.  
  4545. The first thing that happens is that the header display comes to life,
  4546. and allows you to change the names and addresses of destination and
  4547. origination. In netmail areas, the userlist lookup feature is in
  4548. effect for the destination name field. You move around in the header
  4549. with the arrowkeys. Pressing <Tab> or <Enter> moves to the next field.
  4550. Pressing <Enter> in the subject field or <Ctrl-Enter> anywhere, ends
  4551. the header editing. Pressing <Esc> drops the message. While editing
  4552. the header, you can use the Alt-keys to toggle message attributes.
  4553.  
  4554. After the header editing is done, a menu appears, allowing you to
  4555. change the message attributes, origin, template, start the internal or
  4556. external editor or quit it.
  4557.  
  4558. When you select to start the editor, the template is processed and
  4559. prepared for use.
  4560.  
  4561. Safely back from the editor, you are presented with a menu where you
  4562. can select to save the message, drop the message, continue editing,
  4563. view the message, change origin or ROT13 crypt it (the latter only if
  4564. you are a registered user).
  4565.  
  4566.  
  4567. ______________________________________________________________________
  4568.  
  4569.                         The "Hardline" Feature
  4570. ______________________________________________________________________
  4571.  
  4572.  
  4573. This chapter relates only to the use of an *external* editor.
  4574.  
  4575. Like all message editors that allows the use of external text editors
  4576. for writing messages, GoldED must deal with the problem of
  4577. free-flowing text paragraphs versus hard-cr-terminated lines.
  4578.  
  4579. Most text editors terminate *all* lines with a carriage return (CR,
  4580. 13d, 0Dh). Unless you use a fairly short right margin in the text
  4581. editor, those lines can be very annoying to quote if the quotemargin
  4582. is shorter. This usually results in "ragged" quotes, with a long
  4583. quoteline alternating with a short leftover. This looks bad, and
  4584. requires a lot of work to edit to a respectable shape.
  4585.  
  4586. To solve this problem, GoldED treats the file from the text just as if
  4587. text blocks doesn't have any hard-cr's in them - it "reflows" the
  4588. text. Of course, this immediately creates another problem: If you
  4589. include a cut from a log file, source code, table or other stuff that
  4590. *requires* the text block to be aligned with itself. Those blocks
  4591. would become scrambled and unreadable.
  4592.  
  4593. GoldED recognizes a special control string, that tells the reflowing
  4594. code to put hard-cr's on single lines or groups of lines. You define
  4595. the string with the keyword "Hardline" in the configuration file. Here
  4596. is an example of the use of the hardline string (in the example "<<"):
  4597.  
  4598.   <<
  4599.   ==== Log Cut ====
  4600.   + 22.24.31  Event 0-@
  4601.   - 22.24.42  Preparing outbound mail
  4602.   = 22.58.47  RING
  4603.   = 22.58.55  CONNECT 2400
  4604.   + 22.59.02  Incoming call at 2400 baud
  4605.   ==== Log Cut ====
  4606.   <<
  4607.  
  4608. In this example, the hardline string on the lines before and after the
  4609. cutting tells the reflower that all those lines must the hard-cr
  4610. terminated. The hardline string must be the only characters on the
  4611. line, and it must be placed on the *first* position. The reflow code
  4612. looks for <string><cr>. The hardline string works as a "toggle".
  4613.  
  4614. The hardline string also has another use: If you put the string as the
  4615. last characters on a line, that line will also be hard-cr terminated.
  4616.  
  4617. Example:
  4618.  
  4619.   Greetings...<<
  4620.     Odinn Sorensen<<
  4621.  
  4622. The last << in this example was not really necessary, because a blank
  4623. line always ends the preceding line or paragraph with a hard-cr. In
  4624. any case, the hardline string is stripped off before the message is
  4625. saved.
  4626.  
  4627. Some lines are by definition always hard-cr terminated, and does not
  4628. need hardline strings. Those lines are quoted lines and control lines
  4629. such as kludges, tearlines and originlines. In addition, three
  4630. identical characters at the beginning of a line also terminates the
  4631. preceding paragraph.
  4632.  
  4633.  
  4634. ______________________________________________________________________
  4635.  
  4636.                              Quote Reflow
  4637. ______________________________________________________________________
  4638.  
  4639.  
  4640. When you quote a message that already contains quoted lines, those
  4641. lines may be too long for your quotemargin. Most message editors would
  4642. then just cut a bit off the end and put it on a line below. GoldED
  4643. does it differently - it determines the quotestring of the line, and
  4644. then "reflows" all the following lines with the same quotestring and
  4645. puts the quotestring back on the reflowed lines. This usually works
  4646. great and looks good. It can also fail miserably in some
  4647. circumstances.
  4648.  
  4649. The reflowing is in effect in both the message displaying and in
  4650. quoting. If you want to observe the effects, try executing the
  4651. READdecreasemargin or READincreasemargin commands (they don't have any
  4652. default key assignments though).
  4653.  
  4654.  
  4655. ______________________________________________________________________
  4656.  
  4657.                      Carbon Copy and Crossposting
  4658. ______________________________________________________________________
  4659.  
  4660.  
  4661. Carbon copy (CC) is a way to send the same message to a number of
  4662. people without the trouble of manually entering and copying a message
  4663. for each of them. The CC works only in netmail or local areas. You can
  4664. send any message, including fileattaches (in netmail) with the CC
  4665. function.
  4666.  
  4667. Carbon copies are created by putting the string "CC:" followed by one
  4668. or more names or addresses, separated by commas, on one or more lines
  4669. at the beginning of the message. The names and addresses must follow
  4670. the same rules as when using the lookup function in the netmail
  4671. header.
  4672.  
  4673. Example:
  4674.  
  4675.   CC: 16, Joergensen, #236/512
  4676.  
  4677. If you put a "#" in front of a name or address, that node will be left
  4678. out of the list, but will still receive a carbon copy.
  4679.  
  4680. You can also use address macros (see the NAMESFILE keyword) instead of
  4681. names or addresses.
  4682.  
  4683. If you often send carbon copies to the same people, it can get a bit
  4684. tedious to type (and remember) every time. Therefore you can also
  4685. specify a file with the names and addresses:
  4686.  
  4687.   CC: @TESTERS.LST
  4688.  
  4689. Files names and addresses can be mixed on the same line. The lines in
  4690. the file must be the same format as above. No nesting is allowed: You
  4691. can't specify files within files.
  4692.  
  4693. When you save the CC message, GoldED will scan the message text to
  4694. find and process the CC: lines. When this is done, a menu will pop up
  4695. and allow you change the format of the CC: lines, the attributes of
  4696. the CC messages or drop the copies.
  4697.  
  4698. When processing the CC list, GoldED will check each node in the
  4699. nodelist and pop up the nodelist browser in case of more than one
  4700. match or if the node was not found.
  4701.  
  4702.  
  4703. Crosspost is similar to Carbon Copy, except that instead of sending
  4704. copies to a list of persons, it posts copies of a message in several
  4705. different conferences. Typical usage is announcement of files, vital
  4706. BBS information and other general interest info.
  4707.  
  4708. To crosspost a message is simple - just add lines in this format:
  4709.  
  4710.   XC: <echoid> [echoid] [..]
  4711.  
  4712. The "XC:" must be the first three characters on the line. The <echoid>
  4713. must be valid echoid's defined in GoldED. Example:
  4714.  
  4715.   XC: GOLDED, NEWFILES_R23.PRO, ENET.SOFT
  4716.  
  4717. This would produce the following output in the message:
  4718.  
  4719.   * Crossposted in GOLDED
  4720.   * Crossposted in NEWFILES_R23.PRO
  4721.   * Crossposted in ENET.SOFT
  4722.  
  4723. And post it in the conferences.
  4724.  
  4725. Please moderate your use of this feature - it adds duplicate
  4726. information to the mail flow, and excessive use may be frowned upon by
  4727. cost-sensitive individuals.
  4728.  
  4729.  
  4730. ______________________________________________________________________
  4731.  
  4732.                          Encrypting Messages
  4733. ______________________________________________________________________
  4734.  
  4735.  
  4736. GoldED allows you to en/decrypt messages encoded with the ROT13
  4737. encryption method. ROT13 is very simple: It just swaps the letters
  4738. "A-M", "a-m" with "N-Z", "n-z" and vice-versa.
  4739.  
  4740. ROT13 is mostly used in UUCP (or whatever they are called :-)
  4741. networks, where it is used as a "spoiler warning", so that game
  4742. solutions, joke punchlines and other stuff is not read by accident. In
  4743. those networks, all message readers have ROT13 de/crypting
  4744. capabilities.
  4745.  
  4746. In FidoNet, not all message readers have ROT13 capability, and the
  4747. current policy (Policy 4) states:
  4748.  
  4749.     2.1.4  Encryption and Review of Mail
  4750.  
  4751.     FidoNet is an amateur system. Our technology is such that the
  4752.     privacy of messages cannot be guaranteed. As a sysop, you have the
  4753.     right to review traffic flowing through your system, if for no
  4754.     other reason than to ensure that the system is not being used for
  4755.     illegal or commercial purposes. Encryption obviously makes this
  4756.     review impossible. Therefore, encrypted and/or commercial traffic
  4757.     that is routed without the express permission of all the links in
  4758.     the delivery system constitutes annoying behavior.
  4759.  
  4760. If you have registered GoldED, you will be able to encrypt your
  4761. messages with ROT13, but you should not use the crypting facility of
  4762. GoldED, unless your network allows it, and *never* in international
  4763. echoes.
  4764.  
  4765.  
  4766. ______________________________________________________________________
  4767.  
  4768.                      Nodelist Browse and Lookups
  4769. ______________________________________________________________________
  4770.  
  4771.  
  4772. When you write a netmail message, you must know the name and net
  4773. address of the recipient. Unless you have a remarkable memory, this
  4774. information can be a bit hard to remember. Therefore GoldED uses a
  4775. special nodelist/userlist index to enable you to quickly lookup any
  4776. node.
  4777.  
  4778. The index is created by the GoldNODE nodelist/userlist compiler.
  4779. GoldNODE supports the standard "St.Louis" nodelists, the FrontDoor
  4780. Boss/Point pvt/nodelist extensions (also known as Version7 extensions)
  4781. and the simpler FIDOUSER.LST userlist.
  4782.  
  4783. When you enter a name or address in the header (the TO: field) and
  4784. press <Enter>, GoldED looks in the nodelist index to find the missing
  4785. data. You can enter the address in the name field. Names to be
  4786. searched for must be entered last name first (because of the way the
  4787. index is structured). If you enter a partial name or address, GoldED
  4788. will find the closest match. Addresses can be entered in short form,
  4789. based on the current AKA, like .3 for the address of your third Point,
  4790. or 33 for node 33 in your net.
  4791.  
  4792. Before the nodelist is searched, the list of address macros are first
  4793. scanned, and if a match is found there, the information there is used
  4794. instead.
  4795.  
  4796. When GoldED has found a match, it looks a bit further to see if there
  4797. are more matches. If not, the matching data is inserted in the header,
  4798. and you can continue editing. If more than one match was found, it
  4799. starts the nodelist browser. Here you can browse around and find the
  4800. correct destination node. When found, you select it with <Enter>. The
  4801. full name and address of the node you selected is then placed in the
  4802. appropriate fields in the header. Pressing <Esc> in the browser quits
  4803. it without inserting any node information.
  4804.  
  4805. The list of nodes in the browser is sorted differently, according to
  4806. what you entered. If you entered a name, the list is sorted
  4807. alphabetically by last name. If you entered an address, the list is
  4808. sorted ascending by address.
  4809.  
  4810. The nodelist browser can also be accessed in other ways. The keys F10
  4811. and Shift-F10 brings up the browser at the FROM and TO names (nodes)
  4812. respectively, to let you inspect their nodelist data. It's quite
  4813. handy, you will wonder how you could do without it - I did :-)
  4814.  
  4815. The nodelist lookup feature can also be used when in the internal
  4816. editor, but an even more useful key is available there. By pressing
  4817. Alt-L, the browser will pop up for the name or address at the editor
  4818. cursor position!
  4819.  
  4820.  
  4821. ______________________________________________________________________
  4822.  
  4823.                          User Database Lookup
  4824. ______________________________________________________________________
  4825.  
  4826.  
  4827. GoldEd has a special user database lookup feature for BBS sysops.
  4828.  
  4829. In Hudson, Ezycom, Squish (and *.MSG, if you are using Maximus) type
  4830. areas, GoldED can perform an additional type of name lookup, using
  4831. wildcards.
  4832.  
  4833. This form of lookup is triggered by using DOS/4DOS-style wildcard
  4834. characters in the name you want to lookup. Examples:
  4835.  
  4836.   To: Joe*    Finds any name beginning with "Joe".
  4837.   To: *Blow   Finds any name ending with "Blow".
  4838.   To: Od?n*   Finds "Odinn", "Oden" etc.
  4839.  
  4840. Depending on the size of your user database and the speed of your
  4841. computer, the lookup may take a little while.
  4842.  
  4843. As currently implemented, this user database lookup is only good for
  4844. simple one-shot lookups - you can't bring up a browser to pick the
  4845. user, or see his/hers other user data.
  4846.  
  4847.  
  4848. ______________________________________________________________________
  4849.  
  4850.                            Marking Messages
  4851. ______________________________________________________________________
  4852.  
  4853.  
  4854. GoldED has a message marking system, which allows flexible
  4855. manipulation with selected messages.
  4856.  
  4857. You can either mark messages manually one by one using the
  4858. READtogglemark command <Space>, or use the READmarkingoptions menu
  4859. <Alt-S>. With the marking menu, you can for example mark all messages
  4860. in a particular thread (replychain), or all messages that match a
  4861. certain string or a number of other criteria.
  4862.  
  4863. When you have marked the messages, you can then Copy, Move, Delete or
  4864. Write them. Or you can switch to reading only the marked messages.
  4865.  
  4866. The marks stay in position until removed (unmarked) or you exit
  4867. GoldED. Marks are kept even if you leave the current area and do
  4868. business in another for a while.
  4869.  
  4870. Another, more volatile, form of mark is the "bookmark". Bookmarks can
  4871. be used for returning to a certain position after a stroll out a long
  4872. reply chain and stuff like that. There is only one bookmark, and it is
  4873. reset when you leave the area. Using the Find function leaves a
  4874. bookmark at the current message.
  4875.  
  4876.  
  4877. ______________________________________________________________________
  4878.  
  4879.                        The File Request Feature
  4880. ______________________________________________________________________
  4881.  
  4882.  
  4883. Often when you see a msg where new files are announced, you wish you
  4884. could simply press a key and select files to request. Well, with
  4885. GoldED you can!
  4886.  
  4887. The file request function (default key Ctrl-F) will scan the current
  4888. message and present you with a list of the requestable files it found.
  4889. If the message was generated with one of the "standard" file
  4890. announcement programs (like RFD, Ticket etc), GoldED will even show
  4891. the file descriptions.
  4892.  
  4893. You select the files by toggling marks with the Space key. A '+' will
  4894. show in front of the selected files. The selections can be discarded
  4895. by pressing Esc. When done with the selections, press Enter to
  4896. continue.
  4897.  
  4898. Now the destination area must be selected from the list. You have to
  4899. pick a netmail area of the *.MSG type, since the Hudson and Squish
  4900. netmail areas are currently not supported by most mailers today.
  4901.  
  4902. After selecting the area, check that the header data (TO name etc) is
  4903. correct. You can now go on to perhaps write a thank you note in the
  4904. accompanying msg, or you can save (empty) your msg immediately (if you
  4905. have the EDITMENU keyword set to Yes).
  4906.  
  4907. At the moment you start editing the header, the filenames and
  4908. descriptions are written to a FILES.BBS in the INBOUNDPATH. This can
  4909. be very helpful if you are getting files for your own BBS and are
  4910. tired of inventing or finding descriptions for all those files.. The
  4911. fact that the FILES.BBS is written to disk before you even save you
  4912. msg, can be used to get "free" descriptions later from the response
  4913. msgs some mailers send back when you do a file request.
  4914.  
  4915. There are currently a couple of limitations in the file request
  4916. function:
  4917.  
  4918. *   You can only request as many files as can fit in the subject line
  4919.     of one msg.
  4920.  
  4921. *   GoldED recognizes several different types of file announcement
  4922.     formats, but some may not be fully supported. This means that
  4923.     legitimate descriptions may not be found by GoldED, or that some
  4924.     files are not recognized as such.
  4925.  
  4926. *   If a msg does not conform to a known announcement format, it is
  4927.     instead (actually it is _also_) scanned for a number of standard
  4928.     archive extensions. These extensions are currently not
  4929.     configurable. The supported extensions are: .ARC .ARJ .COM .EXE
  4930.     .LHA .LZH .PAK .RUN .RAR .SDA .SDN .ZIP .ZOO. Only one such file
  4931.     per line can be found by GoldED, and only if it is "straight" - no
  4932.     spaces between name and extension, and no "funny" characters in
  4933.     the filename. The description is simply the rest of the line.
  4934.  
  4935.  
  4936. ______________________________________________________________________
  4937.  
  4938. 33. KLUDGE LINES
  4939. ______________________________________________________________________
  4940.  
  4941.  
  4942. Kludge lines are special control lines, that begin with a ^a (ASCII 1)
  4943. as the first character of the line, followed by a unique identifying
  4944. name and the relevant control information.
  4945.  
  4946. GoldED is aware of a lot of these kludges, and supports a number of
  4947. them, if you want to have them inserted in your messages.
  4948.  
  4949. Some kludges are useless junk and more or less commercials for this
  4950. and that software, but a few are useful for miscellaneous purposes. In
  4951. the following, I will list the known and supported kludges, and a
  4952. short description of what they are used for.
  4953.  
  4954. ACUPDATE:
  4955.  
  4956.     This kludge is a feature of Squish 1.10: Message Broadcast
  4957.     Modify/Delete. Read the docs for Squish 1.10 for details.
  4958.  
  4959. AREA:<echoname>
  4960.  
  4961.     This is not really a kludge, and it doesn't begin with a ^a, but I
  4962.     included it on the kludge list because it sometimes turned up in
  4963.     echomail areas where it should have been stripped off by the mail
  4964.     tosser.
  4965.  
  4966. CC: <name> <address>
  4967.  
  4968.     When GoldED produces carbon copies, it adds to each message a full
  4969.     list of the persons who get a copy. One version of this list is
  4970.     hidden behind the CC: kludge.
  4971.  
  4972. CHARSET:<charset identifier>
  4973.  
  4974.     Proposed in FSC-0050 and FSC-0054, this kludge is an attempt to
  4975.     find a solution to the problem of the high-bit characters (like
  4976.     the IBM PC vs Amiga vs Mac etc. national chars) in messages.
  4977.     GoldED can recognize, use and generate this kludge.
  4978.  
  4979. CHRC:<font change id>
  4980.  
  4981.     Proposed in FSC-0054, this is a kludge for changing fonts,
  4982.     underlining and other stuff.
  4983.  
  4984. CHRS:<charset identifier>
  4985.  
  4986.     Alternative FSC-0054 version of the CHARSET kludge.
  4987.  
  4988. DESTADDR:<destaddress>
  4989.  
  4990.     This one is not proposed anywhere, but it looks like it gives the
  4991.     address of the intended recipient. GoldED takes the address for
  4992.     the dest field.
  4993.  
  4994. DOMAIN <destdomain> <destaddress> <origdomain> <origaddress>
  4995.  
  4996.     Proposed in FSC-0038, this tries to solve the problem of mail
  4997.     crossing domain boundaries. GoldED takes both addresses.
  4998.  
  4999. EID:<crc16> <stamp> [replycrc16] <replystamp>
  5000.  
  5001.     Proposed in FSC-0031, this is used for dupe checking and reply
  5002.     linking. The EID is today generally considered as garbage, but a
  5003.     lot of older mail processors such as QMail still generate it.
  5004.  
  5005. EOT:
  5006.  
  5007.     End Of Text. See SOT.
  5008.  
  5009. FLAGS <special attributes>
  5010.  
  5011.     Proposed in FSC-0053, this is a special netmail kludge used by the
  5012.     FrontDoor and D'Bridge mailers and the IMail mail processor. It
  5013.     provides extra attributes not found among the standard attributes
  5014.     in the normal message/packet headers. GoldED uses and generates
  5015.     this kludge, if you set the attributes.
  5016.  
  5017. FMPT <from point>
  5018.  
  5019.     Defined in FTS-0001, this tells the Point number of the
  5020.     originator. Netmail only. GoldED can generate this line.
  5021.  
  5022. GATECHK:<???>
  5023.  
  5024.     Some sort of gating kludge? Don't know what it's for.
  5025.  
  5026. GROUP:<echoname>
  5027.  
  5028.     I think this one comes from stray Groupmail messages. Similar to
  5029.     the AREA: kludge.
  5030.  
  5031. I51 (no parameters)
  5032.  
  5033.     Proposed in FSC-0051, this indicates that the message text
  5034.     conforms to the ISO 8859-1 (LATIN-1) character set, and may
  5035.     contain certain escape codes. The ISO 8859-1 set is used in Amiga
  5036.     and Windows 3.xx. GoldED can recognize, use and generate this
  5037.     kludge.
  5038.  
  5039. INTL <destaddress> <origaddress>
  5040.  
  5041.     Defined in FTS-0001, this one solves the problem of crossing Zone
  5042.     boundaries. Netmail only. GoldED can generate this line.
  5043.  
  5044. MSGID: <origaddress> <serialno>
  5045.  
  5046.     Defined in FTS-0009, this is a method for unique identification of
  5047.     a message. It can be used for dupe checking and replylinking.
  5048.     GoldED can generate this line.
  5049.  
  5050. MSGTO: <destaddress>
  5051.  
  5052.     This one is not proposed anywhere, but it looks like it gives the
  5053.     address of the intended recipient. GoldED takes the address for
  5054.     the dest field.
  5055.  
  5056. Original: <Carbon copy, original name>
  5057.  
  5058.     Generated by the FrontDoor FM editor when it produces carbon
  5059.     copies.
  5060.  
  5061. PATH: <list of nodes>
  5062.  
  5063.     Defined in FTS-0004, this is a valuable tool for finding dupe
  5064.     links and other structural faults in the net structures.
  5065.     Unfortunately the list of nodes is 2D (net/node), and this creates
  5066.     problems when exporting echomail across zones.
  5067.  
  5068. PTH: <list of nodes>
  5069.  
  5070.     Not yet a FSC (or is it?), this is a 5D-version of the PATH
  5071.     kludge, which sticks to the top of the msg.
  5072.  
  5073. PID: <identifier> <version> [serialno]
  5074.  
  5075.     Proposed in FSC-0046, this takes a stab at the tearline abuse, and
  5076.     puts "safe" information about the first mail processing software
  5077.     in the line. This could be message editors, mail scanners and
  5078.     other stuff.
  5079.  
  5080. RFD: <id>
  5081.  
  5082.     Received For Distribution. A kludge inserted by one of the file
  5083.     announcement programs.
  5084.  
  5085. REPLY: <replyaddress> <replyserialno>
  5086.  
  5087.     Defined in FTS-0009, this is the MSGID: counterpart. When replying
  5088.     to a message with a MSGID:, the MSGID: of the original is renamed
  5089.     to REPLY:.
  5090.  
  5091. RID:<stuff>
  5092.  
  5093.     Unknown kludge which looks suspiciously like the EID.
  5094.  
  5095. SEEN-BY: <list of nodes>
  5096.  
  5097.     Defined in FTS-0004, this is a tool for finding dupe links and
  5098.     other structural faults in the net structures. Depending on the
  5099.     mail tosser, the seen-by's may or may not have a preceding ^a
  5100.     character. Unfortunately the list of nodes is 2D (net/node), and
  5101.     this can create problems when exporting echomail across zones.
  5102.  
  5103. SN:<serialno>
  5104.  
  5105.     Serial number inserted by the Dutchie message editor.
  5106.  
  5107. SOT:
  5108.  
  5109.     Start Of Text. See EOT.
  5110.  
  5111. SPLIT:
  5112.  
  5113.     Defined in FSC-47. A method for splitting large msgs so that some
  5114.     mail processors don't choke on them.
  5115.  
  5116.  
  5117. TCL1:, TCL2: <long hex string>
  5118.  
  5119.     Old obsolete swedish dupecheck/replylink kludge.
  5120.  
  5121. TID:
  5122.  
  5123.     Tosser ID. Similar to the PID, but specifically for mail
  5124.     processors.
  5125.  
  5126. TOPT <to point>
  5127.  
  5128.     Defined in FTS-0001, this tells the Point number of the
  5129.     destination. Netmail only. GoldED can generate this line.
  5130.  
  5131. TZ <offset from UTC>
  5132.  
  5133.     Specifies the time to *add* to the header time to get the UTC
  5134.     (Universal Time Coordinated) time. Generated by newer versions of
  5135.     the TrackMail netmail processor.
  5136.  
  5137. TZUTC
  5138.  
  5139.     See TZ.
  5140.  
  5141. VIA: <netmail tossing info>
  5142.  
  5143.     Routed netmail messages usually gets a Via line for each node it
  5144.     passes through. This can be used for tracing faults in the netmail
  5145.     routing structure.
  5146.  
  5147. XID:<stuff>
  5148.  
  5149.     Unknown kludge which looks suspiciously like the EID.
  5150.  
  5151.  
  5152. ______________________________________________________________________
  5153.  
  5154.                      Using the Internet Features
  5155. ______________________________________________________________________
  5156.  
  5157.  
  5158. This chapter discusses how to use the Internet compatibility features
  5159. in GoldED, implementation details, limitations etc.
  5160.  
  5161.  
  5162. These are the configuration keywords that are relevant for use with
  5163. Internet:
  5164.  
  5165.   ADDRESSMACRO      Short aliases for e-mail adresses.
  5166.   INTERNETGATE      Internet gate definition.
  5167.   INTERNETLOOKUP    Parsing of e-mail addresses in the nodelist.
  5168.   INTERNETREPLY     Reply method for long e-mail adresses.
  5169.   QUOTECHARS        Definition of extra quotechars in addition to '>'.
  5170.  
  5171. See the Configuration Keyword Reference chapter for details about
  5172. these keywords.
  5173.  
  5174. <not completed yet>
  5175.  
  5176.  
  5177. ______________________________________________________________________
  5178.  
  5179.                    Using PGP as an External Utility
  5180. ______________________________________________________________________
  5181.  
  5182.  
  5183. This chapter describes how to can install PGP as an external utility
  5184. in the GoldED setup. The examples assume that PGP 2.3 or higher is
  5185. installed in the directory C:\PGP.
  5186.  
  5187.  
  5188. Add the following to your GOLDED.CFG:
  5189.  
  5190. --- Cut ---
  5191. IF DOS
  5192.   EXTERNUTIL 1 c:\pgp\pgp.exe +force -sa @file "@dname" "@oname" -u
  5193.                               "@oname" -o @file
  5194.   EXTERNUTIL 2 c:\pgp\pgp.exe +force -ea @file "@dname" "@oname" -o
  5195.                               @file
  5196.   EXTERNUTIL 3 c:\pgp\pgp.exe +force @file -o @file
  5197.   EXTERNUTIL 4 c:\pgp\pgp.exe +force -ka @file
  5198. ELSEIF OS/2
  5199.   EXTERNUTIL 1 c:\pgp\pgp2.exe +force -sa @file "@dname" "@oname" -u
  5200.                                "@oname" -o @file
  5201.   EXTERNUTIL 2 c:\pgp\pgp2.exe +force -ea @file "@dname" "@oname" -o
  5202.                                @file
  5203.   EXTERNUTIL 3 c:\pgp\pgp2.exe +force @file -o @file
  5204.   EXTERNUTIL 4 c:\pgp\pgp.exe +force -ka @file
  5205. ENDIF
  5206. EDITSAVEMENU Yes
  5207. EDITSAVEUTIL 1 "S PGP Sign the msg"
  5208. EDITSAVEUTIL 2 "E PGP Encrypt the msg"
  5209. EDITSAVEUTIL 3 "D PGP Decrypt the msg"
  5210. EXTERNOPTIONS -Pause
  5211. --- Cut ---
  5212.  
  5213. NOTE: The configuration lines for utilities 1 and 2 were split in two
  5214. due to the document margin. They must of course be on one line in the
  5215. actual GOLDED.CFG.
  5216.  
  5217.  
  5218. Add the following to your GOLDKEYS.CFG:
  5219.  
  5220. --- Cut ---
  5221. F11         ExternUtil01    ; Sign
  5222. F12         ExternUtil02    ; Encrypt
  5223. ^F11        ExternUtil03    ; Decrypt
  5224. ^F12        ExternUtil04    ; Add a publickey to keyring
  5225. --- Cut ---
  5226.  
  5227. You need to have KEYBEXT Yes in GOLDED.CFG if you want to use the
  5228. F11/F12 keys. You can of course assign other keys, just make sure they
  5229. don't clash with already defined keys.
  5230.  
  5231. Both the signature and encryption PGP commandlines are set up for
  5232. multiple recipients, the TO: name and your own FROM: name. Otherwise
  5233. you would not be able to decrypt your own msgs, and that could get a
  5234. bit unpractical ;-)
  5235.  
  5236. HOW TO USE IT:
  5237.  
  5238. To sign or encrypt a msg, simply select the appropriate menu item in
  5239. the save menu. Another method is described below.
  5240.  
  5241. To decrypt an encrypted msg, Hit Ctrl-F11 while viewing the msg in the
  5242. reader. After decryption, you can write the msg to disk/printer, reply
  5243. to it, copy it, etc. The decrypted text will revert as soon as you
  5244. move away from the msg, or after you perform any operation on it. To
  5245. make a decrypted msg permanent (saved to disk in decrypted form), use
  5246. the Change Msg command after decryption and then save the msg
  5247. immediately, or use the copy function if you want to keep the original
  5248. untouched..
  5249.  
  5250. One thing to be aware of, is that the encrypted msg text does NOT
  5251. contain kludges if it was encrypted from the EDITSAVEMENU. If you make
  5252. such a text permanent, you would loose the kludges. Currently the only
  5253. way to keep kludges in the encrypted text is to encrypt it "manually"
  5254. after saving it, using F11, Change Msg, save immediately. If you do it
  5255. this way, you should be careful in a multitask/network environment,
  5256. where a mail scanner could scan out the unencrypted msg before you get
  5257. a chance to encrypt it... I plan to fix this problem in a future
  5258. release.
  5259.  
  5260.  
  5261. ______________________________________________________________________
  5262.  
  5263.                        JAM Implementation Notes
  5264. ______________________________________________________________________
  5265.  
  5266.  
  5267. This chapter describes details about the implementation of the JAM
  5268. messagebase format in GoldED. Should be read in conjunction with the
  5269. JAM specs for better understanding. A lot of technical terms will be
  5270. used, so if you are not the technical type, just skip over it.
  5271.  
  5272.  
  5273. General notes
  5274.  
  5275. The first release of the JAM messagebase specifications (JAM-001,
  5276. rev.1, dated 93-07-01) included an example implementation in the C
  5277. language of a "JAM API".
  5278.  
  5279. For the purpose of use in GoldED, the JAM API C implementation was
  5280. both too complete and not complete enough. Therefore I developed my
  5281. own specialized JAM msgbase handling code. My own code was of course
  5282. designed be compatible with the original JAM API as well as the
  5283. specifications, but some things are done slightly differently for
  5284. various reasons.
  5285.  
  5286.  
  5287. File I/O checks
  5288.  
  5289. Reads and writes to the msgbase files are generally NOT checked for
  5290. errors in GoldED. In contrast, the original JAM API checks everything
  5291. and stores error values in the API, for the user to use or ignore.
  5292.  
  5293. Full checking degrades performance a bit, adds more code to the EXE
  5294. file, and most importantly, GoldED just doesn't have a safe way to
  5295. recover from the detection of such errors anyway at this time.
  5296. Assuming that your system is working well, there are no harddisk
  5297. errors etc., this will normally not be a problem.
  5298.  
  5299.  
  5300. Message header revisions
  5301.  
  5302. The JAM message headers contain a field to indicate the revision
  5303. number of the header structure.
  5304.  
  5305. GoldED currently ignores this field and assumes that future revisions
  5306. will remain backward compatible. When creating new msgs, GoldED uses
  5307. the revision 1 header structure.
  5308.  
  5309. When new revisions of the JAM specs are released, GoldED will be
  5310. updated to handle these as quickly as possible.
  5311.  
  5312.  
  5313. Passwords
  5314.  
  5315. The JAM specs contain fields for passwords to access the msgbase
  5316. and/or indiviual messages.
  5317.  
  5318. GoldED currently doesn't support these passwords. When creating a new
  5319. JAM msgbase and/or new JAM msgs, GoldED sets the password to
  5320. FFFFFFFFh. If you change an existing msg which has a password, the
  5321. password is NOT preserved, but reset to FFFFFFFFh.
  5322.  
  5323.  
  5324. Lastreads
  5325.  
  5326. The JAM lastread file is designed such that is has to be searched for
  5327. a userid/usercrc, because one cannot assume that the records are in a
  5328. specific order.
  5329.  
  5330. The JAM API searches the userid field. However it seems more
  5331. reasonable to search for the usercrc, because that is a value the
  5332. program can calculate from the username without looking in other
  5333. files. I'm not sure why the JAM API chooses to look in the userid
  5334. field instead. GoldED searches for the usercrc, not the userid. In any
  5335. case, it seems that RemoteAccess 2.x sets both the userid and usercrc
  5336. to the same value.
  5337.  
  5338. The specs state that the user's lastread record must be searched for
  5339. both when retrieving it and storing an updated record. However, the
  5340. JAM API seems to implemented slightly differently, because when it
  5341. stores an updated record, it stores it at the same position as it was
  5342. read *without* first searching for it.
  5343.  
  5344. GoldED has been implemented to work in a similar manner. It searches
  5345. for the user's lastread record when the msgbase is opened, and it
  5346. assumes that it will remain in the same position as it was found,
  5347. until the msgbase is closed.
  5348.  
  5349. This is normally a quite reasonable assumption. The only circumstance
  5350. where the lastread records might be re-ordered is when a msgbase
  5351. maintentance utility cleans up or sorts, and such a utility is
  5352. normally designed to open the msgbase files in exclusive mode, which
  5353. it can't do when the files are already open. If it tries to re-order
  5354. without exclusive access, the utility is badly designed and
  5355. potentially dangerous in multitask/networking environments.
  5356.  
  5357.  
  5358. Size limits
  5359.  
  5360. The JAM specs allow msgbases and msgs of really huge sizes. The 16-bit
  5361. DOS version of GoldED cannot handle the full extremes of this. The
  5362. 32-bit OS/2 and 32-bit protected mode DOS versions of GoldED can
  5363. handle any size, only restricted by memory, disk space or unknown
  5364. compiler or operating system limits.
  5365.  
  5366. The internal limits for the 16-bit versions of GoldED means that they
  5367. can only handle msgbases containing a maximum of 8191 msgs (including
  5368. deleted msgs), and msgs a maximum of about 64k long. In theory at
  5369. least. In practice the limits may be smaller due to lack of memory.
  5370.  
  5371.  
  5372. ASCII 7-bit escaping
  5373.  
  5374. GoldED currently doesn't support the escaping described in the JAM
  5375. specs. The specs state that the current revision of JAM does not
  5376. support it either, so I guess it's no great loss.
  5377.  
  5378.  
  5379. Date fields
  5380.  
  5381. GoldED currently doesn't display the DateReceived field, but it is
  5382. updated on disk when a message is received (read) by the recipient.
  5383.  
  5384. The DateProcessed field is set to the current date when a msg is
  5385. writtten or changed with GoldED.
  5386.  
  5387. All new dates are set to the system time and are not adjusted for
  5388. timezone.
  5389.  
  5390.  
  5391. Subfields
  5392.  
  5393. The concept of the JAM subfields is difficult to support easily in a
  5394. program like GoldED, which was designed to support the traditional
  5395. fixed header formats and kludges in the msg body. Therefore the
  5396. implementation in GoldED of the JAM subfields is not currently as
  5397. complete as one might wish.
  5398.  
  5399. However, it should be adequate for most purposes. I will of course do
  5400. what I can to improve the JAM subfield support in future releases. The
  5401. following is a list of the current limitations of the JAM subfield
  5402. support in GoldED:
  5403.  
  5404. *   Subfields are converted internally to the equivalent kludges for
  5405.     easy viewing, and to make it possible to copy JAM msgs to areas
  5406.     with other msgbase formats. Some subfields do not have equivalent
  5407.     known kludges defined. They are converted to kludges with names I
  5408.     have invented for the purpose. All subfields can be viewed if you
  5409.     hit the Alt-I key to display a hexdump of the message.
  5410.  
  5411. *   The subfields with size limits (typically 100 chars) are not
  5412.     specifically checked for size. Since all other msgbase systems
  5413.     have much lower limits for the fields in question, this should not
  5414.     be a problem.
  5415.  
  5416. *   Only one OADDRESS/DADDRESS is supported. When reading a message,
  5417.     only the _first_ OADDRESS/DADDRESS is used.
  5418.  
  5419. *   None of the file attach or file request subfields are supported at
  5420.     this time. File attaches or file requests are stored in the
  5421.     subject field in a manner similar to other msgbase formats. This
  5422.     might not be supported by a fully JAM compliant mail processor,
  5423.     but IMHO a mail processor should use the subject field if it finds
  5424.     the file attach/request attributes set, but can't find any
  5425.     subfields for them.
  5426.  
  5427. *   If you change a JAM message which is not from you, and save it,
  5428.     all unsupported subfields will be missing in the saved message,
  5429.     and some supported subfields may be changed in content (like the
  5430.     PID subfield).
  5431.  
  5432. *   Currently unsupported message attributes:
  5433.  
  5434.     MSG_FPU     "Force pickup"
  5435.     MSG_NODISP  "Msg may not be displayed to user" (always displayed)
  5436.  
  5437.  
  5438. Deleted msgs
  5439.  
  5440. The original JAM specs has a fairly major problem when it comes to the
  5441. specification for deleting msgs and in particular about _detecting_
  5442. deleted msgs. The original specs do not define a fast way to detect
  5443. deleted msgs from the index file alone.
  5444.  
  5445. This may not be so important for a BBS or a mail processor, but it is
  5446. absolutely vital for mail readers such as GoldED, which need a fast
  5447. way to find out how many active msgs there are, and where the lastread
  5448. is, and to calculate how many unread msgs there are. If GoldED had
  5449. scan the header file to check a single bit in each header the area
  5450. scanning would slow down dramatically, because the header file can
  5451. easily grow to many megabytes and thousands of msgs.
  5452.  
  5453. Fortunately there is a way out. The specs state that if the usercrc
  5454. and header offset values in the index are both -1 (FFFFFFFFh), then
  5455. "there is no corresponding header". Such a situation is IMHO highly
  5456. unlikely, so I have proposed to use this to signify a deleted msg
  5457. instead. This should be backward compatible with almost all JAM
  5458. compatible programs, with the possible exception of msg undelete
  5459. utilities.
  5460.  
  5461. With the header offset set to -1 (FFFFFFFFh), there is of course no
  5462. fast way to find the header of a deleted msg. A msg undelete utility
  5463. would have to scan through the entire header file to locate the
  5464. deleted header (or rather the last occurrence of it, because there can
  5465. easily exist more than one deleted header with the same message
  5466. number). This is IMHO a price worth paying for the performance gained
  5467. by using by changing the specs to specify a deleted msg instead of a
  5468. hypothetical non-existing header.
  5469.  
  5470. When I brought up this subject in the JAMDEV echo, the developers who
  5471. replied generally agreed that this was a good idea. At the time of
  5472. writing, I don't know for certain that it will be changed in the
  5473. specs, but I think so.
  5474.  
  5475. GoldED optionally (since version 2.50.B0822) follows my proposed
  5476. method when deleting msgs. The configuration keyword JAMHARDDELETE
  5477. specifies which method to use. If set to Yes, my method is used. The
  5478. default is No, but I recommend (and use myself) Yes.
  5479.  
  5480.  
  5481. Scanning files
  5482.  
  5483. The NETMAIL/ECHOMAIL.JAM files are written/updated when new messages
  5484. are written or changed in JAM netmail/echomail areas. The files are
  5485. written/updated in the JAMPATH. If you don't have a JAMPATH, it
  5486. defaults to the HUDSONPATH. If you don't use a Hudson msgbase and
  5487. haven't defined a HUDSONPATH, the HUDSONPATH defaults to the GOLDPATH.
  5488.  
  5489. At the time of writing, the NETMAIL/ECHOMAIL.JAM files are not a part
  5490. of the official JAM specs, but they are used in RA2 and most JAM
  5491. compatible mail processors to specify the msgs that need to be
  5492. exported from the JAM msgbase files.
  5493.  
  5494.  
  5495. ______________________________________________________________________
  5496.  
  5497.                      PCBoard Implementation Notes
  5498. ______________________________________________________________________
  5499.  
  5500.  
  5501. This chapter describes details about the implementation of the PCBoard
  5502. messagebase format in GoldED.
  5503.  
  5504.  
  5505. Netmail
  5506.  
  5507. GoldED supports FidoPCB-style netmail areas. According to the FidoPCB
  5508. manual, netmail in PCBoard format is supported by specifying the first
  5509. line of the msg to be the to- or from- address in parentheses and the
  5510. second line to be flags (HOLD,CRASH,IMM,INTL) in parentheses.
  5511.  
  5512. The first line can be either to- or from- address, but there is no
  5513. rule to determine when it is what. Here is how GoldED deals with it:
  5514. When you write a netmail, GoldED puts your own address in the
  5515. parentheses. When reading a netmail, GoldED looks at the from-name and
  5516. if it is the same as your first USERNAME, the address is taken to be
  5517. the to-address (written by you). Otherwise it is taken to be the
  5518. from-address (from someone other than you).
  5519.  
  5520. Note that this fails if a netmail is found which is written by
  5521. somebody on your BBS. Is there some way to reliably determine that a
  5522. msg is written locally instead of being imported?
  5523.  
  5524.  
  5525. Extended Headers
  5526.  
  5527. GoldED is aware of PCBoard v15.x extended headers in the message text.
  5528. The TO, TO2, FROM, FROM2 and SUBJECT extended headers are directly
  5529. supported and "swallowed" when reading a msg. Other extended headers
  5530. are currently treated like normal message text and is therefore not
  5531. hidden to the reader. In a later release, I plan to internally convert
  5532. the extended headers to kludges.
  5533.  
  5534.  
  5535. Long Names
  5536.  
  5537. Because of internal design limitations, GoldED only supports name
  5538. fields up to 35 characters in length. Through the extended headers,
  5539. there can be names up to 120 characters (TO+TO2 ext.hdrs). GoldED will
  5540. simply cut them to 35 characters. In a later release, long names will
  5541. be supported so they won't be cut off due to internal limits, but
  5542. display and entry of long names will probably not happen anytime soon.
  5543.  
  5544.  
  5545. Password
  5546.  
  5547. Passwords are not supported in msgs.
  5548.  
  5549.  
  5550. Attributes
  5551.  
  5552. Only the Pvt and Rcv message attributes are directly supported in
  5553. PCBoard messages. Through the FidoPCB netmail extensions the following
  5554. are also supported in netmail: Hld, Cra, Imm and Zon.
  5555.  
  5556.  
  5557. Double-Byte Characters (Foreign Systems)
  5558.  
  5559. GoldED reads the PCBOARD.DAT file to determine whether to use E3h or
  5560. 0Dh (CR) as the line/paragraph termination character when reading and
  5561. writing message text.
  5562.  
  5563.  
  5564. Message Index
  5565.  
  5566. Only the new v15.x .IDX files are suppported. The old .NDX files are
  5567. not supported in any way.
  5568.  
  5569.  
  5570. ______________________________________________________________________
  5571.  
  5572.                    What YOU get when you register!
  5573. ______________________________________________________________________
  5574.  
  5575.  
  5576. *   Reminders disappear.
  5577.     The random pause at the startup goes away. The original screen
  5578.     will appear when you exit GoldED instead of the shareware
  5579.     reminder. Your name and key serial number is displayed in the
  5580.     startup screen.
  5581.  
  5582. *   The Plus!
  5583.     A plus ('+') is added to the version number in the tearline and/or
  5584.     your serial number is added in the PID kludge.
  5585.  
  5586. *   Tearline opened for costumization.
  5587.     Allows you to change the tearline to your hearts content. Change
  5588.     your tearline to a bragline! :-)
  5589.  
  5590. *   Cookie features enabled.
  5591.     With cookie files you can add multi-line random cookies or
  5592.     taglines in your msgs via the template keyword "@random".
  5593.  
  5594. *   ROT13 feature enabled for msg writing.
  5595.     You can use the ROT13 feature to encrypt your msgs.
  5596.  
  5597. *   GROUP item limits removed.
  5598.     You can use more than 10 of each item in a GROUP. Essential if for
  5599.     example you want more than 10 random origins in a group or area.
  5600.  
  5601. *   Keyword limits removed.
  5602.     The limit of max 10 on a number of GOLDED.CFG keywords (such as
  5603.     ORIGIN, USERNAME, AKA and several others) will be gone.
  5604.  
  5605. *   LoadLanguage feature enabled.
  5606.     You can use the LoadLanguage feature to dynamically load a
  5607.     specific language setup depending on a group or area. This is
  5608.     useful to put local language names of days and months in message
  5609.     templates.
  5610.  
  5611. *   Access to betas.
  5612.     Beta versions only work with a key, so this provides free access
  5613.     to beta releases and through that new features before general
  5614.     availability!
  5615.  
  5616. *   You help and encourage the author to continue development on this
  5617.     user-supported program. Without support from users such as YOU,
  5618.     GoldED would not exist today.
  5619.  
  5620. *   You are allowed to use GoldED for more than 30 days.
  5621.  
  5622.  
  5623. ______________________________________________________________________
  5624.  
  5625.                             End Of Manual
  5626. ______________________________________________________________________
  5627.  
  5628.