From a00d404cb8e5a4c65dcf39a5b64ca13ec643dd74 Mon Sep 17 00:00:00 2001 From: "Alexander S. Aganichev" Date: Tue, 20 Nov 2001 12:11:17 +0000 Subject: [PATCH] Updated doc --- manuals/gold_ref.tei | 770 +++++++++++++++++++++++++++---------------- 1 file changed, 483 insertions(+), 287 deletions(-) diff --git a/manuals/gold_ref.tei b/manuals/gold_ref.tei index cd4e170..bc6ccfa 100644 --- a/manuals/gold_ref.tei +++ b/manuals/gold_ref.tei @@ -40,13 +40,201 @@ Odinn Sorensen, Dirk A. Mueller, Alexander S. Aganichev and others - 1990-1999 + 1990-2001 + + + + Introduction + +

+ +

+ IBM OS/2, +

+ Alexander S. Aganichev. A lot of code was contributed to + Dirk A. Mueller, and + Alexander + Tsvyashchenko, Haruyasu + Yoshizaki, Scott J. Dudley and + Folkert J. + Wijnstra, Continental + Software, +

+ We also need to thanks all that people who have contributed configuration + files: Steve + Shapiro, Michael + Hembo, + + + + + License Agreement and Copyright Notices + +

+ +

+ ( +

+ The GNU Library + General Public License ( +

+ Additionally, permission is hereby specifically given to link + Goldware + Library with any software or software library that meets the + http://www.opensource.org. This includes + +

+ The additional permission to link with non-GPL/LGPL software + may be slightly controversial. The intent is to allow developers a + greater freedom to create specialized versions of GoldED. Examples could + be a +

+ Parts of the +

+ So, even though parts of the Mike + Smedley and how to contact him, +

+ Lanius + Corporation. +

+

+ +

+ Products and company names listed are trademarks or trade names of their + respective companies. +

+ + + + + Nodelist and Userlist Support + +

+ GoldED+ supports the FrontDoor, + Version 7(+) nodelist indexes as well as a plain + GoldED+'s own + nodelist index. +

+

+ 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. +

+ + + + Routing Diagram Drawing Tool + +

+ Routing diagram drawing tool intended to analyse files created by + pressing key defined for READmakepathreport + action. + @@ -54,16 +242,17 @@ - Commandline syntax + Mail Reader Commandline Syntax

- Invocation: GoldED [options] [keystacking] - + Invocation: +golded [options] [keystacking]

Depending on used platform GoldED+ could be called geddjg, gedcyg, gedemx, or - gedlnx. Available options are: + gedlnx. Available options are (all options are case + insensitive):

- - - - 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>, + For example, +golded @S A + makes GoldED+ go to the area scanning menu <Alt-S>, and select scanning of <A> all areas.

- See the chapter for more info. + See the chapter for more info. Note, + that only those combinations described in the + KEYBSTACK chapter are allowed + here.

- - - - - Environment Variables - -

- These are the GoldED+ specific environment variables: - - - - 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! - - - - 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. - - - - 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 chapter for specific details of each - supported AREAFILE. -

- - - - - 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 of RUNGOLD.BAT or RUNGOLD.CMD file: -@echo off + + + +

+ 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 of rungold.bat file: 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 @@ -405,7 +545,7 @@ if errorlevel 004 goto e____ if errorlevel 003 goto __n_l if errorlevel 002 goto __n__ if errorlevel 001 goto ____l -goto nomail +if errorlevel 000 goto nomail :error echo GoldED+ error exit! goto end @@ -435,41 +575,15 @@ goto nomail :end echo. echo Thank you for using GoldED+! :-) -

- - - - - 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 + Nodelist Compiler Commandline Syntax

- Invocation: GoldNODE [-options] - [configfile] + Invocation: +goldnode [options] [configfile]

Depending on used platform GoldNODE could be called @@ -477,129 +591,207 @@ goto nomail gnlnx. Available options: Conditional compile. Remove duplicate nodes from index. Forced compile. Quite compiled. No screen output improves speed. Set the max size of names. Normally not used. - Create sorted FIDOUSER.LST userlist file. + Create sorted

- 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 and + environment variables.

- The nodelist index files are named GOLDNODE.GX? are are - placed in the path pointed to by the NODEPATH keyword. + The nodelist index files are named 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. + The V7+ index is automatically used if your + is set correctly. If + +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. + and + keywords, please note + that the addressmask does not accept + + + + Routing Diagram Drawing Tool Commandline Syntax + +

+ Invocation: +rddt <routefile> [options] [address or name] +

+

+ Depending on used platform RDDT could be called + rddtdjg, rddtcyg, rddtemx, or + rddtlnx. Available options: + + + + Reserved for debugging purposes. + + + + Sets indent to n. + + + + This option used to specify yours link address. Requires option + -n. + + + + Use this option to specify your address. + + + + Decode path. + + +

+

+ Example: +RDDT path.rpt -n2:5020/604.19 -l2:5020/604 2:5020/604.19 -p

- Routing Diagram Drawing Tool + Environment Variables

- Routing diagram drawing tool intended to analyse files created by - pressing key defined for READmakepathreport action. - RDDT builds routing tree and display it on the screen if - requested. -

-

- Invocation: RDDT <routefile> [-options] - [address or name] -

-

- Depending on used platform RDDT could be called - rddtdjg, rddtcyg, rddtemx, or - rddtlnx. Available options: + These are the GoldED+ specific environment variables: -

- Example: -RDDT path.rpt -n2:5020/604.19 -l2:5020/604 2:5020/604.19 -p + 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 chapter for specific details of each + supported AREAFILE.

@@ -608,8 +800,8 @@ RDDT path.rpt -n2:5020/604.19 -l2:5020/604 2:5020/604.19 -p Configuration Control

- The GOLDED.CFG configuration reader can be directed in - several ways with special keywords: + The configuration reader can be directed in the several ways with special + keywords:

@@ -707,13 +899,17 @@ ENDIF

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. + until another IGNORE or

However it is probably more useful to use the IF/ELIF/ENDIF control keywords.

+

+ This keyword may cause unpredicable results if used within + IF/ELIF/ENDIF control keywords. +

@@ -847,7 +1043,7 @@ AKA 2:236/77.1 ; SysOp point. 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. See also NETNAME + the header. See also NETNAME

Examples: @@ -1434,7 +1630,7 @@ APP OtherProg IRQ 5 parameter.

- + AREADESC <echoid> <desc> [group] [aka] [(attrs)] [origin] @@ -2222,16 +2418,16 @@ AREALISTSORT T-U+E 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 dot 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. @@ -3872,7 +4068,7 @@ AREASEP !C "Group C" C Local]]> yourself nuts with a cacophony of noises...

