Ŀ
                           SORTDESC version 3.1                           

The document you are reading is formatted for use through the F1 On-line
Help option in SortDesc.  Use SortDesc.DOC for reading using an external
text viewer.

Note:  On-line help contains more information than SortDesc.DOC.

<<Registration>>
<Registration>

                       SHAREWARE (C) 1994 Vince Sorensen
                              All Rights Reserved


                             Registration $25.00US
                       (or equivalent in Canadian funds)


                                   Send to:
                                Vince Sorensen
                                6 Armstrong Bay
                             Regina, Sask. Canada
                                    S4N 4G7

                       BBS 306-789-8682 or 306-789-8690
                                 Fido 1:140/121
                              Voice 306-789-4328


<<Introduction>>
<Introduction>
Ŀ
                               WHO WANTS IT?                              


This is a utility that will allow you to find descriptions for your files
from many sources, then move those files based on the descriptions found.

SortDesc can read TIC files, FILES.BBS (standard format), FILE_ID.DIZ,
captured file listings from PCBoard, Wildcat, Maximus and other BBSs
and/or CD-ROMs, or even documentation within archives. It can write
resulting descriptions into a single file listing, or a several file
listings based on keywords in the description (or TIC area).  These
descriptions can be in PCBoard, FILES.BBS, or "long-line" format.

Options include adding a FILE_ID.DIZ to files without one, adding
tag lines or files to all archives, filtering graphic characters and/or
particular phrases from descriptions, and renaming archives to obey
ISO9660 conventions (handy for CD-ROM creation)!


<Requirements>
Ŀ
                               Requirements                              


   If handling .ARJ files, you need ARJ.EXE. If handling .ZIP files,
you need PKUNZIP.EXE. If handling .LZH programs, you need LHA.EXE.
If handling .SDN files, you need ARJ.EXE. Please note that for archives
with ARJ or SDN secured envelopes the archiver programs do not allow you
to alter the archive itself, and SORTDESC does not attempt to get around
their limitation.


 Minimum Requirements
  1. 8088 based computer or higher
  2. MS/PC-DOS Version 3.3 or higher.
  3. Monochrome 80x25 monitor.
  4. 400K RAM.
  5. Memory manager None.
  6. 1Meg of free disk. (to handle memory overflow, temp files etc.)

 Practical Requirements
  1. 80286 based computer or higher
  2. MS/PC-DOS Version 3.3 or higher.
  3. EGA
  4. 2Meg RAM.
  5. Memory manager None. EMS,XMS,DISK supported. VCPI,DPMI support in extender.
  6. 6Meg of free disk. (to handle memory overflow, temp files etc.)



<<Syntax>>
<Command Line>
Ŀ
                                  Syntax                                 


SORTDESC will start SortDesc in interactive mode, allowing you to change
configuration either temporarily or permanently, and process your files.

SORTDESC /BATCH will start SortDesc in processing-only mode, sorting your
files, then returning to DOS.

SORTDESC /LOG will ask SortDesc to create a "SortDesc.LOG" file listing
the main decisions that are made for each file.

SORTDESC /GUI will start SortDesc in interactive graphics mode, allowing
you to change configuration, and process your files.

SORTDESC SDPATH=path will tell SortDesc to look in the "path" directory for
the main configuration, key words, and TIC area databases.

All switchs and parameters can be combined for multiple options.
Example:   SORTDESC /GUI /BATCH SDPATH=C:\SORTDESC

<Runtime Configuration Switches - Overview>

At runtime, during the initial load of SortDesc
the program will search the current directory for a file named
"Program.ini", where "Program" is the name of the executable
file.  This file contains environment variables which can specify some
of the runtime characteristics of SortDesc.

The Clarion install creates a subdirectory 'OPTIONS' which contains
the Clarion source code, a project file, and a dynalinked OPTIONS.EXE.
Most of these environment switches may be set by the OPTIONS.EXE, or
you may manually create an ascii text file with the settings you
wish to override.  You may also initialize these configuration
variables at the DOS prompt using the DOS SET command.

Your program can use the COMMAND() statement to read the value of any
of these switches. (see the Language Reference manual for details)

The following is a list of the environment switches with a description
of each variable.  If the switch has a default value it is also noted.

<Runtime Configuration Switches - Override .INI filename>

Override .INI filename


   CLAINI:    specifies a configuration file that will be used in
              place of "Program.ini".  This switch may only be specified
              on the command line of SortDesc.

    usage:    Program.exe CLAINI=Drive:\Path\ConfigurationFile.ini
              where ConfigurationFile.ini is replaced with the
              name of the configuration file you wish to use.

    example:  Myprog.exe CLAINI=C:\Config\Other.ini

<Runtime - Video Mode, Screen Objects and Mouse switches>

