Home | History | Annotate | Line # | Download | only in update-leap
update-leap.1update-leapmdoc revision 1.1.1.1.2.2 
      1  1.1.1.1.2.2  snj .Dd April 7 2015
      2  1.1.1.1.2.2  snj .Dt UPDATE_LEAP 1update-leapmdoc User Commands
      3  1.1.1.1.2.2  snj .Os
      4  1.1.1.1.2.2  snj .\"  EDIT THIS FILE WITH CAUTION  (update-leap-opts.mdoc)
      5  1.1.1.1.2.2  snj .\"
      6  1.1.1.1.2.2  snj .\"  It has been AutoGen-ed  April  7, 2015 at 04:21:46 AM by AutoGen 5.18.5pre4
      7  1.1.1.1.2.2  snj .\"  From the definitions    update-leap-opts.def
      8  1.1.1.1.2.2  snj .\"  and the template file   agmdoc-cmd.tpl
      9  1.1.1.1.2.2  snj .Sh NAME
     10  1.1.1.1.2.2  snj .Nm update-leap
     11  1.1.1.1.2.2  snj .Nd leap-seconds file manager/updater
     12  1.1.1.1.2.2  snj .Sh SYNOPSIS
     13  1.1.1.1.2.2  snj .Nm
     14  1.1.1.1.2.2  snj .\" Mixture of short (flag) options and long options
     15  1.1.1.1.2.2  snj .Op Fl flags
     16  1.1.1.1.2.2  snj .Op Fl flag Op Ar value
     17  1.1.1.1.2.2  snj .Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
     18  1.1.1.1.2.2  snj .Pp
     19  1.1.1.1.2.2  snj All arguments must be options.
     20  1.1.1.1.2.2  snj .Pp
     21  1.1.1.1.2.2  snj .Sh DESCRIPTION
     22  1.1.1.1.2.2  snj .Nm
     23  1.1.1.1.2.2  snj will validate the file currently on the local system
     24  1.1.1.1.2.2  snj and if necessary, updates leap\-second definition file.
     25  1.1.1.1.2.2  snj .Pp
     26  1.1.1.1.2.2  snj Ordinarily, the file is found using the "leapfile" directive in
     27  1.1.1.1.2.2  snj .Xr ntp.conf 5 .
     28  1.1.1.1.2.2  snj However, an alternate location can be specified on the command line.
     29  1.1.1.1.2.2  snj .Pp
     30  1.1.1.1.2.2  snj If the file does not exist, is not valid, has expired, or is expiring soon,
     31  1.1.1.1.2.2  snj a new copy will be downloaded.  If the new copy validates, it is installed and
     32  1.1.1.1.2.2  snj NTP is (optionally) restarted.
     33  1.1.1.1.2.2  snj .Pp
     34  1.1.1.1.2.2  snj If the current file is acceptable, no download or restart occurs.
     35  1.1.1.1.2.2  snj .Pp
     36  1.1.1.1.2.2  snj -c can also be used to invoke another script to perform administrative
     37  1.1.1.1.2.2  snj functions, e.g. to copy the file to other local systems.
     38  1.1.1.1.2.2  snj .PP
     39  1.1.1.1.2.2  snj This can be run as a cron job.  As the file is rarely updated, and leap
     40  1.1.1.1.2.2  snj seconds are announced at least one month in advance (usually longer), it
     41  1.1.1.1.2.2  snj need not be run more frequently than about once every three weeks.
     42  1.1.1.1.2.2  snj .PP
     43  1.1.1.1.2.2  snj For cron\-friendly behavior, define CRONJOB=1 in the crontab.
     44  1.1.1.1.2.2  snj .PP
     45  1.1.1.1.2.2  snj This script depends on$REQUIREDCMDS
     46  1.1.1.1.2.2  snj .Sh "OPTIONS"
     47  1.1.1.1.2.2  snj .Bl -tag
     48  1.1.1.1.2.2  snj .It  Fl s Ar string , Fl \-source\-url Ns = Ns Ar string 
     49  1.1.1.1.2.2  snj The URL of the master copy of the leapseconds file.
     50  1.1.1.1.2.2  snj .sp
     51  1.1.1.1.2.2  snj Specify the URL of the master copy to download
     52  1.1.1.1.2.2  snj $LEAPSRC
     53  1.1.1.1.2.2  snj .It  Fl 4 , Fl \-ipv4 
     54  1.1.1.1.2.2  snj Use only IPv4 addresses for DNS name resolution.
     55  1.1.1.1.2.2  snj This option must not appear in combination with any of the following options:
     56  1.1.1.1.2.2  snj ipv6.
     57  1.1.1.1.2.2  snj .sp
     58  1.1.1.1.2.2  snj         Force DNS resolution of following host names on the command line
     59  1.1.1.1.2.2  snj         to the IPv4 namespace.
     60  1.1.1.1.2.2  snj         _EndOfDoc_;
     61  1.1.1.1.2.2  snj };
     62  1.1.1.1.2.2  snj .sp
     63  1.1.1.1.2.2  snj flag = {
     64  1.1.1.1.2.2  snj     name      = ipv6;
     65  1.1.1.1.2.2  snj     flags\-cant = ipv4, prefer;
     66  1.1.1.1.2.2  snj     value     = 6;
     67  1.1.1.1.2.2  snj     descrip   = "Use only IPv6 addresses for DNS name resolution";
     68  1.1.1.1.2.2  snj     doc = <<\-  _EndOfDoc_
     69  1.1.1.1.2.2  snj         Force DNS resolution of following host names on the command line
     70  1.1.1.1.2.2  snj         to the IPv6 namespace.
     71  1.1.1.1.2.2  snj         _EndOfDoc_;
     72  1.1.1.1.2.2  snj };
     73  1.1.1.1.2.2  snj .sp
     74  1.1.1.1.2.2  snj flag = {
     75  1.1.1.1.2.2  snj     name        = prefer;
     76  1.1.1.1.2.2  snj     flags\-cant	= ipv4, ipv6;
     77  1.1.1.1.2.2  snj     value	= p;
     78  1.1.1.1.2.2  snj     arg\-type    = keyword;
     79  1.1.1.1.2.2  snj     keyword	= 4, 6;
     80  1.1.1.1.2.2  snj     descrip     = 'Prefer IPv4 or IPv6 (as specified) addresses, but use either';
     81  1.1.1.1.2.2  snj     doc         = <<\-  _EndOfDoc_
     82  1.1.1.1.2.2  snj Prefer IPv4 or IPv6 (as specified) addresses, but use either.
     83  1.1.1.1.2.2  snj .It  Fl d Ar float , Fl \-destination Ns = Ns Ar float 
     84  1.1.1.1.2.2  snj Filename on the local system.
     85  1.1.1.1.2.2  snj .sp
     86  1.1.1.1.2.2  snj The name to use to store the leapfile on the local system.
     87  1.1.1.1.2.2  snj $LEAPFILE
     88  1.1.1.1.2.2  snj .It  Fl e Ar string , Fl \-expiration Ns = Ns Ar string 
     89  1.1.1.1.2.2  snj Refresh the leapfile this long before it expires.
     90  1.1.1.1.2.2  snj .sp
     91  1.1.1.1.2.2  snj Specify how long before expiration the file is to be refreshed
     92  1.1.1.1.2.2  snj Units are required, e.g. "\-e 60 days"  Note that larger values
     93  1.1.1.1.2.2  snj imply more frequent refreshes.
     94  1.1.1.1.2.2  snj "$PREFETCH"
     95  1.1.1.1.2.2  snj .It  Fl f Ar string , Fl \-ntp\-conf\-file Ns = Ns Ar string 
     96  1.1.1.1.2.2  snj Location of the ntp.conf file.
     97  1.1.1.1.2.2  snj .sp
     98  1.1.1.1.2.2  snj Specify location of ntp.conf (used to make sure leapfile directive is
     99  1.1.1.1.2.2  snj present and to default  leapfile)
    100  1.1.1.1.2.2  snj /etc/ntp.conf
    101  1.1.1.1.2.2  snj .It  Fl F , Fl \-force\-update 
    102  1.1.1.1.2.2  snj Force update of the leapfile.
    103  1.1.1.1.2.2  snj .sp
    104  1.1.1.1.2.2  snj Force update even if current file is OK and not close to expiring.
    105  1.1.1.1.2.2  snj .It  Fl \-dont\-wait 
    106  1.1.1.1.2.2  snj Don't wait for keystroke between plots.
    107  1.1.1.1.2.2  snj .sp
    108  1.1.1.1.2.2  snj .It Fl \&? , Fl \-help
    109  1.1.1.1.2.2  snj Display usage information and exit.
    110  1.1.1.1.2.2  snj .It Fl \&! , Fl \-more\-help
    111  1.1.1.1.2.2  snj Pass the extended usage information through a pager.
    112  1.1.1.1.2.2  snj .It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
    113  1.1.1.1.2.2  snj Output version of program and exit.  The default mode is `v', a simple
    114  1.1.1.1.2.2  snj version.  The `c' mode will print copyright information and `n' will
    115  1.1.1.1.2.2  snj print the full copyright notice.
    116  1.1.1.1.2.2  snj .El
    117  1.1.1.1.2.2  snj .Sh USAGE
    118  1.1.1.1.2.2  snj Usage stuff
    119  1.1.1.1.2.2  snj .Sh "EXIT STATUS"
    120  1.1.1.1.2.2  snj One of the following exit values will be returned:
    121  1.1.1.1.2.2  snj .Bl -tag
    122  1.1.1.1.2.2  snj .It 0 " (EXIT_SUCCESS)"
    123  1.1.1.1.2.2  snj Successful program execution.
    124  1.1.1.1.2.2  snj .It 1 " (EXIT_FAILURE)"
    125  1.1.1.1.2.2  snj The operation failed or the command syntax was not valid.
    126  1.1.1.1.2.2  snj .It 70 " (EX_SOFTWARE)"
    127  1.1.1.1.2.2  snj libopts had an internal operational error.  Please report
    128  1.1.1.1.2.2  snj it to autogen\-users (a] lists.sourceforge.net.  Thank you.
    129  1.1.1.1.2.2  snj .El
    130  1.1.1.1.2.2  snj .Sh AUTHORS
    131  1.1.1.1.2.2  snj .An "Timothe Litt"
    132  1.1.1.1.2.2  snj .Sh "NOTES"
    133  1.1.1.1.2.2  snj This manual page was \fIAutoGen\fP\-erated from the \fBupdate\-leap\fP
    134  1.1.1.1.2.2  snj option definitions.
    135