Convert to mdoc format. Document missing flags.

usr.sbin/xntpd/doc/tickadj.8

@@ -1,143 +1,124 @@
-''' $Id$
-''' 
-.de Sh
-.br
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp
-.if t .sp .5v
-.if n .sp
-..
-.de Ip
-.br
-.ie \\n.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-'''
-'''     Set up \*(-- to give an unbreakable dash;
-'''     string Tr holds user defined translation string.
-'''     Greek uppercase omega is used as a dummy character.
-'''
-.tr \(*W-|\(bv\*(Tr
-.ie n \{\
-.ds -- \(*W-
-.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-.ds L" ""
-.ds R" ""
-.ds L' '
-.ds R' '
-'br\}
-.el\{\
-.ds -- \(em\|
-.tr \*(Tr
-.ds L" ``
-.ds R" ''
-.ds L' `
-.ds R' '
-'br\}
-.TH TICKADJ 8 LOCAL
-.SH NAME
-tickadj - fiddle time\-related variables in the kernel
-.SH SYNOPSIS
-.B tickadj
-[
-.B -Aqs
-] [
-.B -a
-.I new_tickadj
-] [
-.B -t
-.I new_tick
-]
-.SH DESCRIPTION
+.\"	$Id: tickadj.8,v 1.4 1997/02/22 16:14:18 peter Exp $
+.\"
+.Dd December 21, 1993
+.Dt TICKADJ 8
+.Os
+.Sh NAME
+.Nm tickadj
+.Nd fiddle time\-related variables in the kernel
+.Sh SYNOPSIS
+.Nm tickadj
+.Op Fl Adkpqs
+.Op Fl a Ar new_tickadj
+.Op Fl t Ar new_tick
+.Sh DESCRIPTION
 The
-.I tickadj
+.Nm
 program reads, and optionally modifies, several time\-keeping\-related
 variables in the running kernel, via
-.IR /dev/kmem .
+.Pa /dev/kmem .
 The particular variables it is concerned with are
-.IR tick ,
+.Em tick ,
 which is the number of microseconds added to the system time during a
 clock interrupt,
-.IR tickadj ,
+.Em tickadj ,
 which sets the slew rate and resolution used by the
-.IR adjtime (2)
+.Xr adjtime 2
 system call, and
-.IR dosynctodr ,
+.Em dosynctodr ,
 which indicates to the kernels on some machines whether they should internally
 adjust the system clock to keep it in line with time\-of\-day clock
 or not.
-.PP
+.Pp
 By default, with no arguments,
-.I tickadj
+.Nm
 reads the variables of interest in the kernel and prints them.  At the
-same time it determines an \*(L"optimal\*(R" value for the value of the
-.I tickadj
+same time it determines an
+.Qq optimal
+value for the value of the
+.Em tickadj
 variable if the intent is to run the
-.IR xntpd (8)
+.Xr xntpd 8
 Network Time Protocol daemon, and prints this as well.  Since the operation
 of
-.I tickadj
+.Nm
 when reading the kernel mimics the operation of similar parts of the
-.IR xntpd (8)
+.Xr xntpd 8
 program fairly closely, this is useful for doing debugging of problems
 with
-.IR xntpd (8).
-.PP
+.Xr xntpd 8 Ns .
+.Pp
 Various flags may be specified to change the variables of interest in
-the running kernel.  The
-.B -a
-flag allows one to set the variable
-.I tickadj
-to the value specified as an argument.  The
-.B -A
-flag will also cause
-.I tickadj
+the running kernel:
+.Bl -tag -width indent
+.It Fl a Ar new_tickadj
+Allow one to set the variable
+.Em tickadj
+to the value specified as an argument.
+.It Fl A
+Cause
+.Em tickadj
 to be modified, but instead will set it to the internally computed
-\*(L"optimal\*(R" value.  The
-.B -t
-flag may be used to reset the kernel's value of
-.IR tick ,
-a capability which is useful on machines with very broken clocks.  The
-.B -s
-flag tells the program to set the value of the variable
-.I dosynctodr
+.Qq optimal
+value.
+.It Fl d
+Add debugging information.
+.It Fl k
+Use
+.Pa /dev/kmem
+instead of
+.Pa /kernel .
+This is the default.
+.It Fl p
+Tell
+.Nm
+to set the value of the variable
+.Em noprintf
+to one.
+.It Fl q
+Tell
+.Nm
+to shut up about everything except errors. Normally
+.Nm
+is quite verbose about what it is doing.
+.It Fl s
+Tell
+.Nm
+to set the value of the variable
+.Em dosynctodr
 to zero, a prerequisite for running the
-.IR xntpd (8)
-daemon under SunOS 4.0.  Normally
-.I tickadj
-is quite verbose about what it is doing.  The
-.B -q
-flag tells it to shut up about everything except errors.
-.PP
+.Xr xntpd 8
+daemon under SunOS 4.0.
+.It Fl t Ar new_tick
+May be used to reset the kernel's value of
+.Em tick ,
+a capability which is useful on machines with very broken clocks.
+.El
+.Pp
 Note that
-.I tickadj
+.Nm
 should be run with some caution when being used for the first time on
 different types of machines.  The operations which
-.I tickadj
+.Nm
 trys to perform are not guaranteed to work on all Unix machines.
-.SH FILES
-.nf
-/vmunix
-/unix
-/dev/kmem
-.fi
-.SH SEE ALSO
-xntpd(8)
-.SH HISTORY
-Written by Dennis Ferguson at the University of Toronto
-.SH BUGS
+.Sh FILES
+.Bl -tag -width /dev/kmem -compact
+.It Pa /kernel
+.It Pa /dev/kmem
+.El
+.Sh SEE ALSO
+.Xr xntpd 8
+.Sh HISTORY
+Written by
+.An Dennis Ferguson
+at the University of Toronto.
+.Sh BUGS
 Fiddling with kernel variables at run time as a part of ordinary
 operations is a hideous practice which is only necessary to make
 up for deficiencies in the implementation of
-.IR adjtime (8)
+.Xr adjtime 8
 in many kernels and/or brokenness of the system clock in some
 vendors' kernels.  It would be much better if the kernels were fixed
 and the
-.I tickadj
+.Nm
 program went away.