README.md
1<!---
2 Licensed to the Apache Software Foundation (ASF) under one or more
3 contributor license agreements. See the NOTICE file distributed with
4 this work for additional information regarding copyright ownership.
5 The ASF licenses this file to You under the Apache License, Version 2.0
6 (the "License"); you may not use this file except in compliance with
7 the License. You may obtain a copy of the License at
8
9 http://www.apache.org/licenses/LICENSE-2.0
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16-->
17<!---
18 +======================================================================+
19 |**** ****|
20 |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
21 |**** DO NOT EDIT DIRECTLY ****|
22 |**** ****|
23 +======================================================================+
24 | TEMPLATE FILE: readme-md-template.md |
25 | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
26 +======================================================================+
27 | |
28 | 1) Re-generate using: mvn commons:readme-md |
29 | |
30 | 2) Set the following properties in the component's pom: |
31 | - commons.componentid (required, alphabetic, lower case) |
32 | - commons.release.version (required) |
33 | |
34 | 3) Example Properties |
35 | |
36 | <properties> |
37 | <commons.componentid>math</commons.componentid> |
38 | <commons.release.version>1.2</commons.release.version> |
39 | </properties> |
40 | |
41 +======================================================================+
42--->
43Apache Commons Compress
44===================
45
46[](https://travis-ci.org/apache/commons-compress)
47[](https://coveralls.io/r/apache/commons-compress)
48[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-compress/)
49[](https://www.apache.org/licenses/LICENSE-2.0.html)
50
51Apache Commons Compress software defines an API for working with
52compression and archive formats. These include: bzip2, gzip, pack200,
53lzma, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4,
54Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.
55
56Documentation
57-------------
58
59More information can be found on the [Apache Commons Compress homepage](https://commons.apache.org/proper/commons-compress).
60The [Javadoc](https://commons.apache.org/proper/commons-compress/javadocs/api-release) can be browsed.
61Questions related to the usage of Apache Commons Compress should be posted to the [user mailing list][ml].
62
63Where can I get the latest release?
64-----------------------------------
65You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-compress/download_compress.cgi).
66
67Alternatively you can pull it from the central Maven repositories:
68
69```xml
70<dependency>
71 <groupId>org.apache.commons</groupId>
72 <artifactId>commons-compress</artifactId>
73 <version>1.18</version>
74</dependency>
75```
76
77Contributing
78------------
79
80We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
81There are some guidelines which will make applying PRs easier for us:
82+ No tabs! Please use spaces for indentation.
83+ Respect the code style.
84+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
85+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
86
87If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
88You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
89
90License
91-------
92This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
93
94See the `NOTICE.txt` file for required notices and attributions.
95
96Donations
97---------
98You like Apache Commons Compress? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
99
100Additional Resources
101--------------------
102
103+ [Apache Commons Homepage](https://commons.apache.org/)
104+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/COMPRESS)
105+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
106+ `#apache-commons` IRC channel on `irc.freenode.org`
107
108[ml]:https://commons.apache.org/mail-lists.html
109
README.txt
1Apache Commons Compress
2=======================
3
4Commons Compress is a Java library for working with various
5compression and archiving formats.
6
7For full documentation see https://commons.apache.org/proper/commons-compress/
8
9## Apache Commons Compress was derived from various sources, including:
10
11Original BZip2 classes contributed by Keiron Liddle
12<keiron@aftexsw.com>, Aftex Software to the Apache Ant project.
13They are based on a port of Julian Seward's libbzip2.
14
15Original Tar classes from contributors of the Apache Ant project.
16
17Original Zip classes from contributors of the Apache Ant project.
18
19Original CPIO classes contributed by Markus Kuss and the jRPM project
20(jrpm.sourceforge.net).
21
22This distribution includes cryptographic software. The country in
23which you currently reside may have restrictions on the import,
24possession, use, and/or re-export to another country, of encryption
25software. BEFORE using any encryption software, please check your
26country's laws, regulations and policies concerning the import,
27possession, or use, and re-export of encryption software, to see if
28this is permitted. See <http://www.wassenaar.org/> for more
29information.
30
31The U.S. Government Department of Commerce, Bureau of Industry and
32Security (BIS), has classified this software as Export Commodity
33Control Number (ECCN) 5D002.C.1, which includes information security
34software using or performing cryptographic functions with asymmetric
35algorithms. The form and manner of this Apache Software Foundation
36distribution makes it eligible for export under the License Exception
37ENC Technology Software Unrestricted (TSU) exception (see the BIS
38Export Administration Regulations, Section 740.13) for both object
39code and source code.
40
41The following provides more details on the included cryptographic
42software:
43 * the 7zip package can read AES encrypted archives
44
){kind=link}
){kind=link}
){kind=link}
){kind=link}