auto substitute PROG in docs with nb5

devdocs/docs-for-ebhistoric/nb-cli-docs/activity_inputs.md

@@ -19,6 +19,6 @@ However, there are other ways to feed an activity. All inputs are
 modular within the nosqlbench runtime. To see what inputs are
 available, you can simpy run:
 
-    PROG --list-input-types
+    ${PROG} --list-input-types
 
 Any input listed this way should have its own documentation.

devdocs/docs-for-ebhistoric/nb-cli-docs/cycle_log.md

@@ -14,7 +14,7 @@ All cycle logfiles have the *.cyclelog* suffix.
 You can dump an rlefile to the screen to see the content in text form by
 running a command like this:
 
-    PROG --export-cycle-log <filename> [spans|cycles]
+    ${PROG} --export-cycle-log <filename> [spans|cycles]
 
 You do not need to specify the extension. If you do not specify either
 optional format at the end, then *spans* is assumed. It will print output
@@ -40,7 +40,7 @@ If you need to modify and then re-use a cycle log, you can do this with
 simple text tools. Once you have modified the file, you can import it back
 to the native format with:
 
-    PROG --import-cycle-log <infile.txt> <outfile.cyclelog>
+    ${PROG} --import-cycle-log <infile.txt> <outfile.cyclelog>
 
 The importer recognizes both formats listed above.
 

engine-cli/src/main/resources/cli-scripting.md

@@ -1,8 +1,8 @@
 Running Activities and Scenarios via CLI
 ========================================
 
-PROG always runs a scenario script. However, there are multiple ways to tell
+${PROG} always runs a scenario script. However, there are multiple ways to tell
-PROG what that script should be.
+${PROG} what that script should be.
 
 Any argument in name=value format serves as a parameter to the
 script or activity that precedes it.
@@ -10,18 +10,18 @@ script or activity that precedes it.
 To create a scenario script that simply runs a single activity to completion,
 use this format:
 ~~~
-PROG activity <param>=<value> [...]
+${PROG} activity <param>=<value> [...]
 ~~~
 
 To create a scenario script that runs multiple activities concurrently,
 simply add more activities to the list:
 ~~~
-PROG activity <param>=<value> [...] activity <param>=<value> [...]
+${PROG} activity <param>=<value> [...] activity <param>=<value> [...]
 ~~~
 
 To execute a scenario script directly, simply use the format:
 ~~~
-PROG script <scriptname> [param=value [...]]
+${PROG} script <scriptname> [param=value [...]]
 ~~~
 
 Time & Size Units
@@ -55,19 +55,19 @@ so parameters may be dropped into scripts ad-hoc.
 By using the option --session-name <name>, you can name the session logfile
 that will be (over)written with execution details.
 ~~~
-PROG --session-name testsession42
+${PROG} --session-name testsession42
 ~~~
 
 ## Metric Name
 
 If you need to see what metrics are available for a particular activity type,
-you can ask PROG to instantiate an activity of that type and discover the
+you can ask ${PROG} to instantiate an activity of that type and discover the
 metrics, dumping out a list. The following form of the command shows you how
 to make a list that you can copy metric names from for scripting. If you provide
 an example activity alias that matches one of your scripts, you can use it exactly
 as it appears.
 ~~~
-PROG --list-metrics driver=diag alias=anexample
+${PROG} --list-metrics driver=diag alias=anexample
 ~~~
 This will dump a list of metric names in the shortened format that is most suitable
 for scenario script development. This format is required for the --list-metrics

engine-cli/src/main/resources/commandline.md

