Ignore:
Timestamp:
Jan 13, 2010, 12:53:18 AM (10 years ago)
Author:
Sam Hocevar
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • zzuf/trunk/doc/zzcat.1.in

    r4244 r4246  
    33zzcat \- debugging tool for zzuf
    44.SH SYNOPSIS
    5 \fBzzcat\fR PROGRAM FILE
     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
    612.SH DESCRIPTION
    713.PP
    8 \fBzzcat\fR is a tool to read files using various strategies. It is
    9 primarily used as a debugging tool for \fBzzuf\fR.
     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.
    1019.SH USAGE
    1120.PP
    12 \fB    zzcat "fread(1,10000)" /dev/zero\fR
     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.
    1340.SH EXAMPLES
    1441.PP
     
    1946.SH AUTHOR
    2047.PP
    21 Copyright \(co 2002, 2007\-2010 Sam Hocevar <sam@hocevar.net>.
     48Copyright \(co 2002\-2010 Sam Hocevar <sam@hocevar.net>.
    2249.PP
    2350\fBzzcat\fR and this manual page are free software. They come without any
Note: See TracChangeset for help on using the changeset viewer.