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