861b1be906fca228189e2601f8853ed561bc872f
[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 .\" $DragonFly: src/usr.sbin/timed/timedc/timedc.8,v 1.2 2003/06/17 04:30:03 dillon Exp $
35 .\"
36 .Dd June 6, 1993
37 .Dt TIMEDC 8
38 .Os
39 .Sh NAME
40 .Nm timedc
41 .Nd timed control program
42 .Sh SYNOPSIS
43 .Nm
44 .Op Ar command Op Ar argument ...
45 .Sh DESCRIPTION
46 The
47 .Nm
48 utility is used to control the operation of the
49 .Xr timed 8
50 program.
51 It may be used to:
52 .Bl -bullet
53 .It
54 Measure the differences between machines' clocks,
55 .It
56 Find the location where the master time server is running,
57 .It
58 Enable or disable tracing of messages received by
59 .Xr timed 8 ,
60 and
61 .It
62 Perform various debugging actions.
63 .El
64 .Pp
65 Without any arguments,
66 .Nm
67 will prompt for commands from the standard input.
68 If arguments are supplied,
69 .Nm
70 interprets the first argument as a command and the remaining
71 arguments as parameters to the command.  The standard input
72 may be redirected causing
73 .Nm
74 to read commands from a file.
75 Commands may be abbreviated;
76 recognized commands are:
77 .Pp
78 .Bl -tag -width Ds -compact
79 .It Ic \&? Op Ar command ...
80 .Pp
81 .It Ic help Op Ar command ...
82 Print a short description of each command specified in the argument list,
83 or, if no arguments are given, a list of the recognized commands.
84 .Pp
85 .It Ic clockdiff Ar host ...
86 Compute the differences between the clock of the host machine
87 and the clocks of the machines given as arguments.
88 .Pp
89 .It Ic msite Op Ar host ...
90 Show the master time server for specified host(s).
91 .Pp
92 .It Xo
93 .Ic trace
94 .Li \&{ Ar on Li \&|
95 .Ar off \&}
96 .Xc
97 Enable or disable the tracing of incoming messages to
98 .Xr timed
99 in the file
100 .Pa /var/log/timed.log .
101 .Pp
102 .It Ic election Ar host1 Op Ar host2 ...
103 Asks the daemon
104 on the target host to reset its "election" timers and to ensure that
105 a time master has been elected.
106 .Pp
107 .It Ic quit
108 Exit from timedc.
109 .El
110 .Pp
111 Other commands may be included for use in testing and debugging
112 .Xr timed 8 ;
113 the help command and
114 the program source may be consulted for details.
115 .Sh FILES
116 .Bl -tag -width /var/log/timed.masterlog -compact
117 .It Pa /var/log/timed.log
118 tracing file for timed
119 .It Pa /var/log/timed.masterlog
120 log file for master timed
121 .El
122 .Sh SEE ALSO
123 .Xr date 1 ,
124 .Xr adjtime 2 ,
125 .Xr icmp 4 ,
126 .Xr timed 8
127 .Rs
128 .%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
129 .%A R. Gusella
130 .%A S. Zatti
131 .Re
132 .Sh DIAGNOSTICS
133 .Bl -diag
134 .It ?Ambiguous command
135 abbreviation matches more than one command
136 .It ?Invalid command
137 no match found
138 .It ?Privileged command
139 command can be executed by root only
140 .El
141 .Sh HISTORY
142 The
143 .Nm
144 utility appeared in
145 .Bx 4.3 .