source: zzuf/trunk/doc/zzcat.1.in @ 4246

Last change on this file since 4246 was 4246, checked in by sam, 4 years ago

Improve zzcat documentation and add commandline flags, including --help
and --version.

File size: 1.7 KB
Line 
1.TH zzcat 1 "2010-01-07" "zzcat @PACKAGE_VERSION@"
2.SH NAME
3zzcat \- debugging tool for zzuf
4.SH SYNOPSIS
5\fBzzcat\fR [\fB\-x\fR \fIsequence\fR] [\fIFILE\fR]...
6.br
7\fBzzcat \-l\fR | \fB\-\-list\fR
8.br
9\fBzzcat \-h\fR | \fB\-\-help\fR
10.br
11\fBzzcat \-V\fR | \fB\-\-version\fR
12.SH DESCRIPTION
13.PP
14The \fBzzcat\fR utility reads files sequentially, writing them to the
15standard output. The user can decide which sequence of library calls is
16used to seek and read data.
17
18\fBzzcat\fR is primarily used as a debugging tool for \fBzzuf\fR.
19.SH USAGE
20.PP
21\fB    zzcat -x "fread(1,10000)" /dev/zero\fR
22.SH OPTIONS
23.TP
24\fB\-x\fR, \fB\-\-execute\fR=\fIsequence\fR
25Read a file or a stream using the instruction sequence specified in
26\fIsequence\fR.
27
28If no sequence is specified, the following default sequence is used:
29
30\fB    repeat(\-1, fgetc(), feof(1))
31.TP
32\fB\-l\fR, \fB\-\-list\fR
33Display the list of supported keywords and functions and exit.
34.TP
35\fB\-h\fR, \fB\-\-help\fR
36Display a short help message and exit.
37.TP
38\fB\-V\fR, \fB\-\-version\fR
39Output version information and exit.
40.SH EXAMPLES
41.PP
42To do.
43.SH SEE ALSO
44.PP
45\fBzzuf(3)\fR, \fBlibzzuf(3)\fR
46.SH AUTHOR
47.PP
48Copyright \(co 2002\-2010 Sam Hocevar <sam@hocevar.net>.
49.PP
50\fBzzcat\fR and this manual page are free software. They come without any
51warranty, to the extent permitted by applicable law. You can redistribute
52them and/or modify them under the terms of the Do What The Fuck You Want
53To Public License, Version 2, as published by Sam Hocevar. See
54\fBhttp://sam.zoy.org/wtfpl/COPYING\fR for more details.
55.PP
56\fBzzuf\fR's webpage can be found at \fBhttp://caca.zoy.org/wiki/zzuf\fR.
57An overview of the architecture and inner works is at
58\fBhttp://caca.zoy.org/wiki/zzuf/internals\fR.
Note: See TracBrowser for help on using the repository browser.