- + EXCLUDENODES <addressmask> @@ -4459,7 +4655,7 @@ AREASEP !C "Group C" C Local]]> Specifies the lastread set used in the Goldbase message base.

- + GOLDPATH <path> @@ -4617,7 +4813,7 @@ AREASEP !C "Group C" C Local]]> the correct file areas.

- + INCLUDENODES <addressmask> @@ -5495,7 +5691,7 @@ AREASEP !C "Group C" C Local]]> This keyword can be used globally and in Random System groups.

- + NAMESFILE <file> @@ -5574,7 +5770,7 @@ AREASEP !C "Group C" C Local]]> extra details will be missing.

- + NODEPATH <path> @@ -5601,7 +5797,7 @@ AREASEP !C "Group C" C Local]]> FrontDoor uses the same nodelist index files.

- + NODEPATHV7 <path> @@ -5703,7 +5899,7 @@ AREASEP !C "Group C" C Local]]> messages.

- + ORIGIN <"string"> @@ -6806,7 +7002,7 @@ AREASEP !C "Group C" C Local]]> must have a unique SQUISHUSERNO in their GOLDED/GOLDAREA.CFG.

- + SQUISHUSERPATH <path>[file] @@ -6908,7 +7104,7 @@ AREASEP !C "Group C" C Local]]> STYLECODEPUNCT <"charlist">

- (" !\"$%&()+,.:;<=>@[\]^`{|}~") + (!\"$%&()+,.:;<=>@[\]^`{|}~) @@ -6938,12 +7134,12 @@ AREASEP !C "Group C" C Local]]> adding highlights to message text. The defaults are:

- STYLECODEPUNCT " !\"$%&()+,.:;<=>@[\]^`{|}~" - STYLECODESTOPS "" + STYLECODEPUNCT !\"$%&()+,.:;<=>@[\]^`{|}~ + STYLECODESTOPS

- Note that the double-quote (") must have the backslash (\) in - front of it - the sequence (\") is translated to a single ("). + Note that the double-quote (") must have the backslash (\) in + front of it - the sequence (\") is translated to a single (").

@@ -8046,7 +8242,7 @@ The <programname> can be one of the following: Looks for the "DUTCHIE" environment variable.

- + Echolist