From: Harlan Stenn <stenn@ntp.org>
Date: Fri, 13 May 2011 09:08:53 +0000 (-0400)
Subject: Use our autogen templates if we have any
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f7482e9845aa44272feef757c9c74b0cf8d6f519;p=thirdparty%2Fntp.git

Use our autogen templates if we have any

bk: 4dccf5254vSGLQfcfARF5zzlLK9rFw
---

diff --git a/ChangeLog b/ChangeLog
index 2b87907f83..a1a836d5cd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,5 @@
+* If we have local overrides for autogen template files, use them.
+* Convert more of the sntp-opt.def documentation from man to mdoc.
 (4.2.7p165) 2011/05/11 Released by Harlan Stenn <stenn@ntp.org>
 * Convert snmp docs to mdoc format, which requires autogen 5.11.9.
 * from 4.2.6p4-RC1: Require autogen 5.11.9.
diff --git a/sntp/Makefile.am b/sntp/Makefile.am
index 0157c21d87..993baafaeb 100644
--- a/sntp/Makefile.am
+++ b/sntp/Makefile.am
@@ -21,7 +21,7 @@ LDADD += $(PTHREAD_LIBS)
 LDADD += $(LCRYPTO)
 
 run_ag =	cd $(srcdir) &&	env PATH="$(abs_builddir):$(PATH)"	\
-		autogen -L include --writable
+		autogen -L include -L ag-tpl --writable
 
 EXTRA_PROGRAMS = sntp
 
diff --git a/sntp/ag-tpl/agmdoc-cmd.tpl b/sntp/ag-tpl/agmdoc-cmd.tpl
new file mode 100644
index 0000000000..a67c3da81b
--- /dev/null
+++ b/sntp/ag-tpl/agmdoc-cmd.tpl
@@ -0,0 +1,115 @@
+[+: -*- Mode: nroff -*-
+
+  AutoGen5 template mdoc
+
+## agman-cmd.tpl -- Template for command line mdoc pages
+##
+## Time-stamp:      "2011-03-04 10:05:17 bkorb"
+##
+##  This file is part of AutoOpts, a companion to AutoGen.
+##  AutoOpts is free software.
+##  AutoOpts is Copyright (c) 1992-2011 by Bruce Korb - all rights reserved
+##
+##  AutoOpts is available under any one of two licenses.  The license
+##  in use must be one of these two and the choice is under the control
+##  of the user of the license.
+##
+##   The GNU Lesser General Public License, version 3 or later
+##      See the files "COPYING.lgplv3" and "COPYING.gplv3"
+##
+##   The Modified Berkeley Software Distribution License
+##      See the file "COPYING.mbsd"
+##
+##  These files have the following md5sums:
+##
+##  43b91e8ca915626ed3818ffb1b71248b COPYING.gplv3
+##  06a1a2e4760c90ea5e1dad8dfaac4d39 COPYING.lgplv3
+##  66a5cedaf62c4b2637025f049f9b826f COPYING.mbsd
+
+# Produce a man page for section 1, 5 or 8 commands.
+# Which is selected via:  -DMAN_SECTION=n
+# passed to the autogen invocation.  "n" may have a suffix, if desired.
+#
+:+][+:
+
+(define head-line (lambda() (string-append
+   ".Dd "   (shell "date '+%B %e %Y' | sed 's/  */ /g'")
+   "\n.Dt " UP-PROG-NAME " " man-sect " " section-name
+   "\n.Os " (shell "uname -sr") "\n") ))
+
+:+][+:
+
+INCLUDE "cmd-doc.tlib"
+
+:+]
+.Sh NAME
+.Nm [+: prog-name         :+]
+.Nd [+: prog-title        :+]
+[+:
+
+INVOKE build-doc          :+][+:
+
+(out-move (string-append (get "prog-name") "."
+          man-sect))      :+][+:#
+
+.\" = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
+.\"  S Y N O P S I S
+.\" = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = :+][+:
+
+DEFINE synopsis
+
+:+]
+.Sh SYNOPSIS
+.Nm [+:
+
+  IF (define use-flags  (exist? "flag.value"))
+     (define named-mode (not (or use-flags (exist? "long-opts") )))
+     use-flags
+                                            :+][+:
+    IF (exist? "long-opts")                 :+]
+.\" Mixture of short (flag) options and long options
+.Op Fl flags
+.Op Fl flag Ar value
+.Op Fl \-option-name Ar value[+:
+
+    ELSE no long options:                   :+]
+.Op Fl flags
+.Op Fl flag Ar value[+:
+    ENDIF                                               
+                                            :+][+:
+  ELIF (exist? "long-opts")                             
+                                            :+]
+.Op Fl \-option-name
+.Op Fl \-option-name Ar value[+:
+
+  ELIF  (not (exist? "argument"))           :+]
+.Op Ar option\-name Ar value
+.Pp
+All arguments are named options.[+:
+  ENDIF                                     :+][+:
+
+  IF (exist? "argument")                    :+][+:
+    argument                                :+][+:
+
+    IF (exist? "reorder-args")              :+]
+.Pp
+Operands and options may be intermixed.  They will be reordered.
+[+: ENDIF                                   :+][+:
+
+  ELIF (or (exist? "long-opts") use-flags) 
+
+:+]
+.Pp
+All arguments must be options.[+:
+
+  ENDIF                                     :+]
+.Pp
+[+:
+
+FOR explain   "\n.Pp\n"                     :+][+:
+  explain                                   :+][+:
+ENDFOR                                      :+][+:
+
+ENDDEF synopsis
+
+agmdoc-cmd.tpl ends here  :+]
diff --git a/sntp/sntp-opts.def b/sntp/sntp-opts.def
index 0d896b4540..2732091481 100644
--- a/sntp/sntp-opts.def
+++ b/sntp/sntp-opts.def
@@ -340,27 +340,31 @@ seconds.
 
 doc-section	= {
   ds-type	= 'USAGE';
-  ds-format	= 'man';
-  ds-text	= <<-  _END_MAN_DOC
-.SH USAGE
-The simplest use of this program is as an unprivileged command to check the
-current time and error in the local clock.  For example:
-.IP
-.B sntp ntpserver.somewhere
-.PP
-With suitable privilege, it can be run as a command or in a
-.I cron
-job to reset the local clock from a reliable server, like the
-.I ntpdate
-and
-.I rdate
-commands.  For example:
-.IP
-.B sntp -a ntpserver.somewhere
-.SH RETURN VALUE
+  ds-format	= 'mdoc';
+  ds-text	= <<-  _END_MDOC_USAGE
+.Bl -tag -width indent
+.It Li "sntp ntpserver.somewhere"
+is the simplest use of this program
+and can be run as an unprivileged command
+to check the current time and error in the local clock.
+.It Li "sntp -a ntpserver.somewhere"
+With suitable privilege,
+run as a command
+or from a
+.Xr cron 8
+job,
+.Ic "sntp -a"
+will reset the local clock from a synchronized specified server,
+like the (deprecated)
+.Xr ntpdate 8 ,
+or
+.Xr rdate 8
+commands.
+.El
+.Sh RETURN VALUE
 The program returns a zero exit
 status for success, and a non-zero one otherwise.
-.SH BUGS
+.Sh BUGS
 Please report bugs to http://bugs.ntp.org .
-	_END_MAN_DOC;
+	_END_MDOC_USAGE;
 };