Forgot to add dumpiso and sendiso man pages to repository, fixed.

git-svn-id: svn://svn.linux1394.org/libraw1394/trunk@67 53a565d1-3bb7-0310-b661-cf11e63c67ab
This commit is contained in:
aeb 2001-06-08 18:25:31 +00:00
parent 135babee19
commit e8e99d1b9f
2 changed files with 77 additions and 0 deletions

36
doc/dumpiso.1.in Normal file
View File

@ -0,0 +1,36 @@
.TH dumpiso 1 "libraw1394 @VERSION@" "" "Linux IEEE 1394"
.SH NAME
dumpiso \- dump IEEE 1394 isochronous channel packets
.SH SYNOPSIS
.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.
.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).
.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.
.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.
.TP
.B -h\fR,\fB --help
Show help text and exit.
.SH BUGS
None known.
.SH SEE ALSO
.B sendiso\fR(1)
.SH AUTHOR
Andreas Bombe <aeb@debian.org>

41
doc/sendiso.1.in Normal file
View File

@ -0,0 +1,41 @@
.TH sendiso 1 "libraw1394 @VERSION@" "" "Linux IEEE 1394"
.SH NAME
sendiso \- send IEEE 1394 isochronous packets from dump file
.SH SYNOPSIS
.B sendiso
[ \fIoptions\fR ] \fIFILE\fR
.SH DESCRIPTION
sendiso takes the dump file \fIFILE\fR as generated by \fBdumpiso\fR(1),
extracts the packets and sends them as they were received (in the same order,
with the same channel numbers) as fast as possible - timing of the original dump
is not preserved.
.PP
This program does not allocate any isochronous resources but just starts
sending. It should not be used in live environments where it might interfere
with properly set up isochronous transmissions, it is a debug and performance
benchmarking tool.
.SH OPTIONS
.TP
.B -l\fR,\fB --loop=\fICOUNT
Send dump file \fICOUNT\fR times. Defaults to 1.
.TP
.B -i\fR,\fB --infinite
Send dump file in an endless loop.
.TP
.B -s\fR,\fB --speed=\fISPEED
Send packets at speed \fISPEED\fR, which can be given as 100, 200 and 400 (in
Mbit/s) or abbreviated as 1, 2 and 4. Defaults to 100.
.TP
.B -p\fR,\fB --port=\fIPORT
Choose port \fIPORT\fR for sending. 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 dumpiso\fR(1)
.SH AUTHOR
Andreas Bombe <aeb@debian.org>