@database UpScan.guide

Copyright (c) 1993 RamRod.
All Rights Reserved.

@remark $VER: (Aug 22 1993, 21:00:00)
@remark AmigaGuide Database for the UpScan Documentation

@node MAIN "UpScan Users Manual"

                       -> AlPhA fLiGhT <- presents:

            ооо  ооо           ооооооо
            ооо  ооо          оооооооо
            ооо  ооо ооооооо  ооо       оооооо   оооооо  ооо  ооо
            ооо  ооо оооооооо ооо      оооооооо оооооооо оооо ооо
            ооо  ооо ооо  ооо ооооооо  ооо  ооо ооо  ооо оооооооо
            ооо  ооо оооооооо  ооооооо ооо      оооооооо оооооооо
            ооо  ооо ооооооо       ооо ооо      оооооооо ооо оооо
            ооо  ооо ооо           ооо ооо  ооо ооо  ооо ооо  ооо
            оооооооо ооо      оооооооо оооооооо ооо  ооо ооо  ооо
             оооооо  ооо      ооооооо   оооооо  ооо  ооо ооо  ооо

              @{" Introduction to UpScan " Link Lnk01}@{" What You Need to Know  " Link Lnk1b}
              @{" Copyrights Information " Link Lnk02}@{" Hardware Requirements  " Link Lnk03}
              @{" Installation of UpScan " Link Lnk04}@{" How Does It Work       " Link Lnk05}
              @{" UpScan Preferences     " Link Lnk06}@{" Executing UpScan       " Link Lnk09b}
              @{" About the Key File     " Link Lnk10}@{" Registration           " Link Lnk07}
              @{" Credits                " Link Lnk08}@{" Acknowledgements       " Link Lnk09}
@endnode
@node Lnk01 "Introduction to UpScan"

Introduction to UpScan

        UpScan was designed to be used in conjunction with the AmiExpress
        bulletin board system software. It is *not* compatible with other
        BBS software packages and never will be.

        UpScan examines the contents of upload directories each time a
        caller logs off. UpScan checks whether the files uploaded are
        error-free or not and then acts on that information.

        There has been similar utilities in the past, but they have been
        rather slow and some even unreliable.

        UpScan is here to make a SysOp's life easier.

        UpScan -- Spread it, register it and use it!

@endnode
@node Lnk1b "What You Need to Know"

What You Need to Know

        This manual assumes that you know how to use your Amiga computer
        and are familiar with basic Amiga computer terms.

        You should also know how to use the AmiExpress BBS software.

@endnode
@node Lnk02 "Copyrights Information"

Copyright

        This manual is copyright 1993 by RamRod. This program (UpScan) is
        copyright 1993 by RamRod. This program (UpScan) is shareware. This
	program (UpScan) may be redistributed to other bulletin boards,
	networks or individuals. You may not redistribute a modified
	version of the program (UpScan) or this documentation.

Disclaimer

        THIS PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
        EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
        PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE RESULTS AND
        PERFORMANCE OF THE PROGRAM IS ASSUMED BY YOU. SHOULD THE PROGRAM
        PROVE DEFECTIVE, YOU (AND NOT THE AUTHOR OF THIS PROGRAM) ASSUME
        THE ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR, OR
        CORRECTION. FURTHER, THE AUTHOR OF THIS PROGRAM DOES NOT WARRANT,
        GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR
        THE RESULTS OF THE USE OF, THE PROGRAM IN TERMS OF CORRECTIONS,
        ACCURACY, RELIABILITY, CURRENTNESS, OR OTHERWISE; AND YOU RELY ON
        THE PROGRAM AND RESULTS SOLELY AT YOUR OWN RISK.

Limitation of Liability

        The author's liability shall not in any event include damages for
        loss of use or benefits or other incidental or consequential
        costs, expenses or damages, including without limitation any data
        or information which may be lost or rendered inaccurate, even if
        the author of this program has been advised of the possibility of
        such damages.

