bc: remove an extra quote
[linux_from_scratch.git] / BOOK / chapter08 / gzip.xml
blob5040f2e0bec0fde0ce6070c99a94e983401cb709
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4   <!ENTITY % general-entities SYSTEM "../general.ent">
5   %general-entities;
6 ]>
8 <sect1 id="ch-system-gzip" role="wrap">
9   <?dbhtml filename="gzip.html"?>
11   <sect1info condition="script">
12     <productname>gzip</productname>
13     <productnumber>&gzip-version;</productnumber>
14     <address>&gzip-url;</address>
15   </sect1info>
17   <title>Gzip-&gzip-version;</title>
19   <indexterm zone="ch-system-gzip">
20     <primary sortas="a-Gzip">Gzip</primary>
21   </indexterm>
23   <sect2 role="package">
24     <title/>
26     <para>The Gzip package contains programs for compressing and decompressing
27     files.</para>
29     <segmentedlist>
30       <segtitle>&buildtime;</segtitle>
31       <segtitle>&diskspace;</segtitle>
33       <seglistitem>
34         <seg>&gzip-fin-sbu;</seg>
35         <seg>&gzip-fin-du;</seg>
36       </seglistitem>
37     </segmentedlist>
39   </sect2>
41   <sect2 role="installation">
42     <title>Installation of Gzip</title>
44     <para>Prepare Gzip for compilation:</para>
46 <screen><userinput remap="configure">./configure --prefix=/usr</userinput></screen>
48     <para>Compile the package:</para>
50 <screen><userinput remap="make">make</userinput></screen>
52     <para>To test the results, issue:</para>
54 <screen><userinput remap="test">make check</userinput></screen>
56     <para>Install the package:</para>
58 <screen><userinput remap="install">make install</userinput></screen>
60     <para>Move a program that needs to be on the root filesystem:</para>
62 <screen><userinput remap="install">mv -v /usr/bin/gzip /bin</userinput></screen>
64   </sect2>
66   <sect2 id="contents-gzip" role="content">
67     <title>Contents of Gzip</title>
69     <segmentedlist>
70       <segtitle>Installed programs</segtitle>
72       <seglistitem>
73         <seg>gunzip, gzexe, gzip, uncompress (hard link with gunzip), zcat, zcmp, 
74         zdiff, zegrep, zfgrep, zforce, zgrep, zless, zmore, and znew</seg>
75       </seglistitem>
76     </segmentedlist>
78     <variablelist>
79       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
80       <?dbfo list-presentation="list"?>
81       <?dbhtml list-presentation="table"?>
83       <varlistentry id="gunzip">
84         <term><command>gunzip</command></term>
85         <listitem>
86           <para>Decompresses gzipped files</para>
87           <indexterm zone="ch-system-gzip gunzip">
88             <primary sortas="b-gunzip">gunzip</primary>
89           </indexterm>
90         </listitem>
91       </varlistentry>
93       <varlistentry id="gzexe">
94         <term><command>gzexe</command></term>
95         <listitem>
96           <para>Creates self-decompressing executable files</para>
97           <indexterm zone="ch-system-gzip gzexe">
98             <primary sortas="b-gzexe">gzexe</primary>
99           </indexterm>
100         </listitem>
101       </varlistentry>
103       <varlistentry id="gzip">
104         <term><command>gzip</command></term>
105         <listitem>
106           <para>Compresses the given files using Lempel-Ziv (LZ77) coding</para>
107           <indexterm zone="ch-system-gzip gzip">
108             <primary sortas="b-gzip">gzip</primary>
109           </indexterm>
110         </listitem>
111       </varlistentry>
113       <varlistentry id="uncompress">
114         <term><command>uncompress</command></term>
115         <listitem>
116           <para>Decompresses compressed files</para>
117           <indexterm zone="ch-system-gzip uncompress">
118             <primary sortas="b-uncompress">uncompress</primary>
119           </indexterm>
120         </listitem>
121       </varlistentry>
123       <varlistentry id="zcat">
124         <term><command>zcat</command></term>
125         <listitem>
126           <para>Decompresses the given gzipped files to standard output</para>
127           <indexterm zone="ch-system-gzip zcat">
128             <primary sortas="b-zcat">zcat</primary>
129           </indexterm>
130         </listitem>
131       </varlistentry>
133       <varlistentry id="zcmp">
134         <term><command>zcmp</command></term>
135         <listitem>
136           <para>Runs <command>cmp</command> on gzipped files</para>
137           <indexterm zone="ch-system-gzip zcmp">
138             <primary sortas="b-zcmp">zcmp</primary>
139           </indexterm>
140         </listitem>
141       </varlistentry>
143       <varlistentry id="zdiff">
144         <term><command>zdiff</command></term>
145         <listitem>
146           <para>Runs <command>diff</command> on gzipped files</para>
147           <indexterm zone="ch-system-gzip zdiff">
148             <primary sortas="b-zdiff">zdiff</primary>
149           </indexterm>
150         </listitem>
151       </varlistentry>
153       <varlistentry id="zegrep">
154         <term><command>zegrep</command></term>
155         <listitem>
156           <para>Runs <command>egrep</command> on gzipped files</para>
157           <indexterm zone="ch-system-gzip zegrep">
158             <primary sortas="b-zegrep">zegrep</primary>
159           </indexterm>
160         </listitem>
161       </varlistentry>
163       <varlistentry id="zfgrep">
164         <term><command>zfgrep</command></term>
165         <listitem>
166           <para>Runs <command>fgrep</command> on gzipped files</para>
167           <indexterm zone="ch-system-gzip zfgrep">
168             <primary sortas="b-zfgrep">zfgrep</primary>
169           </indexterm>
170         </listitem>
171       </varlistentry>
173       <varlistentry id="zforce">
174         <term><command>zforce</command></term>
175         <listitem>
176           <para>Forces a <filename class="extension">.gz</filename> extension on
177           all given files that are gzipped files, so that <command>gzip</command>
178           will not compress them again; this can be useful when file names were
179           truncated during a file transfer</para>
180           <indexterm zone="ch-system-gzip zforce">
181             <primary sortas="b-zforce">zforce</primary>
182           </indexterm>
183         </listitem>
184       </varlistentry>
186       <varlistentry id="zgrep">
187         <term><command>zgrep</command></term>
188         <listitem>
189           <para>Runs <command>grep</command> on gzipped files</para>
190           <indexterm zone="ch-system-gzip zgrep">
191             <primary sortas="b-zgrep">zgrep</primary>
192           </indexterm>
193         </listitem>
194       </varlistentry>
196       <varlistentry id="zless">
197         <term><command>zless</command></term>
198         <listitem>
199           <para>Runs <command>less</command> on gzipped files</para>
200           <indexterm zone="ch-system-gzip zless">
201             <primary sortas="b-zless">zless</primary>
202           </indexterm>
203         </listitem>
204       </varlistentry>
206       <varlistentry id="zmore">
207         <term><command>zmore</command></term>
208         <listitem>
209           <para>Runs <command>more</command> on gzipped files</para>
210           <indexterm zone="ch-system-gzip zmore">
211             <primary sortas="b-zmore">zmore</primary>
212           </indexterm>
213         </listitem>
214       </varlistentry>
216       <varlistentry id="znew">
217         <term><command>znew</command></term>
218         <listitem>
219           <para>Re-compresses files from <command>compress</command> format to
220           <command>gzip</command> format&mdash;<filename
221           class="extension">.Z</filename> to <filename
222           class="extension">.gz</filename></para>
223           <indexterm zone="ch-system-gzip znew">
224             <primary sortas="b-znew">znew</primary>
225           </indexterm>
226         </listitem>
227       </varlistentry>
229     </variablelist>
231   </sect2>
233 </sect1>