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