Use ocamldoc in each directory.
[virt-df.git] / diskzip / diskzip.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "DISKZIP 1"
132 .TH DISKZIP 1 "2008-04-28" "virt-df-2.0.1" "Disk images"
133 .SH "NAME"
134 diskzip \- 
135 .SH "SUMMARY"
136 .IX Header "SUMMARY"
137 .SH "DESCRIPTION"
138 .IX Header "DESCRIPTION"
139 .SH "OPTIONS"
140 .IX Header "OPTIONS"
141 .IP "\fB\-\-version\fR" 4
142 .IX Item "--version"
143 Display version and exit.
144 .SH "SEE ALSO"
145 .IX Header "SEE ALSO"
146 \&\fIgzip\fR\|(1), \fIbzip2\fR\|(1),
147 <http://www.libvirt.org/ocaml/>,
148 <http://www.libvirt.org/>,
149 <http://et.redhat.com/~rjones/>,
150 <http://caml.inria.fr/>
151 .SH "AUTHORS"
152 .IX Header "AUTHORS"
153 Richard W.M. Jones <rjones @ redhat . com>
154 .SH "COPYRIGHT"
155 .IX Header "COPYRIGHT"
156 (C) Copyright 2007\-2008 Red Hat Inc., Richard W.M. Jones
157 http://libvirt.org/
158 .PP
159 This program is free software; you can redistribute it and/or modify
160 it under the terms of the \s-1GNU\s0 General Public License as published by
161 the Free Software Foundation; either version 2 of the License, or
162 (at your option) any later version.
163 .PP
164 This program is distributed in the hope that it will be useful,
165 but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
166 \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
167 \&\s-1GNU\s0 General Public License for more details.
168 .PP
169 You should have received a copy of the \s-1GNU\s0 General Public License
170 along with this program; if not, write to the Free Software
171 Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0 02139, \s-1USA\s0.
172 .SH "REPORTING BUGS"
173 .IX Header "REPORTING BUGS"
174 Bugs can be viewed on the Red Hat Bugzilla page:
175 <https://bugzilla.redhat.com/>.
176 .PP
177 If you find a bug in diskzip, please follow these steps to report it:
178 .IP "1. Check for existing bug reports" 4
179 .IX Item "1. Check for existing bug reports"
180 Go to <https://bugzilla.redhat.com/> and search for similar bugs.
181 Someone may already have reported the same bug, and they may even
182 have fixed it.
183 .IP "2. Capture debug and error messages" 4
184 .IX Item "2. Capture debug and error messages"
185 Run
186 .Sp
187 .Vb 1
188 \& diskzip --debug > diskzip.log 2>&1
189 .Ve
190 .Sp
191 and keep \fIdiskzip.log\fR.  It contains error messages which you should
192 submit with your bug report.
193 .IP "3. Get version of diskzip." 4
194 .IX Item "3. Get version of diskzip."
195 Run
196 .Sp
197 .Vb 1
198 \& diskzip --version
199 .Ve
200 .IP "4. Submit a bug report." 4
201 .IX Item "4. Submit a bug report."
202 Go to <https://bugzilla.redhat.com/> and enter a new bug.
203 Please describe the problem in as much detail as possible.
204 .Sp
205 Remember to include the version numbers (step 3) and the debug
206 messages file (step 2).
207 .IP "5. Assign the bug to rjones @ redhat.com" 4
208 .IX Item "5. Assign the bug to rjones @ redhat.com"
209 Assign or reassign the bug to \fBrjones @ redhat.com\fR (without the
210 spaces).  You can also send me an email with the bug number if you
211 want a faster response.