1310419Sdelphij.Dd November 21 2016 2281348Scy.Dt UPDATE_LEAP 1update-leapmdoc User Commands 3281348Scy.Os 4281348Scy.\" EDIT THIS FILE WITH CAUTION (update-leap-opts.mdoc) 5281348Scy.\" 6310419Sdelphij.\" It has been AutoGen-ed November 21, 2016 at 07:59:20 AM by AutoGen 5.18.5 7281348Scy.\" From the definitions update-leap-opts.def 8281348Scy.\" and the template file agmdoc-cmd.tpl 9281348Scy.Sh NAME 10281348Scy.Nm update-leap 11281348Scy.Nd leap-seconds file manager/updater 12281348Scy.Sh SYNOPSIS 13281348Scy.Nm 14281348Scy.\" Mixture of short (flag) options and long options 15281348Scy.Op Fl flags 16281348Scy.Op Fl flag Op Ar value 17281348Scy.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18281348Scy.Pp 19281348ScyAll arguments must be options. 20281348Scy.Pp 21281348Scy.Sh DESCRIPTION 22281348Scy.Nm 23281348Scywill validate the file currently on the local system 24281348Scyand if necessary, updates leap\-second definition file. 25281348Scy.Pp 26281348ScyOrdinarily, the file is found using the "leapfile" directive in 27281348Scy.Xr ntp.conf 5 . 28281348ScyHowever, an alternate location can be specified on the command line. 29281348Scy.Pp 30281348ScyIf the file does not exist, is not valid, has expired, or is expiring soon, 31281348Scya new copy will be downloaded. If the new copy validates, it is installed and 32281348ScyNTP is (optionally) restarted. 33281348Scy.Pp 34281348ScyIf the current file is acceptable, no download or restart occurs. 35281348Scy.Pp 36281348Scy-c can also be used to invoke another script to perform administrative 37281348Scyfunctions, e.g. to copy the file to other local systems. 38281348Scy.PP 39281348ScyThis can be run as a cron job. As the file is rarely updated, and leap 40281348Scyseconds are announced at least one month in advance (usually longer), it 41281348Scyneed not be run more frequently than about once every three weeks. 42281348Scy.PP 43281348ScyFor cron\-friendly behavior, define CRONJOB=1 in the crontab. 44281348Scy.PP 45281348ScyThis script depends on$REQUIREDCMDS 46281348Scy.Sh "OPTIONS" 47281348Scy.Bl -tag 48281348Scy.It Fl s Ar string , Fl \-source\-url Ns = Ns Ar string 49281348ScyThe URL of the master copy of the leapseconds file. 50281348Scy.sp 51281348ScySpecify the URL of the master copy to download 52281348Scy$LEAPSRC 53281348Scy.It Fl 4 , Fl \-ipv4 54281348ScyUse only IPv4 addresses for DNS name resolution. 55281348ScyThis option must not appear in combination with any of the following options: 56281348Scyipv6. 57281348Scy.sp 58281348Scy Force DNS resolution of following host names on the command line 59281348Scy to the IPv4 namespace. 60281348Scy _EndOfDoc_; 61281348Scy}; 62281348Scy.sp 63281348Scyflag = { 64281348Scy name = ipv6; 65281348Scy flags\-cant = ipv4, prefer; 66281348Scy value = 6; 67281348Scy descrip = "Use only IPv6 addresses for DNS name resolution"; 68281348Scy doc = <<\- _EndOfDoc_ 69281348Scy Force DNS resolution of following host names on the command line 70281348Scy to the IPv6 namespace. 71281348Scy _EndOfDoc_; 72281348Scy}; 73281348Scy.sp 74281348Scyflag = { 75281348Scy name = prefer; 76281348Scy flags\-cant = ipv4, ipv6; 77281348Scy value = p; 78281348Scy arg\-type = keyword; 79281348Scy keyword = 4, 6; 80281348Scy descrip = 'Prefer IPv4 or IPv6 (as specified) addresses, but use either'; 81281348Scy doc = <<\- _EndOfDoc_ 82281348ScyPrefer IPv4 or IPv6 (as specified) addresses, but use either. 83281348Scy.It Fl d Ar float , Fl \-destination Ns = Ns Ar float 84281348ScyFilename on the local system. 85281348Scy.sp 86281348ScyThe name to use to store the leapfile on the local system. 87281348Scy$LEAPFILE 88281348Scy.It Fl e Ar string , Fl \-expiration Ns = Ns Ar string 89281348ScyRefresh the leapfile this long before it expires. 90281348Scy.sp 91281348ScySpecify how long before expiration the file is to be refreshed 92281348ScyUnits are required, e.g. "\-e 60 days" Note that larger values 93281348Scyimply more frequent refreshes. 94281348Scy"$PREFETCH" 95281348Scy.It Fl f Ar string , Fl \-ntp\-conf\-file Ns = Ns Ar string 96281348ScyLocation of the ntp.conf file. 97281348Scy.sp 98281348ScySpecify location of ntp.conf (used to make sure leapfile directive is 99281348Scypresent and to default leapfile) 100281348Scy/etc/ntp.conf 101281348Scy.It Fl F , Fl \-force\-update 102281348ScyForce update of the leapfile. 103281348Scy.sp 104281348ScyForce update even if current file is OK and not close to expiring. 105281348Scy.It Fl \-dont\-wait 106281348ScyDon't wait for keystroke between plots. 107281348Scy.sp 108281348Scy.It Fl \&? , Fl \-help 109281348ScyDisplay usage information and exit. 110281348Scy.It Fl \&! , Fl \-more\-help 111281348ScyPass the extended usage information through a pager. 112281348Scy.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 113281348ScyOutput version of program and exit. The default mode is `v', a simple 114281348Scyversion. The `c' mode will print copyright information and `n' will 115281348Scyprint the full copyright notice. 116281348Scy.El 117281348Scy.Sh USAGE 118281348ScyUsage stuff 119281348Scy.Sh "EXIT STATUS" 120281348ScyOne of the following exit values will be returned: 121281348Scy.Bl -tag 122281348Scy.It 0 " (EXIT_SUCCESS)" 123281348ScySuccessful program execution. 124281348Scy.It 1 " (EXIT_FAILURE)" 125281348ScyThe operation failed or the command syntax was not valid. 126281348Scy.It 70 " (EX_SOFTWARE)" 127281348Scylibopts had an internal operational error. Please report 128281348Scyit to autogen\-users@lists.sourceforge.net. Thank you. 129281348Scy.El 130281348Scy.Sh AUTHORS 131281348Scy.An "Timothe Litt" 132281348Scy.Sh "NOTES" 133281348ScyThis manual page was \fIAutoGen\fP\-erated from the \fBupdate\-leap\fP 134281348Scyoption definitions. 135