xref: /netbsd-src/usr.sbin/timed/timedc/timedc.8 (revision 7fa608457b817eca6e0977b37f758ae064f3c99c)
1.\"	$NetBSD: timedc.8,v 1.12 2007/02/04 21:17:01 cbiere Exp $
2.\"
3.\" Copyright (c) 1980, 1991 Regents of the University of California.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"     @(#)timedc.8	8.1 (Berkeley) 6/6/93
31.\"
32.Dd February 2, 2007
33.Dt TIMEDC 8
34.Os
35.ad
36.Sh NAME
37.Nm timedc
38.Nd timed control program
39.Sh SYNOPSIS
40.Nm
41.Op Ar command Op Ar argument ...
42.Sh DESCRIPTION
43.Nm
44is used to control the operation of the
45.Xr timed 8
46program.
47It may be used to:
48.Bl -bullet
49.It
50Measure the differences between machines' clocks,
51.It
52Find the location where the master time server is running,
53.It
54Enable or disable tracing of messages received by
55.Xr timed 8 ,
56and
57.It
58Perform various debugging actions.
59.El
60.Pp
61Without any arguments,
62.Nm
63will prompt for commands from the standard input.
64If arguments are supplied,
65.Nm
66interprets the first argument as a command and the remaining
67arguments as parameters to the command.  The standard input
68may be redirected causing
69.Nm
70to read commands from a file.
71Commands may be abbreviated;
72recognized commands are:
73.Pp
74.Bl -tag -width Ds -compact
75.It Ic \&? Op Ar command ...
76.Pp
77.It Ic help Op Ar command ...
78Print a short description of each command specified in the argument list,
79or, if no arguments are given, a list of the recognized commands.
80.Pp
81.It Ic clockdiff Ar host ...
82Compute the differences between the clock of the host machine
83and the clocks of the machines given as arguments.
84.Pp
85.It Ic msite Op Ar host ...
86Show the master time server for specified host(s).
87.Pp
88.It Xo
89.Ic trace
90.Li \&{ Ar on Li \&|
91.Ar off \&}
92.Xc
93Enable or disable the tracing of incoming messages to
94.Xr timed 8
95in the file
96.Pa /var/log/timed.log .
97.Pp
98.It Ic election Ar host
99Asks the daemon
100on the target host to reset its
101.Dq election
102timers and to ensure that a time master has been elected.
103.Pp
104.It Ic quit
105Exit from timedc.
106.El
107.Pp
108Other commands may be included for use in testing and debugging
109.Xr timed 8 ;
110the help command and
111the program source may be consulted for details.
112.Sh FILES
113.Bl -tag -width /var/log/timed.masterlog -compact
114.It Pa /var/log/timed.log
115tracing file for timed
116.It Pa /var/log/timed.masterlog
117log file for master timed
118.El
119.Sh DIAGNOSTICS
120.Bl -tag -width Ds -compact
121.It ?Ambiguous command
122abbreviation matches more than one command
123.It ?Invalid command
124no match found
125.El
126.Sh SEE ALSO
127.Xr date 1 ,
128.Xr adjtime 2 ,
129.Xr icmp 4 ,
130.Xr timed 8
131.Rs
132.%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
133.%A R. Gusella
134.%A S. Zatti
135.Re
136.Sh HISTORY
137The
138.Nm
139command appeared in
140.Bx 4.3 .
141