summaryrefslogtreecommitdiff
path: root/sbin/nmeaattach/nmeaattach.8
diff options
context:
space:
mode:
Diffstat (limited to 'sbin/nmeaattach/nmeaattach.8')
-rw-r--r--sbin/nmeaattach/nmeaattach.886
1 files changed, 86 insertions, 0 deletions
diff --git a/sbin/nmeaattach/nmeaattach.8 b/sbin/nmeaattach/nmeaattach.8
new file mode 100644
index 00000000000..a8f4a64c6dc
--- /dev/null
+++ b/sbin/nmeaattach/nmeaattach.8
@@ -0,0 +1,86 @@
+.\" $OpenBSD: nmeaattach.8,v 1.1 2006/07/04 05:31:54 mbalmer Exp $
+.\"
+.\" Copyright (c) 2006 Marc Balmer <mbalmer@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd June 12, 2006
+.Dt NMEAATTACH 8
+.Os
+.Sh NAME
+.Nm nmeaattach
+.Nd attach serial lines as timedelta sensors
+.Sh SYNOPSIS
+.Nm nmeaattach
+.Op Fl dhm
+.Op Fl s Ar baudrate
+.Ar device
+.Sh DESCRIPTION
+.Nm
+is used to designate a serial line with a NMEA 0183 device as a source of
+timedelta sensors.
+The following operands are supported by
+.Nm nmeaattach :
+.Bl -tag -width Ar
+.It Fl d
+Do not daemonize.
+.It Fl h
+Turn on RTS/CTS flow control.
+By default, no flow control is done.
+.It Fl m
+Maintain modem control signals after closing the line.
+Specifically, this disables HUPCL.
+.It Fl s Ar baudrate
+Specifies the speed of the connection.
+If not specified, the default of 4800 baud is used.
+.It Fl t Ar cond
+Chooses the condition which will cause the current system
+time to be immediately copied to the terminal timestamp storage.
+Only one can be used.
+.Bl -tag -width DCDXX
+.It dcd
+Copy the timestamp when DCD is asserted.
+.It !dcd
+Copy the timestamp when DCD is deasserted.
+.It cts
+Copy the timestamp when CTS is asserted.
+.It !cts
+Copy the timestamp when CTS is deasserted.
+.El
+.Pp
+If no condition is specified, the
+.Xr nmea 4
+line discipline will timestamp on receiving the leading '$' character
+of each GPRMC sentence.
+.It Ar device
+Specifies the name of the serial line.
+.Ar device
+should be a string of the form
+.Dq cuaXX ,
+or
+.Dq /dev/cuaXX .
+.El
+.Pp
+Only the superuser may designate NMEA devices.
+.Pp
+To detach the interface, kill off the
+.Nm
+process.
+.Sh SEE ALSO
+.Xr nmea 4 ,
+.Xr tty 4
+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Ox 4.0 .