HPAVC

home *** CD-ROM | disk | FTP | other *** search

/ HPAVC / HPAVC CD-ROM.iso / pc / RAR.ZIP / RAR.DOC < prev next >

Wrap

Text File | 1994-05-26 | 30.6 KB | 1,032 lines

RAR multifunctional User's manual integrated v1.50 archive manager Wellcome to RAR Archiver! The manual contains full description of RAR 1.50 using. Introduction RAR is powerfull tool that allows you manage archive files with original facilities such as full-screen interactive interface (including mouse, menus), NON-RAR archive support, common 'standard' interface with console command line options. The archiver RAR has original compression algorithm implemented. It provides higher compression ratio than usual archiving tools for PC. Also it realizes special archive type 'solid', that brings compression much higher. Chapter 1 "Installing and Configuring" This chapter describes how to install and configure RAR, gives information about technical requirements. 1.1. Installation procedure RAR is distributed in self-extracting (SFX) archive named RAR?_???.EXE where version number represents for '?_???'. Before installing it's recommended to create directory for RAR and make it current. Then run RAR SFX-archive by typing RAR?_??? at the DOS prompt. It initiates self-extraction RAR files to the current directory. For example, on floppy disk A: you have got file RAR1_50.EXE, that means RAR 1.50. You can install it to your disk typing at the DOS prompt following commands: C:\> mkdir RAR C:\> cd RAR C:\RAR> You've just created new directory C:\RAR and made it current. Then run RAR self-extracting archive: C:\> A:RAR1_50.EXE You will be prompted with RAR archive comment. Press any key to continue, pressing ESC will cancel extraction. When extraction successfully finished RAR is ready to work. The archiver program itself is named RAR.EXE, all of archive managing functions realized there. You can add directory where located RAR.EXE to your DOS path variable. Then you will be able to run RAR while any directory is current. 1.2. Option menu You can set up RAR options and save it to RAR.CFG for future use running RAR.EXE. Just type at your DOS prompt to start RAR in full-screen mode: C:\RAR> RAR When RAR started press F9 - you will enter follow menu: ┌─────────────────────────────────┐ │ Configuration... │ │ Set password ALT-P │ │ Work directory ALT-W │ │ Default comment file │ │ External viewer │ │ Change disk ALT-D │ │ Registration │ │ Save options ALT-S │ └─────────────────────────────────┘ Press <Enter> to get sub-menu "Configuration". You will see configuration options with fields, that can be marked. There you can set up options going through items by pressing arrows, setting option values by typing key <Space>. When you've set up all desired options, to enroll them move to the field "[ Ok ]" and press <Enter> or simply press <Enter> anywhere except the field "[ Cancel ]". If you're going to leave option values unchanged go to the field "[ Cancel ]" and then press <Enter>. If you are using mouse, you can do this with comprehensive mouse-interface: move the mouse cursor and click mouse key. When you're about finish configuring click mouse key upon field "[ Ok ]". Opposite, if you're going discard changes click mouse key upon field "[ Cancel ]". "Configuration/Screen & Mouse" Enable color Marking this option enables using colors in full-screen mode Enable mouse This enables using of mouse in full-screen mode Stdout mode This forces RAR to run in console (stdout) mode while processing commands from command line "Configuration/Put AV" Put auth. verification This forces RAR to place authenticity verification when creating archive (registered version only) "Configuration/Compression" You can choose compression level marking one of the following: Store Do not compress file when adding to archive Fastest Use fastest method (less compressive) Fast Use fast compression method Normal Use normal (default) compression method Good Use good compression method (more compressive) Best Use best compression method "Configuration/Sort names" Choosing name sort way for archive content list mark one of the following: Unsorted Do not sort files By name Sort files by name By extension Sort files by extension By size Sort files by sizes "Configuration/Backup archive" Enable backup archive This forces RAR to save archive file to .BAK before it changed "Configuration/Include" To choose categories of files to be included when searching files for adding to archive you can mark: System files Add files with 'System' attribute Hidden files Add files with 'Hidden' attribute Read only files Add files with 'Read-only' attribute Archive files Add files with 'Archive' attribute Empty directories Add empty directories For more information about file attributes refer to your DOS manual. "Set password" You can assign password that will used when you add or extract files to (from) archive. Also you can enter password using <Alt/P>. Note, the password will not be saved to configuration file. "Work directory" You can assign path where RAR to place temporary created files. It can be done by pressing <Alt/W>. "Default comment file" If you need common comment be added to every archive you are creating you should enter it's name with full path. "External viewer" You can assign external viewer program to run for viewing file from archives (by pressing <F3>). RAR stores default configuration in file RAR.CFG, placed in the same directory RAR.EXE was started from. "Change disk" You can change current disk displaying in work window. "Registration" To register one should have a register code, which can be obtained after sending registering fee and completed register form to author or a dealer. After registration user can put authenticity verification to archives. "Save setup" After pressing <Enter> or clicking mouse key on this item user can choose "[ Save ]" or "[ Cancel ]". It means to save or cancel saving configuration for future use in RAR. Also you can save configuration pressing <Alt/S> (that means pressing keys <Alt> and <S> at the same time). Additionally you can set options using mouse directly on the right bottom part of the screen in window "Settings": ├────────────── Settings ─────────────╢ │ Password Absent ║ │ Compression level Normal ║ │ Archive backup Disabled ║ │ Making AV archives Enabled ║ │ Default comment file Present ║ ┴─────────────────────────────────────╢ For example, click mouse key on word 'Absent' on setting 'Password', you will be asked to enter password etc. 1.3. RAR environment variable You can describe your RAR environment variable using DOS SET command, for example: C:\> SET RAR=-std -s RAR would use this string as default parameters in command line. First RAR looks to the command line switches, then to the switches in environment variable string, then options saved in RAR.CFG. Switches -sfx, -v, -s, -std from RAR variable do no effect in full-screen mode. 1.4. Technical requirements Minimum DOS version to run RAR: 3.0 Version specific (for RAR 1.50) conventional memory requirements: Starting RAR: 260 Kb Extracting and viewing comments: 320 Kb Creating and updating archives: 420 Kb Managing non-RAR archives: 260 Kb (for extraction and updating non-RAR archives plus memory that external archiver needs itself) Chapter 2 "Using RAR interactively" When you start RAR by single command "RAR" at DOS prompt, you get ability to work with RAR full-screen interface. It means "running RAR interactively in full-screen mode". For example, you enter: C:\> RAR When RAR started on the right part of the screen you can see information box with memory status and settings window: current compression method, password status (absent or present), archive back up mode, authenticity verification status (enabled/disabled), whether default comment file present or not. On the left part of the screen you see current directory files. You can move cursor through the files on the screen using arrow keys or clicking the mouse. If you press <Enter> when cursor is on a directory, up-directory ("..") or archive file you enter. Archive can be one of the following types: .rar, .arj .zip, .lzh (or .ice). After you enter archive it is shown like a subdirectory structure. So you can "walk" through directories and archive files, managing files in archives or in normal directories. At bottom of the screen you can see available functions line: 1Help 2Add 3View 4Fresh 5Volume 6Move 7Update 8Repair 9Option 0Quit The line indicates you can get help pressing <F1>, add files to archive pressing <F2>, view file by <F3> etc. Press <F10> to quit. These functions are main set when you are in directory (not in archive). Alternatively when you press <Alt> you see additional available functions line: 1 2Solid 3View.. 4 5SFXVol 6SolVol 7SolSVl 8 9 0 It means you can create solid archive pressing <Alt/F2>, call internal viewer to view file by <Alt/F3> etc. Besides, when you hold <Alt> you can see options list in right bottom part of the screen: Alt-D Select drive Alt-C Toggle between color and black and white mode Alt-M Select compression method Alt-P Set password Alt-W Set work directory to store temporary files Alt-S Save setup When you press other keys (not options and functions), you get file names speed searching. By <Ctrl-Enter> you can list all matches. You could see that available functions line differs whether you are in archive (when you "walk" trough archive contents) or in normal directory structure. When you are in archive available functions line looks like: 1Help 2Test 3View 4Extr 5Commen 6ExCurD 7SFX 8 9Option 0Quit This line indicates you can get help pressing <F1>, test files in archive pressing <F2>, view file by <F3> etc. Press <F10> to quit. These functions are main set when you are in archive. Alternatively when you holding down <Alt> would cause next string: 1 2 3View.. 4ExtrTo 5FilCmt 6SolVol 7Lock 8 9 0 Use <Space>, <Ins>, or right mouse key to mark/unmark file group. You can use either to mark/unmark file group by wildcards (file mask) using <Gray +> and <Gray -> keys (on the numeric keypad). When you mark directory, you mark all directories and files in it if one. You can reverse marking files group by <Gray *>. When you mark on or more files you are prompted in bottom line how many files and directories you've marked and summary file size in bytes. (Note, in current version file size from marked directories does not include in summary file size). In full-screen mode mouse is supported. Use left mouse key to move up trough the directory. Click mouse key twice to <Enter>. Use right mouse key to mark files. While entering text (archive name, password etc.) left mouse key cancel and right one ensures text entered. Use left mouse key to choose function commands (F1-F10) of menu items and options. 2.1. When you are in directory Function keys actions: F1 Get help info F2 Add file(s) to archive, if archive does not exist it will be created F3 View a file (if external viewer is not set, internal viewer will be called) F4 Freshen files in archive - only recently changed files will be added that already were in archive F5 Create archive volumes F6 Update files in archive - update (add) files if they are recently changed or do not present in archive F7 Move file(s) to archive F8 Try to repair broken archive F9 Set up / Save options F10 Quit RAR. You can either press ESC. Alt-F2 Create solid archive. Alt-F3 View file (with internal viewer). Alt-F5 Create SFX-volumes. Alt-F6 Create solid archive volumes. Alt-F7 Create solid SFX-volumes. 2.1. When you are in archive Press <Enter> when standing on archive to get in. You can get in archive either running RAR with command 'en'. (See Chapter 3, 'en' command) When you are in archive it's files are shown on the left part of the screen (like files in directory). You can mark them as files in directory. File encrypted with password shown with asterisk '*' before it's name. On the right part of the screen information box is shown. It includes information: archive name and status, whether comments are present, if there are files encrypted with password, total number of files in archive, file sizes, compression ratio, minimum RAR version needed to extract, host OS archive was created with. For example: Info BOX: Meaning: Archive EXAMPLE.RAR - archive name Archive type Normal - not 'solid' archive Main comment Present - archive comment present File comments Absent - no file comments Passwords Absent - no password encrypted files Lock Absent - archive is not locked Auth. verif. Present - authenticity verification present Files 1 - number of files (1) Total length 14917 - total length in bytes Packed length 3938 - length in archive Ratio 26% - compression ratio Version to extr. 1.30 - minimum version to extract needed Host OS MS-DOS - OS archive was created with Function keys actions: F1 Get help info F2 Test archive F3 View a file (if external viewer is not set, internal viewer will be called) F4 Extract files from archive with directory structure F5 Add comment to archive F6 Extract file(s) to current directory F7 Make SFX-archive F8 Delete file(s) from archive F9 Set up / Save options F10 Return from archive. You can either press ESC. Alt-F3 View a file (with internal viewer) Alt-F4 Extract file(s) to alternate path Alt-F5 Add file comment(s) Alt-F7 Lock archive preventing it's modifications When you work with archive volumes in full-screen mode you need to begin process with the first one, you will be prompted with menu: "Proceed with all volumes from current" "Proceed with selected files only" Choose way you want work with volumes. It would be problematic process all volumes for marking files because they could be on different disks. When you watch files which were split between archive volumes compressed size listed means the size in current volume. This case indicates symbol '' when file parts located on previous volumes and symbol '' when some parts located on next volumes, both symbols appear when no previous and next parts in current directory. Chapter 3 "Using RAR with command line" Command line mode is opposite to full-screen interactive mode. It is available when you call RAR with parameters in command line. Usage: rar <command> -<switch1> -<switchN> <archive> <files...> <@listfiles...> <=comment_file> <path_to_extract\> Command can be one only, however it can applied by a number of switches. Archive means archive name. Files means list of files to be processed. File listfiles includes file names delimited with spaces or carriage return, this equivalent to using files. File comment_file includes comment adding to archive while creating archive, but not when modifying. Parameter path_to_extract is used only with commands 'e' and 'x', indicating directory to put extracted files. When the directory path_to_extract doesn't exist it will be created. 3.1. Commands a: add files to archive m: move files and directories to archive Moving files and directories would be erased when packing successfully finished. Directories will not removed if switch '-ed' used. mf: move files to archive Moving files would be erased when packing successfully finished. d: delete files from archive x: extract files from archive with stored directories if one e: extract files from archive to current directory v: verbosely list archive content (full form) Files are listed in format: full pathname, file comment, original and compressed size, compression ratio, last update date and time, attributes, CRC, compression method and minimum RAR version needed to extract will displayed. If you want to list all archive volumes, you need to use '*' instead of archive file extension. For example: rar v multivol.* l: list archive content (short form) Files are listed as with 'v' commands, but full file path not be displayed, only file names. t: test archive files This command performs test extraction (files will not extracted to disk). u: update files in archive Adds files those not in archive and updates those files recently changed since they were packed to archive. f: freshen files in archive Updates files in archive recently changed since they were packed. p: print file(s) to screen (STDOUT) s: convert archive to SFX-type (*.exe) You can also make SFX first volume from volume sequence, but note it's size would increased by volume of SFX-module. Be sure first volume in sequence would have proper size to be placed on floppy disc if needed. You can make SFX volumes using command 'a' with switches: '-v[<size>] -sfx'. For example: rar s diamant en: start RAR in full-screen mode and enter archive Usually this command included in extension file of shell Norton Commander: RAR: RAR en !.! Examples: rar en disk1.rar rar en puppy.zip You can omit 'en' (starting rar with archive name) Example: rar baby.arj c: add archive comment Press <F10> to save entered comment and exit. Press <Esc> to cancel comment. Pressing <F10> immediately after processing this command would erase existing comment. Comments are displayed while archive processing. Maximum comment size is 16 kilobytes. In comment file RAR provides ANSI-sequences support implemented. It allows use color and cursor movements in comments. It doesn't require ANSI driver when comment displayed. ANSI-sequences programming keyboard are not implemented. Though they would canceled when detected. It protects user against ANSI-bombs, when a key programming to dangerous command such as "echo y | del *.*". Example: rar c distrib.rar Comments could be entered from file, if in command line before it stands '=' symbol (see usage). For example: rar c dummy =info.txt cf: add file comments (not to entire archive) When comment is entered press <F10> to save it. <Esc> will cancel comments entering. Press <F10> immediately after starting entering mode to erase existing comment. Comments are displayed when 'v' command processed. Comment size is limited to 16 kilobytes. Example: rar cf bigarch *.txt cw: write archive comment to a file For example: rar cw oldarch comment.txt Comment from archive oldarch.rar will be written to file comment.txt r: repair broken archive RAR could not restore loosed file information. So you could not repair files with message when extracted "CRC failed". However you can repair broken archive to access probably not damaged files, or if you getting 'hook' RAR while processing archive. After processing this command would create new archive file named $RECOVER.RAR. While repairing archive RAR could find strange entries then user will be prompted with: Suspicious entry Name: <possibly filename> Size: <size> Packed: <compressed size> Add it: Yes/No/All Answer 'Y' to add this entry to file $RECOVER.RAR. Example: rar r buggy.rar k: lock archive Any commands that could change archive will cancelled. Example: rar k final.rar Commands 'd','u','f' will not work with archive volumes and solid archives. Command 'a' could not be used to update archive volumes and solid archives, only to create one. Commands 'c' and 'cf' will not work with archive volumes, but will work with solid archives. Archive comment could be added while archive creation using comment file. 3.2. Switches -? print help on commands and switches -r recourse subdirectories Could be used with commands: a,u,f,m,x,e,t,p,v,l,c,cf,s. When using with commands 'a', 'u', 'f', 'm' causes adding to archive files including those in sub-directories. When using with commands x,e,t,p,v,l,c,cf,s will cause processing all archives including those in sub-directories. -o+ overwrite existing files -o- do not overwrite existing files (default) -x<mask> exclude files specified by mask Example: rar a -x*.bak purearch.rar -x@<list> exclude files using specified list file Example: rar a -x@exlist.txt arch *.exe -sfx create SFX archives If this switch used while creating new archive SFX-archive would created. For example, command: rar a -sfx sources *.asm would create SFX-archive sources.exe. To extract file from such archive you could only execute it. Such archive can be processed also with RAR. -v create volumes with autodetected size -v<size> create archive volumes By default this switch uses <size> in thousands of bytes (not kilobytes). You can also enter size in kilobytes using symbol 'k' after it. If size is omitted it would cause size autodetection. If volumes are created in the same disk where temporary files located (current disk by default, possibly to change it by switch '-w'), you can not change disk. Then autodetected size is nonsense and size must be indicated explicitly. If volumes are created not on the same disk with temporary files, then after one volume is created user will be prompted: Create next volume: Yes/No/All/Quit In this moment you can change floppy disk. If you've answered 'A' - all volumes would created without pauses. First volume file has extension .rar, next are numerated from .r00 to .r99. When you extract or test multi-volume archive you can use only first volume name (*.rar). If there are no next volume in the disk (and volumes placed not in the same directory with temporary files), user will prompted: Insert disk with <next volume name> Insert disk with the volume and press any key. If while extraction next volume not found and volumes placed in the same directory with temporary files RAR will abort with error message: Can't find <volume name> Can't change disk with temporary files Archive volumes cannot be modified. Commands 'd', 'f', 'u', 's' can not apply to them. Command 'a' can be used only for creating new volumes sequence. Compressed file size in archive volumes could sometimes be greater than source (uncompressed) size, because storing (do not compress if compression failed) not enabled in volumes. Archive volumes can be SFX, you should create such archive using both '-v' and '-sfx' switches. Example: 1. Archive disk C: on floppy disks A: rar a -r -v a:allhard c:\*.* (current disk MUST be C:) 2. Create archive volumes with 362000 byte size in current directory. rar a -v362 4flopp or rar a -v362 4flopp *.* -w<path> assign work directory It is useful to assign electronic disk or path with high performance disk input/output as work directory. Note, if file cannot be created in current directory, RAR would search available disk automatically. Example: rar a -we:\tmp bmps *.bmp Temporary files would be created in E:\TMP -p<password> set password -p set password Letters in password are case-sensitive. If you omit password after switch it will be asked by query: Enter password: Example: rar a -pmyhoney secret *.txt Newly added files will be encrypted with password 'myhoney'. -y assume Yes on all queries -std stdout mode All output text do in stdout form. It allows to reassign RAR output to file, for example: rar v -std bambam >bambam.lst or you could process without any output: rar x -std dime 10cents.txt >nul -m<0..5> set compression method -m0 store do not compress file when adding to archive -m1 fastest use fastest method (less compressive) -m2 fast use fast compression method -m3 normal use normal (default) compression method -m4 good use good compression method (more compressive) -m5 best use best compression method By default RAR uses -m3 method (Normal compression). -col color mode -bw black & white mode -b enable backup archives This case archive before updating will be stored in copy with .bak extension. If archive named with .bak extension, backup copy will have .$bk extension. -f freshen files Could be used with archive extraction or creation. Command string "a -f" is equivalent to command 'f', you could use switch '-f' with commands 'm' or 'mf'. If switch '-f' would using together with commands 'x' or 'e', then only old files should be replaced with new versions from archive. -u update files Could be used with archive extraction or creation. Command string "a -u" is equivalent to command 'u', you could use switch '-u' with commands 'm' or 'mf'. If switch '-f' would using together with commands 'x' or 'e', then only old files should be replaced with new versions from archive. -ed don't add empty directories When using this switch empty directories will not be stored in archive, only directories with files. -ep exclude paths from names When using this switch files with same (not unique) names can be added to archive from different directories. -ep1 exclude base dir from names Do not store path from command line. For example: rar a -ep1 -r basta tmp\*.* All files and directories from directory TMP will be added to archive 'basta', but path will not include 'TMP\'. It works equivalent to commands: cd tmp rar a -ep1 -r basta cd .. For proper working of this switch you have to use full form in path (from example before), but not command string: rar a -ep1 -r basta tmp -cfg- disable read configuration and environment -c- disable comments show -e<s,h,a,r> set file exclude attributes If using 's', 'h', 'a' or 'r' it means do not look to file with types System, Hidden, Archive, Read only attributes accordingly. Attributes order is not significant. Example: rar a -ehs purity *.exe Means do not add files with Hidden and System attributes. -s create solid archive Solid is special archive type, look to Appendix "Glossary". Example: rar a -s -v362 -sfx maddy *.* Will create solid SFX volumes 362000 size. -av put authenticity verification (registered versions only!) This switch forces RAR to put in every created and updated archive information about author, last update time, archive name. If archive created with switch '-av' is being modified without this switch, authenticity verification information would be removed. When extracting, testing, listing archive, created or updated with '-av', RAR will check integrity of the archive and prompt user with message: Verifying authenticity information ... In case it successfully verified message 'Ok', creator name and last update information will be displayed. In case archive damaged message 'FAILED' will be displayed. When creating archive volumes with '-av' switch Cyclic Redundancy Check (CRC) will be added to every volume. Feature '-av' is recommended to use with archives for distributing software products. You have to register to obtain possibility using this feature, because in this mode creator name stored in archive which entered during registration. Glossary Archive Special file containing one or more files encoded that could be extracted from it. Compression A method of encoding data to reduce it's size. CRC Cyclic Redundancy Check. Mathematic method to store special checking information for data validity. SFX Archive module used to extract files from when executed. (Self-extracting module). Solid An archive packed with a special method when archive program places to archive all files compressed together as information flow (as if they were parts of one file to be compressed). Volume Part of splitted archive. Splitting archive to volumes allows store them apparently on floppy disks. Volumes need to be extracted starting from first one in sequence.