diff options
| author | Sebastiano Tronto <sebastiano.tronto@gmail.com> | 2021-12-10 18:40:33 +0100 |
|---|---|---|
| committer | Sebastiano Tronto <sebastiano.tronto@gmail.com> | 2021-12-10 18:40:33 +0100 |
| commit | d754425bfaaaedc15faa98e3391af50682c82e31 (patch) | |
| tree | 8fe3990e31cf47d4c75cad40a49a38ced29b67d8 /doc/nissy.1 | |
| parent | 46e3e639f8efe35d2a878a5b1674235cead05abf (diff) | |
| download | nissy-d754425bfaaaedc15faa98e3391af50682c82e31.tar.gz nissy-d754425bfaaaedc15faa98e3391af50682c82e31.zip | |
Added batch mode
Diffstat (limited to '')
| -rw-r--r-- | doc/nissy.1 | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/doc/nissy.1 b/doc/nissy.1 index 992745d..0e2e5cb 100644 --- a/doc/nissy.1 +++ b/doc/nissy.1 | |||
| @@ -6,25 +6,34 @@ | |||
| 6 | .Nd a Rubik's cube solver and FMC assistant | 6 | .Nd a Rubik's cube solver and FMC assistant |
| 7 | . | 7 | . |
| 8 | .Sh SYNOPSIS | 8 | .Sh SYNOPSIS |
| 9 | .Nm | 9 | .Nm Op Fl b |
| 10 | .Nm | 10 | .Nm |
| 11 | .Ar command | 11 | .Ar command |
| 12 | .Op options... | 12 | .Op options... |
| 13 | . | 13 | . |
| 14 | When run without any argument an interactive shell is launched, otherwise | ||
| 15 | the provided | ||
| 16 | .Ar command | ||
| 17 | is executed and nissy terminates. | ||
| 18 | The commands that can be run in the interactive shell are the same that can | ||
| 19 | be run non-interactively and are provided below. | ||
| 20 | . | ||
| 21 | .Sh DESCRIPTION | 14 | .Sh DESCRIPTION |
| 22 | .Nm | 15 | .Nm |
| 23 | is a Rubik's Cube solver. Its optimal solver function uses Kociemba's one-step | 16 | is a Rubik's Cube solver. Its optimal solver function uses Kociemba's one-step |
| 24 | algorithm (huge optimal solver), and its performance is comparable to that | 17 | algorithm (huge optimal solver), and its performance is comparable to that |
| 25 | of Kociemba's implementation in Cube Explorer. | 18 | of Kociemba's implementation in Cube Explorer when using a single CPU |
| 19 | thread, and much faster when using multiple threads. | ||
| 26 | nissy can also solve different substeps of the Thistlethwaite's algorithm | 20 | nissy can also solve different substeps of the Thistlethwaite's algorithm |
| 27 | and more. | 21 | and more. |
| 22 | .Pp | ||
| 23 | When run without any argument an interactive shell is launched, otherwise | ||
| 24 | the provided | ||
| 25 | .Ar command | ||
| 26 | is executed and nissy terminates. If the option | ||
| 27 | .Fl b | ||
| 28 | is given, every argument after it is ignored and the shell is launched without | ||
| 29 | any prompt or welcome message. This can be used to run nissy in batch mode, | ||
| 30 | for example writing a list of commands in a | ||
| 31 | .Ar file | ||
| 32 | (one per line) and running | ||
| 33 | .Ar nissy -b < file | ||
| 34 | .Pp | ||
| 35 | The commands that can be run in the interactive shell are the same that can | ||
| 36 | be run non-interactively and are provided below. | ||
| 28 | . | 37 | . |
| 29 | .Sh COMMANDS | 38 | .Sh COMMANDS |
| 30 | The available | 39 | The available |
