aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/nissy.127
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.
14When run without any argument an interactive shell is launched, otherwise
15the provided
16.Ar command
17is executed and nissy terminates.
18The commands that can be run in the interactive shell are the same that can
19be run non-interactively and are provided below.
20.
21.Sh DESCRIPTION 14.Sh DESCRIPTION
22.Nm 15.Nm
23is a Rubik's Cube solver. Its optimal solver function uses Kociemba's one-step 16is a Rubik's Cube solver. Its optimal solver function uses Kociemba's one-step
24algorithm (huge optimal solver), and its performance is comparable to that 17algorithm (huge optimal solver), and its performance is comparable to that
25of Kociemba's implementation in Cube Explorer. 18of Kociemba's implementation in Cube Explorer when using a single CPU
19thread, and much faster when using multiple threads.
26nissy can also solve different substeps of the Thistlethwaite's algorithm 20nissy can also solve different substeps of the Thistlethwaite's algorithm
27and more. 21and more.
22.Pp
23When run without any argument an interactive shell is launched, otherwise
24the provided
25.Ar command
26is executed and nissy terminates. If the option
27.Fl b
28is given, every argument after it is ignored and the shell is launched without
29any prompt or welcome message. This can be used to run nissy in batch mode,
30for example writing a list of commands in a
31.Ar file
32(one per line) and running
33.Ar nissy -b < file
34.Pp
35The commands that can be run in the interactive shell are the same that can
36be run non-interactively and are provided below.
28. 37.
29.Sh COMMANDS 38.Sh COMMANDS
30The available 39The available

Generated with cgit - Back to sebastiano.tronto.net