diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 19 insertions, 5 deletions
@@ -25,17 +25,31 @@ program, ensure proper security is applied to this file. **he-dyndns** takes the following options: ## Requied Options -- **-4**: Update the IPv4 "A" record for the FQDN(s) -- **-6**: Update the IPv6 "AAAA" record for the FQDN(s). +- **-4**: Update the IPv4 "A" record for the FQDN(s). Note that to use this option, +the system making the call must be able to reach dyn.dns.he.net with an IPv4 address. +NAT is okay. Without using **-a** then the public address or public NAT address is +what is set for the FQDN(s). + +- **-6**: Update the IPv6 "AAAA" record for the FQDN(s). Note that to use this option, +the system making the call must be able to reach dyn.dns.he.net with an IPv6 address. + - **-d**: One or more fully-qualified host entries for the domain separated by commas Note that one or both of -4 and -6 must be specified for the script to -actually do anything. +actually do anything. Not specifing at least one of them will result in a +successful script exit with no actions being taken. ## Optional Options -- **-s**: The secret key for updating the entries +- **-a**: Use the supplied IPv4 address instead of allowing HE DNS to auto-set +based on source. Note that the address is not validated for well-formedness. + +- **-A**: Use the supplied IPv6 address instead of allowing HE DNS to auto-set +based on source. Note that the address is not validated for well-formedness. + +- **-s**: The secret key for updating the entries. This overrides any +existing /etc/he-dns-secret file, if one exists. -Any other unsupported option or no options will print a usage message +Any other unsupported option or no options will print a usage message. # Return Values Returns 0 on success or 1 on failure. Failure message returns the exact error |