[unix-history] / usr.sbin / timed / timedc / timedc.8

.\" Copyright (c) 1980, 1991 Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)timedc.8	6.6 (Berkeley) 3/16/91
.\"
.Dd March 16, 1991
.Dt TIMEDC 8
.Os BSD 4.3
.ad
.Sh NAME
.Nm timedc
.Nd timed control program
.Sh SYNOPSIS
.Nm timedc
.Oo Ar command\ \&
.Op Ar argument ...
.Oc
.Sh DESCRIPTION
.Nm Timedc
is used to control the operation of the
.Xr timed 8
program.
It may be used to:
.Bl -bullet
.It
Measure the differences between machines' clocks,
.It 
Find the location where the master time server is running,
.It
Enable or disable tracing of messages received by
.Xr timed ,
and
.It
Perform various debugging actions.
.El
.Pp
Without any arguments,
.Nm timedc
will prompt for commands from the standard input.
If arguments are supplied,
.Nm timedc
interprets the first argument as a command and the remaining
arguments as parameters to the command.  The standard input
may be redirected causing
.Nm timedc
to read commands from a file.
Commands may be abbreviated;
recognized commands are:
.Pp
.Bl -tag -width Ds -compact
.It Ic \&? Op Ar command ...
.It Ic help Op Ar command ...
Print a short description of each command specified in the argument list,
or, if no arguments are given, a list of the recognized commands.
.Pp
.It Ic clockdiff Ar host ...
Compute the differences between the clock of the host machine
and the clocks of the machines given as arguments.
.Pp
.It Xo
.Ic trace
.Li \&{ Ar on Li \&|
.Ar off \&}
.Xc
Enable or disable the tracing of incoming messages to
.Xr timed
in the file
.Pa /var/log/timed.log.
.Pp
.It Ic quit
Exit from timedc.
.El
.Pp
Other commands may be included for use in testing and debugging
.Xr timed ;
the help command and
the program source may be consulted for details.
.Sh FILES
.Bl -tag -width /var/log/timed.masterlog -compact
.It Pa /var/log/timed.log
tracing file for timed
.It Pa /var/log/timed.masterlog
log file for master timed
.El
.Sh SEE ALSO
.Xr date 1 ,
.Xr adjtime 2 ,
.Xr icmp 4 ,
.Xr timed 8 ,
.Rs
.%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
.%A R. Gusella
.%A S. Zatti
.Re
.Sh DIAGNOSTICS
.Bl -tag -width Ds -compact
.It ?Ambiguous command
abbreviation matches more than one command
.It ?Invalid command
no match found
.It ?Privileged command
command can be executed by root only
.El
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.3 .
Commit	Line	Data
15637ed4 RG	1	.\" Copyright (c) 1980, 1991 Regents of the University of California.
	2	.\" 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 6.6 (Berkeley) 3/16/91
	33	.\"
	34	.Dd March 16, 1991
	35	.Dt TIMEDC 8
	36	.Os BSD 4.3
	37	.ad
	38	.Sh NAME
	39	.Nm timedc
	40	.Nd timed control program
	41	.Sh SYNOPSIS
	42	.Nm timedc
	43	.Oo Ar command\ \&
	44	.Op Ar argument ...
	45	.Oc
	46	.Sh DESCRIPTION
	47	.Nm Timedc
	48	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 ,
	60	and
	61	.It
	62	Perform various debugging actions.
	63	.El
	64	.Pp
65	Without any arguments,
66	.Nm timedc
67	will prompt for commands from the standard input.
68	If arguments are supplied,
69	.Nm timedc
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 timedc
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	.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 Xo
89	.Ic trace
90	.Li \&{ Ar on Li \&\|
91	.Ar off \&}
92	.Xc
93	Enable or disable the tracing of incoming messages to
94	.Xr timed
95	in the file
96	.Pa /var/log/timed.log.
97	.Pp
98	.It Ic quit
99	Exit from timedc.
100	.El
101	.Pp
102	Other commands may be included for use in testing and debugging
103	.Xr timed ;
104	the help command and
105	the program source may be consulted for details.
106	.Sh FILES
107	.Bl -tag -width /var/log/timed.masterlog -compact
108	.It Pa /var/log/timed.log
109	tracing file for timed
110	.It Pa /var/log/timed.masterlog
111	log file for master timed
112	.El
113	.Sh SEE ALSO
114	.Xr date 1 ,
115	.Xr adjtime 2 ,
116	.Xr icmp 4 ,
117	.Xr timed 8 ,
118	.Rs
119	.%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
120	.%A R. Gusella
121	.%A S. Zatti
122	.Re
123	.Sh DIAGNOSTICS
124	.Bl -tag -width Ds -compact
125	.It ?Ambiguous command
126	abbreviation matches more than one command
127	.It ?Invalid command
128	no match found
129	.It ?Privileged command
130	command can be executed by root only
131	.El
132	.Sh HISTORY
133	The
134	.Nm
135	command appeared in
136	.Bx 4.3 .