.Dd November 2021
.Dt NISSY 1
.Os
.Sh NAME
.Nm nissy
.Nd a Rubik's cube solver and FMC assistant
.
.Sh SYNOPSIS
.Nm
.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.
nissy can also solve different substeps of the Thistlethwaite's algorithm
and more.
.
.Sh COMMANDS
The available
.Ar commands
are the following:
.
.Bl -tag -width Ds
.
.It Nm commands
List all available commands.
.
.It Nm help Op Ar command
Display help. If no
.Ar command
is given, a generic help message is printed, otherwise a specific help
relative to
.Ar command
is returned.
.
.It Nm print Ar scramble
Display a text-only description of the cube obtained after applying
.Ar scramble .
.
.It Nm quit
Quit nissy.
.
.It Nm solve Ar step Oo Ar options Oc Ar scramble
Solve the given
.Ar step
on the given
.Ar scramble.
By default it finds only one (shortest) solution, without using niss, and it
displays the number of moves at the end of the line.
.
The options for the
.Ar solve
command are the following:
.
.Bl -tag -width Ds
.
.It Fl m Ar min
Only look for solution that are at least
.Ar min
moves long.
.
.It Fl M Ar MAX
Only look for solution that are at most
.Ar MAX
moves long.
.
.It Fl s Ar n
Try to find
.Ar n
solutions.
.
.It Fl a
Print all solutions: some solutions are filtered out by default for some
steps, for examples EOs that finish with F\(aq, with this options they are not.
.
.It Fl n
Allow use of NISS.
.
.It Fl o
Only find solutions that require the minimum number of moves.
.
.It Fl p
Plain style: do not print the number of moves.
.
.It Fl v
Verbose mode: print some information during the search and print each solution
as it is found instead of only printing them all together at the end.
.
.
.El
.
.It Nm steps
List all available
.Ar steps
for the
.Ar solve
command.
.
.It Nm version
Display version information.
.
.El
.
.Sh ENVIRONMENT
Data is stored in the folder pointed to by
.Nm $NISSYDATA.
If that variable is unset the folder
.Nm $XDG_DATA_HOME/nissy
or
.Nm $HOME/.nissy
is used instead.
.
.Sh EXAMPLES
.
The command:
.Dl nissy solve -v \(dqR\(aqU\(aqFD2L2FR2U2R2BD2LB2D\(aqB2L\(aqR\(aqBD2BU2LU2R\(aqU\(aqF\(dq
.
Returns:
.Dl Found 0 solutions, searching depth 0...
.Dl Found 0 solutions, searching depth 1...
.Dl (some more lines)
.Dl Found 0 solutions, searching depth 16...
.Dl D2 F\(aq U2 D2 F\(aq L2 D R2 D F B2 R\(aq L2 F\(aq U\(aq D
.Dl D2 F\(aq U2 D2 F\(aq L2 D R2 D F B2 R\(aq L2 F\(aq U\(aq D (16)
.
The command:
.Dl nissy solve eofb -m 4 -M 5 -n -s 6 \(dqR\(aqU\(aqFD2L2 FR2 U2R2BD2 L B2 D\(aq B2 L\(aq R\(aq\(dq
.
Returns:
.Dl U B U\(aq B (4)
.Dl U2 D2 B (B) (4)
.Dl U2 F R2 F (4)
.Dl U2 B U2 B (4)
.Dl U2 B (U B) (4)
.Dl U\(aq B U B (4)
.
.Sh AUTHORS
.An Sebastiano Tronto Aq Mt sebastiano.tronto@gmail.com
.
.Sh SOURCE CODE
Source code is available at
.Lk https://github.com/sebastianotronto/nissy