License

        You are granted a limited license to evaluate this software for a
        30 day period. You must decide at the termination of this
        evaluation period to register this product if you plan to continue
        using it or to cease all use otherwise.

        Registration is not only required for your continued use, it is
        needed to keep the development of future enhancements to UpScan
        active.  Without your support the product cannot continue to
        evolve.

Miscellaneous

        This agreement represents the entire understanding regarding the
        program and related documentation, and supersedes any prior
        communications or representations. This agreement may only be
        modified by a written amendment signed by the author of this
        program.

@endnode
@node Lnk08 "Credits"

Credits

        UpScan, its code, this manual, and anything else distributed
        with this package are the original work of the author, except for
	the icons, More, Copy and IconX.

@endnode
@node Lnk09 "Acknowledgements"

Acknowledgements

        Thanks must go out to The Last Generation BBS and especially to
        its SysOp, HiFi, for suggestions on the UpScan. Other suggestions
        are too numerous to call out individually, but the author
        certainly appreciates them all.

Trademark Acknowledgements

        I have made every effort to supply trademark information about
        company names, products, and services mentioned in this manual.
        Trademarks indicated below were derived from various sources. I
        cannot attest to the accuracy of this information.

        Amiga is a trademark of Commodore-Amiga, Inc.
        AmiExpress - Copyright (c) LightSpeed Technologies 1992-93
        LhA - Copyright (c) 1991,92 Stefan Boberg

@endnode
@node Lnk03 "Hardware Requirements"

Hardware Requirements

        To run UpScan, you need an Amiga computer with at least 512
        kilobytes of memory and Operating System 2.04 or greater.

        A hard disk is required.

        UpScan has not been tested on AGA-machines.

        Please report all compatibility problems.

@endnode
@node Lnk05 "How Does It Work and What Does It Do?"

How Does It Work and What Does It Do?

        As discussed earlier, UpScan scans the specified upload
        directories for new files. If new files are found, they are
        examined one by one in order to determine the type of each file.

        After determining a particular file's type, UpScan will browse
        through its @{"file checking-utilities" Link fileChkUtils} list searching for an
        appropriate file checking-utility. If an appropriate checker is
        found, it will be executed and used for checking the file. If
        UpScan is unable find an appropriate checker, the file in question
        is assumed to be error-free.

        UpScan is also able to recognize normal ASCII, ANSI-formatted and
        non-ASCII text files. In short, there's no filetype UpScan cannot
        be configured to examine.

        All the files that pass the check (or are not checked) are moved
        to a directory which is reserved for error-free files only.
        Respectively, all corrupt files are moved to a separate directory
        or deleted (optional). If a corrupt file is found, UpScan will
        send a user-definable message to whoever uploaded the file
        (optional) and reduce the uploader's byte count (optional) and the
        number of his/her uploads (optional).

        UpScan also makes it possible to add BBS ads, @{"banners" Link prefs_Chap04}, to
        archives (optional) and text files (optional). Adding banners to
	archives depends on the used file checking-utilities' banner-
        adding capabilities.

        If you want, UpScan will also mark the date changes in your "Dir"
        files by writing a user-definable text (a.k.a. the date-separator)
        in between the two different dates.

        UpScan also prevents your "CallersLog" and "UDLog" from becoming
        10 MB monsters (optional).

        UpScan *can* be used on multinode systems.

        I suggest you take a look at the @{"Preferences" Link Lnk06} section in order
        to find out more about UpScan's diverse capabilities.

@endnode
@node fileChkUtils "What Are File Checking-Utilities?"

What Are File Checking-Utilities?

        When people are talking about file checking-utilities or checkers,
        they usually mean small utilities which are used on bulletin board
        systems to examine if there are any corrupt files uploaded on the
        system. Sometimes normal file archiving-utilities (eg. "LhA") can
        be used to do the same thing (provided they have a "testing"
        -option).

        If you have a custom-made file checking-utility and you are not
        sure whether it works with UpScan or not, feel free to send that
        utility (with a complete documentation) to the author of UpScan
        and you can count on the checker being supported in the future
        releases of UpScan. Before sending any checkers, take a look at
        the @{"Known Checking-Utilities List" Link prefs_KnownChkUtils} just to make sure it isn't
        already supported.

        Do *NOT* send commercial software!

