Skip to content

Commit

Permalink
Fixing typos in UnRAR.readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@mplpl
mplpl authored Apr 27, 2020
1 parent 64f90d5 commit cc6a2b8
Showing 1 changed file with 48 additions and 48 deletions.
96 changes: 48 additions & 48 deletions UnRAR.readme
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Version: 5.90
Architecture: ppc-amigaos >=4.1; ppc-morphos >=3; m68k-amigaos >=2.0; i386-aros
Distribution: aminet

This is UnRAR port for MorphOS, AmigaOS and AROS based on source code
This is UnRAR port for MorphOS, AmigaOS, and AROS based on source code
version 5.9.2.

UnRAR license is available in license.txt file in this archive.
This port uses also code from newlib 3.1.0, utf8proc, libnix and iconv.
This port uses also code from newlib 3.1.0, utf8proc, libnix, and iconv.
Newlib license is available in license_newlib.txt file in this archive.
Utf8proc license is available in license_utf8proc.txt file in this archive.
iconv license is available in license_libiconv.txt file in this archive.
Expand All @@ -29,8 +29,8 @@ Requirements
============

There are no special requirements for MorphOS and AmigaOS4. It should work on
any system provided that is has relatively fresh version of operating system
(I test on MorphOS 3.12 and AmigaOS 4.1 FE Update 1).
any system provided that it has a relatively fresh version of the operating
system (I test on MorphOS 3.12 and AmigaOS 4.1 FE Update 1).

AROS version requires i386 and ABI-v0.

Expand All @@ -40,8 +40,8 @@ Classic AmigaOS version requires a system with:
* ixemul V48 (http://aminet.net/package/util/libs/ixemul-48.0)
* 4MB RAM (unrar needs 2.6MB on its own)

Exact memory utilization depends on a size of compressed files. For instance
my test archive with one 2.0GB file in it, needs 32MB of RAM to unpack.
Exact memory utilization depends on the size of compressed files. For instance
my test archive with one 2.0GB file in it needs 32MB of RAM to unpack.


History:
Expand All @@ -50,7 +50,7 @@ History:
* based on unrar source code 5.9.2
* Russian locale added
* Spanish locale added
* stack size increased to 800KB in order to handle unpacks using recovery
* stack size increased to 800KB to handle unpacks using recovery
volumes in rar3 format (it needs more memory)
* unrar prints a warning when it finds chars not present in a target encoding
* if Charset/CODEPAGE/RAR_CODEPAGE is not set, unrar tries to set encoding
Expand Down Expand Up @@ -120,11 +120,11 @@ copy catalogs to locale:catalogs all

Note: MorphOS has its own unrar 3.90 in protected System:MorphOS/C direcory
that is used with higher priority than a file in c:unrar. And so if you want
to use the one from c: you need to call it explicitely, like this:
to use the one from c: you need to call it explicitly, like this:

c:unrar l my_archive.rar

To avaid this, you can also copy unrar to c:unrar5, and then call it as unrar5:
To avoid this, you can also copy unrar to c:unrar5, and then call it as unrar5:

copy unrar_mos to c:unrar5
unrar5 l my_archive.rar
Expand Down Expand Up @@ -163,17 +163,17 @@ Basic functions
---------------

All the basic functions like listing (verbose, base, technical),
unpacking (w/ or w/o path, selected files or all), testing or printing
unpacking (w/ or w/o path, selected files, or all), testing or printing
works fine. Note, that wherever a path is needed it has to be in amiga
format not POSIX i.e. //test.rar not ../../test.rar.
format, not POSIX i.e. //test.rar not ../../test.rar.

National characters support
---------------------------

RAR stores data in UTF-8 in an archive file, then reads it into Unicode
(wchar_t) and finally it uses it (print, create files, find files, ...)
(wchar_t) and finally, it uses it (print, create files, find files, ...)
in UTF-8. Unfortunately, no Amiga operating system supports UTF-8 today,
therefore in order to handle national characters in file names,
therefore to handle national characters in file names,
comments, etc. it needs to be converted to OS local encoding set in OS
prefs. Unrar reads what was set using environment variables:
* on MorphOS: CODEPAGE
Expand All @@ -183,18 +183,18 @@ prefs. Unrar reads what was set using environment variables:

Characters that cannot be converted, because are not present in selected
codepage, are replaced with '?'. That means that national characters are
fully supported but only for selected locale, i.e. if I have Polish
fully supported but only for the selected locale, i.e. if I have Polish
locale with ISO-8859-2 encoding and have a rar archive with Spanish
characters, they will not appear and will be replaced by '?'. That in
turns mean that some files may have the same names even if they are
different files. In that case only one will be unpacked. To deal with
different files. In that case, only one will be unpacked. To deal with
this, you can use special environment variable RAR_CODEPAGE that allows
overriding codepage (for both MorphOS and AmigaOS4) without changing
system prefs. For an example above, if you set RAR_CODEPAGE, you will
system prefs. For the example above, if you set RAR_CODEPAGE, you will
still not see Spanish characters (unless you have the right font) but at
least you should get all the files unpacked.

On AmigaOS3 and AmigaOS2, since there is no buit-in variable to determine
On AmigaOS3 and AmigaOS2, since there is no built-in variable to determine
system character encoding, you have to always use RAR_CODEPAGE. To make it
slightly simpler, if RAR_CODEPAGE is not set, unrar tries to set encoding
based on 'Language' environment variable.
Expand All @@ -205,33 +205,33 @@ encoding). If so, it will print a warning message, asking the user to
set RAR_CODEPAGE.


National characters in file names
National characters in filenames
---------------------------------

