home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / packer / ultracom / config.doc < prev    next >
Text File  |  1993-12-31  |  19KB  |  518 lines
  1. 6. CONFIG: how to configure UC
  2. ==============================
  3.  
  4. When UC is started without parameters there is the option to configure
  5. UC (by pressing the 'C' key).
  6.  
  7. General options are:
  8.  
  9.    A -> Default compression method
  10.    B -> Default operation
  11.    C -> Reliability level
  12.    D -> Automatic archive conversion
  13.    E -> Virus scan during conversion
  14.    F -> Smart skipping
  15.    G -> Amount of output/information
  16.    H -> Show (multimedia) banners
  17.    I -> Store OS/2 2.x extended attributes
  18.    J -> Store system/hidden files
  19.  
  20. System options are:
  21.  
  22.    M -> Video mode
  23.    N -> Dynamic program swapping
  24.    O -> Use EMS
  25.    P -> Use XMS
  26.    Q -> Use 386/486/Pentium features
  27.    R -> Advanced networking
  28.    S -> Location for temporary files
  29.    T -> Location for manuals (*.DOC)
  30.    U -> Location for error logfile
  31.    V -> Loc. for batch&script files
  32.  
  33. Quick setup options are:
  34.  
  35.    1 -> default
  36.    2 -> max speed
  37.    3 -> max compress
  38.    4 -> max safe
  39.    5 -> UNDO
  40.  
  41. The configuration you chose here will be your default configuration
  42. when using UC. Some of the options in the configuration screen can
  43. also be temporary set on the command line. The command line options
  44. are also described in this document.
  45.  
  46. This document contains the following paragraphs:
  47.  
  48.         - A. General options
  49.         - B. System options
  50.         - C. Quick setup
  51.         - D. Batch files
  52.         - E. Optimizing performance
  53.  
  54. To jump to a certain paragraph, press the corresponding letter. To
  55. jump to a specific document/chapter, press the corresponding digit.
  56. See chapter 1 paragraph E for an overview of all documentation.
  57.  
  58.  
  59. 6.A GENERAL OPTIONS.
  60. ====================
  61.  
  62. A -> Default compression method
  63. -------------------------------
  64.    Equivalent command line options: -TN, -TT, -TF
  65.  
  66.    The compression type can be NORMAL, TIGHT/MULTIMEDIA or FAST. When
  67.    installing UC the default compression type is normal.
  68.  
  69.    In TT mode, UC will detect whether a file is a multimedia file.
  70.    Special (lossless) multimedia compression will then take place.
  71.  
  72. B -> Default operation
  73. ----------------------
  74.    Equivalent command line options: -I, -B
  75.  
  76.    The add operation can be in BASIC MODE or INCREMENTAL MODE. In
  77.    basic mode files that already exist in the archive will be replaced
  78.    by a new version.
  79.  
  80.    In incremental mode more versions of a file can be kept in the
  81.    archive. When an already existing file is added to the archive, the
  82.    newer version of the file will be added. This mode increases the
  83.    speed of the addition significantly, especially for slow disks
  84.    and/or large archives.
  85.  
  86.    Another advantage of the incremental mode is the possibility of
  87.    keeping multiple versions of a file in the archive. If, for
  88.    example, you want to see what is changed in the file, just look at
  89.    a previous version.
  90.  
  91. C -> Reliability level
  92. ----------------------
  93.    Equivalent command line options: !RELIA=DETECT, !RELIA=PROTECT,
  94.                                     !RELIA=ENSURE
  95.  
  96.    The reliability level can be DETECT, PROTECT or ENSURE.
  97.  
  98.    Detect means errors will be reported, but no action will be taken.
  99.  
  100.    Protect means errors will be avoided, by using damage protection.
  101.  
  102.    Ensure mode means UC will make as sure as technically possible,
  103.    everything will go perfect. First the existing archive will be
  104.    tested. Then the command given will be executed. The third step
  105.    includes a complete test on the new archive. When something went
  106.    wrong, a 'rollback' will take place, and the original archive will
  107.    be restored. To ensure correct storage on your harddisk, U2_FLUSH
  108.    is called at appropriate moments during execution of your command.
  109.    (See paragraph D.)
  110.  
  111. D -> Automatic archive conversion
  112. ---------------------------------
  113.    Equivalent command line options: !ARCON=ON, !ARCON=OFF
  114.  
  115.    Automatic conversion of other archiver's archives can be ON or OFF.
  116.    When the automatic conversion is on, any operation can be done on
  117.    other archiver's archives. UC will automatically start rebuilding
  118.    the archive to a UC archive. After rebuilding, the command will be
  119.    executed.
  120.  
  121.    When the automatic conversion is off, UC will not automatically
  122.    convert archives, but prompt the user, asking permission to convert
  123.    the archive.
  124.  
  125. E -> Virus scan during conversion
  126. ---------------------------------
  127.    Equivalent command line options: !VSCAN=ON, !VSCAN=OFF
  128.  
  129.    Virus scan can be ON or OFF during the conversion of another
  130.    archiver's archive (also see paragraph D).
  131.  
  132. F -> Smart skipping
  133. -------------------
  134.    Equivalent command line options: !SMSKIP=ON, !SMSKIP=OFF
  135.  
  136.    Smart skipping can be ON or OFF.
  137.  
  138.    When smart skipping is on, unchanged files (already in the archive)
  139.    are skipped during addition. This makes updating much faster.
  140.  
  141. G -> Amount of output/information
  142. ---------------------------------
  143.    The amount of output/information can be MINIMAL, VERBOSE or NORMAL.
  144.  
  145.    UC shows all kinds of information while it is executing your command.
  146.    Minimal information mode only shows the filenames being processed, no
  147.    progress indicators are given. Verbose information mode shows in
  148.    great detail what UC is doing, this includes small popup windows for
  149.    diskcache activities. For instance the file name in process is
  150.    followed by blocks indicating progress. Normal information mode shows
  151.    what UC is doing, but does not give undue attentention to details
  152.    which are not directly related to the given command.
  153.  
  154. H -> Show (multimedia) banners
  155. ------------------------------
  156.    Equivalent command line options: !BAN=ON, !BAN=OFF, !BAN=ASK
  157.  
  158.    You can choose if the banners added to the archives are
  159.    shown/played automatically (ON), only when you agree (ASK) or never
  160.    (OFF).
  161.  
  162. I -> Store OS/2 2.x extended attributes
  163. ---------------------------------------
  164.    Equivalent command line options: !SOS2EA=ON, !SOS2EA=OFF
  165.  
  166.    By putting this option ON, OS/2 EA's will be stored when UC finds
  167.    any during compression, when this option is OFF UC will not store
  168.    OS/2 2.x EA's. OS/2 2.x extended attributes (such as icons, WPS
  169.    long icon names, WordPerfect 5.2 for OS/2 summary information etc.)
  170.    will be retained in an archive when the option is ON. Please note
  171.    that OS/2 2.x EA's will ALWAYS be extracted, when present in an
  172.    archive. Extended attributes are preserved by the optimize command,
  173.    even if this is performed on a machine which does not run OS/2.
  174.  
  175. J -> Store system/hidden files
  176. ------------------------------
  177.    Equivalent command line options: !SYSHID=ON, !SYSHID=OFF,
  178.                                     !SYSHID=ASK
  179.  
  180.    You can choose if you want 'system' and 'hidden' files to be added
  181.    ON, OFF or if you want UC to ASK you how to deal with them.
  182.  
  183.  
  184. 6.B SYSTEM OPTIONS.
  185. ===================
  186.  
  187. M -> Video mode
  188. ---------------
  189.    If your card is not compatible with MDA, HERCULES, CGA, EGA, VGA,
  190.    SVGA, XGA, etc. (very unlikely but possible for some older
  191.    computers) choose BIOS mode. If you have a monochrome monitor (or
  192.    laptops etc.) choose MONO instead of COLOUR. Please note that if UC
  193.    detects DesqView (which prefers BIOS video on 286 computers) it
  194.    will use BIOS video, even if UC is not configured to use BIOS
  195.    video.
  196.  
  197. N -> Dynamic program swapping
  198. -----------------------------
  199.    Dynamic program swapping can be ON (in which case UC will be
  200.    swapped to EMS or disk if it invokes DOS) or OFF.
  201.  
  202. O -> Use EMS
  203. P -> Use XMS
  204. ------------
  205.    Switch EMS/XMS OFF if your EMS or XMS (emulator) is not compatible
  206.    with the Lotus/Intel/Microsoft specifications. This is not likely
  207.    since UC uses these very conservative.
  208.  
  209. Q -> Use 386/486/Pentium features
  210. ---------------------------------
  211.    Switch off use of 386/486/Pentium options. This is usefull in case
  212.    programs are active which violate 386/486/Pentium programming rules.
  213.  
  214. R -> Advanced networking
  215. ------------------------
  216.    Equivalent command line options: !NET=ON, !NET=OFF, !NET=AUTO-SKIP
  217.  
  218.    Network Support. If you have a version of DOS which does not
  219.    support DOS network calls (e.g. 2.0), or if you have a network
  220.    which behaves very differently from IBM, Lantastic, Microsoft, Novell
  221.    or Vines networks, you can set this option to OFF. Sharing archives is
  222.    then no longer possible.
  223.  
  224.    When UC attempts to compress a locked file, it allows the user to
  225.    skip this file by hand. When auto-skip mode is active, locked files
  226.    will be skipped automatically. A warning is reported if files are
  227.    skipped.
  228.  
  229. S -> Location for temporary files
  230. ---------------------------------
  231.    The location for temporary files can be configured. When everything
  232.    goes well you will never notice the temporary files. Please make sure
  233.    the directory configured exists on your disk.
  234.  
  235. T -> Location for manuals (*.DOC)
  236. ---------------------------------
  237.    UC will look for the manual files in the directory configured.
  238.  
  239. U -> Location for error logfile
  240. -------------------------------
  241.    The error logfile will register all errors and warnings that appear
  242.    while executing UC.
  243.  
  244. V -> Loc. for batch&script files
  245. --------------------------------
  246.    UC will look for its special batch and script files in the directory
  247.    configured.
  248.  
  249.  
  250. 6.C QUICK SETUP.
  251. ================
  252.  
  253. 1 -> default
  254. ------------
  255.    The default setup changes the following subjects:
  256.  
  257.        GENERAL OPTIONS:
  258.  
  259.            default compression mode        into    normal
  260.            default operation               into    basic mode
  261.            reliability level               into    detect
  262.            automatic archive conversion    into    off
  263.            virus scan during conversion    into    off
  264.            amount of output/information    into    normal
  265.            show (multimedia) banners       into    ask
  266.            store OS/2 2.x ext. attributes  into    off
  267.            store system/hidden files       into    ask
  268.  
  269.        SYSTEM OPTIONS:
  270.  
  271.            video mode                      into    colour
  272.            dynamic program swapping        into    on
  273.            use EMS                         into    on
  274.            use XMS                         into    on
  275.            use 386/486/Pentium features    into    on
  276.            advanced networking             into    on
  277.            all locations will be set to the same location as UC.EXE
  278.  
  279. 2 -> max speed
  280. --------------
  281.    The max speed setup changes the following subjects:
  282.  
  283.        GENERAL OPTIONS:
  284.  
  285.            default compression             into    fast
  286.            default operation               into    incremental
  287.            reliability level               into    detect
  288.            automatic archive conversion    into    on
  289.            virus scan during conversion    into    off
  290.            amount of output/information    into    minimal
  291.            show (multimedia) banners       into    off
  292.  
  293.        SYSTEM OPTIONS:
  294.  
  295.            video mode   No matter whether the video mode is colour or
  296.                         mono, this configuration will turn off BIOS usage
  297.            use EMS                         into    on
  298.            use XMS                         into    on
  299.            use 386/486/Pentium features    into    on
  300.            advanced networking             into    auto-skip
  301.  
  302.  
  303. 3 -> max compress
  304. -----------------
  305.    The max compress setup changes the following subjects:
  306.  
  307.        GENERAL OPTIONS:
  308.  
  309.            default compression             into    tight
  310.            default operation               into    basic mode
  311.            reliability level               into    detect
  312.            automatic archive conversion    into    on
  313.  
  314. 4 -> max safety
  315. ---------------
  316.    The max safe setup changes the following subjects:
  317.  
  318.        GENERAL OPTIONS:
  319.  
  320.            default operation               into    incremental mode
  321.            reliability level               into    ensure
  322.            automatic archive conversion    into    off
  323.            virus scan during conversion    into    on
  324.            smart skipping                  into    off
  325.            show (multimedia) banners       into    off
  326.  
  327.        SYSTEM OPTIONS:
  328.  
  329.            video mode   No matter whether the video mode is colour or
  330.                         mono, this configuration will turn on BIOS usage
  331.            use EMS                         into    off
  332.            use XMS                         into    off
  333.            use 386/486/Pentium features    into    off
  334.            only if advanced networking was auto-detect:
  335.                                            into    on
  336.  
  337. 5 -> UNDO
  338. ---------
  339.    The configuration will be reset to the state it was before you
  340.    started the configuration screen.
  341.  
  342.  
  343. 6.D BATCH FILES.
  344. ================
  345.  
  346. The following batch files are described in detail:
  347.  
  348.    U2_EDIT    edit text file
  349.    U2_CHECK   check files for viruses
  350.    U2_FLUSH   flush harddisk cache
  351.    U2_SHOW    show/play (GIF, MOD, JPG and TXT) banner files
  352.    U2_EXxxx   extract all files from an archive
  353.    U2_XTRA    perform user defined operations during conversion
  354.  
  355. You are free to edit supplied batch files, to make them call other
  356. than the default programs. You can also add new files (e.g. U2_EXxxx)
  357. to enhance the functionality of UC.
  358.  
  359. U2_EDIT.BAT
  360. -----------
  361.    Task
  362.       This file calls your favourite editor with the file to be edited
  363.       as parameter.
  364.  
  365.    When is it called?
  366.       The file is used when you use the command REVISE COMMENT.
  367.  
  368.    Standard contents
  369.       The default editor is the DOS 5.x/6.x/7.x EDIT.
  370.  
  371. U2_CHECK.BAT
  372. ------------
  373.    Task
  374.       This file calls virus scanner(s). The current directory and
  375.       its subdirectories are scanned for viruses. When no viruses are
  376.       found, the file U$~CHK3 is generated, which is used as a flag.
  377.       (When this file is present, UC knows that no viruses are found
  378.       and that it can continue its work.) When viruses are found, a UC
  379.       fatal error will occur.
  380.  
  381.    When is it called?
  382.       When virus scanning is on in the configuration, this file is
  383.       used during conversion of archives.
  384.  
  385.    Standard contents
  386.       Default McAffee (100 or higher) and F-PROT are called.
  387.  
  388. U2_FLUSH.BAT
  389. ------------
  390.    Task
  391.       Everything in the disk-cache (e.g. SmartDrive, PC-CACHE or
  392.       Norton Cache) which is not yet written to the disk ('delayed' or
  393.       'deferred' write cache) will be written to disk immediately.
  394.  
  395.    When is it called?
  396.       While using UC in ensure mode, it will secure its 'transactions'
  397.       using U2_FLUSH. This is to make sure contents of the disk are
  398.       correct, after the completion of a transaction.
  399.  
  400.    Standard contents
  401.       Attempts to call PC-CACHE, Norton Cache, ADCACHE and SmartDrive.
  402.  
  403. U2_SHOW.BAT
  404. -----------
  405.    Task
  406.       Show/play banners while extracting files from an archive. The
  407.       banners are in the current directory when U2_SHOW is called.
  408.  
  409.    When is it called?
  410.       When files are extracted from an archive and banners are present
  411.       they can be shown/played. In the configuration you can choose
  412.       whether you want the banners to be shown/played.
  413.  
  414.    Standard contents
  415.       First MODPLAY is called to play the .MOD banner. The VPIC is
  416.       called to show the .GIF banner and then FullView is called to
  417.       show the .JPG file. Finally DOS TYPE is used to show the text
  418.       banner.
  419.  
  420. U2_EXxxx.BAT
  421. ------------
  422.    xxx stands for ARC, ARJ, HA, HPK, HYP, LZH, PAK, UCN, ZIP, ZOO etc..
  423.  
  424.    Task
  425.       These files are used to extract all files, from the archive to
  426.       be converted, into the current directory. To check if everything
  427.       worked out well the files U$~CHK1 and U$~CHK2 must be generated.
  428.       UC checks for the existence of those files.
  429.  
  430.    When is it called?
  431.       When an archive is converted, one of these batch files is used
  432.       to extract the original archive. The extension of the archive
  433.       corresponds with the xxx in the name of the batch file.
  434.  
  435.    Standard contents
  436.       All batch files first add a file to an archive and then extract
  437.       the entire archive. The main reason for this is improving
  438.       reliability of the conversion, especially if certain tools are
  439.       incompatible (e.g. older versions). If you are sure certain
  440.       tools are present and up to date, you can simplify their batch
  441.       files if you wish, to speed up conversion.
  442.  
  443.       U2_EXARC.BAT       First ARC is called.
  444.                          When this fails, PK(X)ARC is called.
  445.                          When this also fails PAK is called.
  446.  
  447.       U2_EXARJ.BAT       ARJ is called.
  448.  
  449.       U2_EXHA.BAT        HA (e.g. 0.982b) is called.
  450.  
  451.       U2_EXHPK.BAT       HPACK is called.
  452.  
  453.       U2_EXHYP.BAT       HYPER is called.
  454.  
  455.       U2_EXLZH.BAT       LHA is called.
  456.  
  457.       U2_EXPAK.BAT       PAK is called.
  458.  
  459.       U2_EXUCN.BAT       A .UC2  archive (being renamed to .UCN) is
  460.                          extracted. NOTICE NOTHING IS DONE TO PRESERVE
  461.                          FILES OF WHICH MULTIPLE VERSIONS ARE IN AN
  462.                          ARCHIVE, ONLY THE LATEST VERSION IS EXTRACTED.
  463.  
  464.       U2_EXZIP.BAT       First PK(UN)ZIP 2.04ceg is called. When this is
  465.                          not present PK(UN)ZIP 1.x is called. When this
  466.                          fails, Info(UN)ZIP is called.
  467.  
  468.       U2_EXZOO.BAT       ZOO is called.
  469.  
  470. U2_XTRA.BAT
  471. -----------
  472.    Task
  473.       Performs user defined operations during archive conversion.
  474.  
  475.    When is it called?
  476.       When UC converts an archive, it first calls a U2_EX???.BAT file
  477.       to extract all files from the original archive, the U2_EX???.BAT
  478.       file then calls U2_XTRA.BAT when it has finished extracting all
  479.       files from the archive.
  480.  
  481.    Standard contents
  482.       No operations are performed. A disabled sample for adding
  483.       banners to archives during conversion is included in
  484.       U2_XTRA.BAT.
  485.  
  486.  
  487. 6.E OPTIMIZING PERFORMANCE.
  488. ===========================
  489.  
  490. In general UC will automatically utilize available resources (RAM,
  491. microprocessor) in an optimal fashion. Please note UC does not stretch
  492. beyond the limits of your system to achieve this. It only uses
  493. officially documented methods to access XMS, EMS, DOS, Windows, OS/2
  494. etc.. In many cases the methods UC uses have been double checked with
  495. IBM, Microsoft, QuarterDeck, Novell and others. And of course
  496. everything has been extensively tested on many different environments.
  497.  
  498. There are some tips to allow UC to work as fast as possible:
  499.  
  500.    - make as much base, EMS and XMS memory available as you can spare
  501.  
  502.    - (but) on systems supporting virtual memory (e.g. Windows NT, OS/2)
  503.      you should not make TOO much memory available for UC (to prevent
  504.      swapping)
  505.  
  506.    - select maximal speed in the configuration menu
  507.  
  508.    - or (e.g. if you prefer better compression)
  509.       - enable advanced networking (when applicable)
  510.       - enable EMS/XMS usage
  511.       - enable 386/486/Pentium usage
  512.       - set UC information to minimal
  513.  
  514.    - redirect the output of UC to the NUL device (e.g. UC X test > NUL)
  515.  
  516.    - install sufficient BUFFERS in your CONFIG.SYS and/or install a disk
  517.      caching utility
  518.