[rpms/zerofree] epel10.2: Include zerofree(8) man page from Debian (RHBZ#596732).

[rpms/zerofree] epel10.2: Include zerofree(8) man page from Debian (RHBZ#596732).

[Richard W.M. Jones]

A new commit has been pushed.

Repo   : rpms/zerofree
Branch : epel10.2
Commit : 00ec4eeb70746637976cba0afd7400789e081299
Author : Richard W.M. Jones <rjones@fedoraproject.org>
Date   : 2010-05-27T13:32:41+00:00
Stats  : +242/-1 in 3 file(s)
URL    : https://src.fedoraproject.org/rpms/zerofree/c/00ec4eeb70746637976cba0afd7400789e081299?branch=epel10.2

Log:
Include zerofree(8) man page from Debian (RHBZ#596732).

---
diff --git a/zerofree.8 b/zerofree.8
new file mode 100644
index 0000000..b0be0d2
--- /dev/null
+++ b/zerofree.8
@@ -0,0 +1,65 @@
+.TH "ZEROFREE" "8" 
+.SH "NAME" 
+zerofree \(em zero free blocks from ext2/3 file-systems 
+.SH "SYNOPSIS" 
+.PP 
+\fBzerofree\fR [\fB-n\fP]  [\fB-v\fP]  \fIfilesystem\fR 
+.SH "DESCRIPTION" 
+.PP 
+\fBzerofree\fR finds the unallocated, 
+non-zeroed blocks in an ext2 or ext3 
+\fIfilesystem\fR (e.g. /dev/hda1) and 
+fills them with zeroes. This is useful if the device on which 
+this file-system resides is a disk image. In this case, 
+depending on the type of disk image, a secondary utility may be 
+able to reduce the size of the disk image after zerofree has 
+been run. 
+.PP 
+The usual way to achieve the same result (zeroing the 
+unallocated blocks) is to run \fBdd\fR (1) to 
+create a file full of zeroes that takes up the entire free 
+space on the drive, and then delete this file. This has many 
+disadvantages, which zerofree alleviates: 
+.IP "   \(bu" 6 
+it is slow; 
+.IP "   \(bu" 6 
+it makes the disk image (temporarily) grow to its maximal 
+extent; 
+.IP "   \(bu" 6 
+it (temporarily) uses all free space on the disk, so other 
+concurrent write actions may fail. 
+.PP 
+\fIfilesystem\fR has to be unmounted or 
+mounted read-only for \fBzerofree\fR to work. It 
+will exit with an error message if the 
+\fIfilesystem\fR is mounted writable. To 
+remount the root file-system readonly, you can first switch to 
+single user runlevel (\fBtelinit 1\fR) then use 
+\fBmount \-o remount,ro 
+\fIfilesystem\fR\fR. 
+.PP 
+\fBzerofree\fR has been written to be 
+run from GNU/Linux systems installed as guest OSes inside a 
+virtual machine. It may however be useful in other 
+situations. 
+.SH "OPTIONS" 
+.IP "\fB-n\fP         " 10 
+Perform a dry run  (do not modify the file-system); 
+.IP "\fB-v\fP         " 10 
+Be verbose. 
+.SH "SEE ALSO" 
+.PP 
+dd (1). 
+.SH "AUTHOR" 
+.PP 
+This manual page was written by Thibaut Paumard <paumard@users.sourceforge.net> for 
+the \fBDebian\fP system (but may be used by others).  Permission is 
+granted to copy, distribute and/or modify this document under 
+the terms of the GNU General Public License, Version 2 or any  
+later version published by the Free Software Foundation. 
+ 
+.PP 
+On Debian systems, the complete text of the GNU General Public 
+License can be found in /usr/share/common-licenses/GPL-2. 
+ 
+.\" created by instant / docbook-to-man, Wed 25 Nov 2009, 17:45 

diff --git a/zerofree.sgml b/zerofree.sgml
new file mode 100644
index 0000000..e5c43a3
--- /dev/null
+++ b/zerofree.sgml
@@ -0,0 +1,163 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+
+<!-- Process this file with docbook-to-man to generate an nroff manual
+     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
+     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
+     less'.
+  -->
+
+  <!ENTITY dhfirstname "<firstname>Thibaut</firstname>">
+  <!ENTITY dhsurname   "<surname>Paumard</surname>">
+  <!-- Please adjust the date whenever revising the manpage. -->
+  <!ENTITY dhdate      "<date>February 6, 2008</date>">
+  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
+  <!ENTITY dhemail     "<email>&lt;paumard@users.sourceforge.net&gt;</email>">
+  <!ENTITY dhusername  "Thibaut Paumard">
+  <!ENTITY dhucpackage "<refentrytitle>ZEROFREE</refentrytitle>">
+  <!ENTITY dhpackage   "zerofree">
+
+  <!ENTITY debian      "<productname>Debian</productname>">
+  <!ENTITY gnu         "<acronym>GNU</acronym>">
+  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
+]>
+
+<refentry>
+  <refentryinfo>
+    <address>
+      &dhemail;
+    </address>
+    <author>
+      &dhfirstname;
+      &dhsurname;
+    </author>
+    <copyright>
+      <year>2003</year>
+      <holder>&dhusername;</holder>
+    </copyright>
+    &dhdate;
+  </refentryinfo>
+  <refmeta>
+    &dhucpackage;
+
+    &dhsection;
+  </refmeta>
+  <refnamediv>
+    <refname>&dhpackage;</refname>
+
+    <refpurpose>zero free blocks from ext2/3 file-systems</refpurpose>
+  </refnamediv>
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+
+      <arg><option>-n</option></arg>
+
+      <arg><option>-v</option></arg>
+
+      <arg choice=req><replaceable>filesystem</replaceable></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para><command>&dhpackage;</command> finds the unallocated,
+       non-zeroed blocks in an ext2 or ext3
+       <replaceable>filesystem</replaceable> (e.g. /dev/hda1) and
+       fills them with zeroes. This is useful if the device on which
+       this file-system resides is a disk image. In this case,
+       depending on the type of disk image, a secondary utility may be
+       able to reduce the size of the disk image after zerofree has
+       been run.</para>
+
+    <para>The usual way to achieve the same result (zeroing the
+       unallocated blocks) is to run <command>dd</command> (1) to
+       create a file full of zeroes that takes up the entire free
+       space on the drive, and then delete this file. This has many
+       disadvantages, which zerofree alleviates:</para>
+    <itemizedlist>
+    <listitem><para>it is slow;</para></listitem>
+
+    <listitem><para>it makes the disk image (temporarily) grow to its maximal
+      extent;</para></listitem>
+
+    <listitem><para>it (temporarily) uses all free space on the disk, so other
+      concurrent write actions may fail.</para></listitem>
+
+    </itemizedlist>
+
+    <para><replaceable>filesystem</replaceable> has to be unmounted or
+    mounted read-only for <command>&dhpackage;</command> to work. It
+    will exit with an error message if the
+    <replaceable>filesystem</replaceable> is mounted writable. To
+    remount the root file-system readonly, you can first switch to
+    single user runlevel (<command>telinit 1</command>) then use
+    <command>mount -o remount,ro
+    <replaceable>filesystem</replaceable></command>.</para>
+
+    <para><command>&dhpackage;</command> has been written to be
+      run from GNU/Linux systems installed as guest OSes inside a
+      virtual machine. It may however be useful in other
+      situations.</para>
+
+  </refsect1>
+  <refsect1>
+    <title>OPTIONS</title>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>-n</option>
+        </term>
+        <listitem>
+          <para>Perform a dry run  (do not modify the file-system);</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-v</option>
+        </term>
+        <listitem>
+          <para>Be verbose.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+  <refsect1>
+    <title>SEE ALSO</title>
+
+    <para>dd (1).</para>
+
+  </refsect1>
+  <refsect1>
+    <title>AUTHOR</title>
+
+    <para>This manual page was written by &dhusername; &dhemail; for
+      the &debian; system (but may be used by others).  Permission is
+      granted to copy, distribute and/or modify this document under
+      the terms of the &gnu; General Public License, Version 2 or any 
+	  later version published by the Free Software Foundation.
+    </para>
+	<para>
+	  On Debian systems, the complete text of the GNU General Public
+	  License can be found in /usr/share/common-licenses/GPL-2.
+	</para>
+
+  </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
+
+

diff --git a/zerofree.spec b/zerofree.spec
index b19723a..25ca058 100644
--- a/zerofree.spec
+++ b/zerofree.spec
@@ -1,13 +1,21 @@
 Summary:        Utility to force unused ext2 inodes and blocks to zero
 Name:           zerofree
 Version:        1.0.1
-Release:        6%{?dist}
+Release:        7%{?dist}
 License:        GPL+
 Group:          System Environment/Libraries
 
 Source0:        http://intgat.tigress.co.uk/rmy/uml/%{name}-%{version}.tgz
 Source1:        http://intgat.tigress.co.uk/rmy/uml/sparsify.c
 Source2:        http://intgat.tigress.co.uk/rmy/uml/index.html
+
+# zerofree.sgml is the source for the man page from Debian.
+# Unfortunately we cannot build this in Fedora because of an apparent
+# bug in our DocBook tools.  Therefore I also include the generated
+# man page (generated on a Debian system from this source).
+Source3:        zerofree.sgml
+Source4:        zerofree.8
+
 URL:            http://intgat.tigress.co.uk/rmy/uml/
 
 BuildRequires:  e2fsprogs-devel
@@ -44,6 +52,7 @@ rm -rf $RPM_BUILD_ROOT
 
 install -D -p -m 755 zerofree $RPM_BUILD_ROOT%{_sbindir}/zerofree
 install -D -p -m 755 sparsify $RPM_BUILD_ROOT%{_sbindir}/sparsify
+install -D -p -m 644 %{SOURCE4} $RPM_BUILD_ROOT%{_mandir}/man8/zerofree.8
 
 
 %files
@@ -51,6 +60,7 @@ install -D -p -m 755 sparsify $RPM_BUILD_ROOT%{_sbindir}/sparsify
 %doc COPYING index.html
 %{_sbindir}/zerofree
 %{_sbindir}/sparsify
+%{_mandir}/man8/zerofree.8*
 
 
 %clean
@@ -58,6 +68,9 @@ rm -rf $RPM_BUILD_ROOT
 
 
 %changelog
+* Thu May 27 2010 Richard W.M. Jones <rjones@redhat.com> - 1.0.1-7
+- Include zerofree(8) man page from Debian (RHBZ#596732).
+
 * Mon Jul 27 2009 Fedora Release Engineering <rel-eng@lists.fedoraproject.org> - 1.0.1-6
 - Rebuilt for https://fedoraproject.org/wiki/Fedora_12_Mass_Rebuild