bbs/deb-goldedplus
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
93f931255e
deb-goldedplus/manuals/gold_ref.txt

7024 lines
239 KiB
Plaintext
Raw Normal View History

GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
#---------------------------------------------------------------------
# GoldED Reference Manual
# $Id$
#---------------------------------------------------------------------
#manualfile GOLDREF.TXT
#pagelength 60
#pagewidth 80
#leftmargin 8
#rightmargin 2
#---------------------------------------------------------------------
<20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
ڿ ڿ ڿ
<20><> <20><> <20><>
<20><> <20><> <20><>
<20><> <20><> <20><>
<20><><EFBFBD><EFBFBD>¿ <20><><EFBFBD><EFBFBD>¿ <20><> <20><><EFBFBD>Ĵ<EFBFBD> <20><><EFBFBD><EFBFBD>¿ <20><><EFBFBD>Ĵ<EFBFBD>
<20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><>
<20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><>
<20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><> <20><>
<20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><>
<20><> <20><> <20><> <20><> <20><> <20><> <20><> <20><> ڿ <20><> <20><>
<20><><EFBFBD>Ĵ<EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<20><>
<20><>
ڿ <20><> GoldED+ 1.0.0
<20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
Reference Manual
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
Program and manual written by
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
Odinn Sorensen, Dirk A. Mueller and others
Copyright (C) 1990-1999 by Odinn Sorensen
#page
#---------------------------------------------------------------------
#header
#---------------------------------------------------------------------
#heading ______________________________________________________________________
#heading
#heading <center><chapter>
#heading ______________________________________________________________________
#heading
#---------------------------------------------------------------------
#footer ______________________________________________________________________
#footer
#footer <chapter> <right>GoldED Reference, Page <page>
#---------------------------------------------------------------------
#tocbegin
#chapter Table of Contents
#tocline ......................................................................
#tocindent 4
#tocpagenumber i
#toc
#tocend
#---------------------------------------------------------------------
#pagenumber 1
#chapternumber 1
#---------------------------------------------------------------------
#chapter Commandline Reference
Commandline syntax: GOLDED [options] [keystacking]
Available options:
-?
Displays a help screen with all available commandline options.
-C<configname>
Specifies another configuration file than the default GOLDED.CFG.
-D
Disable old configuration keywords. For backward compatibility,
GoldED still supports a number of old names for some configuration
keywords. I recommend that you use -D sometimes and rename the
keywords that are reported as unknown.
-E<echoid>
If specified, GoldED starts directly in the specified echo,
bypassing the arealist screen. See the AREASTART configuration
keyword for more info.
-EXPORTSOUP
Calls the SOUP packet export feature during the startup phase.
This is the same as starting it from the areascan SOUP
Packet->Export menu item. The SOUP export happens immediately
after the regular startup area scanning (if that is enabled) and
after SOUP import.
-F
Force recompile of most configuration files, but not all. Does not
recompile the .CHS files.
-FF
Force complete recompile of all configuration files, regardless of
whether they are up-to-date or not. This is equivalent to deleting
all the *.GE? files.
-H Same as option -?.
-INSTALL[=path]
Start the quick install procedure. You should give a path to your
other mail software if it cannot be found using environment
variables or in current directory.
Please see the INSTALL.TXT document for information about the
quick install procedure.
-IMPORTSOUP
Calls the SOUP packet import feature during the startup phase.
This is the same as starting it from the areascan SOUP
Packet->Import menu item. The SOUP import happens immediately
after the regular startup area scanning (if that is enabled).
-M
Mute. Disables all sounds in GoldED.
-N
No share. If used, this prevents GoldED from using SHARE
compatible file-open calls, which are used by default. Works only
until the SHAREMODE keyword is used in GOLDED.CFG. This keyword is
normally not useful, but may be used to debug your setup or
something.
-NOSCAN
Disable the automatic startup area scanning (if that is enabled).
This is useful for automated SOUP import/export in a batch file.
For example "-noscan -importsoup @x y" imports SOUP then exits.
-P
Since it seems that increasing the thread priority for the Win32
version is a mixed blessing, the default is now to NOT increase
the priority. This option increases the priority (Win32 only).
-Q
Quiet. Turns off verbose config compile. On by default. This could
be used on the commandline to disable a -V(erbose) option in the
GEDCMD environment variable.
-S<sortspec>
Sort all areas according to <sortspec>. See the AREALISTSORT
config keyword for details.
-T<seconds>
Set the timeout value. A value of zero (0) means never timeout.
See the TIMEOUT config keyword for details.
-V
Turns on verbose config compile. When used, GoldED will display
the full filename of each main config file it compiles. It also
displays the name of the detected multitasker, if any. This can be
useful for debugging your setup, and see if GoldED accesses the
files (especially the AREAFILE's) it is supposed to.
-VV
Same as -V, but also displays all the active lines while
compiling. This could be used to find the exact spot if it crashes
or stops while compiling.
-W
If used, GoldED will create (and overwrite if existing) the file
GOLDAREA.INC, which will then contain all areas in the AREADEF
form, sorted by your AREALISTSORT specification. This is very
useful for converting your AREAFILE's to a form you can edit with
your favorite text editor and use in GoldED. It is also useful if
you have used the new AREADESC keyword or the AREAFILE EchoList
reader. The GOLDAREA.INC file (created in the GOLDPATH) can be
used by adding "INCLUDE GOLDAREA.INC" to your GOLDED.CFG or
GOLDAREA.CFG. When creating the file, GoldED will use '.' if an
aka is the same as the main aka, and leave out the optional origin
if it's the same as the first ORIGIN in your GOLDED.CFG. This
makes it easier to share the same GOLDAREA.INC between different
setups.
-X Reserved for debugging purposes.
-Y Reserved for debugging purposes.
-Z Reserved for debugging purposes.
Commandline keystacking
Any non-option characters on the commandline are stuffed into the
keyboard buffer. See the chapter on keyboard definition and the
KEYBSTACK keyword for more info.
Example: GOLDED @S A
Makes GoldED go to the area scanning menu <Alt-S>, and select
scanning of <A> all areas.
See the Macros and Keystacking chapter for more info.
#page
#---------------------------------------------------------------------
#chapter Environment Variables
These are the GoldED specific environment variables:
GOLDED
Path to the GOLDED.CFG file. It is recommended to set this
variable, but don't forget to change it if you move your GoldED
setup to a different directory!
GEDCMD
Specifies additional commandline options. Use this if you want to
specify options, but need to run GoldED without them (for example
when renaming GOLDED.EXE to DBEDIT.EXE in older versions of
D'Bridge). You can override the environment options with
commandline options.
GOLDNODE
The path where GoldNODE can find a GOLDED.CFG to use.
When the using AREAFILE feature to read external area configuration
from other programs, the individual AREAFILE's may use specific
environment variables to find the files. Please read the Area
Configuration chapter for specific details of each supported AREAFILE.
#page
#---------------------------------------------------------------------
#chapter Batchfile Errorlevels
For operation in batch files, GoldED has a set of errorlevel values:
032 or higher Error exit (check the logfile for details).
004 Echomail entered.
002 Netmail entered.
001 Local mail entered.
000 No errors. No mail entered.
Add values together to find the combined error levels. For example,
error level 6 is returned if netmail and echomail (2+4) was entered.
Example RUNGOLD.BAT or RUNGOLD.CMD file:
=== Cut ===
@echo off
golded.exe
rem ged386.exe
rem ged2.exe
if errorlevel 008 goto error
if errorlevel 007 goto e_n_l
if errorlevel 006 goto e_n__
if errorlevel 005 goto e___l
if errorlevel 004 goto e____
if errorlevel 003 goto __n_l
if errorlevel 002 goto __n__
if errorlevel 001 goto ____l
goto nomail
:error
echo golded error exit!
goto end
:e_n_l
echo **** New echo, net and local mail entered.
goto end
:e_n__
echo **** New echo and netmail entered.
goto end
:e___l
echo **** New echo and local mail entered.
goto end
:e____
echo **** New echomail entered.
goto end
:__n_l
echo **** New net and local mail entered.
goto end
:__n__
echo **** New netmail entered.
goto end
:____l
echo **** New local mail entered.
goto end
:nomail
echo **** No new mail entered.
:end
echo.
echo Thank you for using GoldED! :-)
=== Cut ===
#page
#---------------------------------------------------------------------
#chapter Nodelist and Userlist Support
GoldED supports the FrontDoor, Version 7(+) nodelist indexes as well
as a plain FIDOUSER.LST. However, if you run software that doesn't use
any of these formats, you may want to use GoldED's own nodelist index.
This chapter describes how to do that.
In order to enable nodelist/userlist lookup and browsing, GoldED needs
to use a set of special nodelist index files, created by the GoldNODE
nodelist compiler.
GoldED normally uses and displays information from the nodelist when
browsing, but it doesn't really need the nodelist for anything. The
index files contains sufficient information for lookup and browsing of
names or addresses. This means that you can delete or pack away the
nodelists and/or userlists after compiling with GoldNODE, if you want
to save space and you don't need them for anything else.
GoldNODE commandline syntax:
GOLDNODE/GN386/GN2 [-options] [configfile]
Available options:
-C Conditional compile.
-D Remove duplicate nodes from index.
-F Forced compile.
-Q Quite compiled. No screen output improves speed.
-S<size> Set the max size of names. Normally not used.
-U<file> Create sorted FIDOUSER.LST userlist file.
The following options are only interpreted by DOS real mode version:
-M<nodes> Compile max <nodes> nodes (maximum is 65500).
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
-ND Enable DISK usage.
-NE Disable EMS usage.
-NX Disable XMS usage.
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
The [configfile] is the path AND filename of the GOLDED.CFG
configuration file to read. If no filename is given, the path
specified with the GOLDNODE or GOLDED environment variables are used.
The nodelist index files are named GOLDNODE.GX? are are placed in the
path pointed to by the NODEPATH keyword.
The V7+ is automatically used if your NODEPATHV7 is set correctly. If
GoldED shows "xxxx / NODEX.DTP" at the bottom of the browser window,
the displayed information is taken from the raw nodelist entry, taken
from the V7+ index.
GoldNODE can handle up to 45 nodelists and 10 userlists. GoldNODE can
read the german POINTS24-format directly!
NOTE: If you use the EXCLUDENODES and INCLUDENODES keywords, please
note that the <addressmask> does NOT accept "ALL" or "WORLD" etc. You
must use wildcard '*' instead.
#page
#---------------------------------------------------------------------
#chapter Configuration Control
The GOLDED.CFG configuration reader can be directed in several ways
with special keywords:
IF <condition>
ELIF <condition>
ELSEIF <condition> (same as ELIF)
ELSE
ENDIF
These control keywords can be used to setup sections of
configuration which enable different sets of keywords depending on
which version that is used.
The following conditions can be used:
dos true, if GoldED/DOS or GoldED/386 is used
386 true, if GoldED/386 is used
os2 true, if GoldED/2 is used
w32 true, if GoldED/W32 is used
linux, unix true, if GoldED/Lnx is used
firebird true, if GoldED 3.xx is used
asa true, if GoldED-asa is used
yes, true, on always true
Example:
IF OS2
EDITOR c:\qedit\os2\q.exe @file -n@line
EDITSPELLCHECK c:\os2\cmd.exe /c c:\ss\ss.exe @file
ELIF DOS
EDITOR c:\qedit\dos\q.exe @file -n@line
EDITSPELLCHECK c:\ss\ss.exe @file
ENDIF
If both IF 386 and IF DOS are used, it is important to put DOS as
the bottom choice.
IGNORE
This tells the configuration file reader to ignore all subsequent
lines until another IGNORE keyword is encountered. Useful for
testing and quickly switching portions of configuration.
However it is probably more useful to use the IF/ELIF/ENDIF
control keywords.
INCLUDE <file>
This tells the configuration file reader to stop reading the
current .CFG file, and start reading the <file> as an extra
configuration file, then resume reading the previous .CFG. The
INCLUDE filenames are stored and their timestamps are checked when
GoldED is started. INCLUDE files can be nested without limit.
REM
Signifies a REMark (comment) line. The line is ignored.
Any non-alphabetic non-whitespace character at the beginning of a line
makes the line a comment. Example:
; This is a comment
% This is a comment
* This is a comment
// This is a comment
/* This is a comment */
By tradition, the semicolon is the standard comment character. The
semicolon (and only that) can also be used to add a comment at the end
of a configuration line. Example:
ADDRESS 2:236/77 ; Main address.
AKA 2:236/77.1 ; SysOp point.
#page
#---------------------------------------------------------------------
#chapter Configuration Keyword Reference
This is an alphabetical list of all the configuration keywords that
can be used in the main GoldED configuration file (GOLDED.CFG and any
file included from it). It also lists and documents the keywords that
are specific to the Random System groups.
The following special symbols are used in the keyword parameter lists:
() Default value.
[] Optional parameter.
<> Required parameter, not optional.
"" Parameter must be inclosed in quotes ("").
/ Separates mutually exclusive values.
, Separates possible values for the keyword.
Here is the complete keyword list:
ADDRESS <zone:net/node[.point][@domain][, pointnet]>
Your network address, FidoNet-style. More than one address can be
specified if you are member of more than one network. The keywords
ADDRESS and AKA can be used interchangeably.
If a pointnet is specified with a point address, GoldED will use
the so-called "3D" addressing method in netmail msgs, otherwise
the "4D" method is used. The 3D method works by putting the
address ZONE:POINTNET/POINT.0 in the msg header, instead of the 4D
format ZONE:NET/NODE.POINT. Most modern mailers and mail
processors now supports the 4D format, but if you are a point, you
should always consult your Boss about which format to use.
The optional @domain part can be used to specify a "fifth"
dimension to the 4D address. It is normally not necessary to
specify a domain. Domains are never shown in the header and are
not put in the origin line. The only place the domain is
used/added by GoldED is in the MSGID kludge.
Examples:
Address 2:236/77 ; Node address
Address 2:236/77.1 ; Point address (4D)
Address 2:236/77.1, 16077 ; Point address (3D)
Address 2:236/77@fidonet ; Node address with domain
This keyword can be used globally and in a Random System group.
ADDRESSBOOKADD <yes/no/always> (yes)
Setting this keyword to "always" means that GoldED will always add
unknown addressees to the addressbook when writing new or quoted
mails automatically. If you set the value to "yes", GoldED will
add them only if it's a netmail/email. ADDRESSBOOKADD NO disables
this feature entirely.
NOTE that GoldED won't add unknown users if their name match one
of the following criteria:
1) it's a USERNAME
2) it's a ROBOTNAME
3) it's the WHOTO
4) address/aka is unknown
ADDRESSLOOKUPFIRST <MsgID/Origin> (Origin)
By default address of sender taken from Origin line. If this
keyword set to MsgID then GoldEd looks for correct FTN address in
MSGID kludge first.
ADDRESSMACRO <macro>,<name>,<address>[,"subject"][,attribs]
Defines a short name for often used addresses. Typical uses are
for AreaFix/AreaMgr, your uplink, boss, points or others you write
to often. To use a defined address macro, you just type it in the
To: name field.
If (and ONLY if) the subject is enclosed in quotes ("" or ''),
GoldED will look for message attributes after the subject. See the
Message Attributes Reference for a valid attribute. You cannot
have quotes within quotes (not the same type anyway).
The attribues are *added* to the ones already there, they do *not*
replace them.
Examples:
afup,AreaFix,2:236/512,"password -q -l",K/S
ffup,FileFix,2:236/512,password
odin,Odinn Sorensen,2:236/77,GoldED - What else? :-)
A special format is supported for UUCP or INTERNET gateways. The
special format is indicated with a (@) as the first character in
the <name>.
jfu,@fallesen@diku.dk,2:310/33
dn,@INTERNET/david@csource.oz.au,2:241/999
In the first example, GoldED will put "UUCP" (the default gateway
name) in the TO: msg header field and "To: fallesen@diku.dk" on
the first line of the message text.
In the second example, GoldED will put "INTERNET" in the TO:
field, and "To: david@csource.oz.au" in the message. The forward
slash (/) separates the gateway name from the receiver address.
Any gateway name may be used.
The address macros can also be specified in an external file, like
the NAMES.FD file supported by the FrontDoor mailer/editor and
Maximus BBS. See the keyword NAMESFILE for details. However, you
should not use the syntax with the attributes in the NAMES.FD
file, because FrontDoor and Maximus do not know this syntax.
ADEPTXBBSPATH <path>
The path where you keep your AdeptXBBS.
ADEPTXBBSUSERNO <userno>
By default GoldED will use the first record in the userfile and
lastreads. If you are not the first user in the userfile, or are
sharing the messagebase with other GoldED users, you must either
set this keyword to -1, or use a different number for each user.
Each user must be defined in the userbase.
AKA <zone:net/node[.point][@domain][, pointnet]>
AKA (Also Known As) is an alias for the ADDRESS keyword.
This keyword can be used globally and in a Random System group.
AKAMATCH <match> <aka>
This is an enhancement of the existing aka matching logic, which
in some circumstances fails to find the correct aka.
Example: Lets say that zone 21, 22 and 23 are part of the same
network, and that you have an aka in zone 22. You would put
something like this in your setup:
ADDRESS 2:236/77
AKA 22:33/44
In this case, if a mail comes in from zone 23, the normal aka
matching logic would fail, because it does not try to guess the
correct zone. To the rescue comes the new keyword. Now you can add
this to your setup:
AKAMATCH 21:*/*.* 22:33/44
AKAMATCH 23:*/*.* 22:33/44
It tells GoldED that any mail from zone 21 or 23 matches your zone
22 aka. Note the use of wildcards here. Wildcards are not strictly
necessary, you could also have just written "23:" or "23:*".
When an address does not match any AKAMATCH definition, the normal
aka matching logic takes over.
AKAMATCHECHO <yes/no> (no)
If enabled, GoldED will attempt to match one of your akas to the
address of the person you are replying to in echomail areas.
Normally it is not desirable to enable aka matching in echomail,
because some echoes may be restricted to members of one particular
network, and an accidental wrong aka matching may attract unwanted
attention from the moderator or the compulsive flamers :-)
AKAMATCHING <yes/no>
This keyword is only valid in Random System groups. When used, it
overrides any global AKAMATCHNET, AKAMATCHECHO or AKAMATCHLOCAL
you may have.
AKAMATCHLOCAL <yes/no> (no)
If enabled, GoldED will attempt to match one of your akas to the
address of the person you are replying to in local areas.
It doesn't really make sense to do aka matching in local areas.
The keyword is just there for completeness.
AKAMATCHNET <yes/no> (yes)
If enabled, GoldED will attempt to match one of your akas to the
address of the person you are replying to in netmail areas. This
is especially useful if you are a member in more than one network,
and therefore have more than one address.
APP <programname> [keyword and/or parameters]
This is a way for other programs to place configuration data in
GoldED's configuration file.
For example, if a program named "OtherProg" wants to read its
configuration from GOLDED.CFG, here is how it might look:
APP OtherProg REGKEY xyaxajlsaduoiweqeq
APP OtherProg IRQ 5
GoldED itself will ignore APP lines just like REM lines.
AREA <echoid> <"desc"> <msgbase>[type] <loc> [akano] [attrs]
This keyword defines a mail area in GoldED. You need to define at
least one mail area to run GoldED, or use the AREAFILE keyword to
read the area setup of your mailer, mail processor or BBS.
<echoid> Mail area identifier.
<"desc"> Area description in ("") quotes.
<msgbase> O(Opus *.MSG), S(FTS-0001 *.MSG), Q(QuickBBS),
R(RemoteAccess), H(Hudson), M(Squish), J(JAM),
E(Ezycom), G(Goldbase), P(PCBoard).
[type] N(Netmail), E(Echomail), L(Local).
<location> Directory path/file or Hudson board number.
[aka] AKA number (starting from 0)
[attrs] R/O(Read-Only), and/or other attributes.
"O(Opus)" are *.MSG files with binary date/time stamps.
"S(FTS-0001)" are *.MSG files, but with zone/point header fields.
"Q(QuickBBS)", "R(RemoteAccess)" and "H(Hudson) are synonyms.
"M(Squish)" is the Squish format.
"E(Ezycom)" is the Ezycom format.
"J(JAM) is the JAM format.
"G(Goldbase)" is the Goldbase format.
"P(PCBoard)" is the PCBoard format.
"X(AdeptXBBS)" is the AdeptXBBS format.
"W(WildCat!)" is the WildCat! 4.x format.
GoldED can handle enviroment variables correctly in paths
specified in connection with this keyword. For example, if a path
is defined as %MAIL%\path\name, and SET MAIL=C:\POINT is in
AUTOEXEC.BAT (or whatever), then GoldED translates the path to
C:\POINT\path\name.
NOTE: The translation is done at config compile time, so if you
change the environment variable and haven't changed anything else
that would cause GoldED to recompile it's config, you must force
it with the -F or -FF command parameter.
It is recommended to use the newer AREADEF keyword, which allows
more detailed mail area setup.
AREAAUTOID <verbose/long/short> (verbose)
Defines how an automatically created echoid should look, when
AREAFILE finds an area without an echoid.
When the "verbose" option is used, the echoid is given a name
similar to the function of the area, such as NETMAIL, NET_SENT,
ECHO_BAD, ECHO_DUPES and so on.
When the "long" option is used, the echoids are numbered
sequentially like this: NETMAILxxx, ECHOMAILxxx and LOCALxxx. This
is how it worked in older versions (including 2.42.gamma).
When the "short" option is used, the echoids are numbered
sequentially like this: NETxxx, ECHOxxx and LOCALxxx. This is how
it worked in 2.50.beta until B1016.
AREAAUTONEXT <yes/no> (yes)
If enabled, GoldED will automatically jump to the first marked
area in the arealist on startup, and the next marked area after
exiting from an area you have been reading.
AREACATCHUPREAD <yes/no> (yes)
If enabled, GoldED will set all skipped messages to "read" when
using AREAcatchup in the arealist-screen. This implies that
HIGHLIGHTUNREAD YES is used, otherwise it has no function.
AREACOPYADDID <yes/no> (no)
If enabled, GoldED will insert the control line
"AREA:<originalechoid>" at the top of each message that is copied
or moved. This can be a help when regularly copying messages to a
"THE_SAFE" type area.
This keyword can and should only be used in Random System Groups.
It is useful if you copy echomails to some local "ARCHIVE" areas.
In this case, GoldED can add the "AREA:<originalechoid>"-kludge to
inform you from where you copied the mail to.
AREACOPYDIRECT <yes/no> (no)
If enabled, the destination area selection list is bypassed,
thereby making possible a "seamless" copy/move to the default
destination area. The destination area should be set with
AREACOPYTO.
This keyword can be used globally and in a Random System group.
NOTE: It is probably not a good idea to enable this keyword
globally.
AREACOPYTO <echoid>
Sets the default area for the Copy/Move functions. Typically you
could set it to a "safe/permanent storage" type of area, for
example a JOKES2KEEP or THE_SAFE area. Note that the Forward
function uses the AREAREPLYTO area instead.
This keyword can be used globally and in a Random System group.
Related keywords: AREAFREQTO, AREAREPLYTO.
AREADEF <setup>
This is newer version of the "AREA" keyword, with more detailed
parameters.
The full syntax is: (must be all on one line)
AREADEF <echoid> <"desc"> <group> <type> <msgbase> <path/board>
<aka> <(attrs)> ["origin"]
<echoid> The echoid.
<"desc"> Area description in quotes.
<group> Groupid uppercase letter (A-Z) or 0 if not in a
group. Use #groupnumber to specify group numbers in
the 1-999 range. Example: #117.
<type> Net, Echo, Local, EMail or News.
<msgbase> Opus, FTS1, Hudson, Squish, Ezycom, JAM, Goldbase or
PCBoard.
<path/board> Area path, boardnumber or base filename.
<aka> Aka address for the area, or '.' for main aka.
<(attrs)> Default attributes in brackets ().
["origin"] Optional default origin in quotes.
This looks a lot like the AREA keyword. Additional parameters are
the <group>, the verbose <type> and <msgbase>, the fully specified
<aka> address, the brackets for the attributes and the optional
origin.
Note the possibility of using '.' to specify the main aka. This,
and the optional default origin, makes it simpler to create a
common INCLUDE'able area configuration for several setups with
different addresses, for example two people sharing the same
msgbase.
GoldED can handle enviroment variables correctly in paths
specified in connection with this keyword. For example, if a path
is defined as %MAIL%\path\name, and SET MAIL=C:\POINT is in
AUTOEXEC.BAT (or whatever), then GoldED translates the path to
C:\POINT\path\name.
NOTE: The translation is done at config compile time, so if you
change the environment variable and haven't changed anything else
that would cause GoldED to recompile it's config, you must force
it with the -F or -FF command parameter.
AREADESC <echoid> <"desc"> [group] [aka] [(attrs)] ["origin"]
Adds a description and optionally a group letter, aka, attributes
and origin to an _existing_ (previously defined) area. This is
useful if you use an AREAFILE that does not contain descriptions,
groups, akas, attributes or origins.
<echoid> The echoid.
<"desc"> Area description in quotes.
[group] Optional groupid letter (A-Z) or 0 if not in a group,
or #groupnumber (1-999) or '-' to keep the existing
groupid.
[aka] Optional aka address for the area, or '.' for main
aka, or '-' to keep the existing aka.
[(attrs)] Optional default attributes in brackets (), '-' to
keep the existing attributes. Note that if they are
specified, they are _added_ to the default
net/echo/local attributes.
["origin"] Optional default origin in quotes.
NOTE: You cannot skip any of the optional parts in the middle,
even if you only want to set, say, an origin. Use '-' to keep the
existing value for the parts you skip.
AREAEXCL <echoid mask>
With this keyword, you can define the echoids of areas which
should be ignored by GoldED (thereby leaving them out of the
arealist). This is normally used in connection with AREAFILE, to
exclude areas you are not interested in reading. DOS/4DOS-style
wildcards (* and ?) can be used in the echoid mask.
Examples:
AREAEXCL * Excludes all areas.
AREAEXCL *INTER* Excludes all areas containing "INTER" anywhere
in the echoid.
AREAEXCL INT*.* Excludes all areas beginning with "INT" and
containing a '.' anywhere in the echoid.
You can use the AREAINCL keyword to re-include areas which have
been excluded with AREAEXCL.
NOTE: This keyword must be placed before any AREA, AREADEF or
AREAFILE keyword.
AREAFILE <type> [path/file] [switches]
GoldED can read the area setup of many popular mailers, mail
processors and BBS'es, thereby making it much easier and simpler
to configure GoldED for the mail areas you receive, by eliminating
the need to write AREA lines for all or most of your areas.
<type> Name of the program.
[path/file] Filename or path to the area setup files.
[switches] Msgbase specific switches.
For most programs, GoldED can automatically find the path or
filename using environment variables. By default, GoldED will look
for the area setup files in the AREAPATH.
There are switches for sorting the areas, and for turning off an
update-check when GoldED starts up.
GoldED can handle enviroment variables correctly in paths
specified in connection with this keyword. For example, if a path
is defined as %MAIL%\path\name, and SET MAIL=C:\POINT is in
AUTOEXEC.BAT (or whatever), then GoldED translates the path to
C:\POINT\path\name.
NOTE: The translation is done at config compile time, so if you
change the environment variable and haven't changed anything else
that would cause GoldED to recompile it's config, you must force
it with the -F or -FF command parameter.
This keyword is explained in greater detail in the Area
Configuration chapter.
AREAFILEGROUPS <yes/no> (yes)
In some AREAFILE setups, you can groups the areas using single
letters (A-Z) or numbers (#1-999). If this keyword is enabled,
GoldED will use the area groupid instead of the area echoid when
gathering area specific information from the Random System.
If this keyword is enabled, you should setup matching GROUP's in
GOLDRAND.CFG. See the Random System chapter for details.
AREAFREQDIRECT <yes/no> (no)
If enabled, the destination area selection list is bypassed,
thereby making possible a "seamless" file request in the default
destination area. The destination area should be set with
AREAFREQTO.
TIP: If you (like most) only have one mailer netmail area, you
should enable the AREAFREQDIRECT keyword globally for
simpler file requests.
This keyword can be used globally and in a Random System group.
NOTE: It is probably not a good idea to enable this keyword
globally.
AREAFREQTO <echoid> (first netmail area)
Sets the default area for the filerequest function. You should set
this to the netmail area where you normally put the filerequest
messages.
Note that if AREAFREQTO is not specified, it defaults to the first
netmail area found.
This keyword can be used globally and in a Random System group.
Related keywords: AREACOPYTO, AREAREPLYTO.
AREAINCL <echoid mask>
With this keyword, you can define the echoids of areas which
should be re-included by GoldED, if they have been excluded with
the AREAEXCL keyword. DOS/4DOS-style wildcards (* and ?) can be
used in the echoid mask.
Examples:
AREAINCL * Includes all areas.
AREAINCL *INTER* Includes all areas containing "INTER" anywhere
in the echoid.
AREAINCL INT*.* Includes all areas beginning with "INT" and
containing a '.' anywhere in the echoid.
You can use the AREAINCL keyword to re-include areas which have
been excluded with AREAEXCL.
NOTE: This keyword must be placed before any AREA, AREADEF or
AREAFILE keyword.
AREAISEMAIL <echoid>
For Internet e-mail areas. See AREAISNEWS for details.
AREAISNEWS <echoid>
Wildcards * and ? are allowed. These keywords are designed to mark
areas which are read from an AREAFILE as Internet e-mail or
newsgroups. This may be necessary in some cases to enable the
Internet specific features without having to manually define all
Internet areas. Examples:
AREAISNEWS alt.*, rec.*, sci.*
AREAKEEPLAST <yes/no> (yes)
If enabled, GoldED will write the file GOLDLAST.LST in the
GOLDPATH at exit and read it back when run next time. The contents
of the file is a list of lastread information for each area as it
was at last scan.
This feature is helpful when you know that there have not been
tossed new mail and don't want to wait for a full msgbase scan.
Now you can just hit ESC at the startup screen to abort the area
scan and GoldED will put up the lastread info from the previous
session.
It also makes the "new mail since last scan" feature even better,
because the new mail marker now shows which areas that have new
mail since last session even when scanning areas at startup.
In addition, GoldED now makes extra backups of the file, so that
earlier versions of the files can be found in GOLDLAST.BK1 and
GOLDLAST.BK2.
GoldED now only writes the GOLDLAST.LST file at exit if it
survived the initial startup scan.
AREALISTECHOMAX <size> (0)
Allows you to specify a fixed or dynamically sized width of the
EchoID column in the arealist.
If a negative value is specified, the width will be the that of
the widest echoid in the arealist plus the negative value. This
might be useful if some long-name echoes have uninteresting ends,
such as "VERYLONGECHOID_R23.PUB" (could benefit from a <size> of
-7). There is currently no provision for long echoids with common
beginning.
The arealist can dynamically resize the EchoID and Description
columns, so that long echoids are not cut off. The sizing of the
EchoID column is done against the Description column, which
thereby looses or gains width. In version 2.41 and earlier, the
EchoID column width was fixed at 13 chars on 80 column displays.
AREALISTFORMAT <string> ("AM D CPUN E G ")
The arealist column layout is configurable. This keyword allows you
to change the layout to whatever you like
The default is:
AREALISTFORMAT "AM D CPUN E G "
This produces the usual layout. Here is another:
AREALISTFORMAT "ME D CPUN G "
This one puts the echoid in front and eliminates the area numbers.
The letters stand for the following:
letter meaning default width
A Area number 4
M Marked 1
D Description Dynamic
C Number of messages 6
P Personal mail mark ('+') 1
U Number of unread/new messages 6
N Changed since last scan mark ('*') 1
E Echoid AREALISTECHOMAX
G Groupid Dynamic: 0, 1 or 3
You can also specify widths if you don't like the defaults:
AREALISTFORMAT "AM D C4PU4N E G "
In this example, the Msgs and New columns are put back to the size
they had in "old days".
If you leave out a letter, that column will not be shown.
Use only the defined letters. Use spaces to specify required space
between columns. Use only positive numbers for widths. Failure to
obey these rules may cause undocumented behaviour.
AREALISTGROUPID <yes/no> (yes)
If enabled, the arealist screen will display the groupid letters,
if any, in a column to the right of the EchoID column. If a
groupid is not a letter in the range A-Z (a value in the range
#65-#90), the groupid is not shown.
AREALISTNOS <yes/no> (no)
If enabled, GoldED will display the board numbers of Hudson areas
in the arealist instead of the default sequential numbers.
AREALISTPAGEBAR <yes/no> (yes)
Enables or disables a pagebar (scrollbar) in the arealist.
AREALISTSCAN <"L menu text"> [path]<filename> [-delete]]
This keyword allows you to define additional menu items for the
arealist scanning menus (Alt-S or Alt-P).
The first two characters of the menu text are the "hotkey" letter
that will be highlighted in the menu text, plus a space.
The filename specifies a plain text file, with the echoids
(wildcards allowed) of the areas you want to scan when the menu
item is selected. There can be several echoids on each line in the
file. If no path is given, the file is loaded from the GOLDPATH.
The -delete option will cause GoldED to delete the list file after
scanning the areas in it. For example, if your mail processor
generates a list of the areas that it tossed new mail to, you
could add the list as a menu item on the scanning menu and use it
to scan only those areas with new mail. Note that some mail
processors automatically delete their list after using it for
replylinking. You may want to do some creative stuff with
batchfiles to grab a copy.
Examples:
AREALISTSCAN "g Scan Newsgroups" NEWSGRPS.LST
AREALISTSCAN "L Scan Latest" R:\GECHO\IMPORT.ALL -delete
=== Cut, NEWSGRPS.LST ===
ALT.*, COMP.*, MISC.*, NEWS.*
REC.*, SOC.*, SCI.*, TALK.*
=== Cut ===
=== Cut from an import batchfile ===
gecho mgr toss pack -tossbad
if exist import.jam type import.jam >>import.all
if exist import.hmb type import.hmb >>import.all
if exist import.sdm type import.sdm >>import.all
mbutil link -clean
=== Cut ===
AREALISTSORT <sortspec> (FYTUE)
This keyword defines how the area list should be sorted. You can
override the default setting from the commandline with the -S
switch.
The <sortspec> can be composed of the following types:
A Sort by aka.
B Sort by board number.
D Sort by description.
E Sort by echoid.
F Sorts all "fuzzy search" matches first.
G Sort by group (if any).
M Sorts all marked areas first.
O Sort by original order.
P Sort by personal mail.
T Sort by type (in the order net, echo, local).
U Sort by unread messages (try it!).
X Sort by msgbase type.
Y Sorts all areas with "new" mail first.
Z Sort by msgbase path.
- Descending sort (largest first).
+ Ascending sort (smallest first) (default).
In practice 'M' and 'Y' will usually give the same result, because
GoldED automatically marks scanned areas if they contain new mail.
Example:
AREALISTSORT T-U+E
This sorts ascending by Type, descending by Unread (that is, areas
with the most unread messages comes first) and ascending by Echoid
(in case two areas have the same number of unread msgs).
By default no sorting is done, and all areas are listed in the
order they were found (unless sorting was specified with an
AREAFILE keyword). However, the configuration examples all make
use of the Unread sorting type. This is a very useful way of
sorting areas, because it keeps all the areas with mail together.
Personally I now sort my areas like this: "AREALISTSORT FYTUE".
This puts all areas with new mail first, then sorts these into
type (net/echo/local), then into number of new msgs and finally
into echoid. The 'F' at the start enables fuzzy match sorting,
which is very handy when looking for an echoid containing a
particular word. Let's say I want a list of all GOLDED echoes. I
can now simply type "GOLDED" and then the arealist automatically
sorts itself so that all echoes with an echoid containing "GOLDED"
comes first :-)
The 'X' sort type sorts areas according to msgbase type, in the
following order:
Hudson
Goldbase
JAM
Squish
OPUS *.MSG
FTS-1 *.MSG
Ezycom
PCBoard
The 'X' and 'Z' sort types were implemented for internal use, to
optimize area scanning speed. When scanning areas, GoldED starts
by sorting the arealist using the sortspec defined with the
AREASCANSORT keyword.
AREALISTTYPE <new/last> (new)
Defines the contents of the 4th column (the one after the "Total"
column).
New Displays the amount of new (unread) msgs.
Last Displays the number of the last msg read.
AREAPATH <path>
If you use the AREAFILE keyword, GoldED might need to know where
the area setup files are located. This keyword specifies where
they are found, if not current directory.
NOTE: Most AREAFILE types can find the path using the environment
variable(s) specific for the program(s). Such environment
variables (or a path specified with the AREAFILE definition)
always overrides the AREAPATH.
AREAPMSCAN <echoid mask>
This keyword defines areas which will be automatically scanned for
personal mail when starting GoldED. DOS/4DOS-style wildcards (*
and ?) can be used in the echoid mask.
Examples:
AREAPMSCAN * Scan all areas.
AREAPMSCAN *INTER* Scan all areas containing "INTER" anywhere
in the echoid.
AREAPMSCAN INT*.* Scan all areas beginning with "INT" and
containing a '.' anywhere in the echoid.
It is recommended to have an "AREAPMSCAN *" to scan all areas at
startup. If you don't want to wait for the scan to complete, you
can abort the scan by pressing ESC during startup.
AREAPMSCANEXCL <echoid or wildcards>
With this keyword you can prevent areas from being scanned with
AREAPMSCAN on startup. This is good if you use "AREAPMSCAN *", but
have some big areas which slows it down.
AREAPMSCANINCL <echoid or wildcards>
Here you can specify areas to be scanned with AREAPMSCAN even if
they were excluded with AREAPMSCANEXCL. Useful for partial
reversal of wildcard specs in the excludes.
AREAREADONLY <soft/hard> (soft)
If this keyword is set to "hard", it is no longer possible to
enter/reply/change messages in areas marked read-only with the R/O
area attribute. The "soft" setting uses a menu to ask permission
as in the previous versions. This option is designed for those who
setup a system for new computer users who might be confused enough
to enter a message in a read-only area despite the warning menu.
AREARENAME <from echoid> <to echoid>
Renames one echoid to another. The feature is meant to be used in
connection with AREAFILE, where some types do not store echoids
with the areas (and GoldED then automatically gives them unique
echoids).
Examples:
AREARENAME NET001 NETMAIL
AREARENAME ECHO001 BAD_MSGS
AREARENAME LOCAL001 BBS.USERS
AREAREPLYDIRECT <yes/no> (no)
If enabled, the destination area selection list is bypassed,
thereby making possible a "seamless" reply/forward to the default
destination area. The destination area should be set with
AREAREPLYTO.
TIP: If you run a utility or have a mail processor which copies
personal mail to a separate area and puts an "AREA:" line at
the top of the messages, you should create a random system
group for the area and enable AREAREPLYDIRECT in it:
Group ECHO_PERSONAL
AreaReplyDirect yes
With such a setup, GoldED replies directly to the area found
in the "AREA:" line, so that you do not have to explicitly
use the Alt-N command to reply in the original area, because
GoldED automatically stores the reply in the appropiate
area. However, if you use <ALT-N>, you can select a diffrent
area (i.e. Netmail).
This keyword can be used globally and in a Random System group.
NOTE: It is probably not a good idea to enable this keyword
globally.
AREAREPLYTO <echoid> (first netmail area)
Sets the default area for the READmovequotemsg, READmovecommentmsg
and Forward functions. The default area is the first netmail area
found in your setup. You should check if GoldED found the correct
one if you have more than one. If you find yourself often
forwarding or quoting from one area to another, it might be a good
idea to setup a Random System group and put in this keyword.
Example:
Group GOLDED
AreaReplyto GOLDED.BETA
EndGroup
This keyword can be used globally and in a Random System group.
Related keywords: AREACOPYTO, AREAFREQTO.
AREASCAN <echoid mask>
This keyword defines areas which will be automatically scanned
when starting GoldED. DOS/4DOS-style wildcards (* and ?) can be
used in the echoid mask.
Examples:
AREASCAN * Scan all areas.
AREASCAN *INTER* Scan all areas containing "INTER" anywhere in
the echoid.
AREASCAN INT*.* Scan all areas beginning with "INT" and
containing a '.' anywhere in the echoid.
It is recommended to have an "AREASCAN *" to scan all areas at
startup. If you don't want to wait for the scan to complete, you
can abort the scan by pressing ESC during startup.
AREASCANEXCL <echoid or wildcards>
With this keyword you can prevent areas from being scanned with
AREASCAN on startup. This is good if you use "AREASCAN *", but
have some big areas which slows it down.
AREASCANINCL <echoid or wildcards>
Here you can specify areas to be scanned with AREASCAN even if
they were excluded with AREASCANEXCL. Useful for partial reversal
of wildcard specs in the excludes.
AREASCANSORT <sortspec> (XZBE)
When scanning areas, GoldED can optimize area scanning speed if it
first sorts the arealist in an order so that each msgbase format
is scanned in sequence rather than on semi-random order.
If you don't like this or don't need it, you can define your own
sort order.
See the AREALISTSORT keyword for the definition of the sortspecs.
AREASEP <echoid> <"desc"> <group> <type>
You can define area separation lines between groups or areatypes.
The syntax is nearly the same as the AREADEF keyword except for
the fields after <type>.
Examples:
These five are area separation lines that are designed to list
before each type of area. This works well when AREALISTSORT has
T (for type) as one of the primary sort orders.
AREASEP !NET "Netmail areas" 0 Net
AREASEP !EMAIL "E-mail areas" 0 EMail
AREASEP !ECHO "Echomail areas" 0 Echo
AREASEP !NEWS "Newsgroup areas" 0 News
AREASEP !LOCAL "Local areas" 0 Local
These can be used to separate areas with group letters (it will
also work with group numbers like #117). Areas should then be
sorted primarily on the group.
AREASEP !A "Group A" A Local
AREASEP !B "Group B" B Local
AREASEP !C "Group C" C Local
In these examples, I put a '!' in front of the echoid to make
sure it is sorted ahead of the areas. This may not be necessary
in all cases, depending on the sort order in effect. If you do
put '!' in front of the echoid, have fuzzy sorting as the
primary sort order, and type '!' in the fuzzy search, you'll get
the interesting effect that all area separation lines collect
themselves at the top :-)
The area separation lines are implemented like a special kind of
area, and are therefore sorted in the arealist just as if they
were actual areas. This is also the reason why you can place the
cursor bar on the separation lines. Originally I wanted to make
the cursor skip the separation lines, but I think I'll leave it as
it is, because it can be useful sometimes, especially when using
the fuzzy feature to quickly go to an area, for example, type "!C"
to quickly move down to the group C areas (using the group sorted
example).
When configuring area separation lines, be careful to consider the
AREALISTSORT, so that the lines are sorted into the positions you
want. If you don't sort areas, you must make sure that the AREASEP
definitions are placed correctly in your GOLDED.CFG or
GOLDAREA.CFG, that is, between/before AREADEF lines.
You will note that the separation lines are not fully connected
into the left and right edges. This is both by design and for
practical reasons (easier to implement), not a bug.
Currently the descriptions are hardcoded to the natural location
in the description column.
AREASTART <echoid>
Normally GoldED starts by displaying the arealist, to let you
select which area you want to read. If this keyword is defined,
the arealist is bypassed and GoldED starts directly in the
configured area. You can override AREASTART with the -E
commandline switch.
AREATYPEORDER <type1> <type2> <type3> <type4> <type5>
This keyword allows you to change the ordering of the Net, Echo,
Local, EMail and News types when sorted by AREALISTSORT.
The default is
AREATYPEORDER Net EMail Echo News Local
This keyword was added to give greater flexibility to the new
AREASEP feature.
AREAYOUWROTETO <echoid>
GoldED automatically copies mails written by yourself to the given
area when saving a new mail. GoldED will also add an AREA-kludge
so you can see from which area the mail originally is copied from.
This keyword can be used globally and in Random System group.
ASKDELORIG <yes/no> (yes)
If enabled, you will be asked if the message you just replied to
should be deleted. Otherwise it is left untouched.
This keyword is only functional in netmail and local areas.
ATTACHPATH <path>
Defines the default <path> when selecting files for attachement.
ATTRIBSATTACH <attributes>
Defines the attributes that are *added* to the existing attributes
of a message when the file attach attribute is toggled on.
ATTRIBSCC <attributes>
Defines the default attributes of Carbon Copy messages. CC
attributes are *added* to the existing attributes of the original
message. Usually used to add the Kill/Sent attribute.
ATTRIBSCFM <attributes>
Defines the default attributes of the Confirmation Receipt
message.
ATTRIBSECHO <attributes>
Defines the default attributes of messages entered in echomail
areas.
ATTRIBSEMAIL <attributes>
Defines the default attributes of messages entered in e-mail
areas.
ATTRIBSFRQ <attributes>
Defines the attributes to use for messages generated with the file
request function. Suggested attributes are: PVT K/S CRA. The FRQ
and LOC attributes are added automatically.
ATTRIBSLOCAL <attributes>
Defines the default attributes of messages entered in local areas.
ATTRIBSNET <attributes>
Defines the default attributes of messages entered in netmail
areas.
ATTRIBSNEWS <attributes>
Defines the default attributes of messages entered in news groups.
ATTRIBUTES <attributes>
Defines the default attributes for area members of the current
Random System group.
BEEPCOMMENT <yes/no> (yes)
If enabled, GoldED will make a noise when the cursor in the
internal editor is moved across a word defined with the
EDITCOMMENT keyword.
BEEPLOCALMSG <yes/no> (no)
If enabled, GoldED will make a noise if it finds a msg with the
"Local" (LOC) attributes set. This can be useful for the sysop who
wants to monitor the msgs entered by users on his/her BBS.
A related keyword is DISPLOCALHIGH.
BEEPNOISES <yes/no> (yes)
If enabled, GoldED makes noises when it wants attention.
NOTE: This is the "master switch" for all noises in GoldED.
BEEPYOURMAIL <yes/no/always> (yes)
If set to "yes", GoldED will make a noise if it finds a
non-received message to one of your USERNAME's. If set to
"always", GoldED will make the noise even if it has already been
marked as received.
CARBONCOPYLIST <listspec> (Names)
This specifies the format of the Carbon Copy list, as it will look
after processing. You can also change the format in the CC menu
before processing.
The <listspec> can be one of the following:
Keep Keep the list as entered.
Names Convert list to "CC: Name, Name, Name.." format.
Visible Convert list to "CC: Name Address" format.
Hidden Convert list to "^aCC: Name Address" format.
Remove Remove the list completely.
More details can be found in the Carbon Copy and Crossposting chapter.
COLOR <colorspec>
Using this keyword you can define or redefine all the colors used
in GoldED. See the Color Configuration chapter for details.
A complete color setup consists of a quite a lot of COLOR
keywords, and it is normal practice to put them in a separate .CFG
file and use the INCLUDE keyword to let GoldED read it. The COLORS
archive contains a number of example color/mono setups. Try them
out if you think the default colors stink :-)
COLORSET <Normal/Intense/Mono> (Normal or Mono)
Three color setups are built-in, and can be selected with this
keyword.
The Normal set is the default when a color display adapter is
detected. The Normal set has all black background, with bright
neon-like colors for the window frames. Some hate it, some love
it. :-)
The Intense set switches off the "blink" attribute, thereby
enabling the use of intense (bright) colors for the background
("paper") colors as well as the foreground ("ink") colors. This is
used in the Intense set to make a bright white background, sort of
like the standard Windows 3.0 setup.
The Mono set is the default when a monochrome adapter is detected.
CONFIRMFILE <filename> (GOLDED.CFM)
GoldED supports the Confirmation Receipt attribute, as used in
FrontDoor 2.xx with the FLAGS CFM kludge. If GoldED finds an
unreceived message to one of your USERNAME's with the CFM (or the
RRQ Return Receipt Request) attribute set, it generates an
automatic response message from the content of the CONFIRMFILE. In
the file you can use many of the template tokens to personalize
the automatic message. You can specify the default attributes for
the message with the ATTRIBSCFM keyword.
Template tokens are explained in the Message Template chapter.
CONFIRMRESPONSE <yes/no/ask> (ask)
An unreceived message to you with the CFM attribute set tells
GoldED that the sender has requested a receipt that you have read
the message. With this keyword you tell GoldED what to do when
such a message is found. Either always automatically generate the
receipt ("yes"), always ignore the requests ("no") or ask you in
each case. Older versions always generated receipts.
COOKIEPATH <path> (defaults to the GOLDPATH)
Defines the default path for the @random template token.
CROSSPOSTLIST <listspec> (Verbose)
This specifies the format of the Crosspost list, as it will look
after processing.
The <listspec> can be one of the following:
None Crosspost without a list in the msgs.
Verbose Change the list to lines of "* Crossposted in ..."
Yes Also adds "* Crossposted in ...", but expands echolist
in line rather than in column.
Raw Keep the crosspost list as you entered it.
More details can be found in the Carbon Copy and Crossposting
chapter.
CTRLINFO <Tearline,Origin,yes/no>
Specifies if you want a tearline and/or origin in your messages.
This keyword can ONLY be used in random system groups.
This may be helpful for QWK users, who can now create a group for
the QWK areas and put "CTRLINFO No" in it.
CTRLINFOECHO <Tearline,Origin,yes/no> (Tearline Origin)
Specifies if you want a tearline and/or origin in your echomail
messages. They will be added by your echomail processor if you
disable them here.
Examples:
CTRLINFOECHO Tearline Origin ; Add both tearline and origin.
CTRLINFOECHO Tearline ; Add only a tearline.
CTRLINFOECHO Origin ; Add only an origin.
NOTE: If you use the last example, your mail processor may get
confused. However, most modern mail processors *can* handle msgs
without a tearline.
CTRLINFOEMAIL <Tearline,Origin,yes/no> (No)
Specifies if you want a tearline and/or origin in your Internet
e-mail messages. This is not recommended.
CTRLINFOLOCAL <Tearline,Origin,yes/no> (No)
Specifies if you want tearline and origin in your messages in
local areas. In local areas, the tearline and origin is normally
never required but can be used for cosmetic purposes.
Examples:
CTRLINFOLOCAL Tearline Origin ; Add both tearline and origin.
CTRLINFOLOCAL Tearline ; Add only a tearline.
CTRLINFOLOCAL Origin ; Add only an origin.
CTRLINFONET <Tearline,Origin,yes/no> (Tearline)
Specifies if you want tearline and origin in your netmail
messages. In netmail areas, the tearline and origin is normally
never required but can be used for cosmetic purposes.
Examples:
CTRLINFONET Tearline Origin ; Add both tearline and origin.
CTRLINFONET Tearline ; Add only a tearline.
CTRLINFONET Origin ; Add only an origin.
CTRLINFONEWS <Tearline,Origin,yes/no> (No)
Specifies if you want a tearline and/or origin in your Internet
news articles. This is not recommended.
DISPAREANO <yes/no/always> (yes)
This keyword specifies if GoldED should display the area number on
the top line in the reader.
Yes Display it only if non-zero.
No Never display it.
Always Always display the area number.
The area number is the same as that displayed in the leftmost
column in the arealist. This also means that the number displayed
can be either the "real" area number (Hudson/Goldbase/Ezycom
board) or the standard sequential number (toggleable with Alt-B in
the arealist).
The number is displayed in square brackets to the left of the area
description. I am not sure that is the best place for it - things
are getting kinda crowded up there... Suggestions are welcome.
DISPATTACHSIZE <bytes/kbytes/no> (kbytes)
Controls how the size of attached files is displayed in the
header. Either the exact byte size, the rounded kbyte size, or not
displayed at all. If the kbytes setting is chosen, the value is
rounded according to the following formula: kbytes = (bytes + 512)
/ 1024. So a 600 bytes file is rounded up to "1k", but a 500 bytes
file is rounded down to "0k".
DISPAUTONEXT <yes/no> (yes)
If enabled, GoldED will automatically jump to the next message
when entering an area.
DISPHDRDATESET <pos> <len> (-20 20)
Specifies the position and length of the date field in the header
display. If a negative value is specified, that value is added to
the current display width.
DISPHDRNAMESET <pos> <len> (8 36)
Specifies the position and length of the from/to name field in the
header display. If a negative value is specified, that value is
added to the current display width.
DISPHDRNODESET <pos> <len> (44 16)
Specfies the position and length of the from/to node address field
in the header display. If a negative value is specified, that
value is added to the current display width.
NOTE: The attributes display moves along with the DISPHDRNODESET
values.
DISPLISTCURSOR <top/neartop/middle/nearbottom/bottom> (middle)
Selects the starting position of selection bar in the message list
and nodelist browsers.
Top At the top if possible.
NearTop At top + 1/3 if possible.
Middle At middle of possible.
NearBottom At bottom - 1/3.
Bottom At bottom.
DISPLISTWRAP <yes/no> (no)
Enables/disables wrap-around when the selection bar in the main
list/browser windows reaches the top or bottom.
DISPLOCALHIGH <yes/no> (yes)
If enabled, GoldED will display the FROM name with the highlight
color, if a message has the Local (LOC) attribute set.
A related keyword is BEEPLOCALMSG.
DISPMARGIN <width> (0)
This is the right margin (display width) used for message display.
If the value is 0 (zero), GoldED will default to the current
screen width. If a negative value is specified, that value will be
added to the current screen width (thereby decreasing the display
width relative to the screen width).
If the DISPPAGEBAR keyword is enabled, the right margin is
automatically decreased by one char.
DISPMSGSIZE <bytes/kbytes/lines/no> (bytes)
When enabled, this keyword displays the msgbody size in bytes,
kbytes or lines in the lower left side of the header. The size
displayed is for the message body text only, the header and
nul-terminator (and anything that may lurk beyond it) is excluded
from the calculation.
NOTE: This feature currently only works when _reading_ msgs. While
editing a msg in the internal editor, this feature is disabled -
however, the size will be displayed when you are in the Save msg
menu (if EDITSAVEMENU is enabled).
DISPPAGEBAR <yes/no> (yes)
If enabled, a "pagebar" (similar to the scrollbar in GUI's) will
appear on the right margin, telling you about the relative size
and position in the message you are reading. It is only displayed
if a message is longer than a screenful.
The pagebar automatically decreases the DISPMARGIN by one char.
DISPREALMSGNO <yes/no> (no)
GoldED can display the message numbers in two ways:
1. As the actual (real) msg numbers.
2. As "relative" numbers, which are always sequential from msg
number 1.
Normally the relative numbers are best, because they reflect the
actual number of msgs in the system.
DISPSOFTCR <yes/no> (no)
If enabled, GoldED will treat the so-called Soft-CR character
(ASCII 141, HEX 8D) just like any other displayable character,
instead of ignoring it like linefeed chars (LF). Note that by
enabling this feature, you _disable_ the character translation
feature that uses the Soft-CR as an escape character. This feature
was added to help users in countries which use the Soft-CR
character for other purposes like 2-byte characters in Japan.
NOTE: The Ezycom msgbase format requires the Soft-CR to terminate
each line. Therefore this feature is unlikely to be useful to
Ezycom sysops.
DISPSTATUSLINE <yes/no> (yes)
If set to NO, the statusline with memory meter, clock etc. will be
disabled. This option has been implemented as a temporary help for
visually impaired users. More extensive help may be implemented in
future versions.
DISPTABSIZE <chars> (4)
The tab size (number of spaces) used when displaying the tab
(ASCII 9) character, and when pressing <Tab> in the internal
editor.
If you use an external editor, you should switch it to create
spaces instead of tabs, because tabs are technically not allowed
in FidoNet technology messages.
DOSPROMPT (yes/no) (yes)
If enabled, GoldED will add a message about itself to the DOS
prompt when shelling out.
DOSSWAP <yes/no,xms,ems,disk,hide,checknet,noprealloc> (yes)
With this keyword you can specify what storage devices the DOS
shell swapper should try or use, and what order to try them in.
It is only relevant for the standard 16-bit DOS version. The 386,
W32, OS/2 and Linux versions will ignore this keyword.
The YES parameter tells the swapper to try EMS, XMS, DISK in that
order, and NO tells it not to swap at all (this will leave the
main part of GoldED in memory, and give you little room in the DOS
shell).
You can specify your own order, such as "DOSSWAP EMS, XMS, DISK",
which makes it try it in that order, or "DOSSWAP EMS, DISK", which
makes it ignore XMS.
If disk swapping is used, the swap file will be placed in the
SWAPPATH.
These parameters modify the disk swapping behaviour:
HIDE Hides the swapfile, if diskswapping is used.
CHECKNET For some reason, disk swapping is slower if running
on a (Novell) network without this.
NOPREALLOC Use this if you are always running on a network
(instead of enabling CHECKNET).
IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT
Some programs use extended memory in ways that may conflict with
the XMS extended memory driver, causing inexplicable crashes. If
you have problems, you should first try turning off the OVERLAY
keyword, and if it still fails, turn off DOSSWAP (or stop using
those other programs :-)
EDITAUTOATTACH <yes/no> (yes)
If enabled, and you use drivespec (C:, D:, etc.) in the subject in
a netmail message, GoldED will automatically turn on the file
attach attribute. Autoattaching only works if the subject has been
edited, so that subject files will not automatically be
re-attached in replies.
EDITAUTOSAVE <seconds> (30)
If a non-zero value is given, the internal editor will
automatically execute the EDITsavefile function with intervals of
<seconds>. Good for keeping automatic backup of the message you
are writing. The saved file can be restored with the EDITloadfile
command. The name of the saved file is defined with the EDITORFILE
keyword.
If disaster strikes (crash, lockup, power blackout, etc.) while
you are writing a message in the internal editor, this feature
lets you continue from the last autosaved message, which will
popup automatically when you enter the internal editor again.
NOTE: This feature only works 100% if KEYBMODE is set to "poll".
If KEYBMODE is set to "block", autosave won't happen until you
press a key after the interval has passed.
EDITCHANGEDATE <always/yes/no> (yes)
If set to "always", GoldED will always "touch" the message date in
the header, if you change a message after saving it.
If set to "yes", GoldED will only "touch" the message date in the
header, if you change a message written by yourself. This is
useful in cases such as when you need to edit messages written by
other people (in-transit netmails for example) which may be
mis-addressed or something without messing up the date.
If set to "no", the message date is not changed when changing a
message.
EDITCHARPARA [']<char>['] (' ')
This keyword defines the character GoldED displays at the end of
paragraphs in the internal editor. This is where the CR character
will be placed once the msg is saved.
EDITCHARSPACE [']<char>['] (' ')
This keyword defines the character GoldED displays when it should
display a space character in the internal editor. See also the
description of the EDITCHARPARA keyword.
The keywords EDITCHARPARA and EDITCHARSPACE were added to aid me
while rewriting and debugging the new internal editor. By
redefining them to visible characters instead of spaces, I could
see if strange things were happening while inserting or deleting
characters. This was a great help. Personally I now always use
redefinitions to ASCII 20 (a paragraph sign) and CP437 250 (a
small dot).
EDITCOMMENT <"word"> <"comment">
This feature is mostly for fun :-)
It allows you to define words which causes GoldED to display a
comment in the statusline, when you place the cursor on the word
in the internal editor.
Example:
EDITCOMMENT ":-(" "Don't worry, be happy!"
EDITCOMMENT ":-)" "Are we having fun yet?"
EDITCOMMENT ";-)" "Wink wink, nudge nugde..."
EDITCOMMENT "!!!" "Flame Warning!"
EDITCOMMENT "GoldED" "Great program, isn't it?"
EDITCOMMENT "Odin" "One more 'n' please."
EDITCOMMENT "Odinn" "That's right :-)"
Have fun with it!
EDITCOMPLETION <"abbreviation"> <"completion">
This feature allows you to define abbreviations which will be
automatically expanded to full words or sentences when typed in
the internal editor. Examples:
EDITCOMPLETION "/Odin" "Odinn"
EDITCOMPLETION "/GED" "GoldED"
EDITCOMPLETION "/V7" "Version 7"
EDITCOMPLETION "/FD" "FrontDoor"
EDITCOMPLETION "/WfW" "Windows for Workgroups"
NOTE! The abbreviation is case-sensitive. If "XX" is defined as
an abbreviation, completion will NOT be triggered if "xx" is
typed.
EDITCRLFTERM <yes/no> (no)
If enabled, all text paragraphs in your messages will be
terminated with a CR/LF combination. If disabled, only a single CR
is used. This option was created to fix a problem with an older
version of the Dutchie mail processor, that apparently needed the
CR/LF termination of kludge lines.
EDITFIELDCLEAR <yes/no> (yes)
If enabled, the input-fields will be automatically cleared for new
entry, if a non-edit key is the first key pressed.
EDITHARDLINE <string> ("<<")
The string is needed if you use an external editor that terminates
all lines with a CR or CR/LF. The hardline string acts as a text
paragraph terminator, and the normal CR's are ignored.
The concept of "hardlines" is explained in the Hardline Feature
chapter.
EDITHARDLINES <yes/no> (yes)
This keyword enables the "hardline" feature. If disabled, the
EDITHARDLINE string is never written to the editor message file,
and the editor message file is read back exactly as entered,
including terminating CR's on all lines.
EDITHARDTERM <yes/no> (no)
If enabled, GoldED will hard-terminate all lines in your messages
at the editor margin. It is recommended to enable this keyword for
Internet e-mail and newsgroups, because some user-unfriendly
Internet software does not wrap long lines properly. But DON'T
enable it in normal FidoNet echomail.
This keyword can be used globally and in Random System groups.
EDITHDRNAMESET <pos> <len> (8 36)
Specfies the position and length of the from/to name field in the
header edit display. If a negative value is specified, that value
is added to the current display width.
EDITHDRNODESET <pos> <len> (44 36)
Specfies the position and length of the from/to node address field
in the header edit display. If a negative value is specified, that
value is added to the current display width.
EDITHEADERATTRS <yes/no> (yes)
This keyword allows you to turn off the large attributes window
that is shown during header edit. Even if the window is turned
off, the Alt-keys are still active for toggling attributes.
EDITHEADERFIRST <new,changes,replies,forwards,yes/no> (yes)
This keyword controls the circumstances that will present you with
the header editor first of all.
New When entering a new message.
Changes When changing a message
Replies When making a reply.
Forwards When forwarding a message.
Yes Always (all of the above).
No Never.
The New, Changes, Replies and Forwards values can be combined. YES
is equivalent to enabling all four of these.
For example, we want to edit the header only when entering a new
message or when changing a message:
EDITHEADERFIRST New, Changes
If the circumstances match the setup of this keyword, the header
edit will be bypassed and you will start directly in the EDITMENU
(if enabled) or in the internal or external editor. A new menu
item has been added in the EDITSAVEMENU, "Edit Header", which
allows you to edit the header after you have written your message,
but before it is finally saved.
If you set EDITHEADERFIRST to NO, you must either have the
EDITSAVEMENU enabled, or use the internal editor, because
otherwise it is not possible to edit the header at all.
EDITINTERNAL <yes/no> (yes)
Specifies if the internal editor should be the default, even if an
external editor is defined. You can always change the setting in
the editor menu (if EDITMENU is enabled) before you start writing
your message.
EDITMENU <yes/no> (yes)
This keyword enables or disables the "Edit menu" that pops up
right after you have edited the message header. If you disable the
menu, you will go to the internal or external editor immediately
and save a keystroke, but you will of course lose the features
available from the menu, such as selection of template etc.
EDITMIXCASE <yes/no> (no)
If this keyword is enabled, GoldED will automatically format the
name with uppercase the first letter in words and lowercase the
rest, when entering names in the header.
Examples:
"odinn sorensen" or "ODINN SORENSEN"
These would be re-cased to "Odinn Sorensen".
EDITMSGSIZE <bytes> (64000 in DOS, 512000 in all others)
This lets you limit the size of loaded msgs. GoldED currently
cannot handle msgs larger than 64k in the DOS version (all other
platforms do not have this limit). This keyword ensures that the
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
system will not get confused and possibly crash or exit, if a
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
message was encountered that was larger than 64k.
EDITOR <commandline> [@file] [@line]
With GoldED it is possible to use your favorite text editor or
even word processor to write messages. With this keyword you
specify the commandline for the editor.
If you use a word processor, be sure to make it export clean ASCII
text files without control codes. You may also need to enable the
DOSSWAP keyword, if the editor or word processor requires a lot of
free memory to run.
<commandline> Program commandline.
@file Token which is replaced by the editor message
filename.
@line Token which is replaced by the @Position
template line number.
EDITORFILE <file> (GOLDED.MSG)
Defines the name of the temporary editor message file. This file
is written by GoldED when swapping to the external editor, or when
using the EDITsavefile command in the internal editor.
The file is written in the GOLDPATH if there is no explicit path.
EDITQUOTEMARGIN <margin> (75)
Sets the right margin for editing quoted lines in the internal
editor. This should be set to the same or wider than the
QUOTEMARGIN.
EDITREPLYRE <yes/no/numeric> (no)
If enabled, GoldED inserts the "Re:" string in front of the
subject when you reply to a message. If not enabled, GoldED will
strip any leading "Re:" when you reply to a msg.
The "Re:" string in subjects is an obsolete practice, and today it
only slows down modern replylinking software. Do yourself and
others a favor and let GoldED strip the Re: in your replies.
The "numeric" option makes GoldED use numeric Re:'s, of the form
"Re^n:".
This keyword can be used globally and in Random System groups.
EDITSAVEMENU <yes/no> (yes)
This keyword enables or disables the "Save menu" that pops up
after you have edited your message in the internal or external
editor. If you disable the menu, your message will be saved (or
discarded if not edited) immediately and save you a keystroke, but
you will also lose the features available from the menu.
EDITSAVEUTIL <utilno> <"L menu text">
Defines the external utilities that will be added to the
EDITSAVEMENU (if enabled). The menu text is inserted in the menu.
The first two characters of the menu text are the "hotkey" letter
that will be highlighted in the menu text, plus a space. Example:
EDITSAVEUTIL 1 "S PGP Sign the msg"
EDITSAVEUTIL 2 "l PGP Clear-Sign the msg"
EDITSAVEUTIL 3 "E PGP Encrypt the msg"
EDITSAVEUTIL 4 "p PGP Encrypt & Sign the msg"
If you have changed the default language in this menu (in
GOLDLANG.CFG), then make sure the highlight letters don't clash.
With EDITSAVEUTIL definitions and EDITSAVEMENU enabled, you can
directly call an external utility to do things like encoding or
encrypting msgs before saving them.
EDITSOFTCRXLAT <char>
If a translation char is defined, GoldED will translate the
soft-cr character (ASCII 141, HEX 8D) in prompts and in the
internal editor. Example:
EDITSOFTCRXLAT H
This example for russians translates the soft-cr to an 'H'.
Please note that this option only applied when DISPSOFTCR set to
YES.
EDITSPELLCHECK <commandline> [@file]
While in the internal editor, you can use the EDITspellcheck
command to save your message to a file and shell to external
spellchecking software. When the check is completed, the corrected
file is read back and you can continue editing your message. The
EDITspellcheck command internally uses the EDITsavefile and
EDITloadfile commands.
<commandline> Spellchecker program commandline.
[@file] Token which is replaced by the message filename
(defined by the EDITORFILE keyword).
EDITUNDELETE <lines> (50)
This keyword defines the number of lines to keep in the undelete
buffer between messages.
EMPTYTEARLINE <yes/no> (no)
With this keyword enabled, GoldED will always strip the tearline
down to just the three dashes, "---", and instead inserts the PID
(Product IDentification) kludge line, which contains the same
information, but in a safer form in a safer place. The PID kludge
is proposed in FidoNet document FSC-0046.
ENCODEEMAILHEADERS <yes/no> (yes)
By default headers in e-mails MIME-encoded according to RFC. In
Russia it is general practice not to encode headers, so you
probably want to say no if you're in Russia.
ENDGROUP
Ends a Random System GROUP definition.
EVENT <eventtype> <eventcommand [parameters]>
This keyword allows you to specify which soundfile to play when a
specfic event occurs. The following <eventtype>'s are defined:
EVENTTYPE TRIGGER:
Arealist When the arealist shows.
AskYesNo Any Yes/No type prompt.
Attention Warnings or information popup messages.
DosShell When entering a DOS or OS/2 shell.
EditComment When an editcomment is found.
EndOfMsgs When there are no more msgs in the area.
ErrorFatal Fatal error exit.
Exit Exit from GoldED.
JobDone Successful completion of a job.
JobFailed Unsuccessful completion of a job.
MsgDeleting When deleting a msg.
MsgFromYou When a msg from you is found.
MsgIsLocal When a msg marked Local is found.
MsgIsTwit When a msg from a Twit is found.
MsgToYou When a msg to you is found.
SearchFailed Search operation failed.
SearchSuccess Search operation was successful.
Startup When the GoldED startup screen shows.
There is currently only one <eventcommand> defined:
PLAY <filename.ext/beepnoise>.
The parameter to PLAY can be either a sound file or one of the
following standard beepnoises:
TheEnd A high and a low note.
GotIt Two sets of low-high notes.
TooBad A falling note.
ToYou A rising and falling note.
SayBiBi A single beep.
SOS Morse S O S (...---...).
If a sound file is specified, the sound driver must support the
format.
The DOS and 386 versions need a Goldware Sound API compatible TSR
or program loader which installs an interrupt service function on
the multiplex interrupt 2Dh. See the chapter about the Goldware
Sound API for more details. The GCTVSAPI program loader (released
separately) currently only supports the CT-VOICE.DRV driver for
.VOC files.
The OS/2 version relies on MMPM/2 (using the mciSendString API
call) to play the sound files. On my system with a Sound Blaster
Pro, MMPM/2 plays both .WAV and (to my surprise) .VOC files. It
even plays .MID files :-)
The Win32 version uses the Win32 API to play the sound files. It
should be able to play any multimedia file that Windows knows how
to handle.
Example usages:
EVENT MsgToYou PLAY HIMAN.VOC
EVENT MsgIsTwit PLAY SHOTGUN.VOC
You have to select the sounds carefully and probably with a lot of
experimentation, unless you want to turn your mailreader into a
honking, wailing and farting monster and drive your poor family or
yourself nuts with a cacophony of noises...
EXCLUDENODES <addressmask>
You can define up to 50 different addressmasks to be excluded from
the compiled nodelists. Use this if you are short of space, or the
nodelist compile takes very long on your system. This keyword is
used by GoldNODE.
Excluded nodes can be re-included with the INCLUDENODES keyword.
EXTERNOPTIONS <-options>
Defines the default options for the EXTERNUTIL's. Valid options:
-Cls * Clear screen.
-Cursor * Cursor in shell.
-KeepCtrl * Keep control lines in the message.
-Pause Pause for keypress before returning to GoldED.
-PauseOnError * Pause only if utility errorlevel is nonzero.
-Reload * Reload the message file (@file).
-Swap * Swap GoldED out of memory before shelling.
-Wipe Wipe editorfile and temporary file after use.
Plus the reverse options with a "No" prefix, for example -NoCls.
The default options are marked with an asterisk (*).
Use -NoKeepCtrl when you want to clearsign a message. This will
strip the control lines (kludges, tearline and origin) from the
message before passing it to the external utility. The tearline
and origin is appended to the message when reloading it. The
default is to keep control lines in the message.
Use -Wipe when you want the temporary unencrypted message files to
be wiped and removed from the disk after they have been read into
memory. GoldED wipes a file by writing a block of 512 random bytes
over the entire length of the file, then truncating it to zero
bytes and finally deleting it. The default is not to wipe files.
EXTERNUTIL <utilno> [-options] <commandline>
This new feature can be used to "filter" msgs, for example calling
PGP or other encryption utilities.
The <utilno> must be in the range 1 to 24 for utilities that will
be called with key definitions (see below). Higher numbers can be
used for utilities that are called from the EDITSAVEMENU (if
enabled). See the EDITSAVEUTIL keyword for details.
The default options are those specified with the EXTERNOPTIONS
keyword. With [-options], you can change the those options locally
for specific utils. See the EXTERNOPTIONS keyword for a list of
valid options.
The <commandline> specfies the DOS or OS/2 commandline you want to
execute. This works in the same way as for the external editor and
spellchecker. See the manual for details about this, especially if
you want to execute batchfiles. In the <commandline> you can use
@tokens to transfer information from the msg to the commandline.
The @tokens are the same as for templates, and in addition you can
use two other @tokens:
@path The GOLDPATH, including a trailing backslash.
@file The full filename of the message file (GOLDED.MSG)
that will be written to disk before the utility is
called.
@tmpfile The full filename of a temporary message file
(GEDTMPxx.xxx) that will be written to disk before the
utility is called.
Examples:
EXTERNUTIL 1 c:\4dos\4dos.com /c c:\crypt\encrypt.bat @file
EXTERNUTIL 2 c:\4dos\4dos.com /c c:\crypt\decrypt.bat @file
To call a defined external utility, you must assign a key to it.
There are 24 new keyboard commands you can use in GOLDKEYS.CFG for
this purpose:
ExternUtilNN
Where NN is in the range 01 to 24 _with_ leading zero. Examples:
F11 ExternUtil01
F12 ExternUtil02
Then if you press F11, you would call external utility number 1
and so on. The ExternUtilNN keywords ONLY work in reader mode, not
in the internal editor or any other place.
HOW IT WORKS:
1. Just before the external utility is called, GoldED writes the
current message text to the GOLDED.MSG file in the GOLDPATH.
The file is written as a textfile with each line CR-LF
terminated. The content is exactly as you see it on the
screen, which means that kludges are only included if you have
enabled kludge viewing. If the -NoKeepCtrl option is used,
kludges, tearline and origin are stripped before the file is
written. If the token @tmpfile is used, a temporary file named
GEDTMPxx.xxx (where xx.xxx is something unique) is created
with exactly the same content as @file.
2. GoldED clears the screen and then calls the utility after
swapping itself out of memory (if swapping is enabled or
relevant for the version).
3. The utility can now load and process the @file and/or
@tmpfile, or do anything else you want. It doesn't have to
have anything to do with the current msg. You could call a
spreadsheet, a game, whatever. But I think this feature will
mainly be used for utilities that process the @file. If the
utility processes the @file, it could write the changes back
to the @file.
4. After returning from the utility, GoldED reloads the @file and
displays it just as if it was the current message. For
example, if your utility was a decrypter and the msg was
encrypted, you would now see the decrypted msg. Neat eh? :-)
5. If you want to make the reloaded text permanent (save it in
the msg), you can use the Change Msg function and immediately
choose "Save Message" from the Editing menu (if enabled with
EDITMENU Yes). This is in fact the method you could use if you
wanted to EN-crypt a msg (however, it is easier to use the
method which involves the EDITSAVEUTIL keyword).
The QUOTESPACING feature can interfere with encoded msgs that
include the '>' character at the beginning of lines (often seen in
uuencoded msgs), by automatically inserting blank lines before and
after the lines with '>'. I have therefore changed the
quotespacing default from YES to NO. Be sure to check if you have
a different setting if you are using an older edition of the
advanced configuration files.
If the string "-----BEGIN PGP MESSAGE-----" is found as the first
27 characters in a reloaded message, GoldED will automatically add
the FSC-0073 kludge "^aENC: PGP" to indicate that the message is
encrypted. This kludge may be used by some software to set up
alternative routing for encrypted mail which would otherwise be
bounced if sent through normal channels.
See the "Using PGP as an External Utility" chapter for batchfile
examples and instructions on how to use this new feature with PGP.
!!! IMPORTANT !!! From FidoNet Policy 4.07 (chapter 2.1.4):
"[..] Therefore, encrypted and/or commercial traffic that is
routed without the express permission of all the links in the
delivery system constitutes annoying behavior."
So be careful with this feature!
TIP: You can use the EXTERNUTIL feature to setup keys to view or
print an attached fax. Use something like this in GOLDED.CFG:
EXTERNUTIL 11 c:\zfax\zfax.com pf @subject ; print fax
EXTERNUTIL 12 c:\zfax\zfax.com vf @subject ; view fax
And this in GOLDKEYS.CFG:
@F11 ExternUtil11 ; Press Alt-F11 to print the fax
@F12 ExternUtil12 ; Press Alt-F12 to view the fax
Or choose your own key assignments and fax view/print utils.
Note that this assumes that the fax file is listed in the subject
line like an attached file.
NOTE: If you're running GoldED/386 and try to use a Win32 program
as an EXTERNUTIL, you might get the error "This program cannot be
run in DOS mode". You can work around this by calling the Win32
program via the shell. For example if this call fails:
EXTERNUTIL 1 c:\utl\mywin32.exe @file
Replace it with:
EXTERNUTIL 1 command.com /c c:\utl\mywin32.exe @file
Then it should work. If not, try using full path to command.com.
EZYCOMMSGBASE <path>
Defines the base path for the Ezycom msgbase. If not set, AREAFILE
Ezycom will set it.
EZYCOMUSERBASE <path>
Defines the base path for the Ezycom userbase. If not set,
AREAFILE Ezycom will set it.
EZYCOMUSERNO <userno> (0)
Defines the lastread set used in the Ezycom message base.
FIDOHWMARKS <yes/no> (no)
If enabled, GoldED will use the echomail "highwater mark" (1.MSG)
to determine if a message is "sent" or "unsent" in *.MSG areas.
NOTE: Some older echomail processors do not update the highwater
mark in a way that GoldED can recognize. If all messages appear to
marked "Uns", even after the mail has been scanned out, try
turning off this keyword.
FIDOLASTREAD <file> (LASTREAD)
Defines the filename of the *.MSG lastread files. DO NOT specify a
path.
FIDOMSGTYPE <Opus/FTS1> (Opus)
This keyword defines the default format of Fido *.MSG files. It is
only used by some AREAFILE's when reading external area
configuration files, where the preferred format is unknown.
The FTS1 (FTS-0001.012 and later) format uses zone/point fields,
where the Opus format uses date/time stamps. When set to Opus
format, GoldED interprets the date/time stamps as DOS-style
bitmapped date/time.
FIDONULLFIX <yes/no> (no)
If set to YES, GoldED will replace NUL chars with LF chars in the
msg body when reading a Fido *.MSG file. This is slower of course,
but not noticably on fast machines.
This option was created to enable GoldED users to read msgs that
were created/handled by brain-dead programs (I don't have names,
sorry) which are not obeying our primary technical standard:
FTS-0001. FTS-1 states that a NUL terminates the msg body. But
sometimes msgs are encountered which have a NUL as the first char
in the msg body or perhaps in other places, thereby causing GoldED
to show a blank or cut-off msg. In some Pascal-based readers, such
as FM, these msgs can be read anyway, because in Pascal a NUL does
not terminate a string like in C/C++.
NOTE: Even if the new FIDONULLFIX keyword is disabled, GoldED will
still fix a NUL if it is the _first_ character in the msg body.
This probably fixes most of these buggy msgs without the overhead
of checking the entire msg.
FIDOUSERLIST <file>
Path and filename of a FIDOUSER.LST file.
This file is expected to be sorted in ascending alphabetical order
using plain ASCII case-insensitive sort. Each line in the list is
expected to be 60 characters plus a CR and a LF, or in other words
records of 62 bytes each. If the list is produced by a nodelist
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
compiler, everything should be okay, but be careful if you have
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
edited the file manually. Note that a FIDOUSER.LST file only
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
supports a name lookup (to get the address).
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
FIDOUSERNO <userno> (0)
This is an index into the FIDOLASTREAD file. Each user occupies 2
bytes in the lastread file.
FILEALIAS <alias> <filename>
Used to define short alias names for filenames. If you regularly
write msgs to different files in different paths, this feature is
very useful, and reduces the risk of typing wrong.
Example:
FILEALIAS DKB R:\DKBBS\DKBBS
With this file alias, you can simply write "DKB" at the filename
prompt, and the long filename will be used.
FILELISTPAGEBAR <yes/no> (yes)
Enables or disables a pagebar (scrollbar) in the file attach list
function.
FORCETEMPLATE <yes/no> (no)
If enabled, GoldED will popup a template selection menu when you
start writing a new msg or reply. If you have both TEMPLATE(s) and
FORCETEMPLATE in a Random System group, you can tell GoldED to use
the random template(s) by hitting ESC instead of selecting from
the menu.
This keyword can be used globally and in Random System groups.
FORMFEEDSEPARATOR <yes/no> (no)
Used when saving messages to file. If enabled, it inserts a Form
Feed (12d) character after each message.
FRQEXT <.ext>
With this keyword you can add extra known filename extensions for
the filerequest function. The following extensions are already
known by default, and need not be defined (duplicate definitions
are ignored):
.ARC .ARJ .DOC .EXE .GIF .LHA .LZH .JPG .PAK .PNG .RAR .RUN .SDA
.SDN .TXT .ZIP .ZOO
Each extension _must_ have the leading dot.
Example: FRQEXT .XYZ
FRQNODEMAP <to-node> <from-node>
This keyword is used for the file request feature (Ctrl-F). It
allows you to define mappings from a nodenumber used in a file
announcement to another nodenumber. This is useful in the cases
where a multi-line system announces files using their primary
nodenumber, which may be a regular V34 modem number, but they also
have an ISDN number, which you would prefer to use instead.
Examples:
// change-to: from:
FRQNODEMAP 2:236/99 2:236/100
FRQNODEMAP 2:236/1043 2:236/43
So, if I saw a file announcement from 2:236/100, and requested
some files, the request would automatically be addressed to
2:236/99.
FRQOPTIONS <options> (FromTop)
Defines options for the file request function:
Sort Sort the list of files alphabetically.
FromTop Scan the message from the top of the message.
NotFromTop Scan the message from the top of the screen.
NoFiles Don't list the file FILES if no files were found.
NoWazooMsg Don't save the request message.
Fast Bypass the header edit and save the msg immediately.
By default, the "FromTop" option is enabled. If you often request
files from very long announcement messages, you might find it very
useful to set the "NotFromTop" option.
The "NoFiles" option was added because if no filenames are found
in a message, the file request function defaults to listing the
magic name FILES instead of complaining that no files were found.
If the FRQWAZOO keyword is enabled, the default behaviour is to
save the request message with the FRQ attribute stripped. Use the
"NoWazooMsg" option if you don't want the request message.
Use the "Fast" option if you find that you almost never change the
destination of the file request message anyway. If you enable this
option, remember that you can always go over to the netmail area
and change the file request message before it is sent.
The UseFlowFile option enables a feature which was default in
2.50, but which I have been informed is problematic for modern
mailers in some setups. The default is now to ONLY create/update
the .REQ file and NOT also touch/create a .?LO flowfile.
FRQWAZOO <yes/no> (no)
If enabled, GoldED will create WaZOO .REQ files instead of file
request messages. You must define an OUTBOUNDPATH if you enable
this feature.
GEDHANDSHAKE <yes/no> (yes)
If this switch set to yes GoldEd displays handshake char in
statusline. If you annoyed with this feature you could hide this
character by setting this option to no.
GERMANKEYBOARD <yes/no> (autodetect)
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
This option is meanful for w32 version only. Due to right Alt key
required to enter some native characters in german version of
Windows it could be defined to yes for this.
GOLDBASEPATH <path>
Specifies the directory where GoldED can find the Goldbase msgbase
files.
GOLDBASESYSPATH <path>
Specifies the directory where GoldED can find the NETMAIL.DAT and
ECHOMAIL.DAT files of the Goldbase msgbase. If not specified, the
GOLDBASEPATH is used.
GOLDBASEUSERNO <userno> (0)
Specifies the lastread set used in the Goldbase message base.
GOLDPATH <path>
This is the path where GoldED finds all it's control files. It is
not necessary to define this, unless you have special needs. The
GOLDPATH defaults to directory where the GOLDED.CFG file was
found.
GROUP <groupname>
Starts a Random System group. See the Random System chapter for
details.
HIGHLIGHTUNREAD <yes/no> (no)
If enabled, GoldED updates (increases) the "timesread" field in
each message that you read. If set to NO, it doesn't touch the
message. The YES setting causes a slight performance decrease,
because the header of each message has to be read, the timesread
field updated and the header written back to disk. The update
happens immediately after the message is displayed, so you may not
notice it at all. A message is only updated if the timesread field
contains the value 0 (zero).
This keyword only works in the following msgbase formats: Fido
(*.MSG), Hudson, Goldbase, JAM, Squish, Ezycom and AdeptXBBS. In
Squish and Ezycom, there is no timesread field, but I have annexed
a reserved message attribute (in Squish, 0x00080000, now called
MSGSEEN; in Ezycom, extattr 0x80) for the purpose of marking a
message as read at least once. The other formats (PCBoard,
WildCat) have no timesread field, but they have reserved fields or
attributes which *could* be used. Let me know if you want this.
HUDSONPATH <path>
Specifies the directory where GoldED can find the Hudson msgbase
files.
HUDSONSIZEWARN <size in bytes> (16000000)
When the Hudson MSGTXT.BBS file exceeds this size, GoldED starts
to warn that the msgbase is getting dangerously close to the
structural limit (which is 16MB for the MSGTXT.BBS file). With
this keyword you can raise or lower the warning size in case you
think the default is too low or too high.
HUDSONSYSPATH <path>
Specifies the directory where GoldED can find the NETMAIL.BBS and
ECHOMAIL.BBS files of the Hudson msgbase. If not specified, the
HUDSONPATH is used.
HUDSONUSERNO <userno> (0)
Specifies the lastread set used in the Hudson message base.
IGNORECHARSET <yes/no> (no)
If set to yes then GoldEd ignores CHRS kludges in messages thus
you will be able to switch codepage in messages with inappropriate
charset.
IMPORTBEGIN <text> ("=== Cut ===")
This keyword, together with IMPORTEND, defines some text to add in
the beginning and end of an imported text file in the internal
editor. If only IMPORTBEGIN is defined, the text is also used for
the IMPORTEND. The <text> may be enclosed in quotes ("") if
leading or trailing spaces are needed. The quotes are stripped.
The replacement token "@file" can be used in the <text>. It will
be replaced with the import filename as entered.
Example:
IMPORTBEGIN === Cut Begin: @file ===
IMPORTEND === Cut End ===
IMPORTEND <text> (same as IMPORTBEGIN)
See IMPORTBEGIN.
INBOUNDPATH <path> (defaults to GOLDPATH)
The inbound path is currently only used with the file request
feature (the READfilerequest command, <Ctrl-F>). If you use this
feature, GoldED will put the file descriptions into a FILES.BBS in
the inbound path, ready for when the requested files are moved to
the correct file areas.
INCLUDENODES <addressmask>
You can define up to 50 different addressmasks to be included from
the compiled nodelists. This is only used in conjunction with the
EXCLUDENODES keyword to include otherwise EXcluded nodes. This
keyword is only used by GoldNODE.
INPUTFILE <filename> (*)
Defines the default name in the internal editor file import
function.
GoldED can automatically uuencode and apply a base64 encoding to
the files during importing them into the internal editor.
NOTE: This is a very simple implementation of encoders. It cannot
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
split large files over several messages. The file mode number 644
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
is hard-coded and has nothing to do with the actual file mode.
This keyword can be used globally and in Random System groups.
INTENSECOLORS <yes/no> (no)
GoldED is capable of switching off the "blink" color, and thereby
enabling the use of bright background (paper) colors. Enable this
keyword, and try out one of the intense color setup examples.
INTERNETADDRESS <internet-address>
Specifies your Internet address. This must be the address only, no
name. The INTERNETADDRESS and USERNAME will be combined to a
standard "From: internetaddresss (username)" headerline when you
write e-mail or articles.
Example:
USERNAME Odinn Sorensen
INTERNETADDRESS odinn@ibm.net
Produces the RFC line:
From: odinn@ibm.net (Odinn Sorensen)
INTERNETDOMAIN <domainname> (username%domain.net)
Defines the domain-part of outgouing Message-ID's. If you don't
know your full domain, leave it as default, which should work just
fine.
INTERNETGATE [gatename<,>]<address>
Defines the local Internet gate you use when sending netmail to
Internet users. This option is activated when you write an
Internet address in the TO: field in the header display. GoldED
detects the Internet address by looking for the '@' character. If
detected, GoldED puts the gate address from INTERNETGATE in the
TO: address field. If you have defined the optional gate name
(typically UUCP), GoldED also replaces the typed Internet address
with the gate name and puts the Internet address in a TO: line in
the message body. Some gate software accepts the Internet address
directly in the header, while other software may need the special
(UUCP) name and a separate TO: line. Examples:
INTERNETGATE UUCP, 1:105/42 ; Standard, with gate name
INTERNETGATE 2:230/9316 ; My uplink runs GIGO software
This keyword can be used globally in GOLDED.CFG, if you only ever
use one gate, or in GROUP's for specific areas in GOLDRAND.CFG if
you have multiple netmail areas and regularly use more than one
gate.
NOTE: If you enable the INTERNETRFCBODY keyword, you should always
use the gatename UUCP, because otherwise the gateway software may
send duplicate copies (carbon copies) of your e-mails.
INTERNETLOOKUP <yes/no> (no)
If set to Yes, GoldED will check the systemname in the nodelist
when doing a lookup and if the systemname looks like an Internet
address (contains an '@' char), the msg will be addressed to that
Internet address using the INTERNETGATE name/address if defined.
For example, let's say there was something like this in the
nodelist:
,999,somebody@somewhere,Whereever,Some_Body,...
And this in my GOLDED.CFG:
INTERNETLOOKUP Yes
INTERNETGATE 2:230/9316
Then if I did a lookup of "Some Body" and selected the entry with
the Internet address, GoldED would make a msg looking like this:
--------------------------------------
From : odinn@winboss.dk 2:236/77
To : somebody@somewhere 2:230/9316
Subj : whatever
--------------------------------------
Or if my gate was defined as "INTERNETGATE UUCP 2:230/9316":
--------------------------------------
From : odinn@winboss.dk 2:236/77
To : UUCP 2:230/9316
Subj : whatever
--------------------------------------
To: somebody@somewhere
So what's the use of all this? It allows you to make a
nodelist-style list of users with Internet addresses and use it
with GoldED so that you can do a lookup of normal names instead of
trying to remember strange Internet addresses. Of course something
similar could be done using the ADDRESSMACRO's, but with the
nodelist approach, you could build a "network" of users which have
offline Internet access via FTN-gate software and distribute the
nodelist for automatic processing.
INTERNETMSGID <yes/no> (no)
Specifies whether the FTN MSGID kludge should contain an RFC1036
compatible Message-ID or the normal FTS-9 format. Note that using
the RFC1036 format in MSGID breaks the FTS-9 (version 001)
specification, so please don't use this feature in FidoNet netmail
or echomail. As a safeguard, GoldED will only use the RFC1036
format in areas specifically marked as e-mail or newsgroups, using
the SOUPEMAIL and SOUPNEWSRCFILE keywords or using the Email and
News area types with the AREADEF keyword, even when INTERNETMSGID
is set to YES globally.
INTERNETREPLY <yes/no> (yes)
When INTERNETREPLY is enabled, GoldED always uses the FSC-35
REPLYADDR/REPLYTO kludges to gate replies to msgs from Internet
correctly. If disabled, GoldED only uses the FSC-35 method if the
Internet address is too large to fit in the max-35-character TO:
header field. Some gate software requires that the FSC-35 method
is used, while other software accepts Internet addresses directly
in the header.
INTERNETRFCBODY <yes/no> (no)
Tells GoldED whether to look for and process RFC headerlines at
the top of the message body, before the first empty line. Also
tells GoldED to insert its own RFC headerlines at the top of the
message body instead of as kludge lines. This option should only
be used when receiving Internet mail as QWK packets where the RFC
headerlines are usually found at the top of the messages, or when
sending Internet mail via FTN packet to a gateway running GIGO.
GIGO does not recognize RFC header in kludges, but it does
recognize them at the top of the messages, if it is properly
configured (with lines of "Allow_Xxx:" in GIGO's HEADERS.CFG,
where Xxx are the RFC headerlines the gate administrator wants to
allow).
INVALIDATE <type> <"findstring"> <"replacestring">
This is used to invalidate (change) certain control strings in
quoted text. Use this in conjunction with old versions of D'Bridge
or other software that chokes on control strings in quoted text.
As an added bonus feature, if the tearline or origin is
invalidated to a null string (""), they will not be quoted at all.
The <type> can be one of the following:
Tearline Invalidate tearline ("---").
Origin Invalidate origin (" * Origin: ").
Seenby Invalidate SEEN-BY's.
By default, the following invalidations are used:
INVALIDATE Tearline "---" "-+-"
INVALIDATE Origin " * Origin: " " + Origin: "
INVALIDATE Seenby "SEEN-BY" "SEEN+BY"
If you want to disable invalidation entirely, use this:
INVALIDATE Tearline "---" "---"
INVALIDATE Origin " * Origin: " " * Origin: "
INVALIDATE Seenby "SEEN-BY" "SEEN-BY"
The defined INVALIDATEs are also used during importing a file when
editing a mail in the internal message editor.
JAMHARDDELETE <yes/no> (no)
The default setting makes GoldED conform to the JAMAPI specs when
deleting msgs in JAM msgbases. This means that deleted msgs are
only marked as such in the message header, not in the index. As a
result, GoldED will find and display the deleted msgs until you
run a message pack utility to physically remove the deleted msgs.
If JAMHARDDELETE is set to Yes, GoldED will zap the reference to
the message in the index when deleting msgs. This way the deleted
msgs will not show up again later. The drawback of this approach
is that it is hard to undelete msgs, and may break other software
which assume 100% to-the-letter conformance to the specs. Note
however, that the hard-delete method is transparent to normal use
of JAM msgbases. Probably the only software that might break are
undelete utilities.
For the techies and programmers, the hard-delete method is simply
setting both UserCRC and HdrOffset in the index to 0xFFFFFFFF
instead of only the UserCRC. According to the JAMAPI specs, a
value of 0xFFFFFFFF in HdrOffset means that "there is no
corresponding message header". Sounds remarkably like a deleted
msg, right? :-)
JAMPATH <path> (defaults to the HUDSONPATH)
Defines the path where GoldED can access the NETMAIL/ECHOMAIL.JAM
files, which are used by mail processors to find and scan out mail
written by users.
GoldED can handle enviroment variables correctly in paths
specified in connection with this keyword. For example, if a path
is defined as %MAIL%\path\name, and SET MAIL=C:\POINT is in
AUTOEXEC.BAT (or whatever), then GoldED translates the path to
C:\POINT\path\name.
NOTE: The translation is done at config compile time, so if you
change the environment variable and haven't changed anything else
that would cause GoldED to recompile it's config, you must force
it with the -F or -FF command parameter.
KEYBCLEAR <yes/no> (no)
Tells GoldED whether or not to clear the keyboard buffer on
startup. This also clears KEYBSTACK or commandline key stuffing.
In older versions of GoldED, it was necessary to enable this
keyword if you had renamed GOLDED.EXE to DBEDIT.EXE. This version
detects the .EXE renaming and automatically enables KEYBCLEAR,
regardless of the configuration setting.
KEYBDEFAULTS <yes/no> (yes)
GoldED defines a default keyboard configuration setup internally.
The keys can be reconfigured in the GOLDKEYS.CFG file. By default,
the internal keyboard setup is active always, redefinable with the
definitions in GOLDKEYS.CFG. But in some cases it can be
preferrable that the internal keyboard setup is turned off, so
that only the keys in GOLDKEYS.CFG are active. If you want this,
set KEYBDEFAULTS to NO.
KEYBEXT <yes/no> (detect)
If enabled, GoldED will use extended bios calls to read the
keyboard. With the extended keyboard, you can use keys like
<Alt-Left>, <Alt-Home> and other extended keys. If you don't have
an extended keyboard, don't despair - using a few neat tricks, I
have made it possible to use some of the extended keys even with a
non-extended keyboard.
KEYBMODE <poll/block> (poll)
If this option is set to Poll, GoldED switches its keyboard
handling code from "blocking" to "polling" mode. This enables
GoldED to provide a continuously running statusline clock,
automatic internal editor autosave, timeout exit and screensaver.
If set to Block, the timeout exit and screensaver are disabled,
and the clock and autosave are dependent on key presses.
In order to minimize waste of CPU resources in keyboard polling
mode, GoldED automatically detects DESQview, Windows and OS/2 and
releases timeslices during the keyboard poll.
KEYBSTACK <keystring>
With this keyword, you can "stack" keys in the keyboard buffer.
The KEYBSTACK can be overridden by commandline keystacking, which
uses the same syntax.
The <keystring> can be a mixture of the following:
^Char Ctrl-key (^Letter).
~Char Ctrl-key (~Letter). (Use this with 4DOS!).
@Key Alt-key (@Number or @Letter).
Char Literal character.
"String" String, enclosed in double quotes.
'String' String, enclosed in single quotes.
Number Keyboard scan code (decimal).
! Clear keyboard buffer.
Whitespace (space and tab) is ignored, except in quoted strings.
See the Macros and Keystacking chapter for more info.
KLUDGE <kludge-definition>
The definition may optionally be enclosed in quotes. A definition
must be enclosed in quotes if it contains leading or trailing
spaces. The KLUDGE tells GoldED which kludges it should consider
as "known" in addition to the built-in known kludges.
Here are a bunch of examples, most of which are kludges generated
by the GIGO Internet gateway software:
KLUDGE " " ; For wrapped kludges
KLUDGE "Content-Type:"
KLUDGE "Date:"
KLUDGE "From:"
KLUDGE "In-Reply-To:"
KLUDGE "Message-Id:"
KLUDGE "Mime-Version:"
KLUDGE "Organization:"
KLUDGE "Newsgroups:"
KLUDGE "Received:"
KLUDGE "Reply-To:"
KLUDGE "Sender:"
KLUDGE "Subject:"
KLUDGE "To:"
KLUDGE "Errors-To:"
KLUDGE "X-FTN-From:"
KLUDGE "ORIGREF:" ; Gated?
KLUDGE "ORIGID:" ; Gated?
KLUDGE "RFC-" ; Seen in NET_DEV
The kludges defined with KLUDGE are not case-sensitive, but when
GoldED looks for the kludges, it matches to the exact length. This
means that for example "RFC-" will match all kludges beginning
with that string.
The ASCII 1 kludge char should not be included in the definition
string, but GoldED can handle it if you do.
KLUDGECHRS <yes/no> (yes)
If set to YES, GoldED uses the "^aCHRS" kludge instead of the
"^aCHARSET" kludge when appropriate.
LOADLANGUAGE <file>
If defined, this keyword will load a language definition file.
This feature can be used to load a small set of national language
definitions in national areas, an english set in international
areas, etc. Typically this would be used to load the definitions
of the date/time strings for use in the template and the
Msg/From/To/Subj strings in the header display.
In the ADVANCED archive, a set of GEDLNG*.CFG files are provided,
which are designed for use with LOADLANGUAGE. Please note that
there is also a @loadlanguage template token. This way you can
choose to load a language file from the template, or by using the
Random System. The template token takes precedence over the
LOADLANGUAGE in the Random System, but if both are defined, both
will be loaded.
This keyword can be used globally and in Random System groups, but
it is probably not very useful when used globally.
LOGFILE <file> (GOLDED.LOG)
Defines the name of the GoldED logfile. You should not change the
default.
LOGFORMAT <fd,max,bink,qbbs,db> (fd)
Defines the log format GoldED should use when writing to the
logfile.
LOOKUPECHO <yes/no> (no)
If enabled, GoldED will use nodelist lookup when entering the TO:
name in msgs in echomail areas.
GoldED *won't* lookup the name if it exactly matches the current
WHOTO - text. This is a feature, because a lookup of "All" is not
very useful. :-)
LOOKUPLOCAL <yes/no> (no)
If enabled, GoldED will use nodelist lookup when entering the TO:
name in msgs in local areas.
GoldED *won't* lookup the name if it exactly matches the current
WHOTO - text. This is a feature, because a lookup of "All" is not
very useful. :-)
LOOKUPNET <yes/no> (yes)
If enabled, GoldED will use nodelist lookup when entering the TO:
name in msgs in netmail areas.
LOOKUPUSERBASE <yes/no> (no)
If enabled, GoldED will attempt to find a matching username in the
user database if a to-name with wildcards is entered in echo or
local areas.
The userbase lookup feature is not new, but a need arose for an
option to turn off the lookup. I decided to let the default be to
disable the lookup. Previously the lookup was always enabled.
MAILINGLIST <echoid> <senderaddress> [contribution address]
Defines one or more mailing lists. When importing e-mail from a
SOUP packet, GoldED will look at the Internet address in the
"Sender" header and if it matches one of the MAILINGLIST's, the
e-mail will be tossed to the defined area. Note that GoldED
supports only participation in, not hosting of mailing lists. The
contribution address is the destination Internet address for mail
you write to the mailing list - the address is typically given to
you when you subscribe to a list. If the contribution address is
not specified, the senderaddress is assumed.
MAILTOSS <echoid> <contribution-address> <pattern>
This is acutally the same as MAILINGLIST in disguise with the
parameters recorded and it also enables the full set of pattern
matching. The <pattern> can be written exactly as if in the prompt
for the advanced search feature.
Any number of MAILTOSS lines can be given for a particular list,
if there is for some reason no single way to identify the list.
When determining the contribution address, the first MAILTOSS
(or MAILINGLIST) that matches the echoid is chosen.
MAILTOSS and MAILINGLIST can both be used at the same time and for
the same lists. MAILINGLIST is always the faster, because it looks
only at specific headerlines. MAILTOSS uses much more complex
pattern matching and can even match based on message body content.
MAPPATH <server filespec> <local filespec>
This keyword is used to map paths, for example if you have
different drive letters on a server machine and a workstation. You
might have your FidoNet mailer and mail processor setup to run
with the server drive letter (C:), but run GoldED from a
workstation where that drive is mapped to a different letter (J:).
If you use AREAFILE's to get the area configuration for GoldED,
you need to use MAPPATH to map the server drive letter to the
workstation equivalent.
Another case might be that you have a setup with DOS-style paths
and want to run the Linux version with the same GoldED setup. You
can then use MAPPATH to map the DOS drive-based paths to Unix
style paths.
Examples:
MAPPATH C: J:
MAPPATH C:\ /mnt/dos/c/
NOTE: You don't have to worry about backslash/forwardslash in this
case - they are always mapped automatically to the correct type
for the operating system.
MEMBER <echoid>
Defines Random System group members. See the Random System chapter
for details.
MENUDROPMSG <yes/no> (no)
Defines the default selection in the "Drop This Msg?" menu.
MENUMARKED <marked/current/previous/default> (default)
Specifies the position of the selection bar in the Marked/Current
menu.
Marked Set selector to Marked.
Current Set selector to Current.
Previous Set selector to previously selection.
Default Set selector to Marked if there are marked msgs.
Note that older versions (before 2.50) used the equivalent of the
"previous" setting.
MOUSE <yes/no> (no)
The mouse support in GoldED is currently not functional, so this
keyword is ignored.
MSGLISTDATE <written/arrived/received/no> (written)
Can be used globally and in groups. This keyword specifies the
default date shown in the right column in the message list. If
"no" is specified, the date column is removed and the space used
to widen the other columns. Personally I prefer to see the
"arrived" date, which is why I implemented this feature.
The key command LISTtoggledate (Ctrl-D) toggles between them.
Note that the "arrived" date doubles as the "processed" date for
messages that are written locally and scanned out from your
messagebase.
Not all messagebase formats supports all three dates. The table
below shows which messagebase supports which dates:
Written Arrived Received
JAM X X X
*.MSG X X
Squish X X
Ezycom X X
Hudson X
Goldbase X
PCBoard X
If a date is not supported, "n/a" (for "not available") is shown
instead.
MSGLISTFAST <yes/no> (yes)
The message lister can operate in two ways, fast or slow. In the
fast mode, only the message headers are loaded for the list
information. Depending on the msgbase format and message type,
some information may not be quite the same when presented in the
lister because information which is gathered from kludges or other
control information in the message text will be missing. Most of
the time this may not be a problem, so if you want speed, chose
the fast mode (default).
The slow mode loads and fully interprets the content of each
message before the message list is presented. The slowness is most
noticable when entering the lister and when paging up and down.
You may want to use the slow mode for areas with Internet
newsgroups and e-mail, where GoldED uses the "From" kludge to get
the real name of the message writer.
This keyword can be used globally and in Random System groups.
MSGLISTFIRST <yes/no> (no)
If enabled, GoldED automatically starts the message lister when
entering an area.
This keyword can be used globally and in Random System groups.
MSGLISTHEADER <yes/no> (no)
If enabled, GoldED shows the header of the current message when
you scroll the bar up and down. This is how it worked in previous
versions. If disabled, GoldED does not show the header and instead
uses the screen space to show more messages. By eliminating the
header display, it is also much faster at scrolling the list.
This keyword can be used globally and in Random System groups.
MSGLISTPAGEBAR <yes/no> (yes)
Enables or disables a pagebar (scrollbar) in the message list.
MSGLISTVIEWSUBJ <yes/no> (yes)
If enabled, GoldED will display the full subject in the bottom
border of the list window. Note that this feature slows down
scrolling a bit.
MSGLISTWIDESUBJ <yes/no> (no)
If enabled, the Subject column is made wider by removing the To
column. This is especially useful in gated Internet newsgroups,
where the To name is always "All".
You can toggle between wide and short subject with Ctrl-B
(keycommand LISTtogglewidesubj).
This keyword can be used globally and in Random System groups.
NAMESFILE <file> (NAMES.FD)
GoldED supports the "address macro" file supported by FrontDoor
and Maximus. If no path is specified, the file is first searched
for in the path from the "FD" environment variable and then the
GOLDPATH, if the FD variable failed.
The address macros are added *after* those defined with the
ADDRESSMACRO keyword (if any) (see this for details on the
format).
NICKNAME <your pseudo>
Defines the nick name (pseudo) for the current USERNAME. Can be
used globally and in random system groups.
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
NODELIST <file> [zone/addr]
Here you define the nodelists that are used by GoldED and the
companion nodelist compiler GoldNODE. The nodelists must generally
be in the standard "St.Louis" nodelist format, but they can also
contain FrontDoor/Version7 style Boss/Point extensions. The
default zone is defined by the first ADDRESS or AKA, but can be
overridden by adding the zone number or a full address after the
filename. GoldED currently needs it's own special index files to
use the nodelists. These index files are created by GoldNODE.
<file> Nodelist file. If the extension is .999 or a
wildcard (".*"), the newest file with a numeric
extension is used.
[zone/addr] Default zone or address for the nodelist (if no
zone info is present in the list itself).
See also the USERLIST keyword, and the Nodelist Browsing chapter.
NOTE: If you have nodelists with duplicate some of each others
nodes, the nodelist with the newest or most correct entries should
be placed LAST, and you should use the -D (remove duplicates)
option with GoldNODE.
NODELISTWARN <yes/no> (yes)
If set to YES, GoldED will warn you during startup if one or more
nodelists are missing. Use NO to disable the warning if it bothers
you or you delete/pack your nodelists when the nodelists are
compiled.
NOTE: GoldED can work fine with lookups etc. without nodelists as
long as it can access its own indexes (GOLDNODE.GX?). Only the
extra details will be missing.
NODEPATH <path>
This is where GoldED and GoldNODE finds the nodelist files and
indexes.
NODEPATHFD <path>
Path where GoldED can find the FrontDoor nodelist index files.
NODEPATHIM <path>
Path to the InterMail nodelist index files. This is actually just
an alias name of the NODEPATHFD keyword, since InterMail and
FrontDoor uses the same nodelist index files.
NODEPATHV7 <path>
Path where GoldED can find the Version 7 nodelist index files.
NOTE: For the Version 7 nodelist index support, GoldED *requires*
that the files SYSOP.NDX, NODEX.NDX and NODEX.DAT are present.
None of these files may be missing and no other filenames are
supported. Multiple sets of index files are not supported.
NODEV7FLAGS <flag> <value>
The Version 7 nodelist index does not by default define any
nodelist flags except the CM flag. Unfortunately the V7 index does
not point to the actual nodelist, it only has some bits which are
marked "reserved" in the specifications. The NODEV7FLAGS keyword
allows you to define the meaning of each of these bits.
The <value> field can be a number or a bit number. Allowed numbers
are: 32, 64, 128, 256, 512, 1024, 2048, 8192 and 16384. Allowed
bit numbers are: b5, b6, b7, b8, b9, b10, b11, b13 and b14.
Example:
NODEV7FLAGS MO b5
NODEV7FLAGS LO b6
NODEV7FLAGS MN b7
NODEV7FLAGS NC b8
NODEV7FLAGS ZEC b9
NODEV7FLAGS REC b10
NODEV7FLAGS NEC b11
NODEV7FLAGS XA b13
NODEV7FLAGS XX b14
See also the NODEV7MODEM keyword for other nodelist flags.
The nodelist flag bits in the index files are put in by your
Version 7 nodelist compiler. You must make sure that the nodelist
flag definitions in your nodelist compiler setup match those in
your GoldED setup.
NODEV7MODEM <type> <value>
The Version 7 nodelist index does not by default define any
nodelist modem type flags. Unfortunately the V7 index does not
point to the actual nodelist, it only has some bits which are
marked "reserved" in the specifications. The NODEV7MODEM keyword
allows you to define the meaning of each of these bits.
The <value> field can be a number or a bit number. Allowed numbers
are: 1, 2, 4, 8, 16, 32, 64 and 128. Allowed bit numbers are: b0,
b1, b2, b3, b4, b5, b6 and b7.
Example:
NODEV7MODEM VFC b0
NODEV7MODEM HST b1
NODEV7MODEM V34T b2
NODEV7MODEM V32B b3
NODEV7MODEM V34 b4
NODEV7MODEM V42B b5
NODEV7MODEM ZYX b6
NODEV7MODEM ISDN b7
See also the NODEV7FLAGS keyword for other nodelist flags.
The modem type bits in the index files are put in by your Version
7 nodelist compiler. You must make sure that the modem type
definitions in your nodelist compiler setup match those in your
GoldED setup.
ORGANIZATION <text>
Specifies the content of the RFC Organization header for Internet
messages.
ORIGIN <"string">
You can define many different origins for use in GoldED. You can
select one of the defined origins from the Origin selection menu
(the READchangeorigin keyword), which is also available from the
EDITMENU and the EDITSAVEMENU.
Leading and/or trailing spaces can be added by enclosing the
origin string in quotes.
This keyword can be used globally and in a Random System group.
NOTE: Origins defined in the Random System will always override
the global origins defined with this keyword, except when they are
selected from the EDITSAVEMENU.
OUTBOUNDPATH <path>
Defines a Binkley-style outbound path. Currently only used for
WaZOO .REQ file requests (see FRQWAZOO). This should be the name
of your primary outbound without extension.
OUTPUTFILE <file>
This is the default name of the file written using the
READwritemsg command.
This keyword can be used globally and in a Random System group.
OVERLAY <ems/ext/disk> (ems)
This keyword controls where GoldED places the overlay swap blocks.
GoldED (the standard DOS version) uses the Borland VROOMM dynamic
overlays to decrease the resident executable code.
See the DOSSWAP keyword for a warning note!
Ignored by the 386, W32 and OS/2 versions.
PCBOARDPATH <path>
Defines the default path where GoldED should look for the PCBoard
setup files if it can't find the PCBOARD environment variable.
PCBOARDUSERNO <userno> (0)
Specifies the lastread set used in the PCBoard message base.
PERSONALMAIL <startup,allnames>
Specifies options regarding the personal mail scan feature. None
of them are enabled by default.
If the "startup" option is used, GoldED scans for personal mail
while doing the startup mail scan.
If the "allnames" option is used, GoldED scans for mail to all the
USERNAME's instead of only the first. The default is not to scan
for personal mail at startup and to scan only for the first name.
This is faster.
Example:
PERSONALMAIL Startup, AllNames
The example makes GoldED scan for personal mail to all your
USERNAME's at startup.
PLAY <filename.ext/beepnoise>
See the EVENT keyword for a definition of the PLAY parameters.
This keyword can be used globally and in a Random System group.
PRINTDEVICE <devicename> (PRN)
Defines the name of the device used for printing. PRN is the
default, but LPTx can also be used. Printers on COMx ports may
also work, but this has not been tested.
Devices are opened in Write-Only text mode. The function has been
successfully tested to work with two popular peer-to-peer network
packages.
You should NOT use a filename as devicename. Use the filename
option in the Write menu instead.
PRINTFORMFEED <yes/no> (yes)
Used when printing messages. If enabled, it prints a Form Feed
(12d) character after each message.
PRINTINIT <printstring>
This keyword defines the command string sent to your printer to
initialize it before the actual printing.
The <printstring> can contain items like these:
$Hex A hexadecimal string.
#Decimal A decimal (integer) number.
"String" Text string, enclosed in double quotes.
'String' Text string, enclosed in single quotes.
Other chars Ignored.
PRINTLENGTH <lines> (60)
Defines the number of lines per page for printing. A formfeed is
printed when every time PRINTLENGTH lines have been printed.
PRINTMARGIN <characters> (80)
The right margin to use in printed messages.
PRINTRESET <printstring>
This keyword defines the command string sent to your printer to
reset it after printing.
<printstring> See the PRINTINIT keyword.
QUOTEBLANK <yes/no> (no)
If enabled, GoldED will put the QUOTESTRING on blank lines in the
quote. Otherwise blank lines are left blank in quotes.
QUOTEBUFFILE <filename>
If used, it sets the default filename for the quotebuffer. If no
path is specified, the GOLDPATH is used.
This keyword can be used globally and in Random System groups.
NOTE: If this keyword is used in globally (in GOLDED.CFG), it
effectively disables the automatically named quotebuffers, as
described in the chapter about the QUOTEBUFMODE keyword.
QUOTEBUFMODE <ask/append/overwrite> (ask)
Specifies what GoldED should do, if the quotebuffer file exists
already.
Ask A menu asks you to select append/overwrite/skip.
Append Always append, no asking.
Overwrite Always overwrite, no asking.
The "always overwrite" mode is not very useful I guess, but it's
there if you need it.
The quotebuffer feature automatically creates special filenames
for the buffer file, using these guidelines:
FORMAT FILENAME LOCATION
Fido GOLDED.QBF In the directory with the *.MSG's.
Hudson GOLDHxxx.QBF In the HUDSONPATH.
Squish filename.QBF Where the Squish area is.
Ezycom GLDxxxxx.QBF In the EZYCOMMSGPATH.
JAM filename.QBF Where the JAM area is.
Goldbase GOLDGxxx.QBF In the GOLDBASEPATH.
PCBoard filename.QBF Where the PCBoard area is.
Note that they all have extension .QBF so that you can easily find
them.
QUOTECHARS ["]<chars>["]
Defines up to 10 chars to recognize in addition to '>' as quote
string chars. This is most useful in gated Internet newsgroups,
where chars such as '|', ':' and ';' are sometimes used instead of
the '>'.
This keyword can be used globally and in Random System groups.
Example:
Group Internet:
Member alt.*, comp.*, net.email
Quotechars "|:;"
Username odinn@winboss.dk
EndGroup
The example is similar to the one I use myself (net.email is a
local netmail area where I import my gated e-mail from
winboss.dk). The username is my actual Internet address.
Note that using additional quotechars such as '|' and ':' may
cause odd results when quoting in the cases when they are actually
NOT used in a message as quotechars. Consider for example quoting
a smiley :-)
QUOTECTRL <Tearline,Origin,yes/no>
Specifies if you want quote tearline and/or origin in your
messages.
This keyword can be used in random system groups.
QUOTEMARGIN <chars> (70)
The margin to which quotes are wrapped. A negative value means
that the negative value is added to the DISPMARGIN (not
recommended).
QUOTESPACING <yes/no> (no)
If enabled, GoldED will automatically add blank lines before and
after a block of quoted text, if none are present already. This
improves the readability of some messages.
QUOTESTRING <quotespec> (" FL> ")
With this keyword you define how you want the quotestring to look
in your quoted replies.
The <quotespec> can contain these characters:
F Replaced with the first letter of the first name.
M Replaced with the letters of the middle names.
L Replaced with the first letter of the last name.
> Required quote-char.
Spaces Cosmetics.
Other characters are allowed but *not* recommended.
This keyword can be used globally and in Random System Groups.
QUOTEWRAPHARD <yes/no> (yes)
This keyword controls behaviour of quoted text (wrap or reflow).
QWKBADMSGS <echoid>
Specifies the area where messages in unknown conferences are put.
If you get messages tossed here by accident, you must move them
manually to the correct area. If the badmsgs area is not defined,
the messages will silently disappear. Messages tossed to the
badmsgs area will have the control line "AREA:<bbsid>_<confno>" at
the top of the message.
QWKCONFMAP <bbsid> ["]<confname>["] <echoid>
Defines the mapping between the BBSID and conference names in the
QWK packets and the echoid name of the conference as required by
GoldED. You MUST define a mapping for every conference that you
subscribe to. If you don't, the messages will be tossed to the
area defined by QWKBADMSGS or disappear. The <bbsid> is the name
listed on line 5 in CONTROL.DAT after the comma. The <confname> is
the conference names listed on line 13 and on alternate lines
onwards in CONTROL.DAT. If a conference name contains embedded
spaces, the <confname> must be enclosed in double quotes, like
this: "Main Board". The area <echoid> must be already defined
either in an AREAFILE or using the AREADEF or AREA keywords.
QWKEXPORTPATH <path>
Path where outgoing QWK reply files (BBSID.MSG) can be placed.
QWKIMPORTPATH <path>
Path where incoming QWK packet files (CONTROL.DAT and
MESSAGES.DAT) can be found.
QWKOPTIONS <bbsid> <options>
The <bbsid> is the BBSID (same as the name of the QWK packet) for
which the options will be active. The <options> can be any or a
combination of the following, separated by commas or spaces:
KLUDGES/NOKLUDGES: Defaults to NOKLUDGES. Specifies whether or not
to include the FidoNet-style kludges at the top of messages when
exporting to QWK. NOTE: Unless you enable this option, GoldED will
*not* include kludges in your QWK packets. You should check if the
BBS supports kludges in QWK packets. If it does, please enable
this option.
MIXCASE/NOMIXCASE: Defaults to NOMIXCASE. Specifies whether or not
the BBS allows mixed upper/lower case in the QWK message headers.
The default is to uppercase the TO and FROM header fields when
exporting to QWK packets.
RECEIPT/NORECEIPT: Defaults to NORECEIPT. Specifies whether or not
the BBS supports return receipt requests (RRQ). If the RECEIPT
option is enabled, GoldED will insert "RRR" at the front of the
subject field if the RRQ attribute is set on your messages, when
exporting to QWK packets.
QWKREPLYLINKER <cmd>
Commandline for a replylinker program to call after QWK import.
QWKTOSSLOG <file>
Name of a file where GoldED puts the echoids of each area where
articles have been imported. The tosslog file is intended to be
used with a replylinker. If no path is given, it defaults to the
GOLDPATH.
RA2USERSBBS <yes/no> (detect)
GoldED supports the two different formats of the Hudson USERS.BBS
file. With this keyword you can tell GoldED which format to use.
If set to YES, the RA2 format is used. Otherwise if the it is set
to NO, the Hudson format is used.
If this keyword is NOT used, GoldED tries to detect the format by
looking at the size of the USERS.BBS file and comparing this to
the record sizes of the RA2 and Hudson formats.
If the size matches one and not the other, the format is detected
to be of the matching type.
If the size matches both (which is quite normal), GoldED looks for
the RA environment variable and if found, in the RA config files
for the RA version.
If the size does not match either of them (indicating a possibly
damaged userfile), GoldED exits with an error message and writes
in the log with details of the problem and an advise to run a
userbase packing utility.
If used, this keyword should be placed in the configuration file
_after_ any AREAFILE keyword.
RCVDISABLESCFM <yes/no> (yes)
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
If this keyword defined to "no" then GoldEd will recognize RRq
(receipt request) and/or CFM (confirmation) flag on messages with
RCV (received) flag set. After that RRq and CFM flags will be
resetted. It is useful if your netmail tracker sets RCV flag
before you actually read messages.
REGISTERKEY
REGISTERNAME
These keywords do nothing and won't do anything in the future.
They were used when GoldED was a Shareware product.
REM
This keyword ignores everything behind it. This is useful to
comment a single line out.
REPLYLINK <chain/direct>
Defaults to "direct" for JAM and "chain" for everything else.
If set to "direct", GoldED will link your reply directly to the
original message. If set to "chain", it will link to the last
message in the reply chain. The default ("chain") is how GoldED
has done it in all previous versions.
The advantage of the "direct" linking method is that you can
easily find the the original message the reply was for. Unless of
course you have later re-linked using a chain-linking replylinker
utility. I can recommend the utility SQLINK by Serge Terekhov.
SQLINK links Squish areas using the MSGID/REPLY kludges and makes
direct links instead of chain-linking on the subject line like
most other replylinkers do. There are probably also similar
replylinkers for other msgbase formats, I just don't know them.
REPLYLINKLIST <fast/full> (fast)
When there is more than one reply to a msg in a JAM or Squish
area, GoldED pops up a list of the replies. This keyword affects
the contents of the list.
In the "fast" mode, the list data is based solely on what can be
found by reading the message header, which is quite fast.
Unfortunately some software does not (or cannot) fill the header
with the correct origination address. In that case, set this
keyword to "full", which makes GoldED read and scan each message
for control data to get the origination address. That can be very
slow.
ROBOTNAME <name>
A "robot" is a program on the Boss or Uplink system which responds
automatically to netmail messages. Usually the robot links or
unlinks echomail areas or distributed files.
The following ROBOTNAME's are defined by default:
AreaFix, AreaMgr, FileFix, AreaLink, AllFix, Raid, GEcho.
If you write a netmail message where the TO: name is one of the
robot names, GoldED will ignore any template definition, and give
you a blank msg (possibly with a tearline) to edit.
SCREENBLANKER <seconds> [BLACK] (180)
If non-zero, GoldED will blank the screen after the defined number
of seconds, and put a small moving window up instead. Hitting any
key (including shiftkeys) will return the screen to normal. If
zero, no blanking is done.
If the additional parameter "BLACK" is given, GoldED will switch
the screen completely black instead of showing its own animated
screenblanker. This is useful if you have a monitor with
powersaving-features.
Example:
SCREENBLANKER 300 BLACK
NOTE: This feature only works if KEYBMODE is set to "poll".
SCREENMAXCOL <columns> (0)
On some systems, GoldED may no detect the correct display size.
With this keyword you can force a specific size. If zero,
autodetect is used.
SCREENMAXROW <rows> (0)
On some systems, GoldED may not detect the correct display size.
With this keyword you can force a specific size. If zero,
autodetect is used.
SCREENPALETTE <reg> <value> OR <reg> (red green blue)
You can change the color palette used in GoldED. The palette has
16 color registers, corresponding to the 16 colors from black (0)
to intense white (15). By changing the values in the palette
registers, it is possible to make any of the 16 colors a
completely different color. You can even make the background
colors intense, without using the intense color feature. There are
64 different colors to chose from.
To configure the palette colors in GoldED, the SCREENPALETTE
keyword is used. There are two different syntaxes:
SCREENPALETTE <reg> <value>
SCREENPALETTE <reg> (red green blue)
So you can either compose the color value using separate red,
green, blue components, or directly use a precalculated value. The
red/green/blue values can only be in the range 0-3.
These are the original palette values:
SCREENPALETTE 0 (0 0 0)
SCREENPALETTE 1 (0 0 2)
SCREENPALETTE 2 (0 2 0)
SCREENPALETTE 3 (0 2 2)
SCREENPALETTE 4 (2 0 0)
SCREENPALETTE 5 (2 0 2)
SCREENPALETTE 6 (2 2 0)
SCREENPALETTE 7 (2 2 2)
SCREENPALETTE 8 (1 1 1)
SCREENPALETTE 9 (1 1 3)
SCREENPALETTE 10 (1 3 1)
SCREENPALETTE 11 (1 3 3)
SCREENPALETTE 12 (3 1 1)
SCREENPALETTE 13 (3 1 3)
SCREENPALETTE 14 (3 3 0)
SCREENPALETTE 15 (3 3 3)
Copy these lines into your GOLDED.CFG and start experimenting! :-)
If you have written a program to edit the palette and write a
GoldED palette setup file, please don't keep it a secret! :-)
SCREENSHADOWS <yes/no> (yes)
If enabled, all relevant windows and menus in GoldED will have
shadows.
SCREENSIZE <mode> (Auto)
Use this to force GoldED to use either 25 lines, 43/50 lines on
EGA/VGA, or even special videomodes supported by your SuperVGA
adapter (modes like 132x44, 100x40 or 80x60).
The <mode> can be one of the following:
Auto Use detected size.
25 Switch to 25 lines.
28 Switch to 28 lines.
4350 Switch to 43/50 lines.
Mode <NN> Switch to videomode NN (a hexadecimal value).
Please check your video adapter manual carefully before trying out
the Mode option. SELECTING A WRONG MODE CAN DAMAGE YOUR MONITOR!!!
The Mode option is ignored in the W32 and OS/2 version.
SCREENUSEBIOS <yes/no> (no)
If enabled, GoldED will use standard BIOS calls for screen
updates. This is VERY slow, and should only be used if really
needed. Normally GoldED uses direct screen writes.
This feature is only interpreted in the DOS version.
SEARCHFOR ["]<string|string|..>["]
Defines a set of search strings, separated by the '|' character.
The search set defined here is the default when using the Alt-F/Z
search functions or the marking system.
The '|' character works like an OR operator. That is, the search
is successful if one OR more of the strings are matched. The '&'
character is used as the logical AND operator.
Please refer to appropriate section in user's guide for more
information.
Older versions used the ';' semicolon character as a separator,
but that conflicts with the config reader which treats the
semicolon in a special way. The semicolon is still accepted as
separator char like '|', but if semicolons are used, you MUST
enclose the search strings with quotes or the config reader will
treat the first semicolon as the start of a comment.
Examples:
SEARCHFOR string1
SEARCHFOR string1|string2|stringx
SEARCHFOR "string1;string2;stringx"
SEARCHFOR "string 1"|string2&stringx
This keyword can be used globally and in Random System groups.
SEMAPHORE <type> <file>
This keyword defines "semaphore" files, for use with other mailer
and/or mail processing software.
The <type> can be one of the following:
NETSCAN Empty netmail scan file (for D'Bridge/FD).
ECHOSCAN Empty echomail scan file (for D'Bridge).
EXPORTLIST Echoid-list of your new messages.
IMPORTLIST Echoid-list of new imported messages.
The semaphore files are placed in the AREAPATH, if no path is
specified.
See the example .CFG files for typical semaphore filenames.
NOTE: You should not set SEMAPHORE EXPORTLIST to
%JAMPATH%\ECHOMAIL.JAM. This is incorrect and probably may cause
your mail processor to malfunction. Use the JAMPATH keyword
instead.
GoldED can handle enviroment variables correctly in paths
specified in connection with this keyword. For example, if a path
is defined as %MAIL%\path\name, and SET MAIL=C:\POINT is in
AUTOEXEC.BAT (or whatever), then GoldED translates the path to
C:\POINT\path\name.
NOTE: The translation is done at config compile time, so if you
change the environment variable and haven't changed anything else
that would cause GoldED to recompile it's config, you must force
it with the -F or -FF command parameter.
In addition, GoldED itself can watch for some semaphore files and
execute the appropiate function if it is in the arealist screen.
This can be useful if you have a multitasking system and you want
to "tell" GoldED that there is new mail in some areas and GoldED
should update its display correctly.
In detail, there are
EXITNOW <file> Quit immediately.
SCANALL <file> Scan all areas
SCANNETMAIL <file> Scan all netmail areas
SCANTHIS <file> Scan the areas listed in the file
PMSCANALL <file> PM-scan all areas
PMSCANNETMAIL <file> PM-scan all netmail areas
PMSCANTHIS <file> PM-scan the areas listed in the file
QWKIMPORT <file> Import QWK packets
QWKEXPORT <file> Export to QWK
SOUPIMPORT <file> Import SOUP packets
SOUPEXPORT <file> Export to SOUP
IDLETIME <seconds> Number of seconds between checks
If SEMAPHORE IDLETIME is defined and non-zero, then GoldED will
check this list of semaphore files when the user has not pressed a
key in the specified number of seconds. The semaphores are only
checked when the arealist screen is active. If a semaphore file is
found, the file is deleted and then the action is performed. If no
path is given for the files, the GOLDPATH is assumed.
Example:
SEMAPHORE SCANALL SCANALL.NOW
SEMAPHORE IDLETIME 30
This causes GoldED to check every 30 seconds for the SCANALL.NOW
file in the GOLDPATH, and scan all areas if it's found.
SERIALNO
Everything mentioned above about REGISTERKEY and REGISTERNAME
applied to this keyword.
SHAREMODE <yes/no/mode#> (yes)
If enabled, GoldED opens all files in a SHARE.EXE compatible mode.
The default share-mode is "Share Deny None", but another may be
specified directly if you give the mode number as the keyword
parameter (decimal).
It is normally not necessary to change the default.
SOUNDPATH <path> (defaults to the GOLDPATH)
Tells GoldED where to find the sound files for the PLAY and EVENT
keywords.
SOUPBADMSGS <echoid>
Specifies the area where "bad messages" from SOUP packets can be
tossed. It should be an echomail or newsgroup area.
SOUPEMAIL <echoid>
Specifies the area where Internet e-mails can be tossed. It must
be a netmail or e-mail area.
SOUPEXPORTMARGIN <margin> (76)
This is the margin that GoldED will hard-wrap to when exporting to
SOUP packets. If you're getting complaints that your lines are too
long, you may want to set this to 70 or 60.
NOTE: You should NOT enable EDITHARDTERM in email and newsgroups
that are exported to SOUP. If you do, your messages will probably
be exported with short line "droppings" after the wrapping margin.
SOUPEXPORTPATH <path>
Path where outgoing SOUP reply packet files (REPLIES and
GOLD*.MSG) can be placed.
SOUPIMPORTPATH <path>
Path where the incoming SOUP packet files (AREAS and *.MSG) can be
found.
SOUPNEWSRCFILE <file>
Name with full path of the NEWSRC file which lists the newsgroups
you are connected to. GoldED uses the list to mark the matching
areas as newsgroups. These will then be scanned for outgoing mail
when starting a SOUP export.
SOUPREPLYLINKER <cmd>
Commandline for a replylinker program to call after SOUP import.
SOUPREPLYTO <internet-address>
Internet-Address other users should use when they respond to your
mails (Reply-To Headerline).
SOUPTOSSLOG <file>
Name of a file where GoldED puts the echoids (newsgroup names) of
each area where articles have been imported. The tosslog file is
intended to be used with a replylinker. If no path is given, it
defaults to the GOLDPATH.
SQUISHDIRECT <yes/no> (no)
If enabled, then in Squish areas, if the DIR (direct) attribute is
set on a message, GoldED will automatically set both the CRA
(crash) and HLD (hold) attributes when saving the message.
According to the Squish Developers Kit, this is the way to tell
SquishMail that a message should be routed direct, because
SquishMail does not recognize the FLAGS kludge where the DIR
attribute is normally found. This keyword should probably only be
used with SquishMail (the mail processor) and then only when used
with Binkley or other so-called "static" mailers. DON'T use it
with FrontDoor!
SQUISHSCAN <api/quick> (quick)
Specfies whether to use a quick scanning method which only looks
in the .SQI files. This will normally work fine, but may fail
slightly in obscure cases, especially when used with Squish 1.0x
or programs using the old version of the MSGAPI. If you suspect
problems, try to set this keyword to "api", which tells GoldED to
look in the .SQD file for an exact count of active msgs in the
.SQI file.
NOTE: GoldED does NOT use the original MSGAPI by Scott Dudley.
Since version 2.50, a completely rewritten implementation is used.
SQUISHUSERNO <index> (0)
This sets the lastread index number for the Squish *.SQL lastread
files. Lowest number is 0 (zero), highest is (in theory) 65534.
If used, this disables the use of USER.BBS to find the index
number, and will in effect also stop GoldED from creating USER.BBS
or any new entries in it (useful in a single-user point system).
If a Squish msgbase is shared between several users, and you don't
want to have a USER.BBS (recommended in such a case), each user
must have a unique SQUISHUSERNO in their GOLDED/GOLDAREA.CFG.
SQUISHUSERPATH <path>[file]
This keyword defines the path where GoldED can find and use/create
your USER.BBS file, which is used in connection with the Squish
area lastreads. You can also specify the exact filename if not
USER.BBS.
If this path or filename is not defined, GoldED will instead take
the one specified with AREAFILE Squish or AREAFILE Maximus
(whichever comes first), or failing that, use the MAXIMUS or
SQUISH environment variables. If even that fails, the AREAPATH or
GOLDPATH is used. If AREAFILE Maximus is used, GoldED gets the
filename from MAX.PRM.
STATUSLINECLOCK <yes/no> (yes)
If enabled, GoldED will display a clock in HH:MM:SS format in the
right side of the statusline.
You can redefine the clock format with the language keyword
ST_STATUSLINETIMEFMT in GOLDLANG.CFG. See the Language Definition
chapter to details about the date/time codes you can use.
NOTE: The clock will only run continuously if KEYBMODE is set to
"poll".
STATUSLINEHELP <yes/no/nologo> (no)
If set to YES, GoldED will replace the "logo" in the left side of
the statusline with a text saying "F1 Help". This is for use in
"point package" setups where the user may be a complete novice,
maybe even to computers, and who needs to be guided to the help
screens. The "F1 Help" text is configurable with the
ST_STATUSLINEHELP language keyword (put it in GOLDLANG.CFG).
If set to NO, GoldED will display it's logo (name and version) in
the left side of the statusline.
If set to NOLOGO, GoldED will not display anything in the left
side. The middle part is extended to fill the space on the left
side.
STYLECODES <yes/hide/no> (hide)
If enabled (yes or hide), GoldED will highlight text surrounded by
one of the following characters in a different color: '*' for bold
text, '/' for italic text, '_' for underlined text and '#' for
reversed text. These are commonly used "stylecodes" which add
emphasis to the text, without making it harder to read. Examples:
*This* will be shown in bold color, /this/ in italic color and
_this_ in underlined color. It is also possible to combine styles,
such as */this/*, in bolditalic color.
The differ in yes and hide is that hide strips surrounding
stylecodes.
To define the highlight colors, use COLOR STYLECODE. See the color
chapter for details.
STYLECODEPUNCT <"charlist"> (" !\"$%&()+,.:;<=>@[\]^`{|}~")
STYLECODESTOPS <"charlist"> ("")
The STYLECODEPUNCT keyword specifies all the characters that
punctuates words. The stylecode line parser scans forward until it
meets one of these characters and then looks back to see if it
found a word with stylecodes around it.
The STYLECODESTOPS keyword specifies characters which, if found
within the word to be highlighted, causes the highlight to be
cancelled.
These keywords were added to allow users to experiment with the
characters for punctuation and stop for stylecode sequences. This
is mostly to illustrate the point that it is almost impossible to
make stylecodes work in every case you want without getting a lot
of false highlights too. Please keep in mind that stylecodes are,
and always will be, a primitive and very error-prone method for
adding highlights to message text. The defaults are:
STYLECODEPUNCT " !\"$%&()+,.:;<=>@[\]^`{|}~"
STYLECODESTOPS ""
Note that the double-quote (") must have the backslash (\) in
front of it - the sequence (\") is translated to a single (").
SWAPPATH <path> (defaults to TEMPPATH)
Defines where the swap file will be placed in case of disk
swapping in DOS shells. It is recommended that this points to a
RAM disk, if available. GoldED needs 3-500k free disk space for
the swapfile, depending on the overlay buffer size specified with
the -O commandline switch.
This keyword is only interpreted by the DOS platform version.
TAGLINE <string or filename>
Defines one or more taglines. A tagline collection filename can be
specified if prepended with an '@' character, like this: TAGLINE
@TAGLINE.LST. If a tagline collection file is used, GoldED will
create an index file for it the first time it is used or any time
the file is edited. The index file has the same name, but
extension ".SDX". The index file is an array of 32-bit long
integers, containing the offset of each line in the tagline
collection file.
This keyword can be used globally and in a Random System group.
Taglines defined in the Random System *always* overrides the
default global taglines defined with this keyword.
TAGLINECHAR <char> ('.')
Defines the character GoldED uses when putting a tagline in your
message. The default is '.'. You should not change this default.
GoldED itself only recognizes taglines with '.' or '_'
(underscore).
TAGLINESUPPORT <yes/no> (yes)
Allows you to turn off the internal tagline support, in case it
turns out to be too buggy or if you want to use one of the many
good external tagline utilties out there instead.
TASKTITLE <string> (@longpid)
Sets window title in Win32 and OS/2 versions, ignored in other.
TEARLINE <string> (@longpid @version)
Here you can define your default tearline. The tearline can be up
to 76 chars long (excluding the leading "--- "), but beware that
policies (such as FidoNet ECHOPOL1) may set a significantly lower
limit (around 30).
This keyword can be used globally and in a Random System group.
Tearlines defined in the Random System *always* overrides the
default tearline defined with this keyword.
If your tearline does not contain at least the string "GoldED" or
"GED", GoldED will automatically insert it's PID kludge. See also
description of USEPID keyword.
TEMPLATE <file> ["desc"] [match-address] (GOLDED.TPL)
You can define many different template files. The templates can be
switched using the READchangetemplate (Ctrl-T) popup menu or the
EDITMENU.
The optional "desc" can be used to give the templates more
meaningful names like "International template" instead of
non-obvious names like "GOLDED.TPL". If a description is used, it
must appear before the match-address. It must always be enclosed
in quotes, even if it is only one word.
The match-address is an address mask (wildcards allowed) which can
be used to tell GoldED to select that template if the destination
address on a message you write matches the match-address. The
matching will only take place if the TEMPLATEMATCH keyword has
been enabled.
This keyword can be used globally and in a Random System group. In
Random System groups, only the <file> parameter can be used.
Templates defined in Random System groups always override the
globally defined templates, except when selected from the EDITMENU
or when automatic template matching is in effect.
To override the automatic template matching, start by selecting a
template manually using the READchangetemplate (Ctrl-T) command or
the EDITMENU.
Currently only one match-address per template can be specified,
but you can specify several TEMPLATE keywords for the same file.
Example:
// Use DANSK.TPL for messages to Danish nodes/points.
TEMPLATE DANSK.TPL "Danish" 2:23/*
TEMPLATE DANSK.TPL "Danish" 2:234/*
TEMPLATE DANSK.TPL "Danish" 2:235/*
TEMPLATE DANSK.TPL "Danish" 2:236/*
TEMPLATE DANSK.TPL "Danish" 2:237/*
TEMPLATE DANSK.TPL "Danish" 2:238/*
// Use INTERNET.TPL for messages to the WinBoss gateway
TEMPLATE INTERNET.TPL "Internet" 2:230/9316
// Use ENGLISH.TPL for messages to everywhere else
TEMPLATE ENGLISH.TPL "English" *
TEMPLATEMATCH <yes/no> (no)
If enabled, GoldED will select a template which matches the
destination address on messages that you write. This keyword can
be used globally or in random system groups.
TEMPLATEPATH <path> (defaults to the GOLDPATH)
Defines the default path for msg templates. Use this if you want
to place templates in a path separate from the GOLDPATH.
TEMPPATH <path>
Defines the directory where temporary files are placed by GoldED
and GoldNODE.
This path should *NOT* point to a RAM disk or other volatile
media!
GoldNODE uses this path to store a temporary file which can become
as large as the largest index file (GOLDNODE.GXN), so again, don't
point it to a small RAM disk. If GoldNODE cannot find a TEMPPATH,
it will use the NODEPATH instead.
TIMEOUT <seconds> (0)
Similar to the screen blanking (SCREENBLANKER) feature, GoldED can
auto-exit after a specified period of time. Useful if you are in a
hurry (or didn't get enough sleep last night ;-), and run GoldED
from your mailer shell. The timeout value can be overridden with
the -T commandline option.
NOTE: This feature only works if KEYBMODE is set to "poll".
TIMEOUTSAVEMSG <yes/no> (yes)
If set to YES, GoldED behaves as usual: It saves the (perhaps
partially written) msg text in the internal editor to the msgbase
and exits. If set to NO, GoldED will save the msg text in
GOLDED.MSG just as if EDITAUTOSAVE function was in use and the
power went out. Next time you started GoldED and entered a msg, it
would detect the "lost" msg and ask you if it should be continued.
+TITLESTATUS <yes/no> (yes)
If enabled then brief status will be added to title. (Win32 and
OS/2 versions only)
TWITMODE <mode> (Blank)
In GoldED you can define several "Twit" names, addresses or
subjects. With this keyword you can specify the action taken when
a Twit message is encountered.
The <mode> can be one of the following:
Show Show twit messages.
Blank Blank twit messages.
Skip Skip twit messages, unless to your USERNAME's.
Ignore Skip twit messages, always.
Kill Deletes twit messages, *without* confirmation!
This keyword can be used globally and in a Random System group.
TWITNAME <name/address>
With this keyword, you can specify "Twit" names and/or addresses.
When a Twit name/address is detected, the TWITMODE setting will
determine the action taken.
TWITSUBJ <"string">
With this keyword, you can specify "Twit" subjects. When a Twit
subject is detected, the TWITMODE setting will determine the
action taken. The subject string is searched in the entire subject
text, so you can specify a partial twit subject. Twit subjects are
limited to maximum 35 characters.
TWITTO <yes/no> (no)
If enabled, GoldED will check both from- and to-names when
checking for twitnames. By default only the from-names are
checked.
This is a global keyword and won't work as intended if used in a
random system group.
USECHARSET <yes/no> (yes)
If set to no then GoldEd will not generate @CHRS and @CHARSET
kludges.
USEFLAGS <yes/no> (yes)
If enabled, GoldED inserts the FLAGS kludge for certain extended
attributes, as defined in FSC-0053 by Joaquim H. Homrighausen, and
supported by FrontDoor, D'Bridge, IMail and other modern software.
GoldED uses FLAGS to emulate the Hold and Freq attributes which
are not defined in the Hudson message format.
USEFWD <yes/no/ask> (yes)
If enabled, GoldED inserts the FSC-0092 kludges introduced by the
author of FleetStreet, Michael Hohner. These are
FWDFROM The original From-Name
FWDORIG The original From-Aka
FWDTO The original TO-Field
FWDDEST The original TO-aka (only in netmails)
FWDSUBJ The original subject
FWDAREA The original areatag
FWDMSGID The original MSGID (useful for reply-linking)
When forwarding, GoldED now adds these kludges, unless the
original message already contains them, in which case they are
preserved. When doing a normal reply (Alt-Q or Alt-R) to a message
with the FWD kludges, GoldED replies to the forwarder. To reply to
the from-name in the forwarded message, use the comment-reply
function (Alt-G). If the message contains the FWDAREA kludge, you
can reply to the forwarder in the original area (Alt-N) or reply
to the from-name in the original area (Alt-B). Note that it is not
possible to reply to the to-name of a message with the FWD
kludges, and it is also not possible to reply to the to-name of
the forwarded message (the FWDTO name).
USEINTL <type> (yes)
The INTL kludge is normally only inserted in netmail messages, if
the origination zone is different from the destination zone (the
"Auto" setting), but on systems with many AKA's in the mailer, it
might be useful/necessary to add it ALWAYS (the "Yes" setting).
The "No" option should never be used.
The <type> can be one of the following:
Auto Only insert in inter-zone netmail.
Yes Always insert. Recommended and default.
No Never insert.
USEMSGID <yes/no> (yes)
If enabled, the MSGID kludge is inserted in netmail and echomail,
and the REPLY kludge is inserted when replying to a msg with a
MSGID.
The MSGID kludge is defined in FidoNet document FTS-9.
USEPID <yes/no> (no if GoldEd mentioned in tearline, yes otherwise)
If disabled then @PID kludge will not be used in your messages
regardless of tearline contents.
USERLIST <file> [zone/addr]
In addition to normal nodelist support, GoldED also supports the
"FIDOUSER.LST" style userlist format. The default zone is defined
by the first ADDRESS or AKA, but can be overridden by adding the
zone number or a full address after the filename.
<file> Userlist file in FIDOUSER.LST format.
[zone/addr] Default address for the userlist (if no zone info
is present).
USERLISTFILE <file> (GOLDED.LST)
GoldED can generate a list of all users in the current area. This
keyword defines the default name of the FIDOUSER.LST style
userlist output file generated with the READmakeuserlist command.
USERNAME <name>[[,]< >address]
You can define many different names/aliases. When GoldED finds an
un-received message to one of your USERNAME's, it is marked as
received. Useful if you use alias names in some conferences. It is
possible to change the current name using the READchangeusername
popup menu.
For msgbase formats with an associated user database, GoldED uses
the *first* defined USERNAME to look in the user database for
which lastread record to use. If your name is not found, it is
added and a new lastread record created.
Example:
USERNAME Odinn Sorensen, 2:236/77.999
This keyword can be used globally and in a Random System group.
USETZUTC <yes/no> (no)
Activates usage of TZUTC kludge in your messages. You should
properly setup timezone information in your OS. For example,
in DOS you should set environment variable TZ to something
like this:
TZ=MSK-3MSD,M3.5.0/02:00,M10.5.0/03:00
This line valid for Moscow, Russia.
This option could be used in random system groups.
UUDECODEPATH <path>
Specifies the path where files are placed when using the uudecode
feature. Files are placed in current directory if a path is not
specified.
The specified path *must* exist !
VIEWHIDDEN <yes/no> (no)
Hidden lines are "unknown" kludge lines. If enabled, hidden lines
will be displayed (in a different color) when reading msgs.
A hidden line is defined as a line which has the FidoNet kludge
char (^a, ASCII 1) as the first char and is not on the list of
internally or user defined known kludges.
This keyword can be used globally and in a Random System group.
IMPORTANT NOTE:
In some conferences the hidden lines are used to give witty
comment "between the lines" in the plain text, but generally it is
considered a bad practice and should be avoided because it may
cause severe technical problems if a witty comment in a hidden
line happens to match a (perhaps experimentally) defined kludge
somewhere. It should also be noted that hidden lines are not kept
in their original places when used in the JAM msgbase. This is due
to the way the JAM specification stores FidoNet kludges.
VIEWKLUDGE <yes/no> (no)
If enabled, known kludge lines will be displayed (in a different
color) when reading msgs.
Known kludges are those defined internally in GoldED plus those
defined with the KLUDGE keyword.
This keyword can be used globally and in a Random System group.
VIEWQUOTE <yes/no> (yes)
This is an experimental feature. It is similar to the VIEWHIDDEN
and VIEWKLUDGE keywords, but for quoted text. I implemented it
because I was annoyed with the excessive quoting often seen in
Internet newsgroups. When this keyword is set to NO, GoldED
attempts to trim down the quotes so that only the first line of
each quote block is shown. It is not always successful, sometimes
the result is not so useful.
A key command has been added to supplement this feature:
READtogglequote. Suggested key assignment: Ctrl-V. Example:
^V READtogglequote
Try it out if you are annoyed with excessive quotes.
This keyword can be used globally and in a Random System group.
WHOTO <name>
This name is inserted in the TO: name field, when entering new
messages (not replies) in echomail or local areas.
This keyword can be used globally and in a Random System group.
WILDCATUSERNO <userno>
Defines the lastread set used in the WildCat! 4.x message base.
XLATCHARSET <importid> <exportid> <file>
This keyword defines character set translation table files.
<importid> Charset import identifier.
<exportid> Charset export identifier.
<file> Charset translation table file.
See the Character Translation chapter for details.
XLATESCSET <import> <export> <escfile>
This keyword defines escape sequence translation table files.
<importid> Escset import identifier.
<exportid> Escset export identifier.
<file> Escape sequence translation table file.
See the Character Translation chapter for details.
XLATEXPORT <charsetid>
Defines the export charset for your messages. See the Character
Translation chapter for details.
This keyword can be used globally and in a Random System group.
It can also be used in templates (the @xlatexport token).
XLATIMPORT <charsetid> (IBMPC)
Defines the local charset for your machine. See the Character
Translation chapter for details.
This keyword can be used globally and in a Random System group.
XLATLOCALSET <charsetid> (IBMPC)
Use this keyword to specify the actual physical charset in effect
for text screen display. This was previously the hardcoded value
IBMPC, corresponding to the IBM codepage 437 (or the nordic
edition 865).
NOTE: All charset translation files must translate from and to the
charset identified with the XLATLOCALSET keyword!
XLATPATH <path>
This is the path where GoldED tries to find the XLATCHARSET and
XLATESCSET files.
ZONEGATING <yes/no/ask> (ask)
When writing a netmail message to a destination in another zone,
you can either send the message directly (No) or via the local
ZoneGate (Yes). You can also be consulted each time (Ask). GoldED
won't ask if Cra or Hld attribute is set.
#page
#---------------------------------------------------------------------
#chapter Obsolete Keywords
This is a list of keywords which were used in various older versions.
These keywords are now obsolete, either because they have been renamed
or replaced, or if they no longer have any function. Most of the
keywords are still active and remapped to the new names.
To check if you have obsolete keywords in your setup, run GoldED with
the -F -D commandline parameters. Then if you get a number of "Unknown
keyword" warnings, you should replace the old keywords with the new
ones or remove them.
Old keyword: New keyword:
AREAAUTOFREQ AREAFREQTO
AREABADMSGS SOUPBADMSGS
AREASORT AREALISTSORT
ASSIGNTO MEMBER
AUTOATTACH EDITAUTOATTACH
BEEPFACTOR (removed)
BLANKTIME SCREENBLANKER
BOARDNOS (removed)
CCATTRIB ATTRIBSCC
CCLIST CARBONCOPYLIST
CFMATTRIB ATTRIBSCFM
CHANGEDATE EDITCHANGEDATE
CHANGEPROMPT (removed)
CHARSET XLATCHARSET
CLEARKEYS (removed)
COLOUR COLOR
COMMENTNOISE BEEPCOMMENT
COOKIEFILE (removed)
CRLFTERM EDITCRLFTERM
DELORIG ASKDELORIG
DISPMSGLIST MSGLISTFIRST
DISPMSGLISTFAST MSGLISTFAST
DISPSTYLECODES STYLECODES
ECHOATTRIB ATTRIBSECHO
ECHOINFO CTRLINFOECHO
EDITMARGIN (removed)
EDITORVERSION (removed)
ELIMSNOW (removed)
ESCSET XLATESCSET
EXCLAREA AREAEXCL
EXPORTCHARSET XLATEXPORT
EXTKEYS (removed)
FIDOLASTREADNO FIDOUSERNO
FIELDCLEAR EDITFIELDCLEAR
FILECHECK (removed)
FILECHECKALL (removed)
FREEAREA (removed)
FREETEAR (removed)
GOLDEDCFM CONFIRMFILE
GOLDEDLOG LOGFILE
GOLDEDLST USERLISTFILE
GOLDEDMSG EDITORFILE
GOLDEDNAM NAMESFILE
GOLDEDPRN OUTPUTFILE
GOLDHELP (no longer documented)
GOLDKEYS (no longer documented)
GOLDLANG (no longer documented)
GOLDRAND (no longer documented)
GOLDXLAT (no longer documented)
HARDLINE EDITHARDLINE
HARDLINES EDITHARDLINES
HWMARKS (removed)
INCLAREA AREAINCL
INTERNALEDITOR EDITINTERNAL
LASTREAD FIDOLASTREAD
LASTREADUSER FIDOUSERNO
LISTWRAP (removed)
LOCALATTRIB ATTRIBSLOCAL
LOCALCHARSET XLATIMPORT
LOCALHIGHLIGHT (removed)
LOCALINFO CTRLINFOLOCAL
LOCALNOISE (removed)
MAPDRIVE MAPPATH
MATCHAKA AKAMATCH
MAXCOLS SCREENMAXCOL
MAXMSGSIZE EDITMSGSIZE
MAXROWS SCREENMAXROW
MIXCASE EDITMIXCASE
MULTIQBBS (removed)
NETATTRIB ATTRIBSNET
NETINFO CTRLINFONET
NETTEAR CTRLINFONET performs similar function
NEXTAREA AREANEXT
NEXTMSGS (removed)
NODELISTPAGEBAR (removed)
NOISEFACTOR (removed)
OVERLAYEMS OVERLAY performs similar function
OVERLAYEXT OVERLAY performs similar function
PAGEBAR (removed)
QBBSINCRESCAN (removed)
QBBSPATH HUDSONPATH
QBBSREBUILD (removed)
QBBSSCAN (removed)
QMSGPATH HUDSONPATH
REALMSGNO (removed)
REBUILD (removed)
RENAREA AREARENAME
REPLYRE EDITREPLYRE
RIGHTMARGIN DISPMARGIN
SAVEMENU EDITSAVEMENU
SAVETIME EDITAUTOSAVE
SAYBIBI (removed)
SCANAREA AREASCAN
SCREENELIMSNOW (removed)
SCREENUSEANSI (removed)
SHADOWS (removed)
SHARE SHAREMODE
SHOWTWITS TWITMODE
SIGNALFILE SEMAPHORE
SOUNDDEVICE (removed)
SPACEQUOTES (removed)
SPELLCHECKER EDITSPELLCHECK
STACKKEYS KEYBSTACK
STARTECHO AREASTART
SWAPALL DOSSWAP
SYSOP USERNAME
TABSIZE DISPTABSIZE
TAGLINEFILE (removed)
TIMESLICE (removed)
TIMEZONEOFFSET USETZUTC performs similar function
UNDELETELINES EDITUNDELETE
USEBIOS SCREENUSEBIOS
XPLIST CROSSPOSTLIST
#page
#---------------------------------------------------------------------
#chapter Location Dependent Configuration Keywords
The following configuration keywords are location dependent and should
be placed in a particular order in the configuration file(s). Keywords
that are *not* listed can be placed anywhere you want.
The keywords are listed in groups of those that depend on each other.
They are listed in the recommended order within each group. The order
between the groups is not important, with one noted exception.
Name/Address/Areas:
USERNAME
ADDRESS
AKA
ATTRIBSNET Specifies default attributes for AREAFILE etc.
ATTRIBSECHO As above.
ATTRIBSLOCAL As above.
FIDOMSGTYPE
PCBOARDPATH Recommended if you use PCBoard.
MAPPATH
AREARENAME Rename occurs before AREAEXCL/INCL.
AREAEXCL
AREAINCL
AREAISEMAIL
AREAISNEWS
AREAPATH Default path for the AREAFILE's.
AREAFILE
RA2USERSBBS Overrides AREAFILE RemoteAccess.
AREADESC Add description and more to some AREAFILE's.
AREA Overrides areas in AREAFILE's.
AREADEF As above.
Paths:
GOLDPATH
TEMPPATH MUST be in GOLDED.CFG. Used only by GoldNODE.
SWAPPATH
Nodelists: MUST be below ADDRESS/AKA and ONLY in GOLDED.CFG!
NODEPATH
NODELIST
USERLIST
EXCLUDENODES Remember to replace "ALL" with '*'.
INCLUDENODES As above.
Colors:
INTENSECOLORS Selects a default intense colorset if enabled.
COLORSET Selects a default colorset.
COLOR
External utils:
EXTERNOPTIONS
EXTERNUTIL
Character translation:
XLATPATH
XLATCHARSET
XLATESCSET
Random System:
GROUP Starts a group.
MEMBER Defines areas that are members of the group.
<Group Items> See the Random System chapter for a list.
ENDGROUP Ends a group.
#page
#---------------------------------------------------------------------
#chapter Message Attributes Reference
This is a list and description of all message attributes that are
supported by GoldED in the keywords that accept attribute settings or
can be displayed in the header.
A/S Archive/sent.
ARQ Audit request.
ATT File attached.
CFM Confirmation receipt requested.
COV Fax cover letter.
CRA Crash - high priority mail.
DEL Deleted.
DIR Direct. Don't route this message.
FAX Fax image attached.
FRQ File request.
GRP Group message.
HIR Fax hi-resolution image.
HLD Hold for pickup.
HUB Host- or Hub-route message.
IMM Immediate - Send message NOW!
K/S Kill/sent. Delete message automatically after it is sent.
KFS Kill/file/sent. Delete attached files after they are sent.
LET Fax letterhead.
LOC Local. Message was written on your system.
LOK Lock. Prevents send/delete/purge/editing.
ORP Orphan. Could not be sent because destination node is unknown.
PRN Msg has been printed. Specific for Squish (bitvalue 00040000h).
PVT Private. Message may only be read by the addressee and author.
R/O Read only. Used in area definitions to prevent writing.
RCV Received. Read by the addressee.
RRC Return receipt.
RRQ Return receipt requested.
RSV FTS-1 reserved (unused) attribute.
SIG Fax signature.
SNT Sent. Message has been sent or exported from the msgbase.
TFS Truncate/file/sent. Truncate files to zero length when sent.
TRS Transit. Message passing through, not for you.
UNS Unsent message.
URQ Update file request.
XMA Xmail. Attach does not conform to the ARCmail 0.60 standard.
ZON Zonegate. Route through zonegate if possible.
#page
#---------------------------------------------------------------------
#chapter Area Configuration
GoldED offers a wide variety of methods for defining message areas.
You can define each area manually in the GOLDED.CFG file (or an
INCLUDE'ed GOLDAREA.CFG file), or you can tell GoldED to read the area
setup files of many popular BBS/mailer/mail processor packages.
For manual definition of areas, use the AREA or AREADEF (recommened)
keywords.
For external area configuration, the general syntax for the AREAFILE
keyword is:
AREAFILE <programname> [path or filename(s)] [-options]
Available options:
-NoChk
Normally GoldED will check the areafile timestamps when starting
up, and recompile the configuration if a file was changed. If this
option is given for any AREAFILE, those areafiles will not be
checked. This can be useful in cases like TosScan, GEcho, IMail
and several others which "touch" their files every time they run.
-S<sortspec>
If you are *not* using the global AREALISTSORT keyword for sorting
all the areas, you can sort the areas of each AREAFILE separately.
See the AREALISTSORT keyword for the definition of <sortspec>.
If no path is specified, the appropriate environment variable or the
AREAPATH is used to find the files.
The <programname> can be one of the following:
AdeptXBBS
Reads the AdeptXBBS configuration files.
Looks for the ADEPTXBBS environment variable.
AreasBBS
GoldED is can handle a wide variety of AREAS.BBS type files. It
can read and distinguish between the old CONFMAIL style with paths
for *.MSG areas, the Hudson/Goldbase style with board numbers, the
Squish style with "$basename" and the JAM style with "!basename".
The disadvantage of using an AREAS.BBS is that there are no area
descriptions. The echoid is used as description instead. However,
GoldED will use any text behind a semicolon on definition lines as
description. This may or may not be compatible with mail
processors, so be careful. A better solution may be to use the
AREAFILE Echolist to add descriptions from a separate file.
One or more AREAS.BBS files may be specified on the same line.
Concord
Support is planned but not yet implemented.
D'Bridge
Reads the DBRIDGE.AA1/.AA2 files (for version 1.30) or the
DBRIDGE.ADF of the later versions.
Looks for the "DBRIDGE" and "DB" environment variables.
Dutchie
Reads the DUTCHIE.ARE file.
Looks for the "DUTCHIE" environment variable.
Echolist
Reads a simple ascii-text file containing an echolist in this
format:
<echoid> <description>
or DZ-format (requires -DZ switch):
[Status], Tag, Comment, Moderator's Name, Address,[Flags]
This feature adds descriptions to already existing areas in
GoldED. Example:
AREAFILE AreasBBS AREAS.BBS
AREAFILE EchoList ECHOLIST.TXT
AREAFILE EchoList echo5020.lst -dz
Descriptions for unknown echoids are ignored. Blank lines and
lines beginning with characters which are illegal in echoids (such
as ';') are also ignored.
Additional switch -SqaFix could be used to read echolist and groups
from SqaFix configuration file:
AREAFILE Squish C:\SQUISH\
AREAFILE EchoList C:\SQUISH\SQAFIX.CFG -SqaFix
Ezycom
Reads CONFIG.EZY and MESSAGES.EZY. Supports Ezycom 1.02 and 1.10g,
but not 1.01.
Looks for the "EZY" and "TASK" environment variables.
FastEcho
Reads the FASTECHO.CFG file. Supports version 1.10 up to 1.46.
Looks for the "FASTECHO" environment variable.
Fidoconfig
Reads fidoconfig (used in Husky Project software). Supports
version 0.15. Used parser is more powerful than original from
fidoconfig, due to it strictly follows specification from proposal
and implements all features from there. Additionaly it implements
groups not described in proposal but used in in library.
Looks for the "FIDOCONFIG" environment variable.
FidoPCB
Reads FIDOPCB.CFG. Supports version 1.x.
Looks for the "FIDOPCB" environment variable.
FMail
Reads FMAIL.CFG and FMAIL.AR. Supports versions 0.92, 0.98, 1.0g,
and 1.20.
Looks for the "FMAIL" environment variable.
FrontDoor
Reads the SETUP.FD/FD.SYS and FOLDER.FD/FOLDER.SYS files. If you
want the real echoid's attached to the areas, you will also need
to supply the filename of the relevant AREAS.BBS file(s). Supports
versions 1.99c and 2.xx.
Looks for the "FD" environment variable.
GEcho
Reads SETUP.GE and AREAFILE.GE. Supports versions 1.00, 1.02,
1.10, 1.11 and 1.20.
Looks for the "GE" environment variable.
IMAIL
Reads the IMAIL.CF and IMAIL.AR files. Supports version 1.60,
1.7x and 1.8x.
Looks for the "IMAIL" environment variable.
InterMail
Reads the FD.SYS/IMSYS.CFG and FOLDER.CFG/IMFOLDER.CFG files.
Supports version 2.26 and newer.
Looks for the "IM" environment variable.
LoraBBS
Reads the CONFIG.DAT and SYSMSG.DAT files. Supports version 2.33,
2.40 and possibly others.
Looks for the "LORA" and "LORABBS" environment variables.
Maximus
Reads the MAX.PRM and AREA.DAT or MAREA.DAT files. Compatible (or
should be) with both the old (1.xx) and (2.xx) and new (3.xx)
formats. If your AREA.DAT is named differently, you must supply
the correct filename.
Looks for the "MAXIMUS" environment variable.
ME2
Reads the old ME2 editor AREADESC.ME2 file and AREAS.BBS file(s).
You must supply the names of both files.
Opus
Reads the Opus 1.1x SYSTEM??.DAT files or the Opus 1.7x SYSMSG.DAT
file.
Looks for the "OPUS" environment variable.
ParToss
Reads the ParToss configuration file.
PCBoard
Reads the PCBOARD.DAT, CNAMES.@@@ and CNAMES.ADD files. Supports
version 14.x and 15.x, up to and including 15.22. Note that,
depending on the version, echoid's may not be read from this
format. If the echoid is not available, the description is used as
echoid, after conversion to uppercase and spaces to underscores.
Looks for the "PCBOARD" environment variable.
Portal
Reads the PORTAL*.CFG and PORTAL.ARE files.
Looks for the "POPCMDLINE" environment variable.
ProBoard
Reads MSGAREAS.PB. Supports version 2.0.
Looks for the "PB" environment variable.
QEcho
Reads /etc/qecho/AreaList. Supports version patched by Eugene
Sorochinsky for JAM message base support.
QFront
Reads QORIGIN.DAT and QECHOS.DAT. Supports version 1.13b.
Looks for the "QFRONT" environment variable.
QuickBBS
Reads the CONFIG.BBS or QUICKCFG.DAT and MSGCFG.DAT files. To get
the real echoid's, you must also supply the filename of the
relevant AREAS.BBS.
Looks for the "QUICKBBS" and "QBBS" environment variables.
RaEcho
Reads AREAS.RAE. Supports version 1.00 and 1.01.
Looks for the "RAECHO" environment variable.
RemoteAccess
Reads the MESSAGES.RA file. To get the real echoid's, you must
also supply the filename of the relevant AREAS.BBS. Supports
versions 0.xx, 1.xx, 2.0x and 2.5x.
Looks for the "RA" environment variable.
Squish
Reads SQUISH.CFG and AREAS.BBS (if used). Supports version 1.0x
and 1.1x. The "Include <filename>" feature of Squish 1.10 is also
supported.
The optional /G switch specifies the default group of the imported
areas, i.e. /g=G or /g=#103.
Looks for the "SQUISH" and "MAXIMUS" environment variables.
SuperBBS
Reads CONFIG.BBS, SCONFIG.BBS and BOARDS.BBS. Supports version
1.16 and 1.17.
Looks for the "SUPERBBS" and "SBBS" environment variables.
timEd
Reads TIMED.CFG and any included file. Also reads the
configuration from other mail software defined in TIMED.CFG.
Looks for the "TIMED" environment variable.
Termail
This is for the Terminate Mail system (Termail). GoldED does
currently only support Termail 4.00 und 5.xx style .CFG-files.
Reads TM.CFG and any AREAFILE (an AREAS.BBS type file) defined
there.
NOTE: If you use this, you must start GoldED in the Termail
directory, because the standard TM configuration files use
relative paths.
Looks for the "TM" environment variable.
TosScan
Reads the FD.SYS/SETUP.FD and AREAFILE.FD files. Supports version
1.00 and FrontDoor 1.99c and 2.xx.
Looks for the "FD" environment variable.
WaterGate
Reads the WTRCFG.TDB and AREABASE.TDB files. Supports version
0.93.
WMail
Reads the WMAIL.PRM and AREAS.PRM files. Supports version 2.2.
Looks for the "WMAIL" environment variable.
XMail
Reads the AREAS.XM file. Supports version 1.00.
Looks for the "XM" environment variable.
#page
#---------------------------------------------------------------------
#chapter The Random System
With the Random System, you can define area-specific sets of origins,
netnames, tearlines, templates, usernames and many other items. If
more than one item of each type is specified, a random one is picked -
a Random System. This is a very useful feature when (for example)
participating in conferences with different languages.
The Random System is built on the idea of "groups". A group is a
collection of "items", belonging to the group. You can assign one or
more echomail areas, designated by their echoid's to a group. Groups
can also be specified for just a single echo, and DOS/4DOS-style
wildcards can be used to simplify the assignment of echoes with common
strings in their name, such as *.DK, SIG.* and so on. In this way, you
could for example setup one group for all national echoes, another for
special local echoes, a third for international echoes etc.
Defining Groups
The general syntax of a group definition is:
GROUP <id>[:]
; items go here
[Member <id list>]
ENDGROUP
The Group <id> can be one of three things:
1. A group letter or #number, matching the group letters or numbers
used in the AREAFILE's of D'Bridge, GEcho, IMAIL, TosScan and many
others. To use this feature, you need to enable the AREAFILEGROUPS
keyword.
2. An individual echoid or echoid mask (wildcards can be used). The
items are then simply defined below the Group line.
3. A group label, terminated by a colon (:). The group items are
defined below the Group line. Echoes are assigned to the group by
adding one or more Member statements.
You can't assign a group to another group. It will not harm, but it
also won't work :-)
The order of groups is very important. GoldED scans the groups from
the top down. This means that the most general groups must be placed
at the bottom and exceptions (individual areas for example) must be
placed at the top.
Defining Random Items
The random items are defined much like in the main GoldED
configuration file.
If more than one of each item is defined within a group, those items
will be picked randomly (hence the name "Random System"), while GoldED
collects items when entering an area.
Random Item Keywords:
AKA
AKAMATCHING
AREACOPYDIRECT
AREACOPYTO
AREAFREQDIRECT
AREAFREQTO
AREAREPLYDIRECT
AREAREPLYTO
AREAYOUWROTETO
ATTRIBUTES
CTRLINFO
EDITHARDTERM
EDITMIXCASE
EDITREPLYRE
FORCETEMPLATE
INPUTFILE
INTERNETADDRESS
INTERNETGATE
INTERNETMSGID
INTERNETRFCBODY
LOADLANGUAGE
MSGLISTDATE
MSGLISTFAST
MSGLISTFIRST
MSGLISTHEADER
MSGLISTWIDESUBJ
NETNAME
NICKNAME
ORGANIZATION
ORIGIN
OUTPUTFILE
PLAY
QUOTEBUFFILE
QUOTECHARS
QUOTESTRING
QUOTEWRAPHARD
SEARCHFOR
TAGLINE
TAGLINECHAR
TEARLINE
TEMPLATE
TEMPLATEMATCH
TWITMODE
USEFWD
USERNAME
USETZUTC
VIEWHIDDEN
VIEWKLUDGE
VIEWQUOTE
WHOTO
XLATEXPORT
XLATIMPORT
See the Configuration Keyword Reference chapter for details about each
keyword.
Random System Example
Below is an example of how a Random System could be setup. Note how
the letter group 'D' goes first, followed by the explicit group
definitions for the NERDS and FOO echoes. Then comes the more general
groups (those with Label:'s), where the echoes are assigned with one
or more Member statements. At last there is the catch-all "Group *",
which works as the default group.
=== Cut, GOLDRAND.CFG ===
Group NERDS ; For the NERDS echo.
Origin "I am a Nerd. Take me to your Loser!"
Group FOO ; This group is *only* for the FOO echo.
Tearline FooED @rev
Origin "Foo-ing my day away"
Group FooEchoes:
Member *FOO* ; Use wildcards to catch any other foo echo.
Tearline FooED @rev
Origin "This is a Foo-lish origin"
Group FidoNet:
Member NET_DEV, WORLDPOL, INTERCOOK
Member GREEN.029, C_ECHO, C_PLUSPLUS
Origin "Fight-O-Net? Good name..."
Template FIDONET.TPL
Whoto Everyone
Group SigNet:
Member SIG.* ; The wildcard is VERY handy here ;-)
Origin "To SIG or not to SIG..."
Template SIGNET.TPL
Group D ; Letter D for Danish echoes.
Template DANSK.TPL
Group * ; This is default group
Origin "Yet another forgotten echo"
=== Uncut ===
See the example GOLDRAND.CFG in the ADVANCED archive for a real-life
setup similar to the one I use myself.
#page
#---------------------------------------------------------------------
#chapter Color Configuration
Color configuration in GoldED is a bit complicated, and you probably
have to experiment quite a bit, if you want make your own setup. For
your convenience, I have added a number of example color setups,
provided by some of my many good users. I suggest you try them all and
use the one that suits you best, perhaps tuning it a bit to your
taste.
The COLOR keyword uses the following syntax:
COLOR <window> <part> <colors>
<window> AREA, ASK, BACKGROUND, BRAG, HEADER, HELP, INFO, MENU,
READER, SHADOW, STATUS.
<part> BLOCK, BORDER, BTYPE, EDIT, HIDDEN, HIGHLIGHT, INPUT,
KLUDGE, NOSELECT, ORIGIN, QUOTE, SELECTOR, TEARLINE,
TITLE, WINDOW.
The <colors> are composed of [blinking] <ink> [on <paper>].
<ink> Black, Blue, Green, Cyan, Red, Magenta, Brown, LGrey,
DGrey, LBlue, LGreen, LCyan, LRed, LMagenta, Yellow,
White.
<paper> Black, Blue, Green, Cyan, Red, Magenta, Brown, LGrey.
For monochrome setups we instead have:
<ink> Normal, Highlight, Reverse, Underline.
The SHADOW color does not need a <part>, because it is global.
The paper color always defaults to Black if not specified.
If <part> is "BTYPE", the <color> is a value in the range 0-3, which
defines the type of lines used when drawing menus and windows:
BTYPE 0 is single horizontal and single vertical lines.
BTYPE 1 is double horizontal and double vertical lines.
BTYPE 2 is single horizontal and double vertical lines.
BTYPE 3 is double horizontal and single vertical lines.
The default border type is always BTYPE 0.
The following is a description of the different window parts:
Various general color items
SHADOW Shadow below windows and menus.
STATUS WINDOW Status line at the bottom.
BACKGROUND WINDOW Background for the startup window.
BACKGROUND BORDER Overscan color (currently DOS only).
<anything> PAGEBAR Pagebar (scrollbar).
The PAGEBAR color specifially sets the color of the pagebars
(scrollbars) in GoldED. A pagebar color can currently be set for
AREA, READER and MENU. Note that BORDER will set both the BORDER and
PAGEBAR colors, so remember to place the PAGEBAR color below the
BORDER color.
Startup screen / logo window
BRAG WINDOW The Copyright window.
BRAG BORDER Lines around the Copyright window.
BRAG TITLE The logo text.
BRAG HIGHLIGHT The inner logo lines.
BRAG BLOCK The outer logo lines.
BRAG BTYPE Copyright window border type.
Area Selection Menu
AREA WINDOW Descriptions, the top line (inc. search).
AREA BORDER Lines.
AREA TITLE Titles on the border.
AREA SELECTOR Selection bar.
AREA HIGHLIGHT The color for the area marks.
AREA BTYPE Window border type.
Message Header
HEADER WINDOW Header text.
HEADER BORDER Lines.
HEADER TITLE Titles on the border.
HEADER INPUT Message number input field.
HEADER EDIT Header input fields.
HEADER HIGHLIGHT Marks.
HEADER BTYPE Window border type.
HEADER FROM Header From field.
HEADER TO Header To field.
HEADER SUBJECT Header Subject field.
The FROM/TO/SUBJECT colors supplement the HEADER WINDOW color. Note
that WINDOW will also set the FROM/TO/SUBJECT colors, so remember to
place the new colors below it.
Message Text
READER WINDOW Normal message text.
READER BORDER The Pagebar.
READER QUOTE (Odd) Quoted lines.
READER QUOTE2 (Even) Quoted lines.
READER CURSOR Character at cursor pos. (int. editor).
READER KLUDHIDD Kludges and hidden lines.
READER TEARORIG Tearline and Origin.
READER BLOCK Block color (internal editor).
READER BTYPE Window border type.
READER HIGHLIGHT Search highlight in the message text.
READER KLUDGE Known kludges.
READER HIDDEN Hidden lines. (Unknown kludges).
READER SIGNATURE Internet-Style signatures ("-- ").
READER TAGLINE Taglines. (Only the one just above tearline).
READER TEARLINE Tearline.
READER ORIGIN Origin.
See notework.txt
2002-04-21 12:01:13 +00:00
READER URL URL (http://, ftp://, E-mail).
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
The KLUDGE/HIDDEN colors replaces the old KLUDHIDD color. Note that
KLUDHIDD will set both the KLUDGE and HIDDEN colors, so remember to
place the new colors below it if you keep the old definition.
The TAGLINE color is the color of taglines. GoldED detects a tagline
if it starts with "..." or "___" and is just above the tearline or
origin.
The TEARLINE/ORIGIN colors replaces the old TEARORIG color. Note
that TEARORIG will set both the TEARLINE and ORIGIN colors, so
remember to place the new colors below it if you keep the old
definition.
Miscellaneous Smaller Menus
ASK WINDOW Menu items.
ASK BORDER Lines.
ASK TITLE Menu title.
ASK SELECTOR Selection bar.
ASK NOSELECT Non-selectable menu items.
ASK HIGHLIGHT Hotkeys.
ASK BTYPE Window border type.
Miscellaneous Larger Menus (Browser Windows)
MENU WINDOW Menu items.
MENU BORDER Lines.
MENU TITLE Menu title.
MENU SELECTOR Selection bar.
MENU NOSELECT Non-selectable menu items.
MENU HIGHLIGHT Hotkeys/marks.
MENU UNREAD When a msg is unread.
MENU UNREADHIGH Additional highlight of to/from.
MENU UNSENT When a msg is unsent.
MENU UNSENTHIGH Additional highlight of to/from.
Help Screens
HELP WINDOW Help text.
HELP BORDER Lines.
HELP SELECTOR Current keyword.
HELP HIGHLIGHT Other keywords.
HELP BTYPE Window border type.
Pop Up Information Windows
INFO WINDOW Window text.
INFO BORDER Lines.
INFO TITLE Info title.
INFO BTYPE Window border type.
Stylecodes
STYLECODE ALL All stylecodes at once.
STYLECODE B *Bold*
STYLECODE I /Italic/
STYLECODE BI /*BoldItalic*/
STYLECODE U _Underline_
STYLECODE BU _*BoldUnderline*_
STYLECODE IU /_ItalicUnderline_/
STYLECODE BIU _/*BoldItalicUnderline*/_
STYLECODE R #Reverse#
STYLECODE RB *#ReverseBold#*
STYLECODE RI /#ReverseItalic#/
STYLECODE RBI /*#ReverseBoldItalic#*/
STYLECODE RU _#ReverseUnderline_#
STYLECODE RBU _*#ReverseBoldUnderline#*_
STYLECODE RIU _/#ReverseItalicUnderline#/_
STYLECODE RBIU _/*#ReverseItalicUnderline#*/_
Note that stylecode color definitions must be placed below COLOR
READER WINDOW, because it overrides the COLOR STYLECODE definitions.
See the GEDCOL*.CFG and GEDMON*.CFG files for examples of color
configuration.
#page
#---------------------------------------------------------------------
#chapter The Message Template
The message template gives you a ready-made skeleton for writing your
messages in the editor. The template is one of GoldED's many strong
features. With this, you can eliminate the tedious typing of greetings
etc etc. GoldED also provides a number of replacement strings,
"tokens", to dynamically add message specific information to the
template.
As in the configuration file, a semicolon (;) first on the line makes
the line a comment. Any other line is put into the editor file, after
token expansion. Tokens are not case sensitive.
The following is a list of the tokens available:
Conditional tokens (these are replaced with a null string)
@changed Line is only inserted in Changed msgs (from others).
@comment Line is only inserted in Reply-Comments.
@echo Line is only inserted in Echomail.
@forward Line is only inserted in Forwarded messages.
@local Line is only inserted in Local messages.
@moderator Line is only inserted if substring "moderator" appeared in
from line.
@moved Line is only inserted in Reply-Moved messages.
@net Line is only inserted in Netmail.
@new Line is only inserted in New messages (not replies).
@position Specifies the starting line for the editor cursor.
@quotebuf Line is only inserted in Quotebuffered msgs.
@quoted Line is only inserted in Quoted replies.
@reply Line is only inserted in Non-Quoted Replies.
Insert tokens (anything else on the line is ignored)
@attrib <attributes> - Adds specific message attributes.
@include <filename> - Inserts the file.
@forcefrom <"from"> - sets message FROM: field, even if non-empty
(see @setfrom)
@forcesubj <"subject"> - sets message SUBJ: field, even if non-empty
(see @setsubj)
@forceto <"to"> - sets message TO: field, even if non-empty
(see @setto)
@loadlanguage Loads a partial language config file.
@message Inserts the original message (in Forward & Change).
@quote Inserts a quote of the original message.
@random [random.txt] - Inserts random text.
@setfrom <"from"> - Sets the message FROM: field.
@setsubj <"subject"> - Sets the message SUBJ: field.
@setto <"to"> - Sets the message TO: field.
@xlatexport <charset> - Sets the export charset.
Replacement tokens (replaced with message specific data):
@c3daddr Current user 3D (boss) address.
@caddr Current user address.
@cdate Current date.
@cdesc Current area description.
@cecho Current echoid.
@cfname Current user first name.
@clname Current user last name.
@cname Current user name.
@cpseudo Current pseudonym given by NICKNAME keyword, or @cfname.
@ctime Current time.
@ctzoffset Current timezone offset (if available and enabled).
@d3daddr Destination 3D (boss) address.
@daddr Destination address.
@dfname Destination first name.
@dlname Destination last name.
@dname Destination name.
@dpseudo Destination pseudonym (see addressbook), or @dfname.
update list of macros
2005-11-04 10:20:26 +00:00
@areapath path to echoarea base (fill pathname like specified in config),
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
this token is valid for echoareas only.
update list of macros
2005-11-04 10:20:26 +00:00
@areaname echoarea name (areatag), this token is valid for echoareas only.
@areatype echoarea base type (OPUS, JAM, Squish, PCBoard, ...), this token
New template tokens: @echopath, @echoname, @echotype
2005-09-27 17:23:59 +00:00
is valid for echoareas only.
GoldED+ sources: Initial revision.
2000-02-25 10:15:17 +00:00
@f3daddr Current from 3D (boss) address.
@faddr Current from address.
@ffname Current from first name.
@flname Current from last name.
@fname Current from name.
@fpseudo Current from pseudonym (see addressbook), or @ffname.
@longpid Long program id. "GoldED", "GoldED/2" or "GoldED/386".
@o3daddr Original 3D (boss) address.
@oaddr Original address.
@odate Original date.
@odesc Original area description if moved, else current.
@oecho Original echoid if moved, otherwise current.
@ofname Original first name.
@ofrom Original RFC "From" headerline.
@olname Original last name.
@omessageid Original RFC "Message-ID" headerline.
@omsgid Original MSGID kludge content.
@oname Original name.
@opseudo Original pseudonym (see addressbook), or @ofname.
@origin The current global or Random System origin.
@os2slash "/2" if running GoldED/2. Empty otherwise.
@osslash same as above.
@otime Original time.
@otzoffset Original timezone offset (if available and enabled).
@oto Original RFC "To" headerline.
@pid Short program id. "GED", "GED/2" or "GED386".
@pseudo pseudonym (see addressbook), or @tfname.
@rev The revision number (in the form mmdd).
@serialno Emptiness.
@subject The message subject line.
@t3daddr Destination to 3D (boss) address.
@taddr Destination to address.
@tagline The current global or Random System tagline.
@tearline The current global or Random System tearline.
@tfname Destination to first name.
@tlname Destination to last name.
@tname Destination to name.
@tpseudo Destination to pseudonym (see addressbook), or @tfname.
@ver The simple version number (in the form x.yy)
@version The complete release version number of GoldED.
@_caddr Current user address (fixed width: 19 chars).
@_cname Current user name (fixed width: 34 chars).
@_daddr Destination address (fixed width: 19 chars).
@_dname Destination name (fixed width: 34 chars).
@_oaddr Original address (fixed width: 19 chars).
@_oname Original name (fixed width: 34 chars).
@_taddr Destination to address (fixed width: 19 chars).
@_tname Destination to name (fixed width: 34 chars).
Tokens dealing with names may optionally have two parameters (each
parameter enclosed in curve brackets): your name and opponent name,
destination name additionally accepts third parameter - WhoTo name.
Here is example on how this feature could be used:
@oname{I}{You} wrote to @dname{me}{you}{everyone}:
The template text begins at the first non-comment line.
See the included GOLDED.TPL for example usage.
If you need to put some text which contains one of these tokens into a
template file, use an extra '@' in front of the token.
Example:
Internet: somebody@veryhot.com
would produce
Internet: somebody2.51yhot.com (because @ver is a token)
so write it like this instead:
Internet: somebody@@veryhot.com
The double '@' will then be translated to a single, and token
translation skips past the @token.
#page
#---------------------------------------------------------------------
#chapter The Online Help System
GoldED has a built-in context sensitive help system, tied to the <F1>
key (one of the very few keys that cannot be reconfigured). It
contains a complete keyboard reference and help for most situations.
It is current not as complete or sophisticated as I'd like it myself,
but this may be improved in future versions.
You can completely redefine the help screens if you wish - the
GOLDHELP.CFG file is a plain ASCII text file which contains all help
definitions. The help file is split into several help categories. Here
is an example of a couple of defined help categories:
*B 1,Help Category 1
help text help text help text
help text help text help text
*P
help text help text help text
help text help text help text
*E
*B 2,Help Category 2
help text help text help text
help text help text help text
*P
help text help text help text
help text help text help text
See also: ^Help Category 1^
*E
The "*B" indicator specifies the beginning of a help category. The
format is "*B helpcatnumber[,helpcatname]". In GoldED the help
categories are numbered 1000-9999, split into more or less logical
groups. See the help file for assignments. There should be only one
space between the "*B" and the help category number. The help category
name is only required for cross-references. If there are no
cross-references to that help category, then you can leave the
helpcatname parameter out.
The "*P" indicator specifies a page break and is optional. You may
have as many page breaks as you'd like. The "*E" indicator specifies
the end of the help category. The "*B", "*P", and "*E" indicators must
all begin in the first column. These indicators and the help category
name are case insensitive (can be in lowercase, uppercase, or mixed).
In the definition of Help Category 2, you will notice the
crossreference to Help Category 1. All cross-referencing is done by
embedding the cross- reference category name (not number) inside
carats (^). If you need to display a carat inside the help file, use a
double carat (^^).
Any text contained outside of the "*B" and "*E" is treated as
comments. If an "*E" is not found, then the end-of-file will be
treated as an "*E".
Not all of the help categories in this help file are actually used in
the current version of GoldED. The ones not used are empty, except for
a two-line "header".
The usable dimensions of the help window are 60 columns by 16 lines.
In the help file there is a model of the actual window.
#page
#---------------------------------------------------------------------
#chapter Character Translation
GoldED implements several different proposals for character
translation in imported and exported messages:
FSC-0050 "Charset Identifier" by Thomas Sundblom.
FSC-0051 "I51" by Thomas Gradin.
FSC-0054 "CHARSET proposal" by Duncan McNutt.
No FSC "Composed Characters" by Andre van de Wijdeven.
FSC-0050 is currently known to be implemented in the OPMED 3.xx
message editor, and in Opus 1.7x. It uses the same identifier as
FSC-0054 (a ^aCHARSET kludge), but is a lot simpler (but not
necessarily better).
The "I51" and "CHARSET" proposals are in the process of being merged
to one proposal, which should combine the advantages of both. They are
both based on using the LATIN-1 (also known as ISO 8859-1) character
set for extended ASCII. The LATIN-1 set is the same set used by
Windows 3.xx, Amiga and many other non-PC computers. In addition to
LATIN-1, I51 defines a set of so-called escape sequences for
characters not found in the LATIN-1 set.
"Composed Characters" became quite popular in Holland, but the author
decided to drop his proposal because it relied on escape sequences
using the so called "soft-cr" (141d, 8Dh) character. GoldED will
continue to support Composed as long as it seems necessary.
If you want to know more about the details, I suggest you read the
proposals or contact the authors.
GoldED currently supports two types of translation tables, the *.ESC
files and the *.CHS files.
The ESC translation tables
The *.ESC files are used for import translation of the escape
sequences defined in I51 and Composed Characters.
In the ESC files, the semicolon is used for comments. The *first*
non-comment line defines the charset the escape code are mapped TO.
This is normally IBMPC, and should not be changed. Any other
non-comment line is treated as an escape sequence definition with this
syntax:
<esc1><esc2><space><map chars>[; comment/description]
Leading spaces are *not* allowed in ESC files. <esc1> and <esc2> are
the two characters that define the escape sequence. <space> is ignored
and can be used to make the table look better. <map chars> defines the
local representation of the escape sequence, up to three characters.
Normally you would only map to one extended ascii character. The map
chars can be either the characters themselves, or decimal or
hexadecimal numbers of the form "\d<dec>" or "\x<hex>" (like in the C
programming language).
The CHS translation tables
The *.CHS files are used for import and export translation of the
CHARSET type character sets, and export of I51 and Composed escape
sequences.
The CHS files uses the format of the raw text files provided in the
CHARSET3.ZIP example implementation of FSC-0054. Study some of the
files provided if you want to know how to define them.
The two keywords XLATESCSET and XLATCHARSET are used to define which
files belong to what import and export set. You can define more than
one import and export set for each file.
The keyword XLATIMPORT defines which charset you have on your own
machine - this would normally be "IBMPC". It can be useful to change
this (using the Random System) in areas where another character set
than IBMPC is the dominant (like Amiga or MacIntosh, whatever).
The keyword XLATEXPORT defines the charset your messages should be
exported to, if any.
Confused? Yeah, I know - this is a confusing subject, and my
implementation and documentation is not perfect. Normally you will not
have to worry about it. Turn it off completely if you don't understand
it.
#page
#---------------------------------------------------------------------
#chapter Keyboard Command Reference
Most of the GoldED keyboard commands can be reached with just one
keystroke. To ease operation for experienced users of other message
editors, GoldED comes with several sets of keys for each of the
keyboard commands - direct non-shifted keys, Alt/Ctrl-keys and
function keys. Many of these key assignments will be familiar for
users of Msged, Msged/Q, ME2 and FM.
The following is a list of all keyboard commands, sorted by type and
alphabetically, using the format
<command> <short description>
This list is also available in the context-sensitive help system on
the <F1> key.
It is possible to almost completely redefine the keyboard - this in
done in the GOLDKEYS.CFG file, which also handles macro definition
(see later).
Arealist commands:
AREAabort Abort the arealist.
AREAaskexit Exit GoldED, prompt for final decision.
AREAboardnos Toggle sequential areas vs. board numbers.
AREAcatchup Point the lastread pointer to the last message
in the current area.
AREAdosshell Shell to DOS.
AREAdropmsgmarks Unmark all msgs in selected areas.
AREAgotofirst Move selection bar to first area.
AREAgotolast Move selection bar to last area.
AREAgotonext Move selection bar to next area.
AREAgotoprev Move selection bar to previous area.
AREAheat Heat highwatermarks.
AREAjump Move selection bar to next marked area.
AREAjumpnextmatch Move selection bar to next matching area.
AREAquitnow Exit immediately, no questions asked.
AREAscan Scan areas.
AREAscanpm Scan areas for personal mail.
AREAselect Enter the reader for the selected area.
AREAselectmarks Select which set of area marks should be used.
AREAsoundkill Stops currently played sound file.
AREAtoggle Toggle mark on the selected area.
AREAtouchnetscan Touches the SEMAPHORE NETSCAN file.
AREAwritegoldlast Write a fresh copy of GOLDLAST.LST
AREAzap Zap highwatermarks.
Internal editor commands:
EDITabort Abort editing this message - ask first.
EDITanchor Set a block "anchor" on the current line.
EDITaskexit Exit from GoldED - ask first.
EDITblockdown Extend block area one line down.
EDITblockend Extend block area to the end of line.
EDITblockhome Extend block area to the beginning of line.
EDITblockleft Extend block area one character left.
EDITblockpgup Extend block area one screen up.
EDITblockpgdn Extend block area one screen down.
EDITblockright Extend block area one character right.
EDITblockup Extend block area one line up.
EDITcleardeletebuf Clears the undelete buffer.
EDITclearpastebuf Clears the cut'n'paste buffer.
EDITcopy Copies the block to the cut'n'paste buffer.
EDITcopyabovechar Inserts character same as in the same position
in previous line.
EDITcut Cut the block to the cut'n'paste buffer.
EDITdelchar Delete the char at the cursor position.
EDITdelete Delete the block.
EDITdeleteeol Delete from cursor position to end of line.
EDITdelleft Delete the char to the left of the cursor.
EDITdelline Delete the current line. (Copied to the
EDITdelltword Delete the word to the left of the cursor.
EDITdelrtword Delete the word to the right of the cursor.
EDITdosshell Shell to DOS.
EDITdupline Duplicates the current line.
EDITexitmsg Drop this message - NO ASKING! DANGEROUS!
EDITexporttext Exports the current block to a file.
EDITgobegline Move cursor to beginning of line.
EDITgobotline Move cursor to the bottom line in the display.
EDITgobotmsg Move cursor to the last line in the message.
EDITgodown Move cursor down to next line.
EDITgoeol Move cursor to the end of the line.
EDITgoleft Move cursor one position left.
EDITgopgdn Move cursor one page of lines down.
EDITgopgup Move cursor one page of lines up.
EDITgoright Move cursor one position right.
EDITgotopline Move cursor to the top line in the display.
EDITgotopmsg Move cursor to the first line in the message.
EDITgoup Move cursor up to the previous line.
EDITgowordleft Move cursor to the previous word.
EDITgowordright Move cursor to the next word.
EDITheader Edit the message header, attributes etc.
EDITimportquotebuf Imports the current quote buffer.
EDITimporttext Import text file into this message.
EDITkillquotes (ignored)
EDITloadfile Load the message file saved with EDITsavefile.
EDITlookupcursor Lookup name/node at cursor position.
EDITlookupdest Lookup TO: node.
EDITlookuporig Lookup FROM: node.
EDITnewline Terminate paragraph and/or add a new line.
EDITpaste Paste a previously cut block at the cursor.
EDITquitnow Quit GoldED immediately - no asking.
EDITreflow Reflows the current text or quote paragraph.
EDITsavefile Saves the current message as a file.
EDITsavemsg Save this message.
EDITsoundkill Stops currently played sound flie.
EDITspellcheck Calls an external spell checker for the msg.
EDITtab Add spaces to the next tab-stop.
EDITtabreverse Remove spaces to the prev tab-stop.
EDITtogglecase Toggle the case of the cursor character.
EDITtoggleinsert Toggle insert mode.
EDITtolower Change the cursor character to lowercase.
EDITtoupper Change the cursor character to uppercase.
EDITundelete Undelete previously deleted lines.
EDITzapquotebelow Deletes quotes below.
File selection commands:
FILEabort Abort file selection.
FILEaskexit Exit GoldED - ask first.
FILEdosshell Shell to DOS.
FILEgotofirst Go to first file.
FILEgotolast Go to last file.
FILEgotonext Go to next file.
FILEgotoprev Go to previous file.
FILEmark Mark file.
FILEmarkall Mark all files.
FILEquitnow Quit GoldED immediately.
FILEselect Select the marked file(s).
FILEtogglemark Toggle file mark.
FILEunmark Unmark file.
FILEunmarkall Unmark all files.
Message lister commands:
LISTabort Abort message lister.
LISTaskexit Exit GoldED - ask first.
LISTdosshell Shell to DOS.
LISTgotobookmark Go to BookMark message.
LISTgotofirst Go to first message.
LISTgotolast Go to last message.
LISTgotonext Go to next message.
LISTgotoprev Go to previous message.
LISTmarkingoptions Marking menu.
LISTquitnow Quit GoldED immediately.
LISTselect Go to reader at the selected message.
LISTtogglebookmark Toggle BookMark on the selected message.
LISTtoggledate Toggle date column content.
LISTtogglemark Toggle Mark on the selected message.
LISTtogglewidesubj Toggle between wide and short subject.
Nodelist browser commands:
NODEabort Abort nodelist browsing.
NODEaskexit Exit GoldED - ask first.
NODEdosshell Shell to DOS.
NODEgotofirst Go to first node.
NODEgotolast Go to last node.
NODEgotonext Go to next node.
NODEgotoprev Go to previous node.
NODEquitnow Quit GoldED immediately.
NODEselect Select node.
Message reader commands:
READaddressbookadd Add current/marked mail writer(s) to
addressbook. Ask first.
READaskexit Exit GoldED, prompt for final decision.
READchangeaka Change default AKA address for current area.
READchangeattrs Change the attributes of the current message.
READchangemsg Change current message.
READchangeorigin Change default origin for the current area.
READchangetagline Change default tagline.
READchangetemplate Change default template.
READchangeusername Change default username.
READchangexlatimport Change default import charset.
READcommentmsg Comment-Reply to message. (Reply to TO name).
READcopymoveforward Enter the Copy/Move/Forward function menu.
READdecreasemargin Decrease message margin. For test purposes.
READdeletemsg Delete current/marked message(s). Ask first.
READdosshell Shell to DOS.
READfidorenumber Renumber Fido/Opus *.MSG files.
READfilerequest Generate a filerequest from the current msg.
READfindall Find string(s) in message header and text.
READfindheader Find string(s) in message header.
READgotobookmark Go to the "BookMark" message.
READgotofirstmsg Go to the first message in the area.
READgotolastmsg Go to the last message in the area.
READgotomsgno Go to a specific message number.
READgotonextarea Go directly to the next area.
READgotonextmsg Go to the next message.
READgotonextunread Go to the next unread message.
READgotoprevarea Go directly to the previous area.
READgotoprevmsg Go to the previous message.
READgotoprevunread Go to the previous unread message.
READgotoreplies Choose from the next messages in the replylink.
READgotoreply1st Go to the first reply to this message.
READgotoreplynext Go to the next reply to this message.
READgotoreplyprev Go to the parent message in the replylink.
READincreasemargin Increase message margin. For test purposes.
READlookupdest Lookup TO: node.
READlookuporig Lookup FROM: node.
READmakeuserlist Generate FIDOUSER.LST of users in the area.
READmakepathreport Added "path report" feature. The output file
can be processed by a RDDT (Route Diagram
Drawing Tool) utility.
READmarkingoptions Enter the marking menu.
READmessagelist Enter the message lister.
READmovecommentmsg Comment-Reply in another area.
READmovequotemsg Quote-Reply in another area.
READmsgcontinue Page down or go to next message.
READmsgend Display last part of current message.
READmsghome Display first part of current message.
READmsglinedown Scroll message display.
READmsglineup Scroll message display.
READmsgpgdn Page message display.
READmsgpgup Page message display.
READnewarea Enter the area selection screen.
READnewmsg Start a new message.
READquitnow Exit GoldED immediately, no questions asked.
READquotebuf Append quote of the msg to the quotebuffer.
READquotemsg Quote-Reply to message. (Reply to FROM name).
READreplymsg Reply to the current message, without quoting.
READsearch Launches the search engine.
READsoundkill Stops currently played sound file.
READthreadtree Enter the Message Threading lister.
READtogglebookmark Toggle a "BookMark" on the current message.
READtogglehexdump Toggle hexdump mode. For debugging purposes.
READtogglehiddklud Toggle display of Hidden and Kludge lines.
READtogglehidden Toggle display of Hidden lines.
READtogglekludge Toggle display of Kludge lines.
READtogglemark Toggle a message mark on the current message.
READtogglemarkread Toggle "Read Marked" mode.
READtogglepagebar Toggle the "PageBar" feature.
READtogglequote Toggle display of quoted lines. Experimental.
READtogglerot13 Toggle ROT13 encryption for the current msg.
READtogglerealmsgno Toggle between seq. or real message numbers.
READtogglestyles Toggle Disable/Show/Show+Strip of STYLECODES.
READtoggletwits Toggle Twit display - Show/Blank/Skip/Ignore.
READtouchnetscan Touches the SEMAPHORE NETSCAN file.
READtouchsemaphore Popup touch a manually entered semaphore file.
READuserbase Launches the addressbook.
READuudecode UUdecodes the current message.
READwritemsg Write message(s) to file or printer.
Key undefine commands:
AREAundefine
EDITundefine
FILEundefine
LISTundefine
NODEundefine
READundefine
The undefine commands can used to undefine any of the built-in default
keyboard definitions.
See the Key Reference below for a list of the key symbols you can use
in keyboard redefinition.
#page
#---------------------------------------------------------------------
#chapter Macros and Keystacking
GoldED has a simple keyboard macro facility, which you can use to
automate certain common operations. In addition, a "keystacking"
facility allows you to create simple automatic macros on the fly.
The macro definition syntax is modelled after the syntax used in the
QEdit text editor:
<assignment-key> Macro <commands or keys>
<assignment-key> AreaMacro <commands or keys>
<assignment-key> EditMacro <commands or keys>
<assignment-key> FileMacro <commands or keys>
<assignment-key> ListMacro <commands or keys>
<assignment-key> NodeMacro <commands or keys>
<assignment-key> ReadMacro <commands or keys>
Macros are defined in the GOLDKEYS.CFG file, where you can also find
several examples.
By using the word "Auto" as <assignment-key>, you can even define a
special macro which will be automatically executed when you start
GoldED.
Keystacking is a special form of auto-macros. You simply specify a
bunch of keys to be "stacked" in the (special internal) keyboard
buffer for sequential execution.
You can either specify a default set of keystacking in the .CFG
configuration file, or override any default keystacking by typing the
keystack definitions at the GoldED commandline or the GEDCMD
environment variable.
See the Key Reference chapter for a list of the key symbols you can
use in macros and keystacking.
#page
#---------------------------------------------------------------------
#chapter Key Reference
Below is the list of key symbols recognized by GoldED for
keyboard/macro definition and keystacking.
Unshifted function keys
F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12
Shift-function keys
#F1 #F2 #F3 #F4 #F5 #F6 #F7 #F8 #F9 #F10 #F11 #F12
Alt-function keys
@F1 @F2 @F3 @F4 @F5 @F6 @F7 @F8 @F9 @F10 @F11 @F12
Ctrl-function keys
^F1 ^F2 ^F3 ^F4 ^F5 ^F6 ^F7 ^F8 ^F9 ^F10 ^F11 ^F12
Alt-Numbers
@0 @1 @2 @3 @4 @5 @6 @7 @8 @9
Alt-Letters
@A @B @C @D @E @F @G @H @I @J @K @L @M
@N @O @P @Q @R @S @T @U @V @W @X @Y @Z
Ctrl-Letters
^A ^B ^C ^D ^E ^F ^G ^H ^I ^J ^K ^L ^M
^N ^O ^P ^Q ^R ^S ^T ^U ^V ^W ^X ^Y ^Z
Insert/Delete
Ins ^Ins @Ins
Del ^Del @Del
Home/End
Home ^Home @Home
End ^End @End
Page up/down
PgUp ^PgUp @PgUp
PgDn ^PgDn @PgDn
Cursor left/right
Left ^Left @Left
Right ^Right @Right
Cursor up/down
Up ^Up @Up
Down ^Down @Down
Misc other keys
Esc ^Grey* Key5 Space Tab #Tab @Tab BackSpace ^BackSpace
@BackSpace Enter ^Enter @Enter
Note that some of the Alt-keys, especially the cursor-related keys and
the F11/F12 keys, are "extended" keys normally only available on
systems with an extended keyboard bios. However, GoldED uses a few
tricks to make some the extended keys available on non-extended
systems.
#page
#---------------------------------------------------------------------
#chapter Language Definition
GoldED allows you to almost completely redefine the language dependent
text in the program.
The language dependent text in GoldED is defined in the plain ASCII
text GOLDLANG.CFG file.
See the example language file for the actual method and format of
language redefinition.
If you are planning to translate the text in GoldED, you should also
look into the definition of the help screens.
You do not need permission from the author before announcing or
distributing your own modified language files.
Date/Time Substitution Codes
A few of the language texts can contain special date/time substitution
codes. The keywords for those are: MS_DateTimeFmt, MS_DateFmt,
MS_TimeFmt and ST_StatuslineTimeFmt.
Here are the valid substitution codes:
%a Abbreviated weekday name (Mon, Tue, Wed, ...).
%A Full weekday name (Monday, Tuesday, Wednesday, ...).
%b Abbreviated month name (Jan, Feb, Mar, ...).
%B Full month name (January, February, March, ...).
%d Day of month (01-31).
%e Day of month, with leading space for single digits (1-31).
%E Day of month (1-31).
%H Hour (00-23) (24-hour clock).
%I Hour (01-12) (12-hour clock).
%j Day of the year (001-366).
%m Month (01-12).
%M Minute (00-59).
%p AM or PM according to 12-hour clock.
%S Second (00-59).
%U Week number (00-52) where sunday is first day of the week.
%w Weekday (0-6) where 0 is sunday.
%W Week number (01-53) where monday is first day of the week.
%y Year without century (00-99).
%Y Year with century.
%% Character '%'.
The %a, %A, %b and %B codes substitute to the current language setup
loaded using the LOADLANGUAGE keyword.
*** NOTE ***
In the continuing development of GoldED, it is impossible to
completely maintain backward compatibility of the language format or
the text defined there. New features may add and/or obsolete some
definitions, or may change the format of others.
The existing language file may contain definitions which are already
obsolete, but which I haven't had time to search for and remove, as
well as there may be some texts in GoldED which are not yet definable.
All this will of course be corrected in future versions. If you find
inconsistencies, please report them, because I may have overlooked
them.
#page
#---------------------------------------------------------------------
#chapter Message Kludge Lines
Kludge lines are special control lines, that begin with a ^a (ASCII 1)
as the first character of the line, followed by a unique identifying
name and the relevant control information.
GoldED is aware of a lot of these kludges, and supports a number of
them, if you want to have them inserted in your messages.
Some kludges are useless junk and more or less commercials for this
and that software, but a few are useful for miscellaneous purposes. In
the following, I will list (some of) the known and supported kludges,
and a short description of what they are used for.
ACUPDATE:
This kludge is a feature of Squish 1.10: Message Broadcast
Modify/Delete. Read the docs for Squish 1.10 for details.
AREA:<echoname>
This is not really a kludge, and it doesn't begin with a ^a, but I
included it on the kludge list because it sometimes turned up in
echomail areas where it should have been stripped off by the mail
tosser.
CC: <name> <address>
When GoldED produces carbon copies, it adds to each message a full
list of the persons who get a copy. One version of this list is
hidden behind the CC: kludge.
CHARSET:<charset identifier>
Proposed in FSC-0050 and FSC-0054, this kludge is an attempt to
find a solution to the problem of the high-bit characters (like
the IBM PC vs Amiga vs Mac etc. national chars) in messages.
GoldED can recognize, use and generate this kludge.
CHRC:<font change id>
Proposed in FSC-0054, this is a kludge for changing fonts,
underlining and other stuff.
CHRS:<charset identifier>
Alternative FSC-0054 version of the CHARSET kludge.
DESTADDR:<destaddress>
This one is not proposed anywhere, but it looks like it gives the
address of the intended recipient. GoldED takes the address for
the dest field.
DOMAIN <destdomain> <destaddress> <origdomain> <origaddress>
Proposed in FSC-0038, this tries to solve the problem of mail
crossing domain boundaries. GoldED takes both addresses.
EID:<crc16> <stamp> [replycrc16] <replystamp>
Proposed in FSC-0031, this is used for dupe checking and reply
linking. The EID is today generally considered as garbage, but a
lot of older mail processors such as QMail still generate it.
ENC:
Signifies that the message contains encrypted data. GoldED will
add this kludge if it detects that the message has been encrypted
with PGP.
EOT:
End Of Text. See SOT.
FLAGS <special attributes>
Proposed in FSC-0053, this is a special netmail kludge used by the
FrontDoor and D'Bridge mailers and the IMail mail processor. It
provides extra attributes not found among the standard attributes
in the normal message/packet headers. GoldED uses and generates
this kludge, if you set the attributes.
FMPT <from point>
Defined in FTS-0001, this tells the Point number of the
originator. Netmail only. GoldED can generate this line.
FWDAREA <original area>
FSC-0092: The original area in forwards. See USEFWD and FSC-0092
for a more detailed description.
FWDDEST <aka>
FSC-0092: The original To-aka in forwards. See USEFWD and FSC-0092
for a more detailed description.
FWDFROM <name>
FSC-0092: The original From-Name in forwards. See USEFWD and
FSC-0092 for a more detailed description.
FWDMSGID <aka serial#>
FSC-0092: The original MSGID in forwards. See USEFWD and FSC-0092
for a more detailed description.
FWDORIG <aka>
FSC-0092: The original from-aka in forwards. See USEFWD and FSC-0092
for a more detailed description.
FWDSUBJ <original subject>
FSC-0092: The original subject in forwards. See USEFWD and FSC-0092
for a more detailed description.
FWDTO <name>
FSC-0092: The original TO-field in forwards. See USEFWD and FSC-0092
for a more detailed description.
GATECHK:<???>
Some sort of gating kludge? Don't know what it's for.
GIF:<filename>
Invented by Henk Wever and used in his Dutchie software. The
filename (which does not have an extension) indicates a .GIF
picture of the author of the message. If you have the GIF file on
your system, you can setup an external utility to view the gif at
the press of a key.
GROUP:<echoname>
I think this one comes from stray Groupmail messages. Similar to
the AREA: kludge.
I51 (no parameters)
Proposed in FSC-0051, this indicates that the message text
conforms to the ISO 8859-1 (LATIN-1) character set, and may
contain certain escape codes. The ISO 8859-1 set is used in Amiga
and Windows 3.xx. GoldED can recognize, use and generate this
kludge.
INTL <destaddress> <origaddress>
Defined in FTS-0001, this one solves the problem of crossing Zone
boundaries. Netmail only. GoldED can generate this line.
MSGID: <origaddress> <serialno>
Defined in FTS-0009, this is a method for unique identification of
a message. It can be used for dupe checking and replylinking.
GoldED can generate this line.
MSGTO: <destaddress>
This one is not proposed anywhere, but it looks like it gives the
address of the intended recipient. GoldED takes the address for
the dest field.
Original: <Carbon copy, original name>
Generated by the FrontDoor FM editor when it produces carbon
copies.
PATH: <list of nodes>
Defined in FTS-0004, this is a valuable tool for finding dupe
links and other structural faults in the net structures.
Unfortunately the list of nodes is 2D (net/node), and this creates
problems when exporting echomail across zones.
PTH: <list of nodes>
Not yet a FSC (or is it?), this is a 5D-version of the PATH
kludge, which sticks to the top of the msg.
PID: <identifier> <version> [serialno]
Proposed in FSC-0046, this takes a stab at the tearline abuse, and
puts "safe" information about the first mail processing software
in the line. This could be message editors, mail scanners and
other stuff.
Realname: <Name>
This kludge was probably born in Russia because of some software
was not able to properly handle high ASCII in headers. Name should
be written in national codepage. Otherwise it lose any sence.
I don't know any software that generate this kludge.
RFD: <id>
Received For Distribution. A kludge inserted by one of the file
announcement programs.
REPLY: <replyaddress> <replyserialno>
Defined in FTS-0009, this is the MSGID: counterpart. When replying
to a message with a MSGID:, the MSGID: of the original is renamed
to REPLY:.
RID:<stuff>
Unknown kludge which looks suspiciously like the EID.
ROUTE <list of nodes and points>
Specifies route path. Currently supported by Unimail and S\Tosser.
SEEN-BY: <list of nodes>
Defined in FTS-0004, this is a tool for finding dupe links and
other structural faults in the net structures. Depending on the
mail tosser, the seen-by's may or may not have a preceding ^a
character. Unfortunately the list of nodes is 2D (net/node), and
this can create problems when exporting echomail across zones.
SN:<serialno>
Serial number inserted by the Dutchie message editor.
SOT:
Start Of Text. See EOT.
SPLIT:
Defined in FSC-47. A method for splitting large msgs so that some
mail processors don't choke on them.
TCL1:, TCL2: <long hex string>
Old obsolete swedish dupecheck/replylink kludge.
TID:
Tosser ID. Similar to the PID, but specifically for mail
processors.
TOPT <to point>
Defined in FTS-0001, this tells the Point number of the
destination. Netmail only. GoldED can generate this line.
TZ <offset from UTC>
Specifies the time to *add* to the header time to get the UTC
(Universal Time Coordinated) time. Generated by newer versions of
the TrackMail netmail processor.
TZUTC
See TZ. GoldED can generate this line.
Via: <netmail tossing info>
Routed netmail messages usually gets a Via line for each node it
passes through. This can be used for tracing faults in the netmail
routing structure.
XID:<stuff>
Unknown kludge which looks suspiciously like the EID.
#---------------------------------------------------------------------
#end
#---------------------------------------------------------------------
Reference in New Issue Copy Permalink