Skip to content

Updated nsec3-hash man pages. #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ximon18 wants to merge 1 commit into from
Closed

Updated nsec3-hash man pages. #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/manual/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
]


Expand Down
18 changes: 9 additions & 9 deletions doc/manual/source/man/dnst-nsec3-hash.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ dnst-nsec3-hash
Synopsis
--------

:program:`dnst nsec3-hash` [``options``] :samp:`domain-name`
:program:`dnst nsec3-hash` [``OPTIONS``] :samp:`<DOMAIN NAME>`

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 <NUMBER OR MNEMONIC>, --algorithm <NUMBER OR MNEMONIC>

Use the given algorithm number for the hash calculation. Defaults to
``sha1``.
1 (SHA-1).

.. option:: -s salt, --salt=count
.. option:: -i <NUMBER>, -t <NUMBER>, --iterations <NUMBER>

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 <HEX STRING>, --salt <HEX STRING>

Use *count* iterations for the hash calculation.
Use the given salt for the hash calculation. The salt value should be
in hexadecimal format.

29 changes: 29 additions & 0 deletions doc/manual/source/man/ldns-nsec3-has.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.