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