diff --git a/doc/manual/source/conf.py b/doc/manual/source/conf.py index ffa9b5d4..56e04bdf 100644 --- a/doc/manual/source/conf.py +++ b/doc/manual/source/conf.py @@ -189,8 +189,8 @@ # (source start file, name, description, authors, manual section). man_pages = [ ('man/dnst', 'dnst', 'DNS Management Tools', author, 1), - ('man/dnst-nsec3-hash', 'dnst-nsec3-hash', 'DNS Management Tools', author, - 1), + ('man/dnst-nsec3-hash', 'dnst-nsec3-hash', 'print out the NSEC3 hash for a domain name', author, 1), + ('man/ldns-nsec3-hash', 'ldns-nsec3-hash', 'print out the NSEC3 hash for a domain name', author, 1), ] diff --git a/doc/manual/source/man/dnst-nsec3-hash.rst b/doc/manual/source/man/dnst-nsec3-hash.rst index 20014476..56e093ba 100644 --- a/doc/manual/source/man/dnst-nsec3-hash.rst +++ b/doc/manual/source/man/dnst-nsec3-hash.rst @@ -4,27 +4,27 @@ dnst-nsec3-hash Synopsis -------- -:program:`dnst nsec3-hash` [``options``] :samp:`domain-name` +:program:`dnst nsec3-hash` [``OPTIONS``] :samp:`` Description ----------- -**dnst nsec3-hash** prints the NSEC3 hash for the given domain name. +**dnst nsec3-hash** prints the NSEC3 hash of a given domain name. Options ------- -.. option:: -a number-or-mnemonic, --algorithm=number-or-mnemonic +.. option:: -a , --algorithm Use the given algorithm number for the hash calculation. Defaults to - ``sha1``. + 1 (SHA-1). -.. option:: -s salt, --salt=count +.. option:: -i , -t , --iterations - Use the given salt for the hash calculation. The salt value should be - in hexadecimal format. + Use the given number of additional iterations for the hash calculation. -.. option:: -i count, -t count, --iterations=count +.. option:: -s , --salt - Use *count* iterations for the hash calculation. + Use the given salt for the hash calculation. The salt value should be + in hexadecimal format. diff --git a/doc/manual/source/man/ldns-nsec3-has.rst b/doc/manual/source/man/ldns-nsec3-has.rst new file mode 100644 index 00000000..20c16e66 --- /dev/null +++ b/doc/manual/source/man/ldns-nsec3-has.rst @@ -0,0 +1,29 @@ +ldns-nsec3-hash +=============== + +Synopsis +-------- + +:program:`ldns-nsec3-hash` :samp:`<{domain-name}>` + +Description +----------- + +**ldns-nsec3-hash** is used to print out the NSEC3 hash for the given domain name. + +Options +------- + +.. option:: -a number + + Use the given algorithm number for the hash calculation. Defaults to + 1 (SHA-1). + +.. option:: -s salt + + Use the given salt for the hash calculation. The salt value should be + in hexadecimal format. + +.. option:: -t count + + Use count iterations for the hash calculation.