@endnode
@node Lnk04 "UpScan Installation Procedure"

UpScan Installation Procedure

        You must have the AmiExpress bulletin board system software
        correctly installed to a partition of your hard drive before you
        can install UpScan.

        1) Click on the "Install"-icon.

        2) Disable /X's own internal DMS, WRP, LhA and LZH checking.

        3) Create two new directories in each conference you want
           UpScan to scan.

           Eg. makedir BBS:Conf1/Passed
               makedir BBS:Conf1/Failed

           One is for the files that pass the check and the other is for
           the files that fail the check.

        4) /X 2.3X USERS ONLY: Locate a file called "PATHS". There should
           be a path to "Upload"-directory. Replace that path with a one
           which tells /X that the files are now to be found in a
           different directory.

           Eg. BBS:Conf1/Passed

           /X 3.XX USERS ONLY: There's an icon for each conference. Locate
           that icon, activate it, and press "Right Amiga"-key and "i"
           simultaneously (this brings up an info-window) and replace the
           path found after the "DLPATH"-tooltype with a one which tells
           /X that the files are now to be found in a different directory.

           Eg. BBS:Conf1/Passed

           Refer to the @{"preferences" Link Lnk06} section in order to find out how
           to tell UpScan the names of these two directories.

        5) Now, move all files that are present in each conference's
           "Upload"-directory to the directory you just made for each
           conference's error-free files (this is just to speed up the
           initial scan UpScan performs when first executed).

        6) Adjust the @{"preferences" Link Lnk06} to suit your needs.

@endnode
@node Lnk09b "Executing UpScan"

Executing UpScan

        You probably already use /X's ability to execute a so called
        "log-off script". If not, I suggest you take a look at your /X-
        manual to find out about this feature.

        Insert the following line in your log-off script:

        BBS:Utils/UpScan nX nX ... ... ...

        Where "nX" stands for a node number. If you have a multinode
        system, create separate log-off scripts for each node and insert
        a similar line in all of the scripts. Include as many node numbers
        as you have nodes. If you have, say two nodes (0 and 1), this is
        what you'd write:

        LogOffScript for node 0:

        ----------------------------------- cut here -------------
        BBS:Utils/UpScan 0 1
        ----------------------------------- cut here -------------

        LogOffScript for node 1:

        ----------------------------------- cut here -------------
        BBS:Utils/UpScan 1 0
        ----------------------------------- cut here -------------

        As you compare those lines, you can see that the node numbers are
        not in the same order. Why? Well, UpScan will scan the nodes in
        the exact order they are entered on that line and it wouldn't be
        wise to scan node 1 first, if someone logs off from node 0 and
        vice versa.

@endnode
@node Lnk10 "About the Key File"

About the Key File

        The "UpScan.key"-file must be present in your "L:"-directory.
        Otherwise UpScan won't work.

        When you register, you'll get a new "UpScan.key"-file. Replace the
        one found in this package with that. Otherwise you'll be using a
        T.L.G.-registered version of the program and that will become
        irritating as I'm sure you'll notice.

@endnode
@node Lnk06 "UpScan Preferences"

UpScan Preferences

        @{" About the Preferences      " Link prefs_Chap01}@{" Customizing UpScan         " Link prefs_Chap02}
        @{" Commands and Properties    " Link prefs_Chap03}@{" About Banners              " Link prefs_Chap04}
        @{" File Checking-Utility List " Link prefs_FileChkUtilList}@{" Known Checking-Utilities   " Link prefs_KnownChkUtils}
@endnode
@node prefs_Chap01 "About the Preferences"

