update-leap(1update-leapman)

πŸ“¦
version 4.2.8.p18 Β· 3 versions
, in arch rolling, nixos 26.05, nixpkgs unstable

πŸ’– update-leap(1update-leapman) β€” User Commands, but make it fashion πŸ’–

okay so bestie, welcome to the update-leap(1update-leapman) page ✨ (yes, that's the manual name, and it's giving User Commands energy). We're about to manage leap-seconds files and look cute doing it. πŸ’…

🌟 NAME 🌟

update-leap β€” leap-seconds file manager/updater. That's literally the whole vibe: it manages and updates your leap-seconds file. πŸ¦‹

✨ SYNOPSIS ✨

update-leap [-flags] [-flag [value]] [--option-name[[=| ]value]]

All arguments must be options. No positional besties allowed, periodt. πŸ’€

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so here's the tea: update-leap will validate the file currently on the local system and if necessary, updates leap-second definition file. (Grammatically iconic, we don't fix it.) Slay.

Ordinarily, the file is found using the "leapfile" directive in ntp.conf(5). However, an alternate location can be specified on the command line. Very demure, very mindful. πŸŽ€

If the file does not exist, is not valid, has expired, or is expiring soon, a new copy will be downloaded. If the new copy validates, it is installed and NTP is (optionally) restarted. πŸ”₯

If the current file is acceptable, no download or restart occurs. We love a low-effort queen.

-c can also be used to invoke another script to perform administrative functions, e.g. to copy the file to other local systems. So yes, -c is a thing even though it's not in the options list below β€” the manpage said it, so we're saying it. 🫢

This can be run as a cron job. As the file is rarely updated, and leap seconds are announced at least one month in advance (usually longer), it need not be run more frequently than about once every three weeks. So like, don't set it to every minute, bestie. ⏰

For cron-friendly behavior, define CRONJOB=1 in the crontab.

This script depends on$REQUIREDCMDS (no space, that's canon πŸ’€).

πŸŽ€ OPTIONS πŸŽ€

okay bestie, here's every flag and option. Don't skip a single one β€” we keep all the details, even the weird embedded code block. It's giving "the manpage had a little too much to drink but we still love her". 😭

  • -s string, --source-url=string β€” The URL of the master copy of the leapseconds file. Specify the URL of the master copy to download $LEAPSRC.
  • -4, --ipv4 β€” Use only IPv4 addresses for DNS name resolution. This option must not appear in combination with any of the following options: ipv6.
               Force DNS resolution of following host names on the command line
               to the IPv4 namespace.
               _EndOfDoc_; };

       flag = {
           name      = ipv6;
           flags-cant = ipv4, prefer;
           value     = 6;
           descrip   = "Use only IPv6 addresses for DNS name resolution";
           doc = <<-  _EndOfDoc_
               Force DNS resolution of following host names on the command line
               to the IPv6 namespace.
               _EndOfDoc_; };

       flag = {
           name        = prefer;
           flags-cant     = ipv4, ipv6;
           value     = p;
           arg-type    = keyword;
           keyword   = 4, 6;
           descrip     = 'Prefer IPv4 or IPv6 (as specified) addresses, but use
       either';
           doc         = <<-  _EndOfDoc_ Prefer IPv4 or IPv6 (as specified)
       addresses, but use either.
  • -d float, --destination=float β€” Filename on the local system. The name to use to store the leapfile on the local system. $LEAPFILE
  • -e string, --expiration=string β€” Refresh the leapfile this long before it expires. Specify how long before expiration the file is to be refreshed Units are required, e.g. "-e 60 days" Note that larger values imply more frequent refreshes. "$PREFETCH"
  • -f string, --ntp-conf-file=string β€” Location of the ntp.conf file. Specify location of ntp.conf (used to make sure leapfile directive is present and to default leapfile) /etc/ntp.conf
  • -F, --force-update β€” Force update of the leapfile. Force update even if current file is OK and not close to expiring.
  • --dont-wait β€” Don't wait for keystroke between plots.
  • -?, --help β€” Display usage information and exit.
  • -!, --more-help β€” Pass the extended usage information through a pager.
  • -v [{v|c|n --version [{v|c|n}]}] β€” Output version of program and exit. The default mode is v, a simple version. The c mode will print copyright information and n will print the full copyright notice.

🌈 USAGE 🌈

Usage stuff

The manpage literally just says that. Iconic minimalism. πŸ’…

πŸ’€ EXIT STATUS πŸ’€

One of the following exit values will be returned:

  • 0 (EXIT_SUCCESS) β€” Successful program execution. Yay!
  • 1 (EXIT_FAILURE) β€” The operation failed or the command syntax was not valid. Oop.
  • 70 (EX_SOFTWARE) β€” libopts had an internal operational error. Please report it to autogen-users@lists.sourceforge.net. Thank you.

πŸ‘‘ AUTHORS πŸ‘‘

Timothe Litt

Shoutout to the icon who wrote this. πŸ‘‘

🧚 NOTES 🧚

This manual page was AutoGen-erated from the update-leap option definitions. (AutoGen-erated is a word now, apparently. We love that for her.) ✨


okay that's the whole page, bestie 🫢 This gem is from ntp (4.2.8p18), dated 25 May 2024, and it's the update-leap(1update-leapman) manual. Now go update those leap seconds and slay βœ¨πŸ’–

πŸ“¦ where this page comes from