From: Jeremy Lunn <jeremy@austux.net>
Date: Wed, 29 Jun 2011 04:06:56 +0000 (-0700)
Subject: Add man page.
X-Git-Tag: sersniff-0.0.5~4
X-Git-Url: https://the.earth.li/gitweb/?p=sersniff.git;a=commitdiff_plain;h=c342e4845d0e07d61bdc0400798835bf487b31a8

Add man page.
---

diff --git a/sersniff.8 b/sersniff.8
new file mode 100644
index 0000000..97d012e
--- /dev/null
+++ b/sersniff.8
@@ -0,0 +1,70 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH SERSNIFF 8 "July  9, 2001"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+sersniff \- a program to tunnel/sniff between 2 serial ports
+.SH SYNOPSIS
+.B sersniff
+.RI [-h] [-i DEVICE ] [-o DEVICE] [-b BAUD] [-s] [-n] [-w USECS]
+.SH DESCRIPTION
+This manual page explains how to use the
+.B sersniff
+command.  
+This manual page was written for the Debian GNU/Linux distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
+.\" respectively.
+\fBsersniff\fP is a program that...
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.B \-h
+Show summary of options.
+.TP
+.B \-i \fP\fUfile
+Set the device to use for Port1. Default of /dev/ttyS0. If you want
+to listen on a TCP port then use the format :port. If there's a / in
+the string then it will always be treated as a device rather than a
+port to listen on.
+.TP
+.B \-o \fP\fUfile
+Set the device to use for Port2. Default of /dev/ttyS1. If you want
+to connect to a TCP port then use the format host:port. Again if
+there's a / in the string then it will always be treated as a device.
+.TP
+.B \-b \fP\fUbaud
+Specify baud rate for serial connections. Defaults to 19200.
+.TP
+.B \-s
+Make sersniff not copy data between the two ports - useful if a
+Y cable is being used for serial port sniffing for example.
+.TP
+.B \-n
+Don't do any port configuration.
+.TP
+.B \-w \fP\fUusecs
+How many microsecs to wait before reporting a delay
+.TP
+.B \-x
+Show hex characters instead of normal ASCII characters.
+.B \-f
+Specify the format string that should be used to print hex characters.
+.SH AUTHOR
+This manual page was written by Jeremy Lunn <jeremy@austux.net>,
+for the Debian GNU/Linux system (but may be used by others).