From: pirofti <pirofti@openbsd.org>
Date: Wed, 15 Jan 2014 11:01:46 +0000 (+0000)
Subject: Add documentation for the octrtc driver.
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=5f4a0d5ccd0bf7b5751e927edf4bf209834b87d9;p=openbsd

Add documentation for the octrtc driver.
---

diff --git a/share/man/man4/man4.octeon/Makefile b/share/man/man4/man4.octeon/Makefile
index 1026aaafe6b..4d4b379db6d 100644
--- a/share/man/man4/man4.octeon/Makefile
+++ b/share/man/man4/man4.octeon/Makefile
@@ -1,6 +1,6 @@
-#	$OpenBSD: Makefile,v 1.1 2013/10/24 21:20:11 pirofti Exp $
+#	$OpenBSD: Makefile,v 1.2 2014/01/15 11:01:46 pirofti Exp $
 
-MAN=	octrng.4
+MAN=	octrng.4 octrtc.4
 MANSUBDIR=octeon
 
 .include <bsd.prog.mk>
diff --git a/share/man/man4/man4.octeon/octrtc.4 b/share/man/man4/man4.octeon/octrtc.4
new file mode 100644
index 00000000000..569dac68feb
--- /dev/null
+++ b/share/man/man4/man4.octeon/octrtc.4
@@ -0,0 +1,62 @@
+.\"	$OpenBSD: octrtc.4,v 1.1 2014/01/15 11:01:46 pirofti Exp $
+.\"
+.\" Copyright (c) 2014 Paul Irofti <pirofti@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 $Mdocdate: January 15 2014 $
+.Dt OCTRTC 4 octeon
+.Os
+.Sh NAME
+.Nm octrtc
+.Nd time-of-day clock
+.Sh SYNOPSIS
+.Cd "octrtc* at mainbus?"
+.Sh DESCRIPTION
+The
+.Nm
+driver supports the low resolution DS1337 time-of-day clock found on some
+of the octeon models.
+The clock has a resolution of 1 second.
+.Pp
+The
+.Nm
+driver is used for getting and setting the system time.
+.Sh HARDWARE
+Supported models:
+.Bl -tag -width Ds -offset indent -compact
+.It D-Link DSR-500
+.It Portwell CAM-0100
+.El
+.Pp
+Known models missing a DS1377 clock:
+.Bl -tag -width Ds -offset indent -compact
+.It Ubiquiti Networks EdgeRouter Lite
+.El
+.Sh SEE ALSO
+.Xr intro 4 ,
+.Xr inittodr 9
+.Xr resettodr 9
+.Xr time 9
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 5.5 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Paul Irofti Aq Mt pirofti@openbsd.org .