udyfi

Small client for dy.fi (and possibly other services) DNS renewals
git clone https://git.inz.fi/udyfi/
Log | Files | Refs

udyfi.8 (2596B)


      1 .Dd Jul  6, 2023
      2 .Dt UDYFI 8
      3 .Os
      4 .
      5 .Sh NAME
      6 .Nm udyfi
      7 .Nd dynamic dns updater daemon
      8 .
      9 .Sh SYNOPSIS
     10 .Nm
     11 .Bk -words
     12 .Op Fl 4
     13 .Op Fl 6
     14 .Op Fl a Ar user-agent string
     15 .Op Fl d Ar dyndns server
     16 .Op Fl i Ar interface to bind to
     17 .Op Fl u Ar dyndns username
     18 .Op Fl p Ar dyndns password
     19 .Op Fl F Ar configuration file
     20 .Op Fl f Ar password file
     21 .Op Fl c Ar checkip server
     22 .Op Fl D Ar dyndns port
     23 .Op Fl C Ar checkip port
     24 .Op Fl b
     25 .Op Fl l Ar logfile
     26 .Op Fl P Ar pidfile
     27 .Op Fl U Ar run as user
     28 .Op Fl s
     29 .Op Fl S
     30 .Op Fl z
     31 .Op Fl Z
     32 .Ar domain names
     33 .Ek
     34 .
     35 .Sh DESCRIPTION
     36 .Bd -filled
     37 .Nm
     38 is a dynamic DNS updater daemon
     39 .Ed
     40 .
     41 .Sh OPTIONS
     42 udyfi options and default settings
     43 .Bl -tag -width Ds
     44 .
     45 .It Fl 4
     46 Operate over IPv4 only. (Default: any)
     47 .
     48 .It Fl 6
     49 Operate over IPv6 only. (Default: any)
     50 .
     51 .It Fl b
     52 Fork into background. (Default: don't fork)
     53 .
     54 .It Fl l Ar logfile
     55 Location for a log file (no default).
     56 .
     57 .It Fl a Ar user-agent string
     58 User-agent string used in requests (Default: udyfi/version)
     59 .
     60 .It Fl d Ar dyndns server
     61 Dynamic DNS server to connect to (Default: dy.fi)
     62 .
     63 .It Fl i Ar interface to bind to
     64 Interface or address to connect from (Default: any)
     65 .
     66 .It Fl u Ar dyndns username
     67 Username for the dynamic DNS service
     68 .
     69 .It Fl p Ar dyndns password
     70 Password for the dynamic DNS service
     71 .
     72 .It Fl F Ar configuration file
     73 Read configuration from file
     74 .
     75 .It Fl f Ar password file
     76 Read password from file
     77 .
     78 .It Fl c Ar checkip server
     79 Checkip service to check public IP from (Default: checkip.dy.fi)
     80 .
     81 .It Fl D Ar dyndns port
     82 Dynamic DNS server port (Default: 80 for HTTP, 443 for HTTPS)
     83 .
     84 .It Fl C Ar checkip port
     85 Checkip server port (Default: 80 for HTTP, 443 for HTTPS)
     86 .
     87 .It Fl P Ar pidfile
     88 Write daemon pid to pidfile (Default: none)
     89 .
     90 .It Fl U Ar run as user
     91 Change to user after startup (Default: none)
     92 .
     93 .It Fl s
     94 Connect to dynamic DNS server over HTTPS (Default: yes)
     95 .
     96 .It Fl S
     97 Connect to checkip server over HTTPS (Default: no)
     98 .
     99 .It Fl z
    100 Connect to dynamic DNS server over HTTP (Default: no)
    101 .
    102 .It Fl Z
    103 Connect to checkip server over HTTP (Default: yes)
    104 .
    105 .It Ar domain names
    106 Comma-separated list of domain names to update
    107 .
    108 .It
    109 At minimum, username, password and at least one domain name needs to be
    110 specified, either on command line, or in a configuration file.
    111 .
    112 .Sh CONFIGURATION FILE
    113 .Bd -filled
    114 The configuration file is a single-line file consisting of command line
    115 arguments. The arguments are processed in-place, overriding arguments
    116 specified before, and overridden by arguments after. Multiple files may
    117 be read sequentially, but cannot be nested. Basic quotation is supported.
    118 .