]> zoso.dev Git - nano-pow.git/commitdiff
Fix man page formatting.
authorChris Duncan <chris@zoso.dev>
Thu, 13 Mar 2025 23:35:19 +0000 (16:35 -0700)
committerChris Duncan <chris@zoso.dev>
Thu, 13 Mar 2025 23:35:19 +0000 (16:35 -0700)
nano-pow.1

index f0a4afa2ee6ea76b8bd99b2bc7681697b973a99a..f25f20eeaae1b807e2e6321163d361998590d430 100644 (file)
@@ -11,15 +11,10 @@ nano-pow \- proof-of-work generation and validation for Nano cryptocurrency
 
 .SH DESCRIPTION
 Generate work for \fIBLOCKHASH\fR, or multiple work values for \fIBLOCKHASH\fR(es).
-Nano PoW documentation: <https://docs.nano.org/integration-guides/work-generation/\#work-calculation-details>
 .PP
-\fIBLOCKHASH\fR is a 64-character hexadecimal string.
+\fIBLOCKHASH\fR is a 64-character hexadecimal string. Multiple blockhashes must be separated by spaces.
 .PP
-Multiple blockhash values must be separated by spaces.
-.PP
-Prints a 16-character hexadecimal work value to standard output.
-.PP
-If \fB--validate\fR is used, prints 'true' or 'false' to standard output.
+Prints a 16-character hexadecimal work value to standard output. If \fB--validate\fR is used, prints 'true' or 'false' to standard output.
 
 .SH OPTIONS
 .TP
@@ -39,33 +34,40 @@ Override the minimum threshold value. Higher values increase difficulty. Must be
 Check an existing work value instead of searching for one.
 
 .SH EXAMPLES
+.PP
 Search for a work nonce for a blockhash using the default threshold 0xFFFFFFF8:
 .EX
-nano-pow 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+$ nano-pow \fB0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
 .EE
 
+.PP
 Search for a work nonce using a custom threshold and increased effort:
 .EX
-nano-pow \-t fffffe00 \-e 32 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+$ nano-pow \fB\-t fffffe00 \-e 32 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
 .EE
 
+.PP
 Search for multiple nonces from a file:
 .EX
-nano-pow $(cat /path/to/file.txt)
+$ nano-pow \fB$(cat /path/to/file.txt)\fR
 .EE
 
+.PP
 Validate an existing work nonce against a blockhash and show debugging output:
 .EX
-nano-pow \-d \-v fedcba9876543210 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+$ nano-pow \fB\-d \-v fedcba9876543210 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
 .EE
 
 .SH AUTHOR
 Written by Chris Duncan.
 
 .SH BUGS
-Email: <mailto:bug-nano-pow@zoso.dev>
+Email <bug-nano-pow@zoso.dev>.
 
 .SH COPYRIGHT
-Copyright \(co 2025 Chris Duncan <chris@zoso.dev>
 .PP
+.EX
+Copyright \(co 2025 Chris Duncan <chris@zoso.dev>
+Nano PoW documentation: <https://docs.nano.org/integration-guides/work-generation/#work-calculation-details>
 License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
+.EE