From: Harlan Stenn <stenn@ntp.org>
Date: Thu, 15 Oct 2009 11:15:55 +0000 (-0700)
Subject: sntp doc updates
X-Git-Tag: NTP_4_2_5P248_RC~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=354ff344e74cf269c6f5053e7d3eff099ef92fcf;p=thirdparty%2Fntp.git

sntp doc updates

bk: 4ad7046bUGDqIBXRHXY0vSIGiv3j9Q
---

diff --git a/sntp/Makefile.am b/sntp/Makefile.am
index 11d3d764f..858ec9304 100644
--- a/sntp/Makefile.am
+++ b/sntp/Makefile.am
@@ -48,6 +48,7 @@ sntp_SOURCES =		\
 EXTRA_DIST=	bincheck.mf	\
 		COPYRIGHT	\
 		sntp-opts.def sntp.1 sntp-opts.texi sntp-opts.menu	\
+		sntp.texi	\
 		$(NULL)
 OLD_EXTRA_DIST=		\
 		autogen-version.def version.def version.m4
diff --git a/sntp/sntp.texi b/sntp/sntp.texi
new file mode 100644
index 000000000..3833983c5
--- /dev/null
+++ b/sntp/sntp.texi
@@ -0,0 +1,84 @@
+\input texinfo    @c -*-texinfo-*-
+@c %**start of header
+@setfilename sntp.info
+@settitle Sntp User's Manual
+@include version.texi
+@paragraphindent 2
+@c %**end of header
+
+@ifinfo
+This file documents the use of the NTP Project's SNTP, a program for
+querying and setting the time.
+@end ifinfo
+
+@direntry
+* sntp: (sntp).                               Simple Network Time Protocol
+@end direntry
+
+@titlepage
+@title Simple Network Time Protocol User Manual
+@subtitle sntp, version @value{VERSION}, @value{UPDATED}
+@c @author Max @email{foo@ntp.org}
+@end titlepage
+
+@c @page
+@c @vskip 0pt plus 1filll
+
+@node Top, sntp Description, (dir), (dir)
+@top Simple Network Time Protocol User Manual
+
+This document describes the use of the NTP Project's sntp, a program
+that can be used to query a Network Time Protocol (NTP) server and
+display the time offset of the system clock relative to the server
+clock.  Run as root, it can correct the system clock to this offset as
+well.  It can be run as an interactive command or from a cron job.
+
+This document applies to version @value{VERSION} of sntp.
+
+The program implements the SNTP protocol as defined by the draft NTPv4
+IETF specification.
+
+@shortcontents
+
+@menu
+* sntp Description::            Description
+@include sntp-opts.menu
+* Usage::                       Usage
+@end menu
+
+@node sntp Description, Usage, Top, Top
+@comment  node-name,  next,  previous,  up
+@section Description
+
+By default, sntp writes the local data and time (i.e., not UTC) to the
+standard output in the format:
+
+@example
+1996 Oct 15 20:17:25.123 + 4.567 +/- 0.089 secs
+@end example
+
+where the + 4.567 +/- 0.089 secs indicates the time offset and
+error bound of the system clock relative to the server clock.
+
+@c @include sntp-opts.texi
+
+@node Usage,  , sntp Description, Top
+@comment  node-name,  next,  previous,  up
+@section Usage
+
+The simplest use of this program is as an unprivileged command to
+check the current time, offset, and error in the local clock.
+For example:
+
+@example
+sntp ntpserver.somewhere
+@end example
+
+With suitable privilege, it can be run as a command or in a
+@code{crom} job to reset the local clock from a reliable server, like
+the @code{ntpdate} and @code{rdate} commands.
+For example:
+
+@example
+sntp -a ntpserver.somewhere
+@end example