About the Preferences

        UpScan has a separate preferences-file that must be present in
        both the "ENV:" and "ENVARC:"-directory for UpScan to work. If
        this file is missing UpScan displays an error message and refuses
        to proceed with the scanning.

        There's an example on a preferences-file ("UpScan.prefs")
        distributed with this package. It is strongly recommended that you
        take a look at it in order to avoid any misunderstandings.

@endnode
@node prefs_Chap02 "Customizing UpScan"

Customizing UpScan

        UpScan's preferences-file ("UpScan.prefs") contains many @{"commands" Link commandsLink}
        and @{"properties." Link propertiesLink}

        Also the date separator text and file checking-utilities list are
        in the "UpScan.prefs"-file.

        Some of the commands and properties are necessary for the program
        to work; they are marked with an asterisk (*) on the list. Command
        or property not marked with an asterisk can be leaved out or
        disabled by placing a dot or a semicolon in front of it.

        NOTE! All commands and properties must begin in the first column
        of each line. Commands and properties *are* case-sensitive! Be
        sure to type a semicolon ";" at the end of each line (the date
        separator text is an exception).

        There's an example on a preferences-file ("UpScan.prefs")
        distributed with this package. It is strongly recommended that you
        take a look at it in order to avoid any misunderstandings.

@endnode
@node commandsLink "UpScan Commands"

UpScan Commands

        Commands instruct UpScan to perform some kind of action. Actions
        include such things as adding banners, deleting failed uploads
        and truncating logs.

@endnode
@node propertiesLink "UpScan Properties"

UpScan Properties

        Properties are named characteristics or attributes of UpScan.
        The characteristics of UpScan properties include the locations
        of certain directories, paths to certain files and so on.

@endnode



@node prefs_Chap03 "UpScan Commands and Properties"

UpScan Commands and Properties

        @{" UploadDirPaths * " Link prefs_Comm01}@{" PassedDirPaths * " Link prefs_Comm02}
        @{" FailedDirPaths * " Link prefs_Comm03}@{" DirXPaths      * " Link prefs_Comm04}
        @{" UseDateSep       " Link prefs_Comm05}@{" UserDataPath   * " Link prefs_Comm06}
        @{" ArcPBannPath     " Link prefs_Comm07}@{" ArcFBannFile     " Link prefs_Comm08}
        @{" TxtBFBannPath    " Link prefs_Comm09}@{" TxtEFBannPath    " Link prefs_Comm09b}
        @{" TFBBeg           " Link prefs_Comm10}@{" TFBEnd           " Link prefs_Comm11}
        @{" SizeFailText     " Link prefs_Comm12}@{" FPercentage      " Link prefs_Comm13}
        @{" DecrNumUploads   " Link prefs_Comm14}@{" DeleteFailed     " Link prefs_Comm15}
        @{" FMsgPathName     " Link prefs_Comm16}@{" SubjectOfMsg     " Link prefs_Comm17}
        @{" NoChkrOutput     " Link prefs_Comm18}@{" CLogTruncat      " Link prefs_Comm19}
        @{" UDLogTruncat     " Link prefs_Comm20}@{" DateSepText      " Link prefs_Comm21}
@endnode
@node prefs_Chap04 "About Banners"

About Banners

        As stated before, depending on the file checking-utilities used,
        you can enable UpScan to make those checkers add so called banners
        to files that are uploaded on your board. This is done by using
        the checkers' internal text adding capabilities which, in some
        cases, are unfortunately non-existent. UpScan itself has the
        capability of adding banners to text files.

        The size of a banner is limited to 10 kilobytes (10240 bytes).
        Banners longer than 10 KBs will be truncated.

        The banners can be regular ASCII, ANSI-formatted or non-ASCII text
        files. There's one rule that applies here: Do *not* use ANSI-
        formatting codes in banners which are to be added to text files.
        It's not that UpScan wouldn't allow that, but it's not nice to
        have billions of ESC-sequence codes in text files and documents.

        Want to have time, date and other information regarding the file
        in banners? No problem! The following %-sequences are allowed in
        banners:

        %A  -  Upload Day    ( Eg. Wednesday ).
        %B  -  Upload Date   ( Format: DD-MM-YY ).
        %C  -  Upload Time   ( Format: HH:MM:SS ).
        %D  -  File's Length ( Eg. 116384 ).
        %E  -  File's Name.

