2 .Dt UPDATE_LEAP 1update-leapmdoc User Commands
4 .\" EDIT THIS FILE WITH CAUTION (update-leap-opts.mdoc)
6 .\" It has been AutoGen-ed June 29, 2015 at 04:27:03 PM by AutoGen 5.18.5
7 .\" From the definitions update-leap-opts.def
8 .\" and the template file agmdoc-cmd.tpl
11 .Nd leap-seconds file manager/updater
14 .\" Mixture of short (flag) options and long options
16 .Op Fl flag Op Ar value
17 .Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
19 All arguments must be options.
23 will validate the file currently on the local system
24 and if necessary, updates leap\-second definition file.
26 Ordinarily, the file is found using the "leapfile" directive in
28 However, an alternate location can be specified on the command line.
30 If the file does not exist, is not valid, has expired, or is expiring soon,
31 a new copy will be downloaded. If the new copy validates, it is installed and
32 NTP is (optionally) restarted.
34 If the current file is acceptable, no download or restart occurs.
36 -c can also be used to invoke another script to perform administrative
37 functions, e.g. to copy the file to other local systems.
39 This can be run as a cron job. As the file is rarely updated, and leap
40 seconds are announced at least one month in advance (usually longer), it
41 need not be run more frequently than about once every three weeks.
43 For cron\-friendly behavior, define CRONJOB=1 in the crontab.
45 This script depends on$REQUIREDCMDS
48 .It Fl s Ar string , Fl \-source\-url Ns = Ns Ar string
49 The URL of the master copy of the leapseconds file.
51 Specify the URL of the master copy to download
54 Use only IPv4 addresses for DNS name resolution.
55 This option must not appear in combination with any of the following options:
58 Force DNS resolution of following host names on the command line
59 to the IPv4 namespace.
65 flags\-cant = ipv4, prefer;
67 descrip = "Use only IPv6 addresses for DNS name resolution";
69 Force DNS resolution of following host names on the command line
70 to the IPv6 namespace.
76 flags\-cant = ipv4, ipv6;
80 descrip = 'Prefer IPv4 or IPv6 (as specified) addresses, but use either';
82 Prefer IPv4 or IPv6 (as specified) addresses, but use either.
83 .It Fl d Ar float , Fl \-destination Ns = Ns Ar float
84 Filename on the local system.
86 The name to use to store the leapfile on the local system.
88 .It Fl e Ar string , Fl \-expiration Ns = Ns Ar string
89 Refresh the leapfile this long before it expires.
91 Specify how long before expiration the file is to be refreshed
92 Units are required, e.g. "\-e 60 days" Note that larger values
93 imply more frequent refreshes.
95 .It Fl f Ar string , Fl \-ntp\-conf\-file Ns = Ns Ar string
96 Location of the ntp.conf file.
98 Specify location of ntp.conf (used to make sure leapfile directive is
99 present and to default leapfile)
101 .It Fl F , Fl \-force\-update
102 Force update of the leapfile.
104 Force update even if current file is OK and not close to expiring.
106 Don't wait for keystroke between plots.
108 .It Fl \&? , Fl \-help
109 Display usage information and exit.
110 .It Fl \&! , Fl \-more\-help
111 Pass the extended usage information through a pager.
112 .It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n
113 Output version of program and exit. The default mode is `v', a simple
114 version. The `c' mode will print copyright information and `n' will
115 print the full copyright notice.
120 One of the following exit values will be returned:
122 .It 0 " (EXIT_SUCCESS)"
123 Successful program execution.
124 .It 1 " (EXIT_FAILURE)"
125 The operation failed or the command syntax was not valid.
126 .It 70 " (EX_SOFTWARE)"
127 libopts had an internal operational error. Please report
128 it to autogen\-users@lists.sourceforge.net. Thank you.
133 This manual page was \fIAutoGen\fP\-erated from the \fBupdate\-leap\fP