Source: rar
Severity: important
Control: tags -1 patch
The Debian manpage for rar is outdated for a long time.
Please find a new version enclosed that was built from the one included in
2:5.5.0-1.
There is a comment on the -sfx option about the license of SFX modules that is not available in
rar.txt or on any other document. I verified with Eugene Roshal that the BSD licenses in acknow.txt
is indeed applicable to default.sfx.
.TH RAR 1 2021-09-24 "" "RAR archiver"
.SH NAME
rar \- archive files with compression
.SH SYNOPSIS
.B rar
.I "<command> [-<switch 1> -<switch N>] archive [files...] [@listfiles...]
[path_to_extract]"
.SH "DESCRIPTION"
This manual page documents briefly the
.BR rar
archiver.
.br
This manual page was written for the Debian GNU/Linux distribution
because the original program does not have a manual page.
.br
Commands and options described here are as of
.BR rar
5.50.
.PP
.B rar
is a program for creating and manipulating .rar archives.
.SH COMMANDS
After the program name comes a command and then optional switches with
dashes before them.
.br
A summary of commands is included below.
For a complete description, run
.B rar \-?
.TP
.B a
Add files to archive.
.TP
.B c
Add archive comment. Comment length is limited to 256 KB.
.TP
.B ch
Change archive parameters.
Can be used with most of archive modification options.
.TP
.B cw
Write archive comment to a specified file.
.TP
.B d
Delete files from archive.
.TP
.B e
Extract files to current directory. Does not create any subdirectories.
.TP
.B f
Freshen files in archive.
Updates those files changed since they were packed to the archive.
This command will not add new to the archive.
.TP
.B k
Lock archive.
Any command which intend to change the archive will be ignored.
.TP
.B l[t[a],b]
List content of archive [technical[all], bare].
'lt' displays the detailed file information in multiline mode.
Commands 'lt', 'lta' and 'lb' are equal to 'vt', 'vta' and 'vb' correspondingly.
.TP
.B m[f]
Move to archive [files only].
Directories will not be removed if 'f' modifier is used and/or '\-ed' switch is
applied.
.TP
.B p
Print file to stdout.
.TP
.B r
Repair archive. For further details look in
.BR rar.txt .
.TP
.B rc
Reconstruct missing volumes using recovery volumes (.rev files).
You need to specify any existing volume as the archive name, for
example, 'rar rc backup.part03.rar'.
.TP
.B rn
Rename archived files.
.TP
.B rr[N]
Add data recovery record. Optionally, redundant information
(recovery record) may be added to an archive.
.TP
.B rv[N]
Create recovery volumes (.rev files), which can be later used to reconstruct
missing files in a volume set.
This command has sense only for multivolume archives.
For further details look in
.BR rar.txt .
.TP
.B s[name|-]
Convert archive to or from SFX. The archive is merged with SFX-module
in the user's home directory.
.TP
.B t
Test archive files.
.TP
.B u
Update files in archive. Adds files not already in the archive
and updates files changed since they were packed to the archive.
.TP
.B v[t[a],b]
Verbosely list archive [technical]
.TP
.B x
Extract files with full path.
.SH OPTIONS
.BR NOTE:
Every switch must be separated by a whitespace.
They cannot be put together.
.TP
.B \-?
Display help on commands and switches. The same as when none
or an illegal command line option is entered.
.TP
.B \-\-
This switch tells to RAR that there is no more switches
in the command line. It could be useful, if either archive
or file name starts from '\-' character. Without '\-\-' switch
such name would be treated as switch.
.TP
.B \-@[+]
Disable [enable] file lists.
.TP
.B \-ad
Append archive name to destination path.
.TP
.B \-ag[format]
Generate archive name using the current date and time.
Appends the current date string to an archive name when
creating an archive. Useful for daily backups.
For further details look in
.BR rar.txt .
.TP
.B \-ai
Ignore file attributes.
.TP
.B \-ap<path>
Set path inside archive. This path is merged to file names when adding files
to an archive and removed from file names when extracting.
.TP
.B \-as
Synchronize archive contents.
.br
If this switch is used when archiving, those archived files
which are not present in the list of the currently added
files, will be deleted from archive. It is convenient to use
this switch in combination with \-u (update) to synchronize
contents of an archive and an archiving directory.
.TP
.B \-cfg\-
Disable reading configuration and environment.
.TP
.B \-cl
Convert file names to lower case.
.TP
.B \-cu
Convert file names to upper case.
.TP
.B \-c\-
Disable showing comments.
.TP
.B \-df
Delete files after archiving. This switch in combination with
the command "a" performs the same action as the command "m".
.TP
.B \-dh
Open shared files. Allows to process files opened by other applications
for writing.
.TP
.B \-ds
Do not sort files while adding to a solid archive.
.TP
.B \-dw
Wipe files after archiving.
.TP
.B \-ed
Do not add empty directories.
.TP
.B \-en
Do not add "end of archive" block.
.br
This switch cannot be used with volumes because the end
of archive block contains information important for correct
volume processing.
.TP
.B \-ep
Exclude paths from names.
.TP
.B \-ep1
Exclude base dir from names.
.TP
.B \-ep2
Expand paths to full. Store full file paths (except a drive
letter and leading path separator) when archiving.
.TP
.B \-e[+]<attr>
Set file exclude [or include] attributes.
.TP
.B \-f
Freshen files. May be used with archive extraction or creation.
.TP
.B \-hp[password]
Encrypt both file data and headers.
The password is case-sensitive. If you omit the password on the
command line, you will be prompted with message "Enter password".
.TP
.B \-ht[b|c]
Select hash type [BLAKE2,CRC32] for file checksum.
.TP
.B \-id[c,d,p,q]
Disable messages.
.TP
.B \-ierr
Send all messages to stderr.
.TP
.B \-ilog[name]
Log errors to file (registered versions only).
.TP
.B \-inul
Disable all messages.
.TP
.B \-isnd
Enable sound.
.TP
.B \-iver
Display the version number
.TP
.B \-k
Lock archive.
.br
Any command which intends to change the archive will be ignored.
.TP
.B \-kb
Keep broken extracted files.
.TP
.B \-log[f][=name]
Write names to log file.
.TP
.B \-m<0..5>
Set compression level (0-store...3-default...5-best). By default
.BR rar
uses \-m3 method (Normal compression).
.TP
.B \-ma[4|5]
Specify a version of archiving format.
.TP
.B \-mc<par>
Set advanced compression parameters.
For further details look in
.BR rar.txt .
.TP
.B \-md<size>[k,m,g]
Set dictionary size in KB, MB or GB.
.TP
.B \-ms[ext;ext]
Specify file types (extensions) to store.
.TP
.B \-mt<threads>
Set the number of threads.
.br
If this switch is not specified,
RAR will try to detect the number of available processors
and selects the optimal number of threads automatically.
.TP
.B \-n<file>
Additionally filter included files.
.TP
.B \-n@
Read additional filter masks from stdin.
.TP
.B \-n@<list>
Read additional filter masks from list file.
.TP
.B \-o+
Overwrite existing files.
.TP
.B \-o\-
Do not overwrite existing files.
.TP
.B \-oh
Save hard links as the link instead of the file.
.TP
.B \-oi[0-4][:min]
Save identical files as references.
.TP
.B \-ol[a]
Process symbolic links as the link [absolute paths].
.TP
.B \-or
Rename files automatically.
.TP
.B \-ow
Save or restore file owner and group.
.TP
.B \-p[password]
Encrypt files with the given string as password while archiving.
The password is case-sensitive. If you omit the password on the
command line, you will be prompted with message "Enter password".
.TP
.B \-p\-
Do not query password.
.TP
.B \-qo[-|+]
Add quick open information [none|force].
.TP
.B \-r
Recurse subdirectories.
.TP
.B \-r\-
Disable recursion.
.TP
.B \-r0
Similar to \-r, but when used with the commands 'a', 'u', 'f', 'm'
will recurse subdirectories only for wildcard names.
.TP
.B \-rr[N]
Add data recovery record.
.TP
.B \-rv[N]
Create recovery volumes.
.B \-s
Create solid archive.
.TP
.B \-s<N>
Create solid groups using file count. Similar to \-s, but reset solid
statistics after compressing <N> files.
.TP
.B \-se
Create solid groups using extension. Similar to \-s, but reset solid
statistics if file extension is changed.
.TP
.B \-sv
Create independent solid volumes. Similar to \-s, but reset solid statistics
as soon as possible when starting a new volume.
.TP
.B \-sv\-
Create dependent solid volumes. Similar to \-s, but reset of solid statistics
is disabled.
.TP
.B \-s\-
Disable solid archiving.
.TP
.B \-sc<chr>[obj]
Specify the character set.
.TP
.B \-sfx[name]
Create SFX archives.
The archive is merged with SFX-module "name" in the user's home directory.
The default module is taken from /usr/lib/default.sfx.
Please be aware that you have to accompany the result with
.B /usr/share/doc/rar/acknow.txt
on distribution, which holds 3rd party licenses that apply to default.sfx.
.TP
.B \-si[name]
Read data from standard input (stdin).
.TP
.B \-sl<size>
Process files with size less than specified.
.TP
.B \-sm<size>
Process files with size more than specified.
.TP
.B \-t
Test files after archiving. This switch is especially
useful in combination with the move command, so files will be
deleted only if the archive has been successfully tested.
.TP
.B \-ta<date>
Process files modified after <date> in YYYYMMDDHHMMSS format.
.TP
.B \-tb<date>
Process files modified before <date> in YYYYMMDDHHMMSS format.
.TP
.B \-tk
Keep original archive time. Prevents
.BR rar
from modifying the archive date when changing an archive.
.TP
.B \-tl
Set archive time to latest file. Forces
.BR rar
to set the date of a changed archive to the date of the newest file in the
archive.
.TP
.B \-tn<time>
Process files newer than <time>.
.TP
.B \-to<time>
Process files older than <time>.
.TP
.B \-ts[m|c|a]
Save or restore file time (modification, creation, access).
.TP
.B \-u
Update files.
.TP
.B \-v<size>[k|b]
Create volumes with size=<size>*1000 [*1024, *1] bytes.
.TP
.B \-ver[n]
File version control.
.TP
.B \-vn
Use the old style volume naming scheme.
.TP
.B \-vp
Pause before each volume.
.TP
.B \-w<path>
Assign work directory.
.TP
.B \-x<file>
Exclude specified file. Wildcards may be used and you may
specify the switch '\-x' several times.
.TP
.B \-x@<list>
Exclude files in specified list file.
.TP
.B \-x@
Read file names to exclude from stdin.
.TP
.B \-y
Assume Yes on all queries.
.TP
.B \-z[file]
Read archive comment from file.
If [file] is not present, comment is read from stdin.
.SH "SEE ALSO"
The program is documented fully in
.IR rar.txt
which you find in /usr/share/doc/rar.
.SH AUTHORS
This manual page was written by Petr Cech <[email protected]> according
to "rar -?" for the Debian GNU/Linux system (but may be used by others).