National characters in file names are handled as described above - this
National characters in filenames are handled as described above - this
covers:
* name of files, directories and links in an archive
* name of files, directories, and links in an archive
* targets for symbolic and hard links in an archive
* archive names given to unrar command
* archive names that were given to unrar command
* names in list files (if -sc option is not used)

Obviously, in order to see national characters in shell or when browsing
To see national characters in the shell or when browsing
unpacked files in Ambient/Workbench you need to have fonts with the
right encoding installed in OS and set as system font and/or as Ambient
fonts.

National characters in password
National characters in a password
-------------------------------

National characters are supported in passwords. A password can be given
in the following forms:
* from shell when asked
* from the shell when asked
* in command invocation using -p switch
* from RAR environment variable
* from rar.conf configuration file

In each of the case above, only passwords containing national characters
of currently selected locale are supported and should be given using
of the currently selected locale are supported and should be given using
locale encoding (as for file names described above). If the password is
not using current locale charset, RAR_CODEPAGE need to be used to select
it.
Expand Down Expand Up @@ -277,16 +277,16 @@ File modification dates

When unpacking, created files get modification date set as stored in RAR
archive. The date is set in the local time zone. As there is no special
attribute for creation and access dates in AmigaOS, these values are
attribute for the creation and access dates in AmigaOS, these values are
always ignored.

File owner and group
--------------------

When unpacking from RAR archive with option -ow, unrar will try to set
owner name and group. It will only succeed if a user with given name and
a group with given name is present in local system. Otherwise an error
will be printed. When -ow is not used, owner/group is ignored.
owner name and group. It will only succeed if a user with a given name and
a group with a given name is present in the local system. Otherwise,
an error will be printed. When -ow is not used, the owner/group is ignored.

Symbolic links in an archive
----------------------------
Expand All @@ -304,15 +304,15 @@ be converted (for instance ../test.txt need to be changed to /test.txt).
This unrar port does such conversion.

Note: unrar checks if a link is safe to create and will skip links
targeting outside of unpacking directory. In order to make it create
targeting outside of unpacking directory. To make it create
them, you need to use -ola switch when unpacking.

Hard links in an archive
------------------------

Hard links are supported in a similar way as symbolic links. Again, they
will only work if target filesystem supports hard links (SFS dos not).
Otherwise an error will be printed and hard link will be ignored. There
Hard links are supported similarly as symbolic links. Again, they
will only work if the target filesystem supports hard links (SFS dos not).
Otherwise, an error will be printed and hard links will be ignored. There
is no option in unrar that would allow the user to unpack hard links as
regular files or symbolic links - so if target filesystem does not
support hard links it is not possible to get them unpacked.
Expand All @@ -321,7 +321,7 @@ Reference files in an archive
-----------------------------

RAR can pack identical files as references inside of an archive - that
reduces size of the archive file. In order to make such archive -oi
reduces the size of the archive file. To make such archive -oi
switch should be used when packing. When unpacking, duplicates are
re-created as separate files. That is fully supported in this unrar
port.
Expand All @@ -330,25 +330,25 @@ NTFS Junction Points in an archive
----------------------------------

NTFS Junction Points are like symbolic links, but their target is always
absolute path with a drive letter in front. In Unrar version 5.7 for
an absolute path with a drive letter in front. In Unrar version 5.7 for
Unix-like systems (including Amiga) these kinds of links are always
skipped silently (!). While it is a different behavior from how it was
skipped silently (!). While it is different behavior from how it was
in 5.0, I decided to keep it unchanged for Amiga. So, in practice,
junction points are always skipped when unpacking.

Configuration file
------------------

Unrar has a config file in which you can store switches that will always
be used when unrar command is called. In order to do that, "switches="
be used when unrar command is called. To do that, "switches="
should be present in the file with all the switches to add (for instance
"switches=-ad -ola"). This port of unrar looks for configuration file in
s:rar.conf.
"switches=-ad -ola"). This port of unrar looks for the configuration file
in s:rar.conf.

There is also "RAR" environment variable that can have switches to use
(like a value of "switches=" in configuration file). The priority of
resolving switches to use is: directly given in command, RAR environment
variable, configuration file.
resolving switches to use is: directly given in the command, RAR environment
variable, the configuration file.

Support for localization
------------------------
Expand All @@ -362,13 +362,13 @@ Large files support
-------------------

On MorphOS and AmigaOS4 large files are supported in the following way:
* rar file can have size >4GiB
* a rar file can have size >4GiB
* a file expanded from a rar file may be bigger than 4GiB

The above is true provided that file system used for unpacking supports files
with size >4GiB.
OFS, FFS, PFS3, SFS and FAT32 do not support such files.
NTFS, exFAT and ext2/3/4 (on MorphOS) and SFS2 (on AmigaOS4) support large
The above is true provided that the file system used for unpacking supports
files with size >4GiB.
OFS, FFS, PFS3, SFS, and FAT32 do not support such files.
NTFS, exFAT, and ext2/3/4 (on MorphOS) and SFS2 (on AmigaOS4) support large
files.

Support for files >4GiB is currently not available on AROS, AmigaOS3 and
Expand Down Expand Up @@ -403,10 +403,10 @@ MorphOS version of unrar has been compiled using gcc 4.4.5 (part of SDK 3.14).

AmigaOS4 version of unrar has been compiled using gcc 4.2.4 (part of SDK 53.20).

AROS version of unrar has been compoled using gcc 4.6.4 (part of Icaros 2.2).
AROS version of unrar has been compiled using gcc 4.6.4 (part of Icaros 2.2).

AmigaOS3/AmigaOS2 version of unrar has been compiled using gcc 3.3 (part of
Cubic IDE).

All AmigaOS versions can also be created by crosscompiling using the same
All AmigaOS versions can also be created by cross-compiling using the same
compile versions as above from AmiDevCpp package.

0 comments on commit cc6a2b8

Please sign in to comment.