From d754425bfaaaedc15faa98e3391af50682c82e31 Mon Sep 17 00:00:00 2001 From: Sebastiano Tronto Date: Fri, 10 Dec 2021 18:40:33 +0100 Subject: Added batch mode --- doc/nissy.1 | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) (limited to 'doc/nissy.1') 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 @@ .Nd a Rubik's cube solver and FMC assistant . .Sh SYNOPSIS -.Nm +.Nm Op Fl b .Nm .Ar command .Op options... . -When run without any argument an interactive shell is launched, otherwise -the provided -.Ar command -is executed and nissy terminates. -The commands that can be run in the interactive shell are the same that can -be run non-interactively and are provided below. -. .Sh DESCRIPTION .Nm is a Rubik's Cube solver. Its optimal solver function uses Kociemba's one-step algorithm (huge optimal solver), and its performance is comparable to that -of Kociemba's implementation in Cube Explorer. +of Kociemba's implementation in Cube Explorer when using a single CPU +thread, and much faster when using multiple threads. nissy can also solve different substeps of the Thistlethwaite's algorithm and more. +.Pp +When run without any argument an interactive shell is launched, otherwise +the provided +.Ar command +is executed and nissy terminates. If the option +.Fl b +is given, every argument after it is ignored and the shell is launched without +any prompt or welcome message. This can be used to run nissy in batch mode, +for example writing a list of commands in a +.Ar file +(one per line) and running +.Ar nissy -b < file +.Pp +The commands that can be run in the interactive shell are the same that can +be run non-interactively and are provided below. . .Sh COMMANDS The available -- cgit v1.3