]> the.earth.li Git - sersniff.git/blob - sersniff.8
Use socklen_t rather than int for the length of the socket address.
[sersniff.git] / sersniff.8
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH SERSNIFF 8 "July  9, 2001"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 sersniff \- a program to tunnel/sniff between 2 serial ports
20 .SH SYNOPSIS
21 .B sersniff
22 .RI [-h] [-i DEVICE ] [-o DEVICE] [-b BAUD] [-s] [-n] [-w USECS]
23 .SH DESCRIPTION
24 This manual page explains how to use the
25 .B sersniff
26 command.  
27 This manual page was written for the Debian GNU/Linux distribution
28 because the original program does not have a manual page.
29 .PP
30 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
31 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
32 .\" respectively.
33 \fBsersniff\fP is a program that...
34 .SH OPTIONS
35 A summary of options is included below.
36 .TP
37 .B \-h
38 Show summary of options.
39 .TP
40 .B \-i \fP\fUfile
41 Set the device to use for Port1. Default of /dev/ttyS0. If you want
42 to listen on a TCP port then use the format :port. If there's a / in
43 the string then it will always be treated as a device rather than a
44 port to listen on.
45 .TP
46 .B \-o \fP\fUfile
47 Set the device to use for Port2. Default of /dev/ttyS1. If you want
48 to connect to a TCP port then use the format host:port. Again if
49 there's a / in the string then it will always be treated as a device.
50 .TP
51 .B \-b \fP\fUbaud
52 Specify baud rate for serial connections. Defaults to 19200.
53 .TP
54 .B \-s
55 Make sersniff not copy data between the two ports - useful if a
56 Y cable is being used for serial port sniffing for example.
57 .TP
58 .B \-n
59 Don't do any port configuration.
60 .TP
61 .B \-w \fP\fUusecs
62 How many microsecs to wait before reporting a delay
63 .TP
64 .B \-x
65 Show hex characters instead of normal ASCII characters.
66 .B \-f
67 Specify the format string that should be used to print hex characters.
68 .SH AUTHOR
69 This manual page was written by Jeremy Lunn <jeremy@austux.net>,
70 for the Debian GNU/Linux system (but may be used by others).