@endnode
@node prefs_Comm01 "UploadDirPaths Property"

SYNOPSIS

        UploadDirPaths  "pathname" "pathname" ... ;

EXPLANATION

        Names of the directories to be scanned for new uploads.

EXAMPLE

        UploadDirPaths  "BBS:CONF1/Upload" "BBS:CONF2/Upload";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm02 "PassedDirPaths Property"

SYNOPSIS

        PassedDirPaths  "pathname" "pathname" ... ;

EXPLANATION

        Names of the directories where all error-free files will be moved
        during the scan.

EXAMPLE

        PassedDirPaths  "BBS:CONF1/Passed" "BBS:CONF2/Passed";

BUGS AND/OR DEFECTS

       -

SEE ALSO

       -

@endnode
@node prefs_Comm03 "FailedDirPaths Property"

SYNOPSIS

        FailedDirPaths  "pathname" "pathname" ... ;

EXPLANATION

        Names of the directories where all corrupt files will be moved
        during the scan.

EXAMPLE

        FailedDirPaths  "BBS:CONF1/Failed" "BBS:CONF2/Failed";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        @{"DeleteFailed" Link prefs_Comm15}

@endnode
@node prefs_Comm04 "DirXPaths Property"

SYNOPSIS

        DirXPaths       "pathname" "pathname" ... ;

EXPLANATION

        Names of the directories where the "Dir"-files (eg. "Dir1") are
        located.

EXAMPLE

        DirXPaths       "BBS:CONF1" "BBS:CONF2";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm05 "UseDateSep Command"

SYNOPSIS

        UseDateSep      "YES/NO" "YES/NO" ... ;

EXPLANATION

        With this command you can specify in which conferences to use date
        separator texts. Remember to put the "YES"/"NO"-options in the
        same order as you put your respective conference paths.

        If you do not specify this command, date separators won't be
        used.

EXAMPLE

        UseDateSep      "YES" "NO";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm06 "UserDataPath Property"

SYNOPSIS

        UserDataPath    "pathname/filename";

EXPLANATION

        Path to your "User.data"-file.

EXAMPLE

        UserDataPath    "BBS:User.data";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm07 "ArcPBannPath Property"

SYNOPSIS

        ArcPBannPath    "pathname/filename";

EXPLANATION

        Full path to a banner file that is to be added to archives. By
        not setting this property, you prevent UpScan from making the
        file checking-utilities add banners to archives.

EXAMPLE

        ArcPBannPath    "S:Texts/Logos/TLG.logo";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        @{"ArcFBannFile" Link prefs_Comm08}

@endnode
@node prefs_Comm08 "ArcFBannFile Property"

SYNOPSIS

        ArcFBannFile    "filename";

EXPLANATION

        The actual filename to be used when adding a banner to an archive.
        This property must be set, if the property "ArcPBannPath" is set.

EXAMPLE

        ArcFBannFile    "TLG.displayme";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        @{"ArcPBannPath" Link prefs_Comm07}

@endnode
@node prefs_Comm09 "TxtBFBannPath Property"

SYNOPSIS

        TxtBFBannerPath  "pathname/filename";

EXPLANATION

        Full path to a banner that is to be added to the beginning of a
        text file. If you do not set this property, no banner will be
        added to the beginning of a text file.

EXAMPLE

        TxtBFBannerPath  "RAM:TheLongestBegBannerFileNameInTheWorld";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm09b "TxtEFBannPath Property"

SYNOPSIS

        TxtEFBannerPath  "pathname/filename";

