home *** CD-ROM | disk | FTP | other *** search
/ HaCKeRz Kr0nlcKLeZ 1 / HaCKeRz Kr0nlcKLeZ.iso / chibacity / rar1_52.exe / RAR.DOC < prev    next >
Encoding:
Text File  |  1994-08-09  |  41.9 KB  |  1,260 lines

  1.  
  2.  ██████╗   █████╗  ██████╗
  3.  ██╔══██╗ ██╔══██╗ ██╔══██╗     RAR version 1.52 - User's Manual
  4.  ██████╔╝ ███████║ ██████╔╝     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  5.  ██╔══██╗ ██╔══██║ ██╔══██╗     Multifunctional Integrated Archive Manager
  6.  ██║  ██║ ██║  ██║ ██║  ██║     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  7.  ╚═╝  ╚═╝ ╚═╝  ╚═╝ ╚═╝  ╚═╝
  8.  
  9.                        =-=-=-=-=-=-=-=-=-=-=-=-=-=-
  10.                        Welcome to the RAR Archiver!
  11.                        -=-=-=-=-=-=-=-=-=-=-=-=-=-=
  12.  
  13.  
  14.  ╔════════════════════════════════════════════════════════════════════════╗
  15.  ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒  Introduction  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  16.  ╚════════════════════════════════════════════════════════════════════════╝
  17.  
  18.  
  19.   RAR is an extremely powerful tool which allows you to manage and
  20.   control archive files.
  21.  
  22.   RAR features include:-
  23.  
  24.     *  Full-screen interactive interface (Optional)
  25.     *  Mouse support and menus
  26.     *  Non-RAR archive support
  27.     *  Common 'standard' command-line interface
  28.     *  Highly sophisticated, original compression algorithm
  29.     *  Better compression than other PC tools using 'solid' archiving
  30.     *  Authenticity verification (registered version only)
  31.     *  Self-extracting archives, locking, password & more ...
  32.  
  33.  
  34.  ╔════════════════════════════════════════════════════════════════════════╗
  35.  ║▒▒▒▒▒▒▒▒▒▒▒▒ Chapter 1.    Installation and Configuration ▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  36.  ╚════════════════════════════════════════════════════════════════════════╝
  37.  
  38.    This chapter describes how to install and configure RAR,
  39.    as well as giving information on technical requirements.
  40.  
  41.    1.1. Installation procedure
  42.  
  43.    RAR is distributed as a self-extracting (SFX) archive named
  44.    RAR?_???.EXE where '?_???' is the version number.
  45.  
  46.    Installation consists of three basic steps:-
  47.  
  48.    ..  Create a directory for the RAR files
  49.  
  50.    ..  Make this directory the current working directory
  51.  
  52.    ..  Execute the RAR Self-Extracting archive
  53.  
  54.  
  55.    For example, on floppy disk A: you have the file
  56.    RAR1_52.EXE, this will be RAR version 1.52.  You may install
  57.    it to your C: disk by typing, at the DOS prompt, the following
  58.    commands:
  59.  
  60.    C:\> mkdir RAR
  61.    C:\> cd RAR
  62.    C:\RAR>
  63.  
  64.    You have now created a new directory, C:\RAR, and it is
  65.    the current working directory.
  66.  
  67.    Then execute the RAR self-extracting archive:
  68.  
  69.    C:\RAR> A:RAR1_52
  70.  
  71.    You will be prompted with the RAR archive comment.  Press
  72.    any key to continue, or press ESC to cancel the extraction.
  73.  
  74.    When the extraction is successfully completed, a number of
  75.    files will be placed in the current directory and RAR will
  76.    be ready for use.
  77.  
  78.    The archiver program itself is named RAR.EXE.  This
  79.    module contains all of the archiver's functionality, packing,
  80.    unpacking, repairing, SFX creation etc.
  81.  
  82.    It is recommended that the name of the directory,
  83.    containing the RAR files, be added to the PATH environment
  84.    variable.  This will enable RAR to be used from any
  85.    directory.  Alternatively the critical modules of RAR may
  86.    be copied to your "Utilities" directory.  These modules are
  87.    RAR.EXE and RAR.CFG but, although it is not essential, you
  88.    may copy UNRAR.EXE as well.
  89.  
  90.  
  91.    1.2. Option menu
  92.  
  93.    A number of RAR options may be configured and saved to
  94.    be used as default options.  To access this menu, start RAR
  95.    without any parameters and then press Function key 9 (F9) to
  96.    bring up the Options menu:
  97.  
  98.  
  99.    C:\RAR> RAR
  100.  
  101.    When RAR has been started, press F9 - the following menu
  102.    will appear:
  103.  
  104.           ┌─────────────────────────────────┐
  105.           │ Configuration...                │
  106.           │ Set password              ALT-P │
  107.           │ Work directory            ALT-W │
  108.           │ Default comment file            │
  109.           │ External viewer                 │
  110.           │ Change disk               ALT-D │
  111.           │ Registration                    │
  112.           │ Save options              ALT-S │
  113.           └─────────────────────────────────┘
  114.  
  115.    Press <Enter> for the sub-menu "Configuration".  The
  116.    configuration menu offers a number of basic options which
  117.    may be changed.
  118.  
  119.    In the configuration menu, use the arrow keys to move
  120.    from item to item.  An item value may be changed by hitting
  121.    the <space> key.  When all items are set as desired, move to
  122.    the "Ok" field and hit <Enter> to save the chosen values.
  123.    To discard any changes, move to the "Cancel" field and hit
  124.    <Enter>.
  125.  
  126.    If you have a mouse attached, this process is even
  127.    easier.  Simply move the mouse cursor to the desired item
  128.    and click the left mouse key.
  129.    When you've completed the configuration, move the mouse
  130.    cursor to the field " Ok " and click on the left mouse key.
  131.    To discard changes click the left mouse key on the " Cancel "
  132.    field.
  133.  
  134.  
  135.    "Configuration/Interface options"
  136.  
  137.      Colour                 Selects/Deselects colour in
  138.                             full-screen mode
  139.  
  140.      Sound                  Enables RAR's sound effects
  141.  
  142.      Stdout mode            Forces RAR to run in console
  143.                             (stdout) mode while processing
  144.                             commands from the command line
  145.  
  146.      Mouse                  Enables the use of mouse-support
  147.                             in full-screen mode
  148.  
  149.  
  150.    "Configuration/Sort names"
  151.  
  152.    Choose the method required for sorting the archive contents
  153.    list from one of the following:
  154.  
  155.         Unsorted ......... Do not sort files
  156.         By name .......... Sort files by name
  157.         By extension ..... Sort files by extension
  158.         By size .......... Sort files by size
  159.  
  160.  
  161.    "Configuration/Include file mask"
  162.  
  163.    Choose the categories of files to be included when adding
  164.    to an archive from the following:
  165.  
  166.        Read only files ..... Add files with 'Read-only' attribute
  167.        System files ........ Add files with 'System' attribute
  168.        Archive files ....... Add files with 'Archive' attribute
  169.        Hidden files ........ Add files with 'Hidden' attribute
  170.  
  171.    For more information on file attributes, please refer to your
  172.    DOS manual.
  173.  
  174.  
  175.    "Configuration/Compression"
  176.  
  177.    Choose the default compression level from one of the
  178.    following:
  179.  
  180.       Store ...... Do not compress file when adding to archive
  181.       Fastest .... Use fastest method (least compressive)
  182.       Fast ....... Use fast compression method
  183.       Normal ..... Use normal (default) compression method
  184.       Good ....... Use good compression method (more compressive)
  185.       Best ....... Use best compression method (most compressive)
  186.  
  187.  
  188.    "Configuration/Other options"
  189.  
  190.      Keep backup archive    Forces RAR to save the archive
  191.                             file to *.BAK before it changed
  192.  
  193.      Add empty directories  Enables "add empty directories"
  194.                             to archive
  195.  
  196.      Always make solid      Forces RAR to create solid
  197.                             archives which are often very
  198.                             much smaller than "normal"
  199.                             archives.
  200.  
  201.  {+} Put Authenticity       Forces RAR to place -AV
  202.        verification         (authenticity verification)
  203.                             into archives when they are
  204.                             created. (This feature is only
  205.                             available in the registered
  206.                             version)
  207.  
  208.  {+} Log errors to file     Enables the logging of critical
  209.                             errors to a file RAR.LOG. (This
  210.                             feature is only available in
  211.                             the registered version)
  212.  
  213.    "Set password"
  214.  
  215.    Assign a password which will used when you add/extract files
  216.    to/from an archive.  You can define the password using <Alt/P>.
  217.    Note, the password will not be saved to the configuration file.
  218.  
  219.  
  220.    "Work directory"
  221.  
  222.    The path where RAR will place temporary files.  This may
  223.    be changed at any time by pressing <Alt/W>.
  224.  
  225.  
  226.    "Default comment file"
  227.  
  228.    If you would like a common comment added to every archive you are
  229.    creating, enter the full path and name here.
  230.  
  231.  
  232.    "External viewer"
  233.  
  234.    You may assign an external viewer program to run for viewing
  235.    file in archives (by pressing <F3>).
  236.  
  237.    While viewing a file of the archive in full-screen mode
  238.    RAR uses internal viewer if external viewer not set.
  239.  
  240.    Internal viewer provides the partial (dynamic) extraction
  241.    of the file. It means the viewer extracts only those part
  242.    which should appear in view at the moment, then next one
  243.    if needed, etc.
  244.  
  245.    While using external viewer the whole file is extracted
  246.    before actual view.
  247.  
  248.    "Change disk"
  249.  
  250.    You may change the current disk displayed in the work window.
  251.  
  252.  
  253.    "Registration"
  254.  
  255.    To register RAR you must have a registration code.  This code may
  256.    be obtained by sending the completed registration form to your
  257.    local registration site or the world-wide distribution center.
  258.  
  259.    You will receive the latest version of RAR in registered form
  260.    along with your registration key and will then be able to create
  261.    archives containing Authenticity verification.
  262.  
  263.  
  264.    "Save setup"
  265.  
  266.    Pressing <Enter> or clicking the left mouse key on this item
  267.    will pop up a small confirmation window in which the user is
  268.    invited to " Save " or " Cancel " the saving of the new
  269.    configuration for future default usage in RAR.
  270.  
  271.    RAR stores the default configuration in the file RAR.CFG, which
  272.    is held in the same directory as RAR.EXE.
  273.  
  274.    The configuration may also be saved by pressing ALT-S keys,
  275.    (pressing the "S" key while simultaneously holding down the "ALT"
  276.    key).
  277.  
  278.    These options may also be set by using the left mouse key in the
  279.    window "Settings":
  280.  
  281.                    ┌────────────── Settings ─────────────┐
  282.                    │   Password                 Absent   │
  283.                    │   Compression level        Best     │
  284.                    │   Archive backup           Disabled │
  285.                    │   Add AV to archives       Disabled │
  286.                    │   Make solid archives      Optional │
  287.                    │   Log errors to file       Enabled  │
  288.                    │   Default comment file     Present  │
  289.                    └─────────────────────────────────────┘
  290.  
  291.    For example, click the left mouse key on the word 'Absent' in
  292.    the setting 'Password', you will be prompted to enter a new
  293.    password. Clicking the left mouse key on the word 'Optional'
  294.    in the setting 'Make solid archives' would cause toggle to
  295.    'Always' - that will force RAR to create solid archives.
  296.  
  297.  
  298.    1.3. RAR environment variable
  299.  
  300.    Default parameters may be added to the RAR command line by
  301.    establishing an environment variable, using the DOS "SET" command.
  302.  
  303.    Examples:
  304.  
  305.    C:\> SET RAR=-std -s
  306.  
  307.    RAR will use this string as default parameters in the command
  308.    line.
  309.  
  310.    RAR looks firstly to the command line switches, then to the
  311.    switches in the environment variable string and finally the options
  312.    saved in RAR.CFG.
  313.  
  314.    Switches -sfx, -v, -s, -std from RAR variable have no effect in
  315.    full-screen mode.
  316.  
  317.  
  318.    1.4. Technical requirements
  319.  
  320.    Minimum DOS version to run RAR: 3.0
  321.  
  322.    Version specific (for RAR 1.52) conventional memory
  323.    requirements:
  324.  
  325.    Starting RAR:.................................230 Kb
  326.  
  327.    Extracting files, viewing comments:...........265 Kb
  328.  
  329.    Creating and updating archives:...............420 Kb
  330.    (as well as adding to solid archives)
  331.  
  332.    Update and delete files in solid archives:....520 Kb
  333.  
  334.    Managing non-RAR archives:....................230 Kb
  335.  
  336.    (for extraction and updating non-RAR archives add the memory
  337.    requirements of the external archiver)
  338.  
  339.  
  340.    1.5. Errorlevels
  341.  
  342.    When RAR.EXE quits to DOS it sets the environment variable
  343.    ERRORLEVEL to a value representing the termination status
  344.    (last operation status and reason for exit).
  345.  
  346.      255   USER BREAK       Ctrl/Break pressed by user
  347.  
  348.        8   MEMORY ERROR     Not enough memory for operation
  349.  
  350.        7   USER ERROR       Wrong command line options
  351.  
  352.        6   OPEN ERROR       Open file error
  353.  
  354.        5   WRITE ERROR      Write to disk error
  355.  
  356.        4   LOCKED ARCHIVE   Trying to modify archive previously
  357.                             locked by the command 'k'
  358.  
  359.        3   CRC ERROR        The CRC error occurred when unpacking
  360.  
  361.        2   FATAL ERROR      A fatal error occurred
  362.  
  363.        1   WARNING          Non fatal error(s) occurred
  364.  
  365.        0   SUCCESS          Successful operation (User exit)
  366.  
  367.  
  368.  ╔════════════════════════════════════════════════════════════════════════╗
  369.  ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Chapter 2.     Using RAR Interactively ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  370.  ╚════════════════════════════════════════════════════════════════════════╝
  371.  
  372.  
  373.    When you execute the command "RAR" at the Dos prompt, you
  374.    are presented with the full-screen interface - this is known
  375.    as RAR's interactive full-screen mode.
  376.  
  377.    For example, you enter:
  378.  
  379.    C:\> RAR
  380.  
  381.    On the right hand side of the opening screen, you will be
  382.    presented with a dialogue box containing the memory
  383.    status and settings window.  This information includes:
  384.    current compression method, password status (present or
  385.    absent), archive back up mode, authenticity verification
  386.    status (enabled/disabled), default comment file .. present
  387.    or not.
  388.  
  389.    On the left-hand side of the screen you are presented with a
  390.    list of files in the current directory. You can move the cursor
  391.    through the files on the screen by using cursor keys or
  392.    clicking the left mouse button.
  393.  
  394.    Pressing <Enter> when the cursor is positioned on a
  395.    directory, up-directory ("..") or archive file name, will
  396.    cause entry to be made to that item.
  397.  
  398.    The following archive types are recognized by RAR:
  399.    .RAR, .ARJ, .ZIP and .LZH.
  400.  
  401.    Entering an archive, causes the files within the archive
  402.    to be displayed in a similar manner to a directory listing.
  403.  
  404.    It is therefore possible to "walk through" directories and
  405.    archive files, managing files both in archives and normal
  406.    directories.
  407.  
  408.    In "directory" mode, the bottom like of the screen contains
  409.    a menu of functions provided by the function keys.
  410.  
  411. 1-Help 2-Add 3-View 4-Fresh 5-Volume 6-Move 7-Update 8-Repair 9-Option 0-Quit
  412.  
  413.    The line indicates that you may obtain help by pressing
  414.    <F1>, add files to an archive by pressing <F2>, view files by
  415.    pressing <F3> etc. Press <F10> to quit. These functions are
  416.    the main command set when you are in a directory (not in
  417.    archive).
  418.  
  419.    Alternatively, pressing and holding down the <ALT> key
  420.    will cause the display of additional functions:
  421.  
  422. 1-   2-Solid  3-View.. 4-   5-SFXVol  6-SolVol  7-SolSVl  8-   9-   0-
  423.  
  424.    This indicates that Pressing <ALT/F2> can be used to
  425.    create a SOLID archive, <ALT/F3> to view an archive using the
  426.    internal viewer, etc.
  427.  
  428.    Also shown, by holding down the <ALT> key, will be the
  429.    options list:
  430.  
  431.    Alt-C ... Toggle between colour and monochrome mode
  432.    Alt-D ... Select drive
  433.    Alt-J ... DOS shell
  434.    Alt-M ... Select compression method
  435.    Alt-P ... Set password
  436.    Alt-S ... Save setup
  437.    Alt-W ... Set work directory to store temporary files
  438.  
  439.    Pressing keys, other than those which indicate options and
  440.    functions, will put RAR into speed search mode for file names.
  441.    This feature can save a lot of keystrokes when looking for
  442.    specific file names.
  443.  
  444.    Changing from a directory to an archive will automatically
  445.    change the set of available functions to those which are
  446.    more suitable to those circumstances.
  447.  
  448.    In "archive" mode the available functions line looks like:
  449.  
  450. 1-Help 2-Test 3-View 4-Extr 5-Comment 6-ExCurD 7-SFX 8-Delete 9-Option 0-Quit
  451.  
  452.    This line indicates you can get help pressing <F1>, test
  453.    files in archive pressing <F2>, view file by <F3> etc. Press
  454.    <F10> to quit. These functions are the main set when you are
  455.    in an archive.
  456.  
  457.    Alternatively, when holding down the <Alt> key, the
  458.    following would be displayed:
  459.  
  460. 1-   2-   3-View.. 4-ExtrTo 5-FilCmt 6-SolVol 7-Lock  8       9       0
  461.  
  462.    Files may be marked/unmarked by using the [Space], [Ins],
  463.    or right mouse key. You may also mark/unmark file groups by
  464.    wildcards (file mask) using the [Gray +] and [Gray -] keys on
  465.    the numeric keypad.  Marking a directory, automatically marks
  466.    all the sub-directories and files within it.
  467.  
  468.    The marked/unmarked status of a group of files can be
  469.    reversed by using the [Gray *] key.  Marking or unmarking a
  470.    file, or group of files, updates a highlighted status display
  471.    line at the bottom of the screen.  This status line indicates
  472.    the number of files marked and the total size in bytes
  473.    (the file size of marked directories is not included in the
  474.    summary file size).
  475.  
  476.    In full-screen mode, the use of the mouse is fully
  477.    supported.  Use the left mouse key to move through a
  478.    directory.  Click the left key twice to <Enter>.  Use the
  479.    right key to mark files.  When entering text (archive
  480.    name, password etc.) the left mouse key cancels the data entry
  481.    operation and right mouse key confirms entered text.  Use
  482.    the left mouse key to choose function commands (F1-F10) of
  483.    menu items and options.
  484.  
  485.    2.1. In a directory
  486.  
  487.      F1       Help information
  488.  
  489.      F2       Add file(s) to an archive, if the archive does
  490.               not exist, it will be created
  491.  
  492.      F3       View a file (if no external viewer is set, the
  493.               internal viewer will be used)
  494.  
  495.      F4       Freshen files in archive - only recently changed files
  496.               will be added instead of their old copies in archive
  497.  
  498.      F5       Create archive volumes (Span diskettes)
  499.  
  500.      F6       Add files not already in the archive and update those
  501.               files changed since they were packed to the archive
  502.  
  503.      F7       Move file(s) to archive
  504.  
  505.      F8       Repair a damaged archive
  506.  
  507.      F9       Set up / Save options
  508.  
  509.      F10      Quit RAR.  Pressing the ESC key has the same
  510.               effect.
  511.  
  512.      Alt-F2   Create a solid archive.
  513.  
  514.      Alt-F3   View file (with internal viewer).
  515.  
  516.      Alt-F5   Create Self-Extracting (SFX) volumes.
  517.  
  518.      Alt-F6   Create solid archive volumes.
  519.  
  520.      Alt-F7   Create solid SFX-volumes.
  521.  
  522.  
  523.    2.2. In an archive
  524.  
  525.    Press [Enter] with the cursor on the archive name to expand
  526.    the archive contents.  The same effect may be achieved with
  527.    the command-line option "en".   (See Chapter 3, 'en' command)
  528.  
  529.    Once inside an archive, the list of files is displayed on
  530.    the left side of the screen.  These files may be marked, just
  531.    as files in a directory.
  532.  
  533.    An asterisk (*) to the left of a file name, indicates that
  534.    the file is password encrypted.
  535.  
  536.    The right-hand portion of the screen is given over to a
  537.    dialogue box, which includes information on:  archive name
  538.    and status, comments present/absent, encrypted files, total
  539.    number of files in the archive, file sizes, compression ratio,
  540.    the minimum RAR version required to extract files and the
  541.    host Operating System used to create the archive.
  542.  
  543.    For example:
  544.  
  545.    Dialogue Box:                    Meaning:
  546.  
  547.    Archive          EXAMPLE.RAR     archive name
  548.    Archive type     Normal          not 'solid' archive
  549.    Main comment     Present         archive comment present
  550.    File comments    Absent          no individual file comments
  551.    Passwords        Absent          no password encrypted files
  552.    Lock             Absent          archive not locked
  553.    Auth. verif.     Present         authenticity verification present
  554.    Files            1               number of files (1)
  555.    Total length     14917           total length in bytes
  556.    Packed length    3938            length in archive
  557.    Ratio            26%             compression ratio.  Now 26% of
  558.                                     original size.
  559.    Version to extr. 1.50            minimum RAR version required to extract
  560.    Host OS          DOS             OS used to create this archive
  561.  
  562.  
  563.    Function keys actions:
  564.  
  565.      F1       Help information
  566.  
  567.      F2       Test archive (validate integrity)
  568.  
  569.      F3       View a file (if an external viewer is not set,
  570.               the internal viewer will be used)
  571.  
  572.      F4       Extract files from archive with directory
  573.               structure
  574.  
  575.      F5       Add a comment to the archive
  576.  
  577.      F6       Extract file(s) to current directory
  578.  
  579.      F7       Make Self-Extracting (SFX) archive
  580.  
  581.      F8       Delete file(s) from archive
  582.  
  583.      F9       Set up / Save options
  584.  
  585.      F10      Quit RAR
  586.  
  587.      ESC      Return from the archive
  588.  
  589.      Alt-F3   View a file (using the internal viewer)
  590.  
  591.      Alt-F4   Extract file(s) to an alternate path
  592.  
  593.      Alt-F5   Add individual file comment(s)
  594.  
  595.      Alt-F7   Lock the archive preventing modifications
  596.  
  597.  
  598.    When working with archive volumes in full-screen mode you
  599.    must begin the process with the first volume, you will be prompted
  600.    with a menu:
  601.  
  602.    "Proceed with all volumes from current"
  603.    "Proceed with selected files only"
  604.  
  605.    Choose the method you wish to use to work with the volumes.
  606.  
  607.    When files are displayed which were split between archive
  608.    volumes, the compressed size displayed refers to the
  609.    compressed size on the current volume.  The symbol ''
  610.    indicates that part of the file exists on a previous volume.
  611.    The symbol '' indicates that part of the file exist on the
  612.    next volume.
  613.  
  614.    2.3. In a non-RAR archive
  615.  
  616.    In full-screen mode RAR offers managing non-RAR archives.
  617.    Well known archive types is supported such as ZIP, ARJ, LZH.
  618.  
  619.    RAR provides following operations for non-RAR archives:
  620.  
  621.     - extract files with creating directory structure;
  622.     - extract to the current directory;
  623.     - extract to the specified directory;
  624.     - test files in the archive;
  625.     - delete files from the archive;
  626.     - view contents of the archive in full-screen mode;
  627.     - make SFX-archives;
  628.     - add archive comment (ZIP and ARJ only);
  629.     - add file comment (ZIP and ARJ only).
  630.  
  631.    Also the user may set password for the archive (pressing Alt-P)
  632.    and the path for temporary files (Alt-W).
  633.  
  634.    For viewing the archive content the user will need only RAR.
  635.    However for operations with non-RAR archives the user should
  636.    have corresponding programs (PKUNZIP, PKZIP, ZIP2EXE, ARJ, LHA)
  637.    as well as the path to these programs should be included into
  638.    the PATH environment variable.
  639.  
  640.    You can use RAR as the archive manager for archives of all
  641.    mentioned types in shell programs such as Norton Commander.
  642.  
  643.    Note, you could not manage non-RAR SFX archives.
  644.  
  645.    Only the standard LZH archives header is supported (the
  646.    archive should be created without switch '/h2').
  647.  
  648.  ╔════════════════════════════════════════════════════════════════════════╗
  649.  ║▒▒▒▒▒▒▒▒▒▒▒▒▒ Chapter 3.       The RAR Command Line Options ▒▒▒▒▒▒▒▒▒▒▒▒║
  650.  ╚════════════════════════════════════════════════════════════════════════╝
  651.  
  652.    Command line mode is the opposite of full-screen
  653.    interactive mode.  This mode is best used in batch files and
  654.    requires no interaction.
  655.  
  656.  
  657.    Usage:
  658.  
  659.  
  660.     RAR <command> -<switch1> -<switchN> <archive> <files...>
  661.         <@listfiles...> <=comment_file> <path_to_extract\>
  662.  
  663.    All parameters must exist on the same, single command line.
  664.  
  665.    command      ..  The function to be performed by RAR, add,
  666.                     extract, move etc.
  667.  
  668.    switch       ..  Switches used to define a specific type of
  669.                     operation, compression strength, type of
  670.                     archive etc.
  671.  
  672.    archive      ..  The name of the archive to be operated upon.
  673.  
  674.    files        ..  The files to be processed.
  675.  
  676.    listfiles    ..  The name of a file containing the names of
  677.                     the files to be operated upon.
  678.  
  679.    comment_file ..  The name of a file containing text to be
  680.                     used as a comment when creating the
  681.                     archive.
  682.  
  683.    path_to_extract  Used only with commands 'e' and 'x',
  684.                     indicating the directory in which to
  685.                     place extracted files.  If this directory
  686.                     does not exist, it will be created.
  687.  
  688.  
  689.    3.1. Commands (Alphabetic sequence)
  690.  
  691.    ..  a: add files to archive
  692.  
  693.    ..  c: add archive comment
  694.  
  695.        Pressing [F10] will save the entered comment and exit.
  696.        Pressing [Esc] will cancel the comment.  Pressing [F10]
  697.        without entering a comment will remove any existing
  698.        comment.
  699.  
  700.        Comments are displayed while the archive is being
  701.        processed.  The maximum comment length is 16384 bytes.
  702.  
  703.        Support for ANSI esc-sequences is provided in RAR which
  704.        allows the use of colour and cursor movements.  No ANSI
  705.        driver is required to display such comments.
  706.  
  707.        Redefinition of the keyboard using ANSI esc-sequences is
  708.        NOT supported and thus the so-called ANSI-bombs cannot be
  709.        delivered using RAR.
  710.  
  711.     Example:
  712.  
  713.        RAR c distrib.rar
  714.  
  715.        Comments may be entered from a file by using the '='
  716.        switch before the name of the file containing the comment.
  717.  
  718.        RAR c dummy =info.txt
  719.  
  720.    ..  cf: add file comments (not to entire archive)
  721.  
  722.        Pressing [F10] will save the entered comment and exit.
  723.        Pressing [Esc] will cancel the comment.  Pressing [F10]
  724.        without entering a comment will remove any existing
  725.        comment.
  726.  
  727.        Comments are displayed when the 'v' command is given.
  728.        Comment length is limited to 16384 bytes.
  729.  
  730.     Example:
  731.  
  732.        RAR cf bigarch *.txt
  733.  
  734.    ..  cw: write the archive comment to a file
  735.  
  736.     Example:
  737.  
  738.        RAR cw oldarch comment.txt
  739.  
  740.        The comment from the archive oldarch.rar will be
  741.        written to the file comment.txt
  742.  
  743.    ..  d: delete files from archive
  744.  
  745.     Note: If the processing of this command resulted in
  746.        removing all the files from the archive, the empty
  747.        archive would removed.
  748.  
  749.    ..  e: extract files from archive to current directory
  750.  
  751.    ..  en: start RAR in full-screen mode and enter an archive
  752.  
  753.        Usually this command is included in the extension file
  754.        of a shell processor such as Norton Commander:
  755.  
  756.        RAR: RAR en !.!
  757.  
  758.     Examples:
  759.  
  760.        RAR en disk1.rar
  761.  
  762.        RAR en puppy.zip
  763.  
  764.        The 'en' may also be omitted, simply start RAR with
  765.        the archive name.
  766.  
  767.     Example:
  768.  
  769.        RAR baby.arj
  770.  
  771.    ..  f: freshen files in archive
  772.  
  773.        Updates those files changed since they were packed to
  774.        the archive.  This command will not add new files to the
  775.        archive.
  776.  
  777.    ..  k: lock archive
  778.  
  779.        Any commands that could change the archive will be
  780.        ignored.
  781.  
  782.     Example:
  783.  
  784.        RAR k final.rar
  785.  
  786.    ..  l: list archive contents (brief listing)
  787.  
  788.        Files are listed as with the 'v' command with the
  789.        exception of the file path.  i.e. only the file name
  790.        is displayed.
  791.  
  792.    ..  m: move files and directories to archive
  793.  
  794.        Moving files and directories results in the files and
  795.        directories being erased upon successful completion of
  796.        the packing operation.  Directories will not be removed
  797.        if '-ed' switch is used.
  798.  
  799.    ..  mf: move files to archive
  800.  
  801.         Moving files results in the files being erased upon
  802.         successful completion of the packing operation.
  803.  
  804.    ..  p: print file(s) to screen (STDOUT)
  805.  
  806.    ..  r: repair damaged archive
  807.  
  808.        RAR cannot restore lost information, so it is not
  809.        possible to recover files which fail the CRC validation,
  810.        but it is possible to recover files which may still exist
  811.        in the archive undamaged.
  812.  
  813.        When this command has completed, a new archive will be
  814.        created, called $RECOVER.RAR
  815.  
  816.        While the recovery process is in operation, RAR will
  817.        prompt the user for assistance when suspicious files are
  818.        located.
  819.  
  820.                       Suspicious entry
  821.  
  822.               Name:  <possibly filename>
  823.               Size:  <size>    Packed: <compressed size>
  824.  
  825.                       Add it: Yes/No/All
  826.  
  827.     Answer 'Y' to add this entry to the file $RECOVER.RAR.
  828.  
  829.     Example:
  830.  
  831.        RAR r buggy.rar
  832.  
  833.    ..  s: convert archive to a Self-Extracting (SFX) type.
  834.  
  835.        In the Dos environment, this will create a *.EXE file
  836.        which, when executed, will extract the files contained
  837.        within it.
  838.  
  839.        It is also possible to make an SFX archive as the first
  840.        of a multi-volume sequence, but it should be noted that
  841.        the size will be larger by the amount of the SFX-module.
  842.        Please ensure that the first volume in the sequence is
  843.        created with the correct size.  SFX volumes may be created
  844.        using the command 'a' with the switches: '-v[<size>] -sfx'
  845.  
  846.     Example:
  847.  
  848.         RAR s diamant
  849.  
  850.    ..  t: test archive files
  851.  
  852.        This command performs a dummy file extraction, writing
  853.        nothing to the output stream, in order to validate the
  854.        specified file(s).
  855.  
  856.    ..  u: update files in archive
  857.  
  858.        Adds files not already in the archive and updates those
  859.        files changed since they were packed to the archive.
  860.  
  861.    ..  v: verbosely list archive content (full listing)
  862.  
  863.        Files are listed using the format: full pathname, file
  864.        comment, original and compressed size, compression ratio,
  865.        last update date and time, attributes, CRC, compression
  866.        method and minimum RAR version required to extract.
  867.  
  868.        To list the contents of all archive volumes, use and
  869.        asterisk (*) in place of the archive file extension.
  870.  
  871.     Example:
  872.  
  873.         RAR v multivol.*
  874.  
  875.    ..  x: extract files from archive to original (relative)
  876.           directory if pathnames exist in the archive
  877.  
  878.    Command limitations:
  879.  
  880.        The commands 'd','u','f' will not operate with archive
  881.        volumes and solid archives.
  882.  
  883.        The command 'a' cannot be used to update an archive
  884.        volume or a solid archives, only to create one.
  885.  
  886.        The commands 'c' and 'cf' will not operate with
  887.        archive volumes, but will work with solid archives.
  888.  
  889.        An archive comment can be added when the archive is
  890.        created using a comment file.
  891.  
  892.  
  893.    3.2. Switches  (Alphabetic sequence)
  894.  
  895.    ..  -? display help on commands and switches
  896.  
  897.    ..  -av  apply authenticity verification (registered versions only!)
  898.  
  899.        RAR will put, in every new and updated archive,
  900.        information concerning the creator, last update time and
  901.        archive name.
  902.  
  903.        If an archive, containing authenticity verification, is
  904.        being modified and this switch is not specified, the
  905.        authenticity verification information will be removed.
  906.  
  907.        When extracting, testing, listing or updating and
  908.        archive with the '-av' switch, RAR will perform integrity
  909.        validation display the message:
  910.  
  911.             Verifying authenticity information ...
  912.  
  913.        In the case of successful authenticity verification, the
  914.        message 'Ok', creator name and last update information
  915.        will be displayed.  In the case of authenticity verification
  916.        failure, the message 'FAILED' will be displayed.
  917.  
  918.        When creating archive volumes with the '-av' switch,
  919.        Cyclic Redundancy Check (CRC) information will be added to
  920.        each volume.
  921.  
  922.        The Authenticity Verification feature, '-av,' is
  923.        recommended for use with archives in a software
  924.        distribution environment.
  925.  
  926.        In order to enable the Authenticity verification feature,
  927.        the program MUST be registered.  Please contact your local
  928.        distribution site or the world-wide distribution center.
  929.  
  930.    ..  -b   enable backup archives
  931.  
  932.        This switch will create a backup before an archive is
  933.        modified.  The backup file will have the same name as the
  934.        original archive but with the .BAK extension.  Should this
  935.        file already exist, the backup file will be named with a
  936.        .$BK extension.
  937.  
  938.    ..  -bw  black & white (monochrome) mode
  939.  
  940.    ..  -c-   disable comment display
  941.  
  942.    ..  -cfg- disable read configuration and environment
  943.  
  944.    ..  -col colour mode
  945.  
  946.    ..  -e<s,h,a,r> set file exclusion attributes
  947.  
  948.        The switches 's', 'h', 'a' or 'r' signify that files
  949.        having the System, Hidden, Archive or Read only attributes
  950.        should be excluded.  The order in which the attributes are
  951.        given is not significant.
  952.  
  953.     Example:
  954.  
  955.        RAR a -ehs purity *.exe
  956.  
  957.        Do NOT add files with Hidden or System attributes.
  958.  
  959.    ..  -ed  do not add empty directories
  960.  
  961.        This switch indicates that empty directories are not
  962.        to be stored in the created archive.
  963.  
  964.    ..  -ep  exclude paths from names
  965.  
  966.        This switch enables files to be added to an archive
  967.        without including the path information.  This could, of
  968.        course, result in multiple files existing in the archive
  969.        with the same name.
  970.  
  971.    ..  -ep1 exclude base dir from names
  972.  
  973.        Do not store the path from the command line.
  974.  
  975.        Example:
  976.  
  977.           RAR a -ep1 -r pasta tmp\*.*
  978.  
  979.        All files and directories from the directory TMP will
  980.        be added to the archive 'pasta', but the path will not
  981.        include 'TMP\'.  This is equivalent to the commands:
  982.  
  983.          cd tmp
  984.          RAR a -ep1 -r pasta
  985.          cd ..
  986.  
  987.        For correct operation of this switch you must use the
  988.        full form of the path, as given in the example above, and
  989.        NOT the command string:  rar a -ep1 -r pasta tmp
  990.  
  991.    ..  -f   freshen files
  992.  
  993.        May be used with archive extraction or creation.
  994.  
  995.        The command string "a -f" is equivalent to the command
  996.        'f', you could also use the switch '-f' with the commands
  997.        'm' or 'mf'.  If the switch '-f' is used with the commands
  998.        'x' or 'e', then only old files would be replaced with new
  999.        versions extracted from the archive.
  1000.  
  1001.    ..  -m<0..5> set compression method
  1002.  
  1003.        -m0   store     do not compress file when adding to
  1004.                        archive
  1005.        -m1   fastest   use fastest method (less compressive)
  1006.        -m2   fast      use fast compression method
  1007.        -m3   normal    use normal (default) compression method
  1008.        -m4   good      use good compression method (more
  1009.                        compressive)
  1010.        -m5   best      use best compression method
  1011.  
  1012.        By default RAR uses -m3 method (Normal compression).
  1013.  
  1014.    ..  -o+ overwrite existing files
  1015.  
  1016.    ..  -o- do not overwrite existing files (default)
  1017.  
  1018.    ..  -p  set password
  1019.  
  1020.        The password is case-sensitive.  If you omit the
  1021.        password on the command line, you will be prompted with:
  1022.  
  1023.        Enter password:
  1024.  
  1025.     Example:
  1026.  
  1027.        RAR a -pmyhoney secret *.txt
  1028.  
  1029.        Newly added files will be encrypted with the password
  1030.        'myhoney'.
  1031.  
  1032.    ..  -p<password> set password
  1033.  
  1034.    ..  -r recourse subdirectories
  1035.  
  1036.        May be used with commands: a,u,f,m,x,e,t,p,v,l,c,cf,s.
  1037.  
  1038.        When used with the commands 'a', 'u', 'f', 'm' will
  1039.        process files in all sub-directories as well as the
  1040.        current working directory.
  1041.  
  1042.        When used with the commands x,e,t,p,v,l,c,cf,s will
  1043.        process all archives in sub-directories as well as the
  1044.        current working directory.
  1045.  
  1046.    ..  -s   create solid archive
  1047.  
  1048.        Solid is a special archive type.  Please refer to the
  1049.        appendix "Glossary" for further information.
  1050.  
  1051.     Example:
  1052.  
  1053.        RAR a -s -v1440 -sfx maddy *.*
  1054.  
  1055.        Will create solid Self-Extracting (SFX) volumes of
  1056.        size 1440000 bytes.
  1057.  
  1058.    ..  -sfx create Self-Extracting (SFX) archive
  1059.  
  1060.        If this switch is used when creating a new archive, a
  1061.        Self-Extracting archive would be created.
  1062.  
  1063.     Example:
  1064.  
  1065.        RAR a -sfx sources *.asm
  1066.  
  1067.        This command would create a Self-Extracting archive
  1068.        named SOURCES.EXE.  To extract files from such an archive,
  1069.        you would simply execute it.  Self-Extracting archives may
  1070.        be processed normally using RAR.
  1071.  
  1072.    ..  -std  stdout mode
  1073.  
  1074.        All output text is sent to the stdout stream.  This
  1075.        allows redirection of RAR output to a file, for example:
  1076.  
  1077.        RAR v -std bambam >bambam.lst
  1078.  
  1079.     or you could process without any output:
  1080.  
  1081.        RAR x -std dime 10cents.txt >nul
  1082.  
  1083.    ..  -tk  do not modify archive date
  1084.  
  1085.        Prevents RAR from modifying the archive date when
  1086.        changing an archive.
  1087.  
  1088.    ..  -tl  set archive date as the date of newest file
  1089.  
  1090.        Forces RAR to set the date of a changed archive to the
  1091.        date of the newest file in the archive.
  1092.  
  1093.    ..  -u   update files
  1094.  
  1095.        May be used with archive extraction or creation.
  1096.  
  1097.        The command string "a -u" is equivalent to the command
  1098.        'u', you could also use the switch '-u' with the commands
  1099.        'm' or 'mf'.  If the switch '-u' is used with the commands
  1100.        'x' or 'e', then files not present on the disk and files
  1101.        newer than their copies on the disk would extracted from
  1102.        the archive.
  1103.  
  1104.    ..  -v create volumes with autodetected size
  1105.  
  1106.    ..  -v<size> create archive volumes
  1107.  
  1108.        By default this switch uses <size> as thousands (1000) of
  1109.        bytes (not 1024 x bytes).   You may also enter the size in
  1110.        kilobytes using the symbol 'k' following the numerical
  1111.        value.  If the size is omitted, autodetection will be
  1112.        used.
  1113.  
  1114.        If volumes are created on the same drive as the
  1115.        temporary files (current drive by default, but may be
  1116.        changed with the switch '-w'), the autodetected size
  1117.        becomes meaningless.  In this case the volume size must be
  1118.        explicitly defined.
  1119.  
  1120.        If volumes are created on a drive OTHER than the drive
  1121.        containing the temporary files, then after the first
  1122.        volume has been created, the user will be prompted with:
  1123.  
  1124.            Create next volume: Yes/No/All/Quit
  1125.  
  1126.        At this moment in time, you should change the disks.
  1127.        Answering 'A' will cause all volumes to be created without
  1128.        a pause.
  1129.  
  1130.        The first volume file in a multi-volume set has the
  1131.        extension .RAR, following volumes are numbered from .R00 to
  1132.        .R99.
  1133.  
  1134.        When extracting or testing a multi-volume archive you
  1135.        must use only the first volume name (*.RAR).  If there is
  1136.        no next volume on the drive (and volumes are not placed in
  1137.        the same directory as the temporary files), the user will
  1138.        be prompted with:
  1139.  
  1140.            Insert disk with <next volume name>
  1141.  
  1142.        Insert the disk with the correct volume and press any key.
  1143.  
  1144.        If while extracting, the next volume is not found and
  1145.        volumes are placed in the same directory as the temporary
  1146.        files, RAR will abort with the error message:
  1147.  
  1148.            Can't find <volume name>
  1149.            Can't change disk with temporary files
  1150.  
  1151.        Archive volumes may not be modified.  The commands 'd',
  1152.        'f', 'u', 's' can not be used with Multi-volume sets.
  1153.        The command 'a' may be used only for the creation of a
  1154.        new multi-volume sequence.
  1155.  
  1156.        It is possible, although unlikely, that the file size,
  1157.        of a file in a multi-volume set, could be greater than
  1158.        it's uncompressed size.  This is due to the fact that
  1159.        'storing' (no compression if size increases) cannot be
  1160.        enabled for multi-volume sets.
  1161.  
  1162.        Archive volumes may be Self-Extracting (SFX).  Such an
  1163.        archive should be created using both the '-v' and '-sfx'
  1164.        switches.
  1165.  
  1166.  
  1167.     Example:
  1168.  
  1169.     1. Archive drive C: on floppy drive A:
  1170.  
  1171.        RAR a -r -v a:allhard c:\*.*
  1172.  
  1173.     (current disk MUST be C:)
  1174.  
  1175.     2. Create archive volumes with 1440000 byte size in current
  1176.        directory.
  1177.  
  1178.        RAR a -v1440 4flopp
  1179.  
  1180.        or
  1181.  
  1182.        RAR a -v1440 4flopp *.*
  1183.  
  1184.    ..  -w<path> assign work directory
  1185.  
  1186.        This switch may be used to assign the directory for
  1187.        temporary files to another drive.  For example a RAM drive
  1188.        or high performance disc.
  1189.  
  1190.        Note, if temporary files cannot be created in the
  1191.        current directory, RAR will search for an available disk
  1192.        automatically.
  1193.  
  1194.     Example:
  1195.  
  1196.        RAR a -we:\tmp bmps *.bmp
  1197.  
  1198.        Temporary files would be created in directory E:\TMP
  1199.  
  1200.  
  1201.    ..  -x<mask> exclude files specified by mask
  1202.  
  1203.     Example:
  1204.  
  1205.        RAR a -x*.bak purearch.rar
  1206.  
  1207.     You can specify the switch '-x' several times:
  1208.  
  1209.        RAR a -r -x*.arj -x*.rar rawfiles
  1210.  
  1211.    ..  -x@<list> exclude files using specified list file
  1212.  
  1213.     Example:
  1214.  
  1215.        RAR a -x@exlist.txt arch *.exe
  1216.  
  1217.    ..  -y   assume Yes on all queries
  1218.  
  1219.    3.3. SFX switches
  1220.  
  1221.    An SFX archive module can be handled by the switches:
  1222.  
  1223.    ..  -t   Test the SFX archive
  1224.  
  1225.        This is similar to 't' command in RAR.
  1226.  
  1227.    ..  -v   View the archive content
  1228.  
  1229.        This is similar to 'v' command in RAR.
  1230.  
  1231.  ╔════════════════════════════════════════════════════════════════════════╗
  1232.  ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒  Glossary  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  1233.  ╚════════════════════════════════════════════════════════════════════════╝
  1234.  
  1235.    Archive       Special file containing one or more files
  1236.                  optionally encoded and/or compressed.
  1237.  
  1238.    Compression   A method of encoding data to reduce it's
  1239.                  size.
  1240.  
  1241.    CRC           Cyclic Redundancy Check. Mathematical method
  1242.                  calculating special checking information
  1243.                  for data validity.
  1244.  
  1245.    SFX           Archive module used to extract files from
  1246.                  when executed. (SelF-eXtracting module),
  1247.                  usually in the form of a .EXE file.
  1248.  
  1249.    Solid         An archive packed using a special compression
  1250.                  method which sees all files as one continuous
  1251.                  data stream.  Particularly advantageous when
  1252.                  packing a large number of small files.
  1253.  
  1254.    Volume        Part of a split archive. Splitting an archive
  1255.                  to volumes allows storing them on diskettes.
  1256.                  Volumes must be extracted starting from first
  1257.                  in sequence.
  1258.  
  1259.  
  1260.