usr.sbin/timed/timedc/timedc.8

   1 .\"     $NetBSD: timedc.8,v 1.12 2007/02/04 21:17:01 cbiere Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1991 Regents of the University of California.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)timedc.8    8.1 (Berkeley) 6/6/93
  31 .\"
  32 .Dd February 2, 2007
  33 .Dt TIMEDC 8
  34 .Os
  35 .Sh NAME
  36 .Nm timedc
  37 .Nd timed control program
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Ar command Op Ar argument ...
  41 .Sh DESCRIPTION
  42 .Nm
  43 is used to control the operation of the
  44 .Xr timed 8
  45 program.
  46 It may be used to:
  47 .Bl -bullet
  48 .It
  49 Measure the differences between machines' clocks,
  50 .It
  51 Find the location where the master time server is running,
  52 .It
  53 Enable or disable tracing of messages received by
  54 .Xr timed 8 ,
  55 and
  56 .It
  57 Perform various debugging actions.
  58 .El
  59 .Pp
  60 Without any arguments,
  61 .Nm
  62 will prompt for commands from the standard input.
  63 If arguments are supplied,
  64 .Nm
  65 interprets the first argument as a command and the remaining
  66 arguments as parameters to the command.  The standard input
  67 may be redirected causing
  68 .Nm
  69 to read commands from a file.
  70 Commands may be abbreviated;
  71 recognized commands are:
  72 .Pp
  73 .Bl -tag -width Ds -compact
  74 .It Ic \&? Op Ar command ...
  75 .Pp
  76 .It Ic help Op Ar command ...
  77 Print a short description of each command specified in the argument list,
  78 or, if no arguments are given, a list of the recognized commands.
  79 .Pp
  80 .It Ic clockdiff Ar host ...
  81 Compute the differences between the clock of the host machine
  82 and the clocks of the machines given as arguments.
  83 .Pp
  84 .It Ic msite Op Ar host ...
  85 Show the master time server for specified host(s).
  86 .Pp
  87 .It Ic trace Li \&{ Ar on Li \&| Ar off Li \&}
  88 Enable or disable the tracing of incoming messages to
  89 .Xr timed 8
  90 in the file
  91 .Pa /var/log/timed.log .
  92 .Pp
  93 .It Ic election Ar host
  94 Asks the daemon
  95 on the target host to reset its
  96 .Dq election
  97 timers and to ensure that a time master has been elected.
  98 .Pp
  99 .It Ic quit
 100 Exit from timedc.
 101 .El
 102 .Pp
 103 Other commands may be included for use in testing and debugging
 104 .Xr timed 8 ;
 105 the help command and
 106 the program source may be consulted for details.
 107 .Sh FILES
 108 .Bl -tag -width /var/log/timed.masterlog -compact
 109 .It Pa /var/log/timed.log
 110 tracing file for timed
 111 .It Pa /var/log/timed.masterlog
 112 log file for master timed
 113 .El
 114 .Sh DIAGNOSTICS
 115 .Bl -tag -width Ds -compact
 116 .It ?Ambiguous command
 117 abbreviation matches more than one command
 118 .It ?Invalid command
 119 no match found
 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 HISTORY
 132 The
 133 .Nm
 134 command appeared in
 135 .Bx 4.3 .