]> git.codecow.com Git - nano-pow.git/commitdiff
Document --score in man page.
authorChris Duncan <chris@zoso.dev>
Tue, 17 Jun 2025 19:25:07 +0000 (12:25 -0700)
committerChris Duncan <chris@zoso.dev>
Tue, 17 Jun 2025 19:25:07 +0000 (12:25 -0700)
docs/nano-pow.1

index 302325e9d179507f090d28dd74ad8be377012fe1..911af8b05180bd4b1096573553e85cbc370d65cd 100644 (file)
@@ -1,7 +1,7 @@
 \# SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
 \# SPDX-License-Identifier: GPL-3.0-or-later
 
-.TH nano-pow 1 2025-06-14 "nano-pow v5.0.0"
+.TH nano-pow 1 2025-06-17 "nano-pow v5.0.0"
 
 .SH NAME
 nano-pow \- proof-of-work generation and validation for Nano cryptocurrency
@@ -45,6 +45,9 @@ Enable additional logging output.
 .TP
 \fB\-\-benchmark\fR \fICOUNT\fR
 Generate work for the specified number of random hashes.
+.TP
+\fB\-\-score\fR \fICOUNT\fR
+Used with \fB\-\-benchmark\fR to run the specified number of benchmarks and calculate a "work-per-second" rate. This command can take a very long time to complete.
 
 .SH SERVER
 Calling \fBnano-pow\fR with the \fI--server\fR option will start the NanoPow work server in a detached process.
@@ -126,6 +129,12 @@ Run a benchmark of generating work for 100 random sample blockhashes:
 $ nano-pow \fB\--benchmark 100\fR
 .EE
 
+.PP
+Run 100 benchmarks of 100 samples each to get a work-per-second rate score:
+.EX
+$ nano-pow \fB\--benchmark 100\fR \fB\--score 100\fR
+.EE
+
 .SH ERRORS
 Errors encountered during work generation will prompt a retry of the request,
 and further errors will return an error object. Server errors will throw as