contrib/ntp/scripts/summary.1summarymdoc

   1 .Dd April 26 2016
   2 .Dt SUMMARY 1summarymdoc User Commands
   3 .Os
   4 .\"  EDIT THIS FILE WITH CAUTION  (summary-opts.mdoc)
   5 .\"
   6 .\"  It has been AutoGen-ed  April 26, 2016 at 08:25:09 PM by AutoGen 5.18.5
   7 .\"  From the definitions    summary-opts.def
   8 .\"  and the template file   agmdoc-cmd.tpl
   9 .Sh NAME
  10 .Nm summary
  11 .Nd compute various stastics from NTP stat files
  12 .Sh SYNOPSIS
  13 .Nm
  14 .Op Fl \-option\-name
  15 .Op Fl \-option\-name Ar value
  16 .Pp
  17 All arguments must be options.
  18 .Pp
  19 .Sh DESCRIPTION
  20 .sp
  21 .Sh "OPTIONS"
  22 .Bl -tag
  23 .It  Fl \-directory  Ns = Ns Ar string
  24 Directory containing stat files.
  25 The default
  26 .Ar string
  27 for this option is:
  28 .ti +4
  29  /var/log/ntp
  30 .sp
  31         The directory where \fBntpd\fP will search for .stat files generated
  32         by \fBntpd\fP.
  33 .It  Fl \-end\-date  Ns = Ns Ar number
  34 End date.
  35 This option takes an integer number as its argument.
  36 .sp
  37         Process all files with the date suffix less or equal to value of this
  38         option.  Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP)
  39         to get the timestamp.
  40 .It  Fl \-output\-directory  Ns = Ns Ar str
  41 Output directory.
  42 The default
  43 .Ar str
  44 for this option is:
  45 .ti +4
  46  /tmp
  47 .sp
  48         The output directory \fBsummary\fP will write all output files to.
  49 .It  Fl \-peer\-dist\-limit  Ns = Ns Ar float
  50 Peer dist limit.
  51 The default
  52 .Ar float
  53 for this option is:
  54 .ti +4
  55  400
  56 .sp
  57 .It  Fl \-skip\-time\-steps  Ns = Ns Ar float
  58 Ignore time offsets larger that this.
  59 The default
  60 .Ar float
  61 for this option is:
  62 .ti +4
  63  3600
  64 .sp
  65 .It  Fl \-start\-date  Ns = Ns Ar num
  66 Start date.
  67 This option takes an integer number as its argument.
  68 The default
  69 .Ar num
  70 for this option is:
  71 .ti +4
  72  19700101
  73 .sp
  74         Process all files with the date suffix more or equal to value of
  75         this option.  Defaults to 197000101.
  76 .It Fl \-help
  77 Display usage information and exit.
  78 .It Fl \-more\-help
  79 Pass the extended usage information through a pager.
  80 .It Fl \-version Op Brq Ar v|c|n
  81 Output version of program and exit.  The default mode is `v', a simple
  82 version.  The `c' mode will print copyright information and `n' will
  83 print the full copyright notice.
  84 .El
  85 .Sh "EXIT STATUS"
  86 One of the following exit values will be returned:
  87 .Bl -tag
  88 .It 0 " (EXIT_SUCCESS)"
  89 Successful program execution.
  90 .It 1 " (EXIT_FAILURE)"
  91 The operation failed or the command syntax was not valid.
  92 .It 70 " (EX_SOFTWARE)"
  93 libopts had an internal operational error.  Please report
  94 it to autogen\-users@lists.sourceforge.net.  Thank you.
  95 .El
  96 .Sh "NOTES"
  97 This manual page was \fIAutoGen\fP\-erated from the \fBsummary\fP
  98 option definitions.