EXPLANATION

        Full path to a banner that is to be added to the end of a text
        file. If you do not set this property, no banner will be added to
        the end of a text file.

EXAMPLE

        TxtEFBannerPath  "RAM:TheLongestEndBannerFileNameInTheWorld";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm10 "TFBBeg Property"

SYNOPSIS

        TFBBeg;

EXPLANATION

        This property enables UpScan to add banners to the beginning of
        text files. This property can be used simultaneously with the
        "TFBEnd" property. If both the "TFBEnd" and "TFBBeg" are unset, no
        banners will be added to text files.

EXAMPLE

        TFBBeg;

BUGS AND/OR DEFECTS

        -

SEE ALSO

        @{"TFBEnd" Link prefs_Comm11}

@endnode
@node prefs_Comm11 "TFBEnd Property"

SYNOPSIS

        TFBEnd;

EXPLANATION

        This property enables UpScan to add banners to the end of text
        files. This property can be used simultaneously with the "TFBBeg"
        property. If both the "TFBEnd" and "TFBBeg" are unset, no banners
        will be added to text files.

EXAMPLE

        TFBEnd;

BUGS AND/OR DEFECTS

        -

SEE ALSO

        @{"TFBBeg" Link prefs_Comm10}

@endnode
@node prefs_Comm12 "SizeFailText Property"

SYNOPSIS

        SizeFailText    "string";

EXPLANATION

        A replacement string for filesizes in "Dir"-files. File's size
        is replaced by this string if the file in question failed the
        check. The length of the string is limited to 6 characters.
        Default string is "*FAIL*".

EXAMPLE

        SizeFailText    "KABOUM";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm13 "FPercentage Property"

SYNOPSIS

        FPercentage     -number%;

EXPLANATION

        If somebody uploads a corrupted file, this is the percentage of
        the file's length that will be reduced from the uploader's byte
        count.

        Valid percentages are: -0%, -25%, -50%, -75%, -100%, -150%, -200%,
        -250%, -300%, -350%, -400% -450% and -500%.

        Default percentage is -0%.

EXAMPLE

        FPercentage     -50%;

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm14 "DecrNumUploads Command"

SYNOPSIS

        DecrNumUploads;

EXPLANATION

        This command instructs UpScan to decrease the number of user's
        uploads, if a file he/she uploaded fails the check.

EXAMPLE

        DecrNumUploads;

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm15 "DeleteFailed Command"

SYNOPSIS

        DeleteFailed;

EXPLANATION

        If this command is implemented, instead of moving corrupt files to
        a certain directory, UpScan deletes them.

EXAMPLE

        DeleteFailed;

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm16 "FMsgPathName Property"

SYNOPSIS

        FMsgPathName    "pathname/filename";

EXPLANATION

        Path to a user-definable message text file. The message will be
        send to a person, whose upload failed. The following %-sequences
        are allowed in the message body:

        %A  -  Upload Day    ( Eg. Wednesday ).
        %B  -  Upload Date   ( Format: DD-MM-YY ).
        %C  -  Upload Time   ( Format: HH:MM:SS ).
        %D  -  File's Length ( Eg. 116384 ).
        %E  -  File's Name.

        If this property is not set, no messages will be send.

        The size of a message text file is limited to 10 kilobytes
        (10240 bytes).

EXAMPLE

        FMsgPathName    "S:UploadFailed.msg";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm17 "SubjectOfMsg Property"

SYNOPSIS

        SubjectOfMsg    "string";

EXPLANATION

        This property defines the subject of the "your upload failed"-
        message. The subject can be up to 30 characters long.

EXAMPLE

        SubjectOfMsg    "Your upload failed!";

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm18 "NoChkrOutput Property"

SYNOPSIS

        NoChkrOutput;

EXPLANATION

        If this property is set, UpScan won't open a separate File
        Checking Utility Output Window, thus forcing the output of
        checking-utilities to "NIL:". This speeds up the scanning process
        somewhat, but you won't be able to see other than the messages
        displayed by UpScan itself.

