xref: /freebsd-12.1/usr.sbin/timed/timedc/timedc.8 (revision b560ec42)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)timedc.8	8.1 (Berkeley) 6/6/93
29.\" $FreeBSD$
30.\"
31.Dd June 6, 1993
32.Dt TIMEDC 8
33.Os
34.Sh NAME
35.Nm timedc
36.Nd timed control program
37.Sh SYNOPSIS
38.Nm
39.Op Ar command Op Ar argument ...
40.Sh DESCRIPTION
41The
42.Nm
43utility is used to control the operation of the
44.Xr timed 8
45program.
46It may be used to:
47.Bl -bullet
48.It
49Measure the differences between machines' clocks,
50.It
51Find the location where the master time server is running,
52.It
53Enable or disable tracing of messages received by
54.Xr timed 8 ,
55and
56.It
57Perform various debugging actions.
58.El
59.Pp
60Without any arguments,
61.Nm
62will prompt for commands from the standard input.
63If arguments are supplied,
64.Nm
65interprets the first argument as a command and the remaining
66arguments as parameters to the command.
67The 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 host1 Op Ar host2 ...
99Asks the daemon
100on the target host to reset its "election" timers and to ensure that
101a time master has been elected.
102.Pp
103.It Ic quit
104Exit from timedc.
105.El
106.Pp
107Other commands may be included for use in testing and debugging
108.Xr timed 8 ;
109the help command and
110the program source may be consulted for details.
111.Sh FILES
112.Bl -tag -width /var/log/timed.masterlog -compact
113.It Pa /var/log/timed.log
114tracing file for timed
115.It Pa /var/log/timed.masterlog
116log file for master timed
117.El
118.Sh DIAGNOSTICS
119.Bl -diag
120.It ?Ambiguous command
121abbreviation matches more than one command
122.It ?Invalid command
123no match found
124.It ?Privileged command
125command can be executed by root only
126.El
127.Sh SEE ALSO
128.Xr date 1 ,
129.Xr adjtime 2 ,
130.Xr icmp 4 ,
131.Xr timed 8
132.Rs
133.%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
134.%A R. Gusella
135.%A S. Zatti
136.Re
137.Sh HISTORY
138The
139.Nm
140utility appeared in
141.Bx 4.3 .
142.Pp
143The latest
144.Nm
145code has been made available as a port (net/timed) in preparation of removal
146from base in
147.Fx 13.0 .
148