contrib/ntp/scripts/calc_tickadj/calc_tickadj.man.in

   1 .de1 NOP
   2 .  it 1 an-trap
   3 .  if \\n[.$] \,\\$*\/
   4 ..
   5 .ie t \
   6 .ds B-Font [CB]
   7 .ds I-Font [CI]
   8 .ds R-Font [CR]
   9 .el \
  10 .ds B-Font B
  11 .ds I-Font I
  12 .ds R-Font R
  13 .TH calc_tickadj 1calc_tickadjman "27 Feb 2018" "ntp (4.2.8p11)" "User Commands"
  14 .\"
  15 .\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-mfaiQP/ag-zfaqPP)
  16 .\"
  17 .\" It has been AutoGen-ed February 27, 2018 at 10:49:40 AM by AutoGen 5.18.5
  18 .\" From the definitions calc_tickadj-opts.def
  19 .\" and the template file agman-cmd.tpl
  20 .SH NAME
  21 \f\*[B-Font]calc_tickadj\fP
  22 \- Calculates optimal value for tick given ntp drift file.
  23 .SH SYNOPSIS
  24 \f\*[B-Font]calc_tickadj\fP
  25 .\" Mixture of short (flag) options and long options
  26 [\f\*[B-Font]\-flags\f[]]
  27 [\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
  28 [\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
  29 .sp \n(Ppu
  30 .ne 2
  31
  32 All arguments must be options.
  33 .sp \n(Ppu
  34 .ne 2
  35
  36 .SH DESCRIPTION
  37 The \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal
  38 tick value. Generally, ntpd can do better job if the drift value is the
  39 smallest possible number.
  40 .sp
  41 The example output of
  42 .br
  43 .in +4
  44 .nf
  45 $ ./calc_tickadj
  46 81.699 (drift)
  47 9999 usec; 9999779 nsec
  48 $ cat /etc/ntp/drift
  49 -23.159
  50 .in -4
  51 .fi
  52 .sp
  53 means the following. If tick on that box is 10,000, by making the value 9999
  54 we'll shift the box from its current drift of \-23.159 to a drift of 81.699, and
  55 in doing so we'll speed the clock up a little every second instead of slowing
  56 the clock down a little.
  57 .sp
  58 If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift
  59 value will be somewhere around 0.0.
  60 .sp
  61 \fBcalc_tickadj\fP tries to determine the the tick value by using
  62 \fBtickadj\fP program from ntp package. If this doesn't work you can specify
  63 current tick manually on command line.
  64 .SH "OPTIONS"
  65 .TP
  66 .NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-drift\-file\f[]=\f\*[I-Font]string\f[]
  67 Ntp drift file to use.
  68 The default
  69 \f\*[I-Font]string\f[]
  70 for this option is:
  71 .ti +4
  72  /etc/ntp/drift
  73 .sp
  74 Use the specified drift file for calculations
  75 .TP
  76 .NOP \f\*[B-Font]\-t\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-tick\f[]=\f\*[I-Font]number\f[]
  77 Tick value of this host.
  78 This option takes an integer number as its argument.
  79 .sp
  80 The current tick which to adjustment will be calculated
  81 .TP
  82 .NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
  83 Display usage information and exit.
  84 .TP
  85 .NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
  86 Pass the extended usage information through a pager.
  87 .TP
  88 .NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]}]
  89 Output version of program and exit.  The default mode is `v', a simple
  90 version.  The `c' mode will print copyright information and `n' will
  91 print the full copyright notice.
  92 .PP
  93 .SH "EXIT STATUS"
  94 One of the following exit values will be returned:
  95 .TP
  96 .NOP 0 " (EXIT_SUCCESS)"
  97 Successful program execution.
  98 .TP
  99 .NOP 1 " (EXIT_FAILURE)"
 100 The operation failed or the command syntax was not valid.
 101 .TP
 102 .NOP 70 " (EX_SOFTWARE)"
 103 libopts had an internal operational error.  Please report
 104 it to autogen-users@lists.sourceforge.net.  Thank you.
 105 .PP
 106 .SH "NOTES"
 107 This manual page was \fIAutoGen\fP-erated from the \fBcalc_tickadj\fP
 108 option definitions.