summaryrefslogtreecommitdiffstats
path: root/doc/dumpiso.1.in
diff options
context:
space:
mode:
authorGravatar aeb 2001-06-11 11:23:00 +0000
committerGravatar aeb 2001-06-11 11:23:00 +0000
commit609968669979823f0b2fdf08b43eab8e38f8dec6 (patch)
treeb68968e5f6e995505ee8ab96e3a93d7f7ae72ff2 /doc/dumpiso.1.in
parentForgot to add dumpiso and sendiso man pages to repository, fixed. (diff)
Added man page describing format of the iso dump file.
git-svn-id: svn://svn.linux1394.org/libraw1394/trunk@68 53a565d1-3bb7-0310-b661-cf11e63c67ab
Diffstat (limited to 'doc/dumpiso.1.in')
-rw-r--r--doc/dumpiso.1.in32
1 files changed, 17 insertions, 15 deletions
diff --git a/doc/dumpiso.1.in b/doc/dumpiso.1.in
index b2ced09..2412dcf 100644
--- a/doc/dumpiso.1.in
+++ b/doc/dumpiso.1.in
@@ -5,32 +5,34 @@ dumpiso \- dump IEEE 1394 isochronous channel packets
.B dumpiso
[ \fIoptions\fR ] [ \fIFILE\fR ]
.SH DESCRIPTION
-dumpiso listens on a selected range of channels and dumps all received packets
-into the file \fIFILE\fR or, if not given, to standard output. While dumping,
-the current number of received packets is written to standard error and updated
-with every packet.
+dumpiso listens on a selected range of channels and dumps all received
+packets into the file \fIFILE\fR or, if not given, to standard output.
+While dumping, the current number of received packets is written to
+standard error and updated with every packet.
.PP
-It uses a simple file format for the dumps, described in another man page yet to
-be written. The dumped packets can be sent out again with \fBsendiso\fR(1).
+It uses a simple file format for the dumps which is described in
+\fBisodump\fR(5). The dumped packets can be sent out again with
+\fBsendiso\fR(1).
.SH OPTIONS
.TP
.B -c\fR,\fB --channels=\fICHANNELS
-Sets the channels to listen on. \fICHANNELS\fR can be either a single number,
-in which case this is the only channel to listen on, or a range of channels in
-the form X-Y. Channel numbers can range from 0 to 63. You can give this option
-multiple times, new channels are added to the list of already set channels.
-Defaults to all channels.
+Sets the channels to listen on. \fICHANNELS\fR can be either a single
+number, in which case this is the only channel to listen on, or a
+range of channels in the form X-Y. Channel numbers can range from 0
+to 63. You can give this option multiple times, new channels are
+added to the list of already set channels. Defaults to all channels.
.TP
.B -p\fR,\fB --port=\fIPORT
-Choose port \fIPORT\fR for receiving. A port is a 1394 card or chip and
-represents one connected bus, therefore this is only relevant when you have
-multiple of these. Defaults to 0.
+Choose port \fIPORT\fR for receiving. A port is a 1394 card or chip
+and represents one connected bus, therefore this is only relevant when
+you have multiple of these. Defaults to 0.
.TP
.B -h\fR,\fB --help
Show help text and exit.
.SH BUGS
None known.
.SH SEE ALSO
-.B sendiso\fR(1)
+.B sendiso\fR(1),
+.B isodump\fR(5)
.SH AUTHOR
Andreas Bombe <aeb@debian.org>