@@ -1,4 +1,4 @@
-### Command-Line Options ###
+# Command-Line Options
 
 Help ( You're looking at it. )
 
@@ -8,27 +8,31 @@ Short options, like '-v' represent simple options, like verbosity. Using multipl
 level of the option, like '-vvv'.
 
 Long options, like '--help' are top-level options that may only be used once. These modify general
-behavior, or allow you to get more details on how to use PROG.
+behavior, or allow you to get more details on how to use ${PROG}.
 
 All other options are either commands, or named arguments to commands. Any single word without
 dashes is a command that will be converted into script form. Any option that includes an equals sign
 is a named argument to the previous command. The following example is a commandline with a command *
 start*, and two named arguments to that command.
 
-    PROG start driver=diag alias=example
+    ${PROG} start driver=diag alias=example
 
-### Discovery options ###
+## Discovery options
 
-These options help you learn more about running PROG, and about the plugins that are present in your
+These options help you learn more about running ${PROG}, and about the plugins that are present in your
 particular version.
 
+Show version, long form, with artifact coordinates.
+
+    --version
+
 Get a list of additional help topics that have more detailed documentation:
 
-    PROG help topics
+    ${PROG} help topics
 
 Provide specific help for the named activity type:
 
-    PROG help <activity type>
+    ${PROG} help <activity type>
 
 List the available drivers:
 
@@ -50,9 +54,9 @@ Provide the metrics that are available for scripting
 
     --list-metrics <activity type> [ <activity name> ]
 
-### Execution Options ###
+## Execution Options
 
-This is how you actually tell PROG what scenario to run. Each of these commands appends script logic
+This is how you actually tell ${PROG} what scenario to run. Each of these commands appends script logic
 to the scenario that will be executed. These are considered as commands, can occur in any order and
 quantity. The only rule is that arguments in the arg=value form will apply to the preceding script
 or activity.
@@ -65,9 +69,7 @@ Add the named activity to the scenario, interpolating named parameters
 
     activity [arg=value]...
 
-### General options ###
+## Logging options
-
-These options modify how the scenario is run.
 
 Specify a directory for scenario log files:
 
@@ -111,12 +113,38 @@ Specify the logging pattern for logfile only:
     # ANSI variants are auto promoted for console if --ansi=enable
     # ANSI variants are auto demoted for logfile in any case
 
+## Console Options
+
+Increase console logging levels: (Default console logging level is *warning*)
+
+    -v         (info)
+    -vv        (debug)
+    -vvv       (trace)
+
+    --progress console:1m (disables itself if -v options are used)
+
+These levels affect *only* the console output level. Other logging level parameters affect logging
+to the scenario log, stored by default in logs/...
+
 Explicitly enable or disable ANSI logging support:
 (ANSI support is enabled if the TERM environment variable is defined)
 
     --ansi=enabled
     --ansi=disabled
 
+Adjust the progress reporting interval:
+
+    --progress console:1m
+
+or
+
+    --progress logonly:5m
+
+NOTE: The progress indicator on console is provided by default unless logging levels are turned up
+or there is a script invocation on the command line.
+
+## Metrics options
+
 Specify a directory and enable CSV reporting of metrics:
 
     --report-csv-to <dirname>
@@ -158,17 +186,6 @@ Each activity can also override this value with the hdr_digits parameter. Be awa
 increase in this number multiples the amount of detail tracked on the client by 10x, so use
 caution.
 
-Adjust the progress reporting interval:
-
-    --progress console:1m
-
-or
-
-    --progress logonly:5m
-
-NOTE: The progress indicator on console is provided by default unless logging levels are turned up
-or there is a script invocation on the command line.
-
 If you want to add in classic time decaying histogram metrics for your histograms and timers, you
 may do so with this option:
 
@@ -191,22 +208,6 @@ automatically. It also imports a base dashboard for nosqlbench and configures gr
 export to share with a central DataStax grafana instance (grafana can be found on localhost:3000
 with the default credentials admin/admin).
 
-### Console Options ###
-
-Increase console logging levels: (Default console logging level is *warning*)
-
-    -v         (info)
-    -vv        (debug)
-    -vvv       (trace)
-
-    --progress console:1m (disables itself if -v options are used)
-
-These levels affect *only* the console output level. Other logging level parameters affect logging
-to the scenario log, stored by default in logs/...
-
-Show version, long form, with artifact coordinates.
-
-    --version
 
 ### Summary Reporting
 

mvn-defaults/pom.xml

@@ -40,6 +40,7 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
 
+        <PROG>nb5</PROG>
     </properties>
 
     <name>${project.artifactId}</name>