During this season of giving, you can show your support for the NTP Project by making a donation to Network Time Foundation.
-- KapilaBogahapitiya - 28 Jun 2009

Ntp Autogen Usage {GSOC2010}

Overview

This page gives in depth instruction on how to write manual page using autogen. Using autogen to write manual pages allows to save time by reducing the repetitive tasks that usually does in writing manual page in man macro pagkage , mdoc macro package or texi macro package. Also you may be a programmer having knowledge about only one macro package. For example you may be familiar with man macro package or you may be familiar with mdoc macro package.Interesting thing with autogen is that it allows you to creat man manual pages in mdoc macros. it allows you to creat mdoc manula pages in mdoc macro package. This page is aimed at giving you good understanding on how to use this capability that autogen provide.

How to set your machine up for testing NTP commands.

How to set up your machine for using extened autegen for automated manual page generation is discussed here considering ntp.keys(5) command.I selected this command because, i am writting this document while doing my developments on ntp commands. But instructions on this page is applicable any other documentation automation task using autogen.

Given Table Depicit the commands which are automated through extended autogen.

Item Directory Option Processing Man Page
.ntprc ? N/A 5-Not started
ntp.audio ? N/A 5-Not started
ntp.conf ? N/A 5-Not started
ntp.keys ? N/A 5-Not started
ntp-keygen util Completed ?
ntpd ntpd Completed ?
ntpdsim ntpd Completed ?
ntpdate ntpdate Will be deprecated 1-N/A
ntpdc ntpdc Completed ?
ntpq ntpq Completed ?
ntptime util Not started ?
ntptrace scripts Not started ?
sntp sntp Pending Not started
tickadj util Not started Not started
timetrim util Not started Not started
refclock entries in /dev ? Not started 4-Not started

mdoc tags

Here is brief description of mdoc macro package.

mdoc package macros are categorized in to three types.

Page layout macros

- mdoc, page layout macros make up the page structure domain which consists of macros for titles, section headers,displays and lists - essentially items which affect the physical position of text on a formatted page.

General text domain macros

- The general text domain is defined as macros which perform tasks such as quoting or emphasizing pieces of text

Manual Domain Macros

- The manual domain is defined as macros that are a subset of the day to day informal language used to describe commands, routines and related UNIX files. Macros in the manual domain handle command names, command line arguments and options, function names, function parameters, pathnames, variables, cross references to other manual pages, and so on.

if you are using autogen to write manual page in mdoc macro package then it is not necessary to know about all the macros that mdoc macro package consist. This page gives you what are macros that you need to know and how you use them in autogen.

UsageExamples: ExamplesUsingManMacros

man tags

Related Items: ExamplesUsingManMacros

texi2mdoc

Related Items: Examples of Using texi2mdoc conversion

texi tags

Texinfo is a documentation system that uses a single source file to produce both online information and printed output. This means that instead of writing two different documents, one for the online information and the other for a printed work, you need write only one document. Therefore, when the work is revised, you need revise only that one document. Using autogen to create texinfo document allows you to save time by reducing the repetitive tasks that you do in writing texinfo file.

Related Items: ExamplesUsingtexiTags

General Notes

Harlan was talking to stickster on #fedora-docs at freenode (https://fedoraproject.org/wiki/PaulWFrields) who recommended docbook, and said that installing the tools on Fedora is Really Easy.

Other items we care about include:

Topic revision: r9 - 03 Aug 2010, KapilaBogahapitiya
Copyright © by the contributing authors.Use of this website indicates your agreement with, and acceptance of, the PrivacyPolicy, the WikiDisclaimer, and the PrivateWebPolicy.