Video Mode, Screen Objects and Mouse switches


   CLASMOOTH:  specifies whether SortDesc uses the smooth
              mouse movement used in the Clarion environment.
              If set to OFF the mouse will move a full character
              for each mouse movement.

    usage:  CLASMOOTH=ON       [ use smooth mouse ]
            CLASMOOTH=OFF      [ don't use smooth mouse ]

    default:CLASMOOTH=ON

   CLAFONTS:  specifies whether SortDesc remaps ascii characters
              for checkboxes, radio buttons, and the mouse cursor.
              If CLAFONTS is ON SortDesc uses an arrow mouse cursor,
              square check boxes, and circular radio buttons.
              This causes replacements of some standard ASCII characters
              with the arrow, square, and circle characters.  Your program
              must issue the LOADSYMBOLS() statement in order to activate
              the graphic style replacements. (see LOADSYMBOLS in the
              Language Reference for more details).

    usage:  CLAFONTS=ON
            CLAFONTS=OFF

    default:CLAFONTS=ON


  CLABORDERS: specifies a list of ascii characters that are remapped to
              achieve display of thin borders.  Thin borders are only
              available in 25 line VGA mode.  Your program can read this
              switch and then issue the LOADBORDER() statement with the
              string specified by CLABORDER. Use the COMMAND() statement
              to return the value of the switch.
              (see LOADBORDER and COMMAND() in the Late Breaking News
              manual for details)

    usage:    CLABORDERS='#,#,#,#,#'
              where # is replaced with an ascii value that will be
              modified at runtime.


  CLAGRAPH:    specifies the initial graphics mode of SortDesc.

    usage:    CLAGRAPH=VideoMode
              where VideoMode may equal:

                              ALLTEXT   [ 25/80 text mode ]
                              EGA       [ standard Ega ]
                              VGA       [ standard Vga ]
                              SVGA256   [ 256 color Super Vga ]
                              ALLGRAPH  [ Stay in Graphics mode, only
                                          use this setting if SortDesc
                                          has a GRAPHIC attribute ]



    usage:    CLAGRAPH=ALLTEXT


  CLAMRESET:  specifies whether the mouse is sent a hardware reset.
              Useful for certain incompatible mouse drivers. When
              set ON the mouse is initialized with a hardware reset.

    usage:    CLAMRESET=ON


  CLASCROLL:  specifies an alternate scrolling method used on
              a virtual screen with a scrolling field.   When set
              to 1 the alternate scroll is used.

     usage:   CLASCROLL=1


  CLAVSCREEN: specifies that a program uses functions which write
              directly to the video screen buffer.   When set to ON
              direct screen writes will be added to the virtual screen
              buffer.  If OFF direct screen writes will not be added to
              the virtual screen buffer, and will not appear on screen
              after being scrolled off the view area.  This switch only
              applies to virtual screens.


    usage:    CLAVSCREEN=ON
  default:    CLAVSCREEN=OFF


  CLASYMBOLS: specifies which ascii characters SortDesc remaps
              for graphic style checkboxes, radio buttons, and the
              arrow mouse cursor.  Your program must read this switch
              and then issue the LOADSYMBOLS() statement with the string
              specified by CLASYMBOLS.  The COMMAND() statement can be
              used to read the value of the switch.

    usage:    CLASYMBOLS='#,#,#,#,#,#,#,#,#,#,#,#,#'
              where # is replaced with an ascii value that will be
              modified at runtime.


<Runtime - Virtual Memory settings>

Virtual Memory settings

   CLAVM:    specifies virtual memory configuration.

    usage:   CLAVM=NOEMS

             New options not in the manual are:
             CLAVM=EMS/2,.,32,3,4   [use half of available EMS]
             CLAVM=EMS/3,.,32,3,4   [use a third of available EMS]

             CLAVM=XMS/2,.,32,3,4   [use half of available XMS]
             CLAVM=XMS/3,.,32,3,4   [use a third of available XMS]

  example:   CLAVM=EMS-64,.,32,3,4


<Runtime - Stop Window Information>

Stop Window Information


   CLASTOP: specify the Hotkey for calling the STOP() function, followed
            by ON or OFF.  The second parameter (ON or OFF) determines
            whether system level information is available in the STOP()
            window.

   usage:   CLASTOP=1085,ON    [use ALT= key, display system information]
   usage:   CLASTOP=1085,OFF   [use ALT= key, don't display system information]
   usage:   CLASTOP=OFF        [do not make STOP available]

<Runtime - Country Dependent Information>

Country Dependent Information


   CLACOLSEQ1: specifies an alternate collating sequence. The total number
               of characters specified must be exactly (223 characters).
               If the length is incorrect, the standard collating sequence
               will be used.  The string may be split into two switches;
               CLACOLSEQ1 and CLACOLSEQ2.  Using the two switches may make
               viewing the strings in an editor somewhat easier.  The
               collating sequence specified will be used for building
               Key and Index files, as well as for sorted Queues.  The
               sort order for a space character (Ascii 32) cannot be
               changed, it must be the first character in the string.

     usage: CLACOLSEQ1="AsciiString"
           [CLACOLSEQ2]="AsciiString"

   example: CLACOLSEQ1=" !""#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
            CLACOLSEQ2=""


   CLAMONTH:    specifies the text to be returned by functions and picture
               formats involving the month full name.

   usage:  CLAMONTH="Month1","Month2", .........
 example:  CLAMONTH="January","February","March","April","May","June","July","August","September","October","November","December"


   CLAMON:     specifies the text to be returned by functions and picture
               formats involving the abbreviated month name.

   usage:  CLAMON="AbbreviatedMonth1","AbbreviatedMonth2", ........
 example:  CLAMON="Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"


   CLAAMPM:    specifies the text returned by functions and picture
               formats for AM and PM indicators.

   usage:  CLAAMPM="AM","PM"


   CLACASE:    specifies a two dimensional array of characters.   The first
               dimension contains a list of the UPPERCASE version of the
               characters. The second dimension specifies the lower case
               version of the corresponding array element.  The length of
               the two dimensions must be equal.

   usage:  CLACASE="string","string"
 example:  CLACASE="ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz"



<Runtime - Printer Control>

Printer Control


   CLAPRINTER: specify the printer control file used by REPORT
               structures.

     usage:  CLAPRINTER=driveletter:\path\printercontrol.ctl
   example:  CLAPRINTER=c:\config\LASER.CTL


   CLAPRINTDEVICE: specify printer parameters.   Can be set thru
                   the Clarion environment Printer Setup (AltF,AltT).
                   The first parameter, the DEVICENAME is used by the
                   PRINT() statement at runtime.  All other parameters
                   are ignored at runtime, however they are used by
                   the Clarion environment.

     usage:  CLAPRINTDEVICE=DosDevice,LinesPerPage,ColsPerLine,
                            PrintLineNumbers,PrintPageNumbers,FormFeedAfter,
                            ControlBefore,ControlAfter

   example:  CLAPRINTDEVICE=COM1,59,80,ON,ON,ON,'<27,54>','<27,56>'

     DOSDevice may contain any valid DOS device name, including a
     valid DOS filename.

<Runtime - General Environment>

General Environment


   CLABREAK:  specifies whether Ctrl-Break will cause program termination.

     usage:   CLABREAK=ON
              CLABREAK=OFF


   CLATMP:   specifies a directory where temporary files will be
             written.

     usage:  CLATMP=Drive:\Path
   example:  CLATMP=C:\temp


   CLARUNFLUSH: specifies whether a RUN(command) will swap extended
                memory to disk.  This is only applicable for Extended
                Memory models (extended and extended w/runtime libs).

     usage:  CLARUNFLUSH=ON
             CLARUNFLUSH=OFF


   CLAKEYS: used for compatibility for IBM 83 or 84 keyboards (XT style).

     usage: CLAKEYS=IBM83/84

   CLAMEMTRAP: Specifies whether a Halt window is displayed when one of the
               following conditions occur: Stack Overflow.
                                           Array index out of range.
                                           Function is called with a
                                           missing parameter.

     usage: CLAMEMTRAP = ON
          : CLAMEMTRAP = OFF


   CLAMATHTRAP: Specifies whether Floating Point Exceptions are reported.
                Floating Point Exceptions Include:
                           Divide By Zero
                           Overflow / Underflow Errors

                CLAMATHTRAP=ON will trap all FP Exceptions
                CLAMATHTRAP=OFF will NOT trap FP Exceptions


     usage: CLAMEMTRAP = ON      (Default)
          : CLAMEMTRAP = OFF



<<Cursor Control Keys>>
Ŀ
                           Cursor Control Keys                           

<Keyboard Movement>
   Up       Cursor up                   ^Left     Go left one word
   Down     Cursor down                 ^Right    Go right one word
   Left     Cursor left                 Gray *    Insert a space
   Right    Cursor right                Gray -    Shift line left
   Home     Go to first character       Gray +    Shift line right
   End      Go to last character        ^\        Toggle character case
   PgUp     Back one page               ^PgUp     Go to first entry
   PgDn     Forward one page            ^PgDn     Go to last entry
   Ins      Toggle Insert mode          ^Home     Erase entire field
   Del      Delete character            ^End      Erase to end of field
   Tab      Next field                  Enter     End edit (save changes)
   ShiftTab Previous field              Esc       Abort edit (no changes)

   When entering any file listing name or path, you can press F5 to look up
   an existing listing or path.


                      ^ means pressed with Ctrl key

<<File Menu>>

     The File Menu may be used to register or to exit.

<Registration Info>
     Registration Info
        If unregistered, shows information on how to register.
        If registered, shows registration information.

<Exit>
     Exit
        Exits to the operating system.


<<General>>

     General information about this program.

<Miscellaneous>
Ŀ
                     Tips for Speeding Up Processing                     


(1)  Only use the options you need, especially when it comes to adding
     files to archives.
(2)  Create a RAM drive, and execute the command:
     SET CLATMP=x:\            where x:\ is the RAM drive letter and path.
(3)  SortDesc will be unarchiving portions of the files being described...
     make sure there is at least 1 meg free on your hard drive.


Also see the Syntax section for more detailed information.


<<Setup>>
Ŀ
                                    Setup                                    

<Setup>

Since SortDesc was designed to handle many different situations, there are 4
pages of general options.  Most can be ignored for simpler operations, but
some are essential.

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.

<File and Description Placement>

   File and Description Placement Ŀ
                                                                           
           Directory to Process:                                           
    Default Output File Listing:                                           
    Default Path to Place Files:                                           
                  Sort Based On:  ()  All                                  
                                  ()  Descriptions                         
                                  ()  TIC Areas                            
                                  ()  None                                 
  

This section is essential.  SortDesc must know where to find the files you
want to get descriptions for.  The default output file listing is where
descriptions that could not be sorted will be placed.  The default path to
place files is the location where files should be moved to, if they cannot
be sorted; if left blank, it defaults to the "directory to process".

"Sort Based On" indicates how you want SortDesc to sort files based on the
descriptions found.  Selecting "All" will cause SortDesc to use the TIC
Area information if found, or keyword information if a TIC area is not
found, to determine where to place descriptions and files.  Selecting
"None" will cause SortDesc to merely find the descriptions, and place
them in the Default File Listing.

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.


<Where to Search for Descriptions>

   Where to Search for Descriptions Ŀ
                            ()  Check .TIC Files                           
                            ()  Check FILE_ID.DIZ                          
                            ()  Check Text Files                           
                            ()  Check .DOC Files                           
  

There are four places where SortDesc can find a description for your files -
standard "TIC" files, embedded "FILE_ID.DIZ" files within archives, captured
text files or other file listings, and documentation or "README" files
within archives.  If the checkbox is not checked for a section, SortDesc
will not look there for descriptions.

<Options When TIC Areas Are Used>

    TIC Options Ŀ
                                                                          
     ()  Remove TIC file once used                                        
     ()  Use FILE_ID.DIZ where available                                  
     ()  Check TIC area password                                          
            If invalid password:  ()  Skip                                
                                  ()  Delete File                         
                                  ()  Move File to...(path)               
   

When SortDesc finds a description for a file using a standard TIC file, you
can ask to have that TIC file removed by checking the "Remove TIC file once
used" box.  Please note that TIC files are not removed unless the files they
describe are found by SortDesc.

Checking the "Use FILE_ID.DIZ" box will cause SortDesc to check the described
archive for a "FILE_ID.DIZ" description.  If found, it will be used in place
of the description in the TIC file.  The TIC Area will still be used to
determine where to place the file and description (unless this option is
overridden, or the TIC Area does not have a File Listing/Path defined - see
"Sort Based On" above).

You can optionally check if the password in the TIC file matches one set-up
in TIC Area Configuration.  If the password for this file does not match
the password for the area, you can skip sorting this file, move it to a
different directory, or remove it altogether.

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.



<Options When Text File Listings Are Used>

    Text File Options Ŀ
                                                                          
     Text files to search:  (file specification)                          
     ()  Ignore archive extensions (I.E. FILE.ZIP will match FILE.ARJ)    
                                                                          
   

You can specify the location and name of text file(s) to search for
descriptions in.  Wildcards are valid, such as "C:\TEXT\*.TXT", but
multiple names are not, such as "THIS.TXT THAT.TXT".

If you check the box "Ignore Archive Extensions", SortDesc will consider
files matched to files described in the text file if the filenames without
the extensions are the same, such as "TEST.ZIP" and "TEST.ARJ".

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.


<Description Output>

    Description Output Ŀ
                 Date in listing:  ()  File Date                           
                                   ()  Today                               
                          Format:  ()  PCBoard                             
                                   ()  Single Line                         
                                   ()  Long Line                           
    Maximum lines of description:   9                                      
                 Tag line to add:  ....                                    
     ()  Filter Graphics                                                   
    Additional Phrases to Filter:  ....                                    
                                                                           
   

Descriptions that are added to file listings can be in one of three formats -
standard PCBoard format, standard FILES.BBS format ("Single Line"), or one
long line per file.  Dates in the listing can be the actual file date, or
today's date.  For PCBoard format, you can limit the number of lines for
the description being written out.

"Tag line to add" is a line of text that will be added to the description
placed in the file listings being written out.

"Filter Graphics" will remove all non-alphanumeric characters from the
descriptions found.  For example, "Ŀ" would be removed.

"Additional Phrases to Filter" will remove phrases from the descriptions
description found.  If there is more than one phrase, separate them using
the pipe ("|") character.  For example "+++|UPLOADED BY|INCREDIBLE" would
change "+++ATH" to "ATH".


<Archive Additions>

    Archive Additions Ŀ
     ()  Add FILE_ID.DIZ   File name to use for FILE_ID.DIZ:               
     ()  Add tagline to new FILE_ID.DIZ                                    
            Add file to archives:                                          
   

If the description was found somewhere other than a FILE_ID.DIZ file already
contained in the archive, you can add a FILE_ID.DIZ using this new
description.  If you want to add it using a different file name, you can.
You can also add the tag line specified in "Description Output" (see above)
to the new FILE_ID.DIZ.  Finally, you may add any file to the archive.

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.


<GIF Options>

Check off "Add Image Information" if you want SortDesc to add the dimensions
of any GIFs found to the description found for them.

Check off "Simpler GIF Description" if you want only the basic dimension
information added ("Image Info" and the background colour are omitted).

Check off "Use Dimensions if Description Not Found" if you want SortDesc to
use the image information if no other description has been found.  Note that
this SortDesc ignores the "If description not found, add anyways" option
if "Use Dimensions..." is checked off.



<Other>

    Path and Command Name - PKZIP:  C:\DOSXTEND\PKZIP.EXE
                          PKUNZIP:  C:\DOSXTEND\PKUNZIP.EXE
                          ARJ ADD:  C:\DOSXTEND\ARJ.EXE A
                      ARJ EXTRACT:  C:\DOSXTEND\ARJ.EXE E
                          LHA ADD:  C:\DOSXTEND\LHA.EXE A
                      LHA EXTRACT:  C:\DOSXTEND\LHA.EXE E

When first run, SortDesc will try to find your archiver and de-archiver
utilities.  If they cannot be found, or you are using compatible utilities,
enter the full path and executable name (with parameters where needed) here.

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.


    Files Without Descriptions Ŀ
             ()  If description not found, add anyways                     
             ()  Recheck for descriptions not found previous run           
             ()  Delete file if description not found                      
   

If SortDesc cannot find a description, you can optionally added a mention
to the default file listing ("** Description Not Found **").  You can also
optionally re-check those files the next time SortDesc is run, or remove
the file entirely.

    Miscellaneous Options Ŀ
                ()  Rename files to ISO9660 (CD-ROM) Standard              
            Move:  ()  Both  ()  Descriptions Only  ()  Files Only         
   

For CD-ROMs, filenames containing characters such as "-" and "@" are invalid.
You may rename files so that they comply with the ISO9660 standard.

Normal SortDesc operation sorts both the description and the file based on
the description.  You can optionally just "move" the description or file.
This effectively changes the "Path" or "Listing" setting in TIC and Keyword
setup to the default path or listing.

<Keyboard Movement>
   Up       Cursor up                   ^Left     Go left one word
   Down     Cursor down                 ^Right    Go right one word
   Left     Cursor left                 Gray *    Insert a space
   Right    Cursor right                Gray -    Shift line left
   Home     Go to first character       Gray +    Shift line right
   End      Go to last character        ^\        Toggle character case
   PgUp     Back one page               ^PgUp     Go to first entry
   PgDn     Forward one page            ^PgDn     Go to last entry
   Ins      Toggle Insert mode          ^Home     Erase entire field
   Del      Delete character            ^End      Erase to end of field
   Tab      Next field                  Enter     End edit (save changes)
   ShiftTab Previous field              Esc       Abort edit (no changes)

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.

                      ^ means pressed with Ctrl key



<<TIC Files>>
<TIC Files>
Ŀ
                                  TIC Areas                                  


There are two sections to the TIC area database update form, "Basic
Information", and "Advanced Options".

      Basic Information Ŀ
                                                                       
                      Area:  1-BUSI                                    
       Path to place files:  K:\ADD\SDN\SDN_BUSI                       
              File Listing:  K:\ADD\SDN\SDN_BUSI\FILES.BBS             
                                                                       
     

      Advanced Options (Optional) Ŀ
                                                                       
                  Password:  DLCWEST                                   
                                                                       
                               Forward                               
           Forward to path:                                            
     

The Advanced Options may be left blank.  The password is only checked if it
is not blank, and the "Check Password in TIC files" box is checked in
General Setup (see above).

Check the "Forward" box if you want an extra copy of files processed placed
in another directory.  "Forward to path" is the directory to place this extra
copy.  This is primarily used by BBS operators who wish to send a copy of
the files they receive to another BBS.


Please note that if SortDesc finds a new TIC area in a TIC file, that area
will automatically be added to the SortDesc TIC database, using the default
path and file listing destinations.

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.

<Keyboard Movement>
   Up       Cursor up                   ^Left     Go left one word
   Down     Cursor down                 ^Right    Go right one word
   Left     Cursor left                 Gray *    Insert a space
   Right    Cursor right                Gray -    Shift line left
   Home     Go to first character       Gray +    Shift line right
   End      Go to last character        ^\        Toggle character case
   PgUp     Back one page               ^PgUp     Go to first entry
   PgDn     Forward one page            ^PgDn     Go to last entry
   Ins      Toggle Insert mode          ^Home     Erase entire field
   Del      Delete character            ^End      Erase to end of field
   Tab      Next field                  Enter     End edit (save changes)
   ShiftTab Previous field              Esc       Abort edit (no changes)

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.

                      ^ means pressed with Ctrl key

<Setting Up Using an Existing TIC.CFG>

If you were using TICK, use this option ("Import from TIC.CFG" on the
Setup Menu) to select your TIC.CFG file.  SortDesc will import as much
information as possible.

<Setting Up Using a Script>

You can use your favorite ASCII editor to set up TIC Areas and SortDesc
Keyword commands.  Simply create an ASCII file with the format:

If you want a new TIC Area, add a line:

AREA_NAME  PATH  LISTING  [PASSWORD]

(the password is optional)


If you want a new SortDesc Keyword Command, add a line:

ORDER  PATH  LISTING  KEYWORD1 [KEYWORD2] [KEYWORD3]

(the 2nd and 3rd keywords are optional, multi-word phrases and leading/trailing
spaces are *not* supported in the ASCII file import)


Lines beginning with a ";" are treated as comments, and are skipped.


For example:

; TIC Areas
1-UTIL D:\UTILITY C:\PCB\NET\UTILITY PASSWORD
1-GAME D:\GAMES C:\PCB\GEN\DIR11

; SortDesc Phrases
100 D:\UTILITY C:\PCB\NET\UTILITY UTILITY DISK DOS
99 D:\GAMES C:\PCB\GEN\DIR11 GAME

<<Keywords>>
<Keywords>
Ŀ
                          Keyword and Phrase Sorting                         




                       Order:    10

              Word or Phrase:  ASCII
       2nd Phrase (optional):
       3rd Phrase (optional):

         Path to place files:  C:\TEXT
                File Listing:  C:\TEXT\FILES.BBS



Once SortDesc has found a description, it can place the file and description
based on one to three phrases found in that description.

"Order" is a number between 1 and 999 indicated what order SortDesc should
check for phrases in.  If two sets of phrases are given the same order number,
they will be checked alphabetically.

Example:  If you want "WINDOWS + GAMES" processed before "GAMES",
 give "WINDOWS + GAMES" a lower number than "GAMES".

To include trailing spaces in a phrase, end the phrase with the | character.

Example: "NDOW" will match descriptions containing WINDOWS or ENDOWED.
         " WINDOWS |" will match descriptions containing the word WINDOWS by
         itself.
         "WINDOWS" will match descriptions containing "WINDOWS-SPECIFIC".
         " PPL |" will match "THIS PPL DOES" but not "THIS APPLIES".

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.

<Setting Up Using a Script>

You can use your favorite ASCII editor to set up TIC Areas and SortDesc
Keyword commands.  Simply create an ASCII file with the format:

If you want a new TIC Area, add a line:

AREA_NAME  PATH  LISTING  [PASSWORD]

(the password is optional)


If you want a new SortDesc Keyword Command, add a line:

ORDER  PATH  LISTING  KEYWORD1 [KEYWORD2] [KEYWORD3]

(the 2nd and 3rd keywords are optional, multi-word phrases and leading/trailing
spaces are *not* supported in the ASCII file import)


Lines beginning with a ";" are treated as comments, and are skipped.


For example:

; TIC Areas
1-UTIL D:\UTILITY C:\PCB\NET\UTILITY PASSWORD
1-GAME D:\GAMES C:\PCB\GEN\DIR11

; SortDesc Phrases
100 D:\UTILITY C:\PCB\NET\UTILITY UTILITY DISK DOS
99 D:\GAMES C:\PCB\GEN\DIR11 GAME


<Keyboard Movement>
   Up       Cursor up                   ^Left     Go left one word
   Down     Cursor down                 ^Right    Go right one word
   Left     Cursor left                 Gray *    Insert a space
   Right    Cursor right                Gray -    Shift line left
   Home     Go to first character       Gray +    Shift line right
   End      Go to last character        ^\        Toggle character case
   PgUp     Back one page               ^PgUp     Go to first entry
   PgDn     Forward one page            ^PgDn     Go to last entry
   Ins      Toggle Insert mode          ^Home     Erase entire field
   Del      Delete character            ^End      Erase to end of field
   Tab      Next field                  Enter     End edit (save changes)
   ShiftTab Previous field              Esc       Abort edit (no changes)

When entering any file listing name or path, you can press F5 to look up
an existing listing or path.

                      ^ means pressed with Ctrl key

<<Excluding Files>>
<Excluding Files>
Ŀ
                                Exclude Files                                


This is a list of files that you do not want SortDesc to process.  FILES.BBS
is always excluded.


<<Upgrading>>
Ŀ
                                Upgrading                                

<From 2.x>

SortDesc has been completely rewritten in version 3.0 using Clarion 3.1.
This allows for faster processing, but also has necessitated a change to
the format of configuration.  All your favorite options are still
available, but you must use SortDesc's configuration screen to change
them.  If you are using a version 2.x or below SortDesc, you must re-enter
your configuration and registration information if applicable.

<From 3.0 Beta>
If you were using SortDesc 3.0 beta 302 (or below) build, you will need to
either run UPG_BETA.BAT or delete SD_TIC.* SD_CONF.* and re-enter your
setup information.  UPG_BETA.ZIP is available on the SortDesc support
BBS.

<From 3.0 Release>

Nothing is required to upgrade from version 3.0 to 3.1.

Version 3.1 adds support for the /LOG option, and Import from ASCII.
Bug fixes are:  Added leading 0 to dates to comply with PCBoard standard.
Doesn't move description to new area if file already exists in new area;
both description and file are left in the default listing and directory.
The REPLACE command in TIC files is partially implemented (only replaces
if file with same name is indicated).


<Options Still Supported>
THE ABOVE OPTIONS ARE EQUIVALENT TO THE FOLLOWING OPTIONS FROM VERSION 2.x:

D=Directory      Directory to Search

I=Import_File    File to search for descriptions for files without FILE_ID.DIZ

E=Export_File    File to place found descriptions in (unless redirected)

S=Smart_On_Off   SMART REDIRECTION (ON or OFF)
                 Whether or not to redirect the files and descriptions according
                 to keywords found in the descriptions

R=ON             RECHECK (ON or OFF)
                 Whether or not to try to find descriptions for files that
                 already exist in the listing being exported to (default
                 export file only)

SKIPEXT=NO       Yes or no; when searching for descriptions, ignore if the
                 extensions don't match (In other words, if this is set to
                 Yes, the program being looked for is EGG.ZIP and the
                 description found is for EGG.ARJ, the description WILL be
                 used).  Default is NO.                   (OPTIONAL)

NODIZ=NO         Yes or no; Skip checking for FILE_ID.DIZ; Default is No.

DATE=REAL        Use actual file date rather than tomorrow's date when adding
                 file descriptions to a text file. As of version 2.9, you
                 may specify TODAY, TODAY+1, TOMORROW, or REAL.
                 Default is TOMORROW.                     (OPTIONAL)

README=NO        Yes or no; If SORTDESC can't find either a FILE_ID.DIZ or
                 a description in the specified text file(s), and you include
                 the line README=YES, SORTDESC will try to find any file
                 in the archive called DESC.SDI, README., READ.ME, README.1ST,
                 or FILENAME.DOC (where Filename is the name of the archive
                 being examined, without an extension). If any of these are
                 found, SORTDESC will try to extract a description. If you
                 use this option, it is HIGHLY recommended that you set a
                 LIMIT. Default is NO.                    (OPTIONAL)

TIC=NO           YES, NO, or REMOVE; If SORTDESC can't find a FILE_ID.DIZ, then
                 attempt to use any TIC files that exist in the same directory.
                 YES simply checks the TIC files; REMOVE removes the TIC files
                 after checking them, whether they are used or not.
                 If TIC files have been included in the I= command,
                 (I.E.  I=*.TIC  or  I=*.TXT when REN *.TIC *.TXT has been run)
                 they will be included no matter what this is set to, but
                 the TIC Area will be ignored.
                 Default is NO.                           (OPTIONAL)

ONLYMOVE=DESC    DESC, FILE or N/A; SORTDESC will optionally only redirect
                 descriptions, and leave files where they are, or vice versa.
                 Default is N/A.                          (OPTIONAL)


                            Ŀ
                             ADDING TO ARCHIVES 
                            

DIZ=NO           Yes or no; Create FILE_ID.DIZ from description found in
                 text file, and add to archive? (Also see TAGDIZ, TAGLINE
                 and NFO below)
                 Default is NO.                           (OPTIONAL)

TAGDIZ=Add_line  A line to add to the newly created FILE_ID.DIZ (does not
                 apply to files already contain a FILE_ID.DIZ).
                                                          (OPTIONAL)

TAGLINE=Add_line A line to add to the description that was found (only adds
                 to new FILE_ID.DIZs, and the created description text file,
                 does not change files that already contain a FILE_ID.DIZ).
                                                          (OPTIONAL)

NFO=FileName     What to call the file that will be added to archives not
                 containing a FILE_ID.DIZ. Defaults to FILE_NFO.DIZ.
                 See the discussion below.
                                                          (OPTIONAL)

MSG=Add_Msg.txt  A text file to add to the archive        (OPTIONAL)

GIF=ZIP          If file is a GIF, and not an archive, but you would still
                 like to attach a FILE_ID.DIZ, add this line. The GIF will
                 be placed in a ZIP file of the same name. You can also
                 specify ARJ and LHA. (You must also set DIZ=YES for this
                 to work). If this line is not included, or one
                 of those three options are not taken, the GIF will be
                 untouched, and no FILE_ID.DIZ will be attached.
                                                          (OPTIONAL)


                            Ŀ
                             FILTERS AND LIMITS 
                            

LIMIT=###        The maximum lines to use for any file's description.
                 Any number ranging from 1 TO 255; use LIMIT=0 or leave this
                 line out entirely for no maximum limit on the number of lines.
                                                          (OPTIONAL)

FILTER=ON        On or Off; Remove certain graphic characters and character
                 combinations that contain no useful information.
                 Default is ON                            (OPTIONAL)

BETA=OFF         On or Off; If ON, removes character 225 () when filtering
                 graphics characters. If OFF, skips filtering "" character.
                 Default is OFF                           (OPTIONAL)

GONE=~STRING1~STRING2~STRING3~ETC~
                 Specify extra character combinations that will be removed
                 during filtering (if filtering not turned OFF). Separate
                 each string with the ~ symbol; up to 80 characters total
                 are allowed. Example: GONE=~GREAT~I LIKED IT~(NEW)~ will
                 remove any occurance of the word "Great", the phrase
                 "I Liked it", and the word "(NEW)".      (OPTIONAL)

ISO=9660         9660 or blank; If 9660, ensures that file names comply
                 with the ISO9660 standard by changing !@#$%- characters
                 to underscores. Default is blank.        (OPTIONAL)

SKIPNF=YES       Yes or no; Skip adding "Description Not Found" to the
                 target description file if a description isn't found.
                 Defaults to NO.                          (OPTIONAL)



<<Troubleshooting>>
The following documentation applies to any program written in Clarion 3.0.
It has been included for your reference.


<Typical System Requirements>


 Minimum Requirements
  1. 8088 based computer or higher
  2. MS/PC-DOS Version 3.3 or higher.
  3. Monochrome 80x25 monitor.
  4. 400K RAM.
  5. Memory manager None.
  6. 1Meg of free disk. (to handle memory overflow, temp files etc.)

 Practical Requirements
  1. 80286 based computer or higher
  2. MS/PC-DOS Version 3.3 or higher.
  3. EGA
  4. 2Meg RAM.
  5. Memory manager None. EMS,XMS,DISK supported. VCPI,DPMI support in extender.
  6. 6Meg of free disk. (to handle memory overflow, temp files etc.)



<Memory Manager Example Settings>

**********************************************************************
IMPORTANT NOTE!

These are only EXAMPLE configurations for these Memory Managers.  ALL
Memory Manager switches are HARDWARE DEPENDENT.  Your settings will
most likely differ from those shown below.

If you are unsure of the settings you should use, run the appropriate
configuration program for your memory manager.

              Memory Mgr.        Configure with
              
                QEMM             OPTIMIZE
                386MAX           MAXIMIZE
                MS DOS 6         MEMMAKER
                PC DOS 6         RAMSETUP


**********************************************************************

MS DOS 6 / EMM386 - CONFIG.SYS

DEVICE=C:\DOS\HIMEM.SYS
DEVICE=C:\DOS\EMM386.EXE RAM HIGHSCAN X=D000-D1FF
BUFFERS=15,0
FILES=60
DOS=UMB
LASTDRIVE=E
FCBS=4,0
DEVICE = C:\hyp\hyperdkx.EXE c:1024 cw:1024 h v
DEVICEHIGH /L:1,12048 =C:\DOS\SETVER.EXE
DOS=HIGH
SHELL=C:\DOS\COMMAND.COM C:\DOS\  /p

*Alternate EMM386 CONFIG.SYS settings under DOS 6
DEVICE=C:\DOS\EMM386.EXE noems X=D000-D1FF


MS DOS 6 / EMM386 - AUTOEXEC.BAT

@ECHO OFF
PROMPT $p$g
PATH C:\DOS;c:\clarion3;c:\cmd;c:\norton
loadhigh doskey
SET TEMP=C:\DOS

----------------------------------------------------------------------

PC DOS 6.1 / EMM386 - CONFIG.SYS

***** NOTE: If you do not have the most recent version of IBM DOS 6
you may have problems running CDD.  The fix for IBMDOS.COM is on the
latest disk compression diskette (if your version did not come w/ disk
compression) or available for download from the Clarion Forum on
CompuServe (Go Clarion) in Library 8.


DEVICE=C:\DOS\HIMEM.SYS
DEVICE=C:\DOS\EMM386.EXE NOEMS RAM X=A000-B1FF I=B200-B7FF X=B800-C7FF I=C800-CFFF X=D000-D3FF I=D400-EFFF X=F000-F7FF H=64 A=7 D=32
DEVICE=C:\DOS\RAMBOOST.EXE LOAD
DOS=HIGH
DEVICE=C:\DOS\SETVER.EXE
FILES=50
BUFFERS=20
DEVICE=C:\HYPERDKX.EXE C:640 CW:512 H OR
SHELL=C:\DOS\COMMAND.COM C:\DOS\  /p
STACKS=0,0


PC DOS 6.1 / EMM386 - AUTOEXEC.BAT


@ECHO OFF
SET CLATMP=C:\TEMP
SET TEMP=C:\TEMP
SET IBMAV=C:\DOS
CALL C:\DOS\IBMAVDR.BAT C:\DOS\
PROMPT $_$t$_$p$g
PATH C:\DOS;C:\;C:\CMD;C:\CLARION3;C:\CDDW\BIN;C:\NU;C:\CLARION;C:\WINDOWS
Rem --- Check for lost clusters or chains
CHKDSK /F
Rem --- Delete any Temp Files left over
DEL C:\TEMP\*.$$$
Rem --- Load Doskey
C:\DOS\DOSKEY
Rem --- Load Mouse
C:\DOS\MOUSE
Rem --- Load Network Drivers
IPX
NET5.COM


----------------------------------------------------------------------

MS DOS 5 / EMM386 - CONFIG.SYS

DEVICE=C:\DOS\HIMEM.SYS
DEVICE=C:\DOS\EMM386.EXE NOEMS I=E000-EFFF
DOS=HIGH,UMB
SHELL=C:\DOS\COMMAND.COM C:\DOS\ /P /E:186
FILES=50
BUFFERS=5
STACKS=0,0
BREAK=ON

Note : Address location E000-EFFF is machine dependent.  This memory
       location may increase your conventional memory by +30K.


MS DOS 5 / EMM386 - AUTOEXEC.BAT

PROMPT $p$g
PATH C:\;C:\CLARION3;C:\DOS
Rem
Rem  In the next statement AUTO switch enables protected mode access
Rem
EMM386 AUTO
LH BTRIEVE /E /M:48 /P:4096 /T:\CLARION3\CLARION.TRN
LH MOUSE
LH DOSKEY

----------------------------------------------------------------------

386/MAX - CONFIG.SYS

DOS=HIGH
FILES=50
         Several CONFIG.SYS variations:

DEVICE=C:\386max\386max.sys pro=c:\386max\386max.pro
DEVICE=C:\386max\386max.sys pro=c:\386max\386max.pro NODPMI
DEVICE=C:\386MAX\386load.sys size=12576 flexframe prog=C:\HYPERKEY.EXE
DEVICE=C:\386MAX\386load.sys size=45360 flexframe prog=C:\HYPERDKX.EXE C:1024 H
DEVICE=C:\386MAX\386load.sys size=9040 flexframe prog=C:\DOS\ANSI.SYS
SHELL=C:\DOS\COMMAND.COM C:\DOS\ /E:186 /p
STACKS=0,0

386/MAX - AUTOEXEC.BAT

PROMPT = $P$G
PATH C:\;C:\CLARION3;C:\DOS
C:\386MAX\386load size=6400 flexframe prog=DOSKEY
C:\386MAX\386load size=10736 prgreg=2 flexframe prog=MOUSE /2

----------------------------------------------------------------------

QEMM386 - CONFIG.SYS

DEVICE=C:\QEMM\QEMM386.SYS R:5 X=B000-B0FF X=C600-C7FF DBF=2 ST:M RAM
DOS=HIGH
DEVICE=C:\QEMM\LOADHI.SYS /R:2 C:\DOS\ANSI.SYS
DEVICE=C:\QEMM\LOADHI.SYS /R:1 C:\MOUSE.SYS
SHELL=C:\DOS\COMMAND.COM /E:500 /P
BUFFERS=20
FILES=70

QEMM386 - AUTOEXEC.BAT

PROMPT $P$G
PATH  C:\;C:\CLARION3;C:\DOS;C:\QEMM
C:\QEMM\LOADHI /R:3 /RES=4336 /SQT=D000-D0FF \DOS\DOSKEY
C:\QEMM\LOADHI /R:2 LSL
C:\QEMM\LOADHI /R:4 TRXNET
C:\QEMM\LOADHI /R:2 /RES=16096 /SQT=C600-C7FF IPXODI
C:\QEMM\LOADHI /R:4 NETX

QEMM386 - CONFIG.SYS

DEVICE=C:\QEMM\QEMM386.SYS R:5 X=B000-B0FF X=C600-C7FF DBF=2 ST:M RAM
DOS=HIGH
DEVICE=C:\QEMM\LOADHI.SYS /R:2 C:\DOS\ANSI.SYS
DEVICE=C:\QEMM\LOADHI.SYS /R:1 C:\MOUSE.SYS
SHELL=C:\DOS\COMMAND.COM /E:500 /P
BUFFERS=20
FILES=70


<Clarion 3.0 ERRORINF.$$$ Errors>

File ERRORINF.$$$ has the format:    SSSS:OOOO ERRORCODE


where SSSS = code segment, OOOO = IP value and ERRORCODE = Hex error code.

IF SSSS:OOOO = ????:????  the error is from the loader.

Run-time Codes:

01H  Stack overflow
     Description: The application is running out of stack, raise the
     stack setting on the Project/Debug window and remake the application.
     The STOP window can be checked before entering the module that fails
     to see how much stack is available.  You should try to have at least
     4k of stack available.
02H  Null pointer de-reference
     Description: The application Project is set for Null Parameter Checking
     and if the procedure that fails contains a SCREEN or REPORT that has
     a USE(MEMO) you must turn OFF Null Parameter Checking for that module.
     Null Parameter Checking is set on the Project/Debug window.
03H  Termination caused by signal.  (User break or Floating point exception)
     Description: Generally means you have referenced an uninitialized
     or invalid floating point number.
04H  Math Overflow.
     Description: Generally means you have referenced an uninitialized
     or invalid floating point number.
05H  Range.
06H  No Return.
07H  No matching Case Label.
08H  Long Integer Divide By Zero.
09H  Index Error.
     Description: An array subscript is not within a valid range.
0AH  Pure Virtual Function Called.


Overlay Loader Errors:

101H Invalid Export Entry In Exe File/DLL.
102H Too many modules.
103H DLL is incorrect version.
104H Module is corrupt.
105H BP chain corrupt.
106H Module not found.
107H Incorrect fixup type.
108H EMS error.
109H Module not corrcet format.
10AH Invalid function request to loader.
10BH Module initialization failed.
10CH File not found.
10DH Out of memory
10EH I/O error on read.
10FH I/O error on seek.
110H Stack overflow.
111H Illegal reference to code segment.
112H Segment list corrupt.
113H Too many segments.
114H Attempt to reload segment.



<Bug Report>

                             Software Product Report


Name                    :
Company                 :
Area code and Phone     :
FAX number              :
Registration#           :


Version                 :
(To obtain the current version number choose "HELP" from the
main menu, then choose "About".)


Description of Bug      :




Steps to reproduce the problem (please explain step by step):


 Work-around:


Reproducible: <Always> <Random> <Never> <Didn't try>



Severity Level:   < > 1. System locks, crashes, or file corruption occurs
                  < > 2. Does not operate as documented
                  < > 3. Cosmetic or user interface problem
                  < > 4. Suggestion or documentation error


Machine Configuration -

Computer Brand and Model        :
System BIOS                     :
CPU type and speed              :
Total Memory                    :
Operating System & Version      :
Memory Manager                  :
Disk Cache                      :
Network O/S                     :
Video Card                      :