EXAMPLE

        NoChkrOutput;

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm19 "CLogTruncat Property"

SYNOPSIS

        CLogTruncat     max_size,truncated_size;

EXPLANATION

        If this property is set, UpScan checks for "CallersLog's" size
        each time UpScan is executed. If "CallersLog's" size exceeds
        "max_size", the log will be shortened by setting its size to
        "truncated_size". The sizes are in kilobytes.

EXAMPLE

        CLogTruncat     400,200;

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm20 "UDLogTruncat Property"

SYNOPSIS

        UDLogTruncat    max_size,truncated_size;

EXPLANATION

        If this property is set, UpScan checks for "UDLog's" size each
        time UpScan is executed. If "UDLog's" size exceeds "max_size",
        the log will be shortened by setting its size to
        "truncated_size". The sizes are in kilobytes.

EXAMPLE

        UDLogTruncat    400,200;

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_Comm21 "DateSepText Property"

SYNOPSIS

        DateSepText;
        <text>
        X

EXPLANATION

        This property, followed by a maximum of 1 KB (1024 bytes) of text,
        enables UpScan to use the text as a date separator. Date
        separators are used in "Dir"-files. They are put in between two
        different dates to display some daily statistics.

        The text must begin in the first column on the line following the
        property.

        NOTE! The text must be terminated by the ASCII code 1 (shown above
        as an X). The following %-sequences are allowed:

        %A  -  Number of calls since the last date separator
        %B  -  Number of uploads since the last date separator
        %C  -  Number of failed uploads since the last date separator
        %D  -  Number of uploaded bytes since the last date separator
        %E  -  Upload CPS record since the last date separator
        %F  -  Upload CPS recordholder's name
        %G  -  Last date separator's date ( format: MM-DD-YY )
        %H  -  Today's date ( format: MM-DD-YY )

        NOTE! UpScan creates a file called "UpScan.stats" for each
        conference. Do *not* delete these files, because they are used for
        storing important statistical data. But, in order to reset a
        particular conference's stats (i.e. the information displayed by
        those %-sequences) you must delete that conference's "UpScan.
        stats"-file.

EXAMPLE

        See separate example files distributed with the package.

BUGS AND/OR DEFECTS

        -

SEE ALSO

        -

@endnode
@node prefs_FileChkUtilList "The File Checking-Utility List"

The File Checking-Utility List

        NOTE! There are no file checking-utilities distributed with this
        package due to various reasons. I'm sure you'll be able to get the
        checkers you need by yourself.

        This list should *always* be located at the end of the prefs-file.

Example

        The first two lines in this example are just comments. UpScan
        ignores all lines that do not begin with the letters "CU".

        ####  ID          Offset  Full path   Testing    Banner
        -----------------------------------------------------------
        CU01  $2D6C6835   2       "U:LhA"     "t %f"     "a %f %b";

####

        First comes the number of the checker preceded by the letters "CU".
        There can be a maximum of 20 checkers (numbers 01-20) on the list
        (the amount of checkers will be limited to 99 in the near future).
        It's wisest to put the checkers in such an order, that the most
        frequently used checkers come first on the list.

ID-Code

        This is the identification code that is used for identifying a
        particular filetype. For example, in DMS-archives this would be
        "DMS!". Finding appropriate ID-codes is simply a matter of
        viewing a certain type of file in hex by using an appropriate
        tool (eg. Zap) and looking for a longword (four characters) that
        is present in each file of that particular type.

        UpScan can then recognize that particular filetype by searching
        for that longword.

        The ID-code must be entered on the list in hexadecimal and cannot
        be longer than a longword (four characters).

Offset

        This value is determined by counting how many bytes there are in
        between the chosen ID-code and the beginning of a particular file.
        The maximum value here is 64 bytes.

Full Path

        Full path to the checking utility + utility's filename.

