Imported Upstream version 9.20
[platform/upstream/7zip.git] / DOC / readme.txt
1 7-Zip 9.20 Sources\r
2 ------------------\r
3 \r
4 7-Zip is a file archiver for Windows. \r
5 \r
6 7-Zip Copyright (C) 1999-2010 Igor Pavlov.\r
7 \r
8 \r
9 License Info\r
10 ------------\r
11 \r
12 7-Zip is free software distributed under the GNU LGPL \r
13 (except for unRar code).\r
14 read License.txt for more infomation about license.\r
15 \r
16 Notes about unRAR license:\r
17 \r
18 Please check main restriction from unRar license:\r
19 \r
20    2. The unRAR sources may be used in any software to handle RAR\r
21       archives without limitations free of charge, but cannot be used\r
22       to re-create the RAR compression algorithm, which is proprietary.\r
23       Distribution of modified unRAR sources in separate form or as a\r
24       part of other software is permitted, provided that it is clearly\r
25       stated in the documentation and source comments that the code may\r
26       not be used to develop a RAR (WinRAR) compatible archiver.\r
27 \r
28 In brief it means:\r
29 1) You can compile and use compiled files under GNU LGPL rules, since \r
30    unRAR license almost has no restrictions for compiled files.\r
31    You can link these compiled files to LGPL programs.\r
32 2) You can fix bugs in source code and use compiled fixed version.\r
33 3) You can not use unRAR sources to re-create the RAR compression algorithm.\r
34 \r
35 \r
36 LZMA SDK\r
37 --------\r
38 \r
39 Also this package contains files from LZMA SDK\r
40 you can download LZMA SDK from this page:\r
41 http://www.7-zip.org/sdk.html\r
42 read about addtional licenses for LZMA SDK in file\r
43 DOC/lzma.txt\r
44 \r
45 \r
46 How to compile\r
47 --------------\r
48 To compile sources you need Visual C++ 6.0.\r
49 For compiling some files you also need \r
50 new Platform SDK from Microsoft' Site:\r
51 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/psdk-full.htm\r
52 or\r
53 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/XPSP2FULLInstall.htm\r
54 or\r
55 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/\r
56 \r
57 If you use MSVC6, specify SDK directories at top of directories lists:\r
58 Tools / Options / Directories\r
59   - Include files\r
60   - Library files\r
61 \r
62 \r
63 To compile 7-Zip for AMD64 and IA64 you need:\r
64   Windows Server 2003 SP1 Platform SDK from microsoft.com\r
65 \r
66 Also you need Microsoft Macro Assembler:\r
67   - ml.exe for x86 \r
68   - ml64.exe for AMD64\r
69 You can use ml.exe from Windows SDK for Windows Vista or some other version.\r
70 \r
71 \r
72 Compiling under Unix/Linux\r
73 --------------------------\r
74 Check this site for Posix/Linux version:\r
75 http://sourceforge.net/projects/p7zip/\r
76 \r
77 \r
78 Notes:\r
79 ------\r
80 7-Zip consists of COM modules (DLL files).\r
81 But 7-Zip doesn't use standard COM interfaces for creating objects.\r
82 Look at\r
83 7zip\UI\Client7z folder for example of using DLL files of 7-Zip. \r
84 Some DLL files can use other DLL files from 7-Zip.\r
85 If you don't like it, you must use standalone version of DLL.\r
86 To compile standalone version of DLL you must include all used parts\r
87 to project and define some defs. \r
88 For example, 7zip\Bundles\Format7z is a standalone version  of 7z.dll \r
89 that works with 7z format. So you can use such DLL in your project \r
90 without additional DLL files.\r
91 \r
92 \r
93 Description of 7-Zip sources package\r
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
95 \r
96 DOC                Documentation\r
97 ---\r
98   7zFormat.txt   - 7z format description\r
99   copying.txt    - GNU LGPL license\r
100   unRarLicense.txt - License for unRAR part of source code\r
101   history.txt    - Sources history\r
102   Methods.txt    - Compression method IDs\r
103   readme.txt     - Readme file\r
104   lzma.txt       - LZMA SDK description\r
105   7zip.nsi       - installer script for NSIS\r
106 \r
107 \r
108 C   - Source code in C\r
109 CPP - Source code in CPP\r
110 \r
111 Common            Common modules\r
112 Windows           Win32 wrappers\r
113 \r
114 7zip\r
115 -------\r
116   Common          Common modules for 7-zip\r
117 \r
118   Archive         7-Zip Archive Format Plugins \r
119   --------\r
120     Common\r
121     7z\r
122     Arj\r
123     BZip2\r
124     Cab\r
125     Cpio\r
126     GZip\r
127     Rar\r
128     Rpm            \r
129     Split\r
130     Tar\r
131     Zip\r
132 \r
133   Bundle          Modules that are bundles of other modules\r
134   ------\r
135     Alone         7za.exe: Standalone version of 7z\r
136     Alone7z       7zr.exe: Standalone version of 7z that supports only 7z/LZMA/BCJ/BCJ2\r
137     SFXCon        7zCon.sfx: Console 7z SFX module\r
138     SFXWin        7z.sfx: Windows 7z SFX module\r
139     SFXSetup      7zS.sfx: Windows 7z SFX module for Installers\r
140     Format7z            7za.dll:  .7z support\r
141     Format7zExtract     7zxa.dll: .7z support, extracting only\r
142     Format7zR           7zr.dll:  .7z support, LZMA/BCJ* only\r
143     Format7zExtractR    7zxr.dll: .7z support, LZMA/BCJ* only, extracting only\r
144     Format7zF           7z.dll:   all formats\r
145 \r
146   UI\r
147   --\r
148     Agent         Intermediary modules for FAR plugin and Explorer plugin\r
149     Console       7z.exe Console version\r
150     Explorer      Explorer plugin\r
151     Resource      Resources\r
152     Far           FAR plugin  \r
153     Client7z      Test application for 7za.dll \r
154 \r
155   Compress\r
156   --------\r
157     BZip2        BZip2 compressor\r
158     Branch       Branch converter\r
159     ByteSwap     Byte Swap converter\r
160     Copy         Copy coder\r
161     Deflate       \r
162     Implode\r
163     Arj\r
164     LZMA\r
165     PPMd          Dmitry Shkarin's PPMdH with small changes.\r
166     LZ            Lempel - Ziv\r
167 \r
168   Crypto          Crypto modules\r
169   ------\r
170     7zAES         Cipher for 7z\r
171     AES           AES Cipher\r
172     Rar20         Cipher for Rar 2.0\r
173     RarAES        Cipher for Rar 3.0\r
174     Zip           Cipher for Zip\r
175 \r
176   FileManager       File Manager\r
177 \r
178 \r
179 ---\r
180 Igor Pavlov\r
181 http://www.7-zip.org\r