update-leap.1update-leapmdoc revision 294904
1285612Sdelphij.Dd January 20 2016 254359Sroberto.Dt UPDATE_LEAP 1update-leapmdoc User Commands 3285612Sdelphij.Os 4182007Sroberto.\" EDIT THIS FILE WITH CAUTION (update-leap-opts.mdoc) 5285612Sdelphij.\" 6285612Sdelphij.\" It has been AutoGen-ed January 20, 2016 at 04:10:28 AM by AutoGen 5.18.5 7285612Sdelphij.\" From the definitions update-leap-opts.def 8182007Sroberto.\" and the template file agmdoc-cmd.tpl 9182007Sroberto.Sh NAME 10182007Sroberto.Nm update-leap 11330567Sgordon.Nd leap-seconds file manager/updater 12132451Sroberto.Sh SYNOPSIS 13182007Sroberto.Nm 14182007Sroberto.\" Mixture of short (flag) options and long options 15182007Sroberto.Op Fl flags 16182007Sroberto.Op Fl flag Op Ar value 17285612Sdelphij.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18132451Sroberto.Pp 19132451SrobertoAll arguments must be options. 20132451Sroberto.Pp 21182007Sroberto.Sh DESCRIPTION 22182007Sroberto.Nm 23285612Sdelphijwill validate the file currently on the local system 24182007Srobertoand if necessary, updates leap\-second definition file. 25132451Sroberto.Pp 26289997SglebiusOrdinarily, the file is found using the "leapfile" directive in 27182007Sroberto.Xr ntp.conf 5 . 28285612SdelphijHowever, an alternate location can be specified on the command line. 29285612Sdelphij.Pp 30285612SdelphijIf the file does not exist, is not valid, has expired, or is expiring soon, 31285612Sdelphija new copy will be downloaded. If the new copy validates, it is installed and 32285612SdelphijNTP is (optionally) restarted. 33285612Sdelphij.Pp 34285612SdelphijIf the current file is acceptable, no download or restart occurs. 35285612Sdelphij.Pp 36285612Sdelphij-c can also be used to invoke another script to perform administrative 37285612Sdelphijfunctions, e.g. to copy the file to other local systems. 38285612Sdelphij.PP 39298770SdelphijThis can be run as a cron job. As the file is rarely updated, and leap 40285612Sdelphijseconds are announced at least one month in advance (usually longer), it 41285612Sdelphijneed not be run more frequently than about once every three weeks. 42285612Sdelphij.PP 43285612SdelphijFor cron\-friendly behavior, define CRONJOB=1 in the crontab. 44285612Sdelphij.PP 45285612SdelphijThis script depends on$REQUIREDCMDS 46285612Sdelphij.Sh "OPTIONS" 47285612Sdelphij.Bl -tag 48285612Sdelphij.It Fl s Ar string , Fl \-source\-url Ns = Ns Ar string 49285612SdelphijThe URL of the master copy of the leapseconds file. 50285612Sdelphij.sp 51182007SrobertoSpecify the URL of the master copy to download 52182007Sroberto$LEAPSRC 53285612Sdelphij.It Fl 4 , Fl \-ipv4 54285612SdelphijUse only IPv4 addresses for DNS name resolution. 55285612SdelphijThis option must not appear in combination with any of the following options: 56285612Sdelphijipv6. 57285612Sdelphij.sp 58182007Sroberto Force DNS resolution of following host names on the command line 59285612Sdelphij to the IPv4 namespace. 60182007Sroberto _EndOfDoc_; 61182007Sroberto}; 6282498Sroberto.sp 63285612Sdelphijflag = { 64182007Sroberto name = ipv6; 6582498Sroberto flags\-cant = ipv4, prefer; 66182007Sroberto value = 6; 67285612Sdelphij descrip = "Use only IPv6 addresses for DNS name resolution"; 68285612Sdelphij doc = <<\- _EndOfDoc_ 69285612Sdelphij Force DNS resolution of following host names on the command line 70285612Sdelphij to the IPv6 namespace. 71285612Sdelphij _EndOfDoc_; 72285612Sdelphij}; 73285612Sdelphij.sp 7454359Srobertoflag = { 75182007Sroberto name = prefer; 76106163Sroberto flags\-cant = ipv4, ipv6; 77106163Sroberto value = p; 78106163Sroberto arg\-type = keyword; 79106163Sroberto keyword = 4, 6; 80106163Sroberto descrip = 'Prefer IPv4 or IPv6 (as specified) addresses, but use either'; 81106163Sroberto doc = <<\- _EndOfDoc_ 82106163SrobertoPrefer IPv4 or IPv6 (as specified) addresses, but use either. 83106163Sroberto.It Fl d Ar float , Fl \-destination Ns = Ns Ar float 84106163SrobertoFilename on the local system. 85182007Sroberto.sp 8654359SrobertoThe name to use to store the leapfile on the local system. 87285612Sdelphij$LEAPFILE 88285612Sdelphij.It Fl e Ar string , Fl \-expiration Ns = Ns Ar string 89285612SdelphijRefresh the leapfile this long before it expires. 90285612Sdelphij.sp 91285612SdelphijSpecify how long before expiration the file is to be refreshed 92285612SdelphijUnits are required, e.g. "\-e 60 days" Note that larger values 93285612Sdelphijimply more frequent refreshes. 94285612Sdelphij"$PREFETCH" 95285612Sdelphij.It Fl f Ar string , Fl \-ntp\-conf\-file Ns = Ns Ar string 96285612SdelphijLocation of the ntp.conf file. 97285612Sdelphij.sp 98285612SdelphijSpecify location of ntp.conf (used to make sure leapfile directive is 99285612Sdelphijpresent and to default leapfile) 100285612Sdelphij/etc/ntp.conf 101285612Sdelphij.It Fl F , Fl \-force\-update 102285612SdelphijForce update of the leapfile. 103285612Sdelphij.sp 104285612SdelphijForce update even if current file is OK and not close to expiring. 105285612Sdelphij.It Fl \-dont\-wait 106285612SdelphijDon't wait for keystroke between plots. 107285612Sdelphij.sp 108285612Sdelphij.It Fl \&? , Fl \-help 109285612SdelphijDisplay usage information and exit. 110285612Sdelphij.It Fl \&! , Fl \-more\-help 111285612SdelphijPass the extended usage information through a pager. 112285612Sdelphij.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 113285612SdelphijOutput version of program and exit. The default mode is `v', a simple 114285612Sdelphijversion. The `c' mode will print copyright information and `n' will 115285612Sdelphijprint the full copyright notice. 116285612Sdelphij.El 117285612Sdelphij.Sh USAGE 118285612SdelphijUsage stuff 119285612Sdelphij.Sh "EXIT STATUS" 120285612SdelphijOne of the following exit values will be returned: 121285612Sdelphij.Bl -tag 122285612Sdelphij.It 0 " (EXIT_SUCCESS)" 123285612SdelphijSuccessful program execution. 124285612Sdelphij.It 1 " (EXIT_FAILURE)" 125285612SdelphijThe operation failed or the command syntax was not valid. 126285612Sdelphij.It 70 " (EX_SOFTWARE)" 127285612Sdelphijlibopts had an internal operational error. Please report 128285612Sdelphijit to autogen\-users@lists.sourceforge.net. Thank you. 129182007Sroberto.El 130182007Sroberto.Sh AUTHORS 131285612Sdelphij.An "Timothe Litt" 132182007Sroberto.Sh "NOTES" 133285612SdelphijThis manual page was \fIAutoGen\fP\-erated from the \fBupdate\-leap\fP 134182007Srobertooption definitions. 135106163Sroberto