[pkg-ntp-maintainers] Bug#450721: ntp: manpage typos: tickadj:ttimekeeping; ntpq:ntpqwill

Fri Nov 9 16:55:48 UTC 2007

Package: ntp
Version: 1:4.2.4p4+dfsg-2
Severity: minor
Tags: patch
File: /usr/share/man/man8/tickadj.8.gz
File: /usr/share/man/man1/ntpq.1.gz

These files should really be split into multiple lines; the
recommendation from VCS is to start each sentence on a new line.

--- /usr/share/man/man8/tickadj.8.gz
+++ -	2007-11-09 11:50:02.426175312 -0500
@@ -1,12 +1,12 @@
 .\" transcribed from ntp 4.2.2p3
-.TH TICKADJ 8 "October 7, 2006" "Network Time Protocol"
+.TH TICKADJ 8 "November 9, 2007" "Network Time Protocol"
 .SH NAME
 tickadj \- set time-related kernel variables
 .SH SYNOPSIS
 .B tickadj
 [ -Aqs ] [ -a \fItickadj\fR ] [ -t \fItick\fR ]
 .SH DESCRIPTION
-The tickadj program reads, and optionally modifies, several timekeeping-related variables in older kernels that do not have support for precision ttimekeeping, including HP-UX, SunOS, Ultrix, SGI and probably others. Those machines provide means to patch the kernel /dev/kmem. Newer machines with precision time support, including Solaris, Tru64, FreeBSD and Linux (with PPSkit patch) should NOT use the program. The particular variables that can be changed with tickadj include tick, which is the number of microseconds added to the system time for a clock interrupt, tickadj, which sets the slew rate and resolution used by the adjtime system call, and 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.
+The tickadj program reads, and optionally modifies, several timekeeping-related variables in older kernels that do not have support for precision timekeeping, including HP-UX, SunOS, Ultrix, SGI and probably others. Those machines provide means to patch the kernel /dev/kmem. Newer machines with precision time support, including Solaris, Tru64, FreeBSD and Linux (with PPSkit patch) should NOT use the program. The particular variables that can be changed with tickadj include tick, which is the number of microseconds added to the system time for a clock interrupt, tickadj, which sets the slew rate and resolution used by the adjtime system call, and 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
 By default, with no arguments, tickadj reads the variables of interest in the kernel and displays them. At the same time, it determines an "optimal" value for the value of the tickadj variable if the intent is to run the ntpd Network Time Protocol (NTP) daemon, and prints this as well. Since the operation of tickadj when reading the kernel mimics the operation of similar parts of the ntpd program fairly closely, this can be useful when debugging problems with ntpd.
 .PP


--- /usr/share/man/man1/ntpq.1.gz
+++ -	2007-11-09 11:52:37.124257193 -0500
@@ -1,5 +1,5 @@
 .\" transcribed from ntp 4.2.2p3
-.TH NTPQ 1 "October 7, 2006" "Network Time Protocol"
+.TH NTPQ 1 "November 9, 2007" "Network Time Protocol"
 .SH NAME
 ntpq \- standard NTP query program
 .SH SYNOPSIS
@@ -10,7 +10,7 @@
 .PP
 The program can be run either in interactive mode or controlled using command line arguments. Requests to read and write arbitrary variables can be assembled, with raw and pretty-printed output options being available. The ntpq can also obtain and print a list of peers in a common format by sending multiple queries to the server.
 .PP
-If one or more request options is included on the command line when ntpq is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, ntpq will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. ntpqwill prompt for commands if the standard input is a terminal device.
+If one or more request options is included on the command line when ntpq is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, ntpq will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. ntpq will prompt for commands if the standard input is a terminal device.
 .PP
 ntpq uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. ntpq makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time.
 .PP
-------------- next part --------------
--- /usr/share/man/man8/tickadj.8.gz
+++ -	2007-11-09 11:50:02.426175312 -0500
@@ -1,12 +1,12 @@
 .\" transcribed from ntp 4.2.2p3
-.TH TICKADJ 8 "October 7, 2006" "Network Time Protocol"
+.TH TICKADJ 8 "November 9, 2007" "Network Time Protocol"
 .SH NAME
 tickadj \- set time-related kernel variables
 .SH SYNOPSIS
 .B tickadj
 [ -Aqs ] [ -a \fItickadj\fR ] [ -t \fItick\fR ]
 .SH DESCRIPTION
-The tickadj program reads, and optionally modifies, several timekeeping-related variables in older kernels that do not have support for precision ttimekeeping, including HP-UX, SunOS, Ultrix, SGI and probably others. Those machines provide means to patch the kernel /dev/kmem. Newer machines with precision time support, including Solaris, Tru64, FreeBSD and Linux (with PPSkit patch) should NOT use the program. The particular variables that can be changed with tickadj include tick, which is the number of microseconds added to the system time for a clock interrupt, tickadj, which sets the slew rate and resolution used by the adjtime system call, and 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.
+The tickadj program reads, and optionally modifies, several timekeeping-related variables in older kernels that do not have support for precision timekeeping, including HP-UX, SunOS, Ultrix, SGI and probably others. Those machines provide means to patch the kernel /dev/kmem. Newer machines with precision time support, including Solaris, Tru64, FreeBSD and Linux (with PPSkit patch) should NOT use the program. The particular variables that can be changed with tickadj include tick, which is the number of microseconds added to the system time for a clock interrupt, tickadj, which sets the slew rate and resolution used by the adjtime system call, and 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
 By default, with no arguments, tickadj reads the variables of interest in the kernel and displays them. At the same time, it determines an "optimal" value for the value of the tickadj variable if the intent is to run the ntpd Network Time Protocol (NTP) daemon, and prints this as well. Since the operation of tickadj when reading the kernel mimics the operation of similar parts of the ntpd program fairly closely, this can be useful when debugging problems with ntpd.
 .PP
-------------- next part --------------
--- /usr/share/man/man1/ntpq.1.gz
+++ -	2007-11-09 11:52:37.124257193 -0500
@@ -1,5 +1,5 @@
 .\" transcribed from ntp 4.2.2p3
-.TH NTPQ 1 "October 7, 2006" "Network Time Protocol"
+.TH NTPQ 1 "November 9, 2007" "Network Time Protocol"
 .SH NAME
 ntpq \- standard NTP query program
 .SH SYNOPSIS
@@ -10,7 +10,7 @@
 .PP
 The program can be run either in interactive mode or controlled using command line arguments. Requests to read and write arbitrary variables can be assembled, with raw and pretty-printed output options being available. The ntpq can also obtain and print a list of peers in a common format by sending multiple queries to the server.
 .PP
-If one or more request options is included on the command line when ntpq is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, ntpq will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. ntpqwill prompt for commands if the standard input is a terminal device.
+If one or more request options is included on the command line when ntpq is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, ntpq will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. ntpq will prompt for commands if the standard input is a terminal device.
 .PP
 ntpq uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. ntpq makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time.
 .PP
