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