.\"	$OpenBSD: mdoc.template,v 1.6 2001/02/03 08:22:44 niklas Exp $
.\"
.\" The following requests are required for all man pages.
.Dd April 13, 2001
.Dt vomit 1
.Os
.Sh NAME
.Nm vomit
.Nd converts an IP phone conversation into a wave filee
.Sh SYNOPSIS
.\" For a program:  program [-abc] file ...
.Nm vomit
.Op Fl h
.Op Fl d Ar dev
.Op Fl p Ar wavfile
.Op Fl r Ar file
.Op Ar filter
.Sh DESCRIPTION
The
.Nm
utility converts a G.711 conversation into a wave file that can be
played with ordinary sound players. G.711 is used by Cisco IP Phones
and Microsoft Netmeeting.  The conversation can either be played
directly from the network or from a
.Xr tcpdump 8
output file.
.Pp
The options are as follows:
.Bl -tag -width Ds_tests
.It Fl h
Displays a short help for the command line options
.It Fl d Ar dev
Specifies the network device from which packets should be read.
.It Fl p Ar wavfile
Specified a wavfile that can be inserted into an ongoing phone
conversation on the network.
The wavfile must have a sample rate of 8 Khz and 16 bit samples.
.It Fl r Ar file
Instead of reading packets from the network, the packets are
read from a 
.Xr tcpdump 8
dump file.
.It Ar filter
A valid
.Xr pcap 3
filter that determines which packets contain a phone
conversation.
.El
.Pp
The
.Nm
utility is meant as a network debugging tool, and should
be used only in accordance to your local laws. The playback
is initiated by hitting return.  Instead of just hitting
return, it is possible to type the packets that should
be skipped and the delay in milli seconds between playback
packets.  The values have to be comma separated.
.Pp
Vomit uses
.Tn libevent
to simplify asynchronous event handling.  You can find the
source code for that library at
.Bd -literal
    http://www.monkey.org/~provos/libevent/
.Ed
.\" The following requests should be uncommented and used where appropriate.
.Sh EXAMPLES
.Bd -literal
vomit -r phone.dump | waveplay -S 8000 -B 16 -C 1
.Ed
.Pp
Plays back the phone conversation that has been captured in the dump file
.Fa phone.dump .
.\" This next request is for sections 2 and 3 function return values only.
.\" .Sh RETURN VALUES
.\" The next request is for sections 2 and 3 error and signal handling only.
.Sh ERRORS
.Nm
works only for protocols that use G.711.
.Pp
The public version does not support directly reading from the network
or rewriting packet streams.
.\" This next request is for section 4 only.
.\" .Sh DIAGNOSTICS
.\" This next request is for sections 1, 6, 7 & 8 only.
.\" .Sh ENVIRONMENT
.\" .Sh FILES
.\" .Sh SEE ALSO
.\" .Xr foobar 1
.\" .Sh COMPATIBILITY
.\" .Sh STANDARDS
.Sh ACKNOWLEDGMENTS
This program contains wave file interpreting code from waveplay by
Y.Sonoda, ulaw conversion code from Sun Microsystems and some
pcap code from Dug Song.
.Pp

.Sh AUTHORS
The
.Nm
utility has been developed by Niels Provos.
.\" .Sh HISTORY
.\" .Sh BUGS
.\" .Sh CAVEATS