forked from svn2github/dotnetzip
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGettingStarted.htm
More file actions
234 lines (175 loc) · 6.81 KB
/
Copy pathGettingStarted.htm
File metadata and controls
234 lines (175 loc) · 6.81 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Getting Started</title>
<style type="text/css">
p,body,a,tr,td
{ font-family: Verdana, Arial, Helvetica; font-size: 10pt }
h1,h2,h3,h4,h5,h6
{ font-family: Verdana, Arial, Helvetica; font-weight: normal; font-style: normal; }
h1 { font-size: 20pt }
h2 { font-size: 18pt; font-weight:bold; color: navy }
h3 { font-size: 16pt; font-weight:bold; color: #483d8b }
h4 { font-size: 14pt; font-weight:bold; color:#C71585; margin-bottom:2px; }
</style>
</head>
<!-- @SortOrder 8 -->
<body>
<h1>Getting Started with DotNetZip</h1>
<p>This page describes how to get started using DotNetZip.</p>
<h2>Which download to choose?</h2>
<p>DotNetZip is free to use. You just need to download it and start using it. Different <a
href="http://dotnetzip.codeplex.com/Release/ProjectReleases.aspx">downloads
of DotNetZip are available</a>. Which one you choose depends on what
you want to do. </p>
<table border='1'>
<tr>
<td style='color:white;Background:Navy;'><strong>If your goal is...</strong></td>
<td style='color:white;Background:Navy;'><strong>Download this...</strong></td>
<td style='color:white;Background:Navy;'><strong>which contains...</strong></td>
</tr>
<tr>
<td>To read the documentation for the library and tools</td>
<td>DotNetZipLib-*.chm</td>
<td>a compiled helpfile containing all the documentation.</td>
</tr>
<tr>
<td>To build .NET, COM, or PowerShell apps that use the Zip
library.
</td>
<td>DotNetZipLib-DevKit-vx.x.zip</td>
<td>the signed DLLs for Zip and Zlib, for both the desktop and Compact
Framework; the XML Documentation file for intellisense; the
compiled help file (CHM); an MSI file that installs help into Visual Studio;
and the License.
</td>
</tr>
<tr>
<td>To modify or view the source code for the Zip & Zlib Libraries,
the setup (msi) project, or the examples. </td>
<td>DotNetzip-src-vx.x.x.x.zip</td>
<td>the VS2008 solution, containing a number of VS projects and the
source code for the library and various examples that use the
library. </td>
</tr>
<tr>
<td>To distribute .NET applications that use the Zip library, or if
you want to run a .NET application that depends on this library.
</td>
<td>DotNetZipLib-Runtime-vx.x.zip</td>
<td>the signed DLLs for Zip and Zlib, for both the desktop and Compact
Framework; and the License. This is a strict subset of the DevKit
download.
</td>
</tr>
<tr>
<td>To distribute .NET applications that use the Zip library, or if
you want to run a .NET application that depends on this library.
</td>
<td>DotNetZipLib-Runtime-vx.x.msi</td>
<td>an .MSI version of the Runtime release, containing signed DLLs for
Zip and Zlib, for both the desktop and Compact Framework; and the
License. </td>
</tr>
<tr>
<td>To create, read, or modify ZIP files from within a Windows GUI interface,
or from the command line, or from within batch files.
</td>
<td>DotNetZipUtils-v1.8.zip</td>
<td>a set of exe tools (command-line and GUI) that rely on the
DotNetZip library, to create and manage zip files. </td>
</tr>
<tr>
<td>To create, read, or modify ZIP files from within a Windows GUI interface,
or from the command line, or from within batch files.
</td>
<td>DotNetZipUtils-v1.8.msi</td>
<td>an .MSI version of the Utils download. This installs a set of exe
tools (command-line and GUI) that rely on the DotNetZip library,
to create and manage zip files. There's also an
uninstaller. </td> </tr>
</table>
<h2>Which DLL to use?</h2>
<p>When you are building an application that manipulates ZIP files, you
will want to use one of the binary releases of DotNetZip. These
releases include multiple distinct DLLs or assemblies. Which one should
you use? </p>
<p>The likely answer is: <em>Ionic.Zip.dll</em></p>
<p>That's the mainstream library, the full library, and it includes all the
capability of DotNetZip. The other DLLs are reduced in various ways, to suite particular requirements.
</p>
<p>For example, you may want a
smaller library, or you want to exclude the Self-Extracting capability, or
you only want the ZLIB capability. In these cases, you may want to choose a
different assembly.
</p>
<p>Here's a summary of the options.</p>
<table border='1'>
<tr>
<td style='color:white;Background:Navy;'><strong>Usage scenario</strong></td>
<td style='color:white;Background:Navy;'><strong>DLL</strong></td>
</tr>
<tr>
<td> Basic reading or writing of Zip files</td>
<td> Ionic.Zip.dll</td>
</tr>
<tr>
<td>raw block or stream compression using ZLIB, DEFLATE, or
GZip </td>
<td>Ionic.Zlib.dll</td>
</tr>
<tr>
<td>compression using the BZip2 algorithm</td>
<td>Ionic.BZip2.dll</td>
</tr>
<tr>
<td>Some combination of ZLIB/DEFLATE/GZIP compression, BZip2
compression, and reading or writing Zip
files </td>
<td>Ionic.Zip.dll</td>
</tr>
<tr>
<td>reading or writing Zip files on .NET Compact Framework </td>
<td>Ionic.Zip.CF.dll</td>
</tr>
<tr>
<td>ZLIB/DEFLATE/GZIP compression on .NET Compact Framework </td>
<td>Ionic.Zlib.CF.dll</td>
</tr>
<tr>
<td>compression using the BZip2 algorithm on .NET Compact Framework </td>
<td>Ionic.BZip2.CF.dll</td>
</tr>
<tr>
<td>Some combination of ZLIB/DEFLATE/GZIP compression, BZip2
compression, and reading or writing Zip
files on .NET CF</td>
<td>Ionic.Zip.CF.dll</td>
</tr>
<tr>
<td>reading or writing Zip files, but never creating a self-extracting
archive </td>
<td>Ionic.Zip.Reduced.dll</td>
</tr>
</table>
<p>There are also Silverlight versions of the Zlib, BZip2, and Zip
libraries. </p>
<p>
Never reference both Ionic.Zlib.dll and Ionic.Zip.dll in the same
application, or both Ionic.BZip2.dll and Ionic.Zip.dll. If your
application does both Zlib and Zip things, or both BZip2 and Zip
things, or all three, you need only add a reference to Ionic.Zip.dll.
Ionic.Zip.dll includes all the capability in Ionic.Zlib.dll and
Ionic.BZip2.dll. You always need to reference only a single Ionic
DLL, regardless whether you use Zlib or BZip2 or Zip or some
combination.
</p>
<p>
If you use COM, then you want to reference the main DLL,
Ionic.Zip.dll. If you install the DotNetZip Runtime library via the
.MSI installer, the correct DLL will automatically be installed and
registered for use with COM. If you don't use the .MSI
installer, you will have to perform these steps yourself. Consult the
documentation on using DotNetZip with COM for more information.
</p>
</body>
</html>