BSD 4_4 release

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

diff --git a/usr/src/usr.sbin/timed/timedc/timedc.8 b/usr/src/usr.sbin/timed/timedc/timedc.8
index 4de7e02..fd495e7 100644 (file)
--- a/usr/src/usr.sbin/timed/timedc/timedc.8
+++ b/usr/src/usr.sbin/timed/timedc/timedc.8
@@ -1,84 +1,145 @@
-
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\"    @(#)timedc.8    1.2 (Berkeley) %G%
+.\" 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.

 .\"
 .\"

-.TH TIMEDC 8 ""
-.UC 6
+.\" 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   8.1 (Berkeley) 6/6/93
+.\"
+.Dd June 6, 1993
+.Dt TIMEDC 8
+.Os BSD 4.3

 .ad
 .ad

-.SH NAME
-timedc \- timed control program
-.SH SYNOPSIS
-.B /etc/timedc
-[ command [ argument ... ] ]
-.SH DESCRIPTION
-.I Timedc
-is used to control the operation of the \fItimed\fP program.
+.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:
 It may be used to:

-.IP \(bu
-measure the differences between machines' clocks,
-.IP \(bu
-find the location where the master time server is running,
-.IP \(bu
-enable or disable tracing of messages received by \fItimed\fP, and
-.IP \(bu
-perform various debugging actions.
-.PP
+.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,
 Without any arguments,

-.I timedc
+.Nm timedc

 will prompt for commands from the standard input.
 If arguments are supplied,
 will prompt for commands from the standard input.
 If arguments are supplied,

-.IR timedc
+.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
 interprets the first argument as a command and the remaining
 arguments as parameters to the command.  The standard input
 may be redirected causing

-.I timedc
+.Nm timedc

 to read commands from a file.
 Commands may be abbreviated;
 recognized commands are:
 to read commands from a file.
 Commands may be abbreviated;
 recognized commands are:

-.TP
-? [ command ... ]
-.TP
-help [ command ... ]
-.br
+.Pp
+.Bl -tag -width Ds -compact
+.It Ic \&? Op Ar command ...
+.Pp
+.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.
 Print a short description of each command specified in the argument list,
 or, if no arguments are given, a list of the recognized commands.

-.TP
-clockdiff host ...
-.br
+.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.
 Compute the differences between the clock of the host machine
 and the clocks of the machines given as arguments.

-.TP
-trace { on | off }
-.br
-Enable or disable the tracing of incoming messages to \fItimed\fP
-in the file /usr/adm/timed.log.
-.TP
-quit
-.br
+.Pp
+.It Ic msite Op Ar host ...
+Show the master time server for specified host(s).
+.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 election Ar host
+Asks the daemon
+on the target host to reset its "election" timers and to ensure that
+a time master has been elected.
+.Pp
+.It Ic quit

 Exit from timedc.
 Exit from timedc.

-.PP
+.El
+.Pp

 Other commands may be included for use in testing and debugging
 Other commands may be included for use in testing and debugging

-.IR timed ;
+.Xr timed ;

 the help command and
 the program source may be consulted for details.
 the help command and
 the program source may be consulted for details.

-.SH FILES
-.nf
-.ta \w'/usr/adm/masterlog       'u
-/usr/adm/timed.log             tracing file for timed
-/usr/adm/timed.masterlog       log file for master timed
-.fi
-.SH "SEE ALSO"
-date(1), adjtime(2), icmp(4P), timed(8), 
-.br
-\fITSP: The Time Synchronization Protocol for UNIX 4.3BSD\fP, 
-R. Gusella and S. Zatti
-.SH DIAGNOSTICS
-.nf
-.ta \w'?Ambiguous command      'u
-?Ambiguous command     abbreviation matches more than one command
-?Invalid command       no match found
-?Privileged command    command can be executed by root only
-.fi
+.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 .