Testing

        You have to check your checking-utility's manual for this one.

        This is the argument-string that the checker uses for testing a
        file.

        Filename is replaced with a %-sequence "%f".

        For example, if your checker's name was "FooCheck" and
        "FooCheck CHECK Archive.foo" would instruct "FooCheck" to check a
        file called "Archive.foo", you would enter the following testing
        argument-string on the list: "CHECK %f". Note how the filename is
        replaced by a %f-sequence. Full path would be "FooCheck" or
        "C:FooCheck" if "FooCheck" was in "C:"-dir. That's all there is
        to it.

Banner

        This argument-string is used by the checking-utility for adding a
        banner to a file.

        Here "%f" represents the filename and "%b" represents the banner's
        filename.

        However, not all the checkers require a special argument-string
        for banner adding. Some checkers have their own internal methods,
        and some might even not be able to add banners to files.

        If "C:FooCheck ADDBANNER MegaBanner.txt Archive.foo" would
        instruct a checker called "FooCheck" to add a banner called
        "MegaBanner.txt" to an archive called "Archive.foo", you would
        enter the following banner adding argument-string on the list:
        "ADDBANNER %b %f". Full path would be "C:FooCheck".

@endnode
@node prefs_KnownChkUtils "Known and Supported File Checking-Utilities"

Known and Supported File Checking-Utilities

        DMScan
        LhA
        ZoomChk5.3
        WarpChecker
        DOSCheck
        UnZip
        OWS
        Zoo
        Arc

@endnode
@node Lnk07 "UpScan Registration"

Registration

        UpScan is *not* a free program. UpScan is ShareWare. If you are
        planning on using UpScan, please register it.

        You are granted a limited license to evaluate this software for a
        30 day period. You must decide at the termination of this
        evaluation period to register this product if you plan to continue
        using it or to cease all use otherwise.

        Registration is not only required for your continued use, it is
        needed to keep the development of future enhancements to UpScan
        active.  Without your support the product cannot continue to
        evolve.

        The basic registration fee is US$10 (or 50 FIM). If you want an
        update service, for US$25 (or 100 FIM) you get a year's worth of
        updates.

        Use the official @{"UpScan Registration Form" Link registrationForm} when registering.

        The place to send any and all inquiries, registration forms, bug
        reports, money, etc. is:

                RamRod / Alpha Flight
                Makipellontie 11
                SF-65520  Helsingby
                Finland, Europe

        You can reach me on the InterNet at the following addresses:

                RamRod@garbo.uwasa.fi
                khe@chyde.uwasa.fi
                khe@gable.uwasa.fi

        You can also contact me by calling to:

                The Last Generation BBS +358 61 321 5483
                                        +358 61 321 5655
 
        NOTE! When sending in your bug reports, please state the version
        number of UpScan you're currently using, the version number of
        Kickstart you are using and also include a detailed description on
        the hardware you're using.

                ALPHA FLIGHT - THIS FLIGHT WON'T NEWER STOP!!
                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@endnode
@node registrationForm "The Official UpScan Registration Form"

UpScan - Electronic Product Registration Form              #UN93@0001


I would like to be a registered user of UpScan.

The basic registration fee is US$10 (or 50 FIM). If I want an update
service, for US$25 (or 100 FIM) I get a year's worth of updates.

No cheques! Cash (US$/FIM) only!


Enclosed is the US$10(50FIM) / US$25(100FIM) registration fee.


       First Name: __________________________________________________

        Sure Name: __________________________________________________

Register to (BBS): ______________________________ (max 30 characters)

   Street Address: __________________________________________________

         Zip Code: __________________________________________________

        City/Town: __________________________________________________

    State/Country: __________________________________________________

         Phone #s: ________________________  ________________________

           BBS #s: ________________________  ________________________

         Comments: __________________________________________________

                   __________________________________________________

                   __________________________________________________

                   __________________________________________________

                   __________________________________________________

@endnode
