aboutsummaryrefslogtreecommitdiff
path: root/doc/nissy.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/nissy.1153
1 files changed, 153 insertions, 0 deletions
diff --git a/doc/nissy.1 b/doc/nissy.1
new file mode 100644
index 0000000..ebabb0e
--- /dev/null
+++ b/doc/nissy.1
@@ -0,0 +1,153 @@
1.Dd November 2021
2.Dt NISSY 1
3.Os
4.Sh NAME
5.Nm nissy
6.Nd a Rubik's cube solver and FMC assistant
7.
8.Sh SYNOPSIS
9.Nm
10.Nm
11.Ar command
12.Op options...
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
22.Nm
23is 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
25of Kociemba's implementation in Cube Explorer.
26nissy can also solve different substeps of the Thistlethwaite's algorithm
27and more.
28.
29.Sh COMMANDS
30The available
31.Ar commands
32are the following:
33.
34.Bl -tag -width Ds
35.
36.It Nm commands
37List all available commands.
38.
39.It Nm help Op Ar command
40Display help. If no
41.Ar command
42is given, a generic help message is printed, otherwise a specific help
43relative to
44.Ar command
45is returned.
46.
47.It Nm print Ar scramble
48Display a text-only description of the cube obtained after applying
49.Ar scramble .
50.
51.It Nm quit
52Quit nissy.
53.
54.It Nm solve Ar step Oo Ar options Oc Ar scramble
55Solve the given
56.Ar step
57on the given
58.Ar scramble.
59By default it finds only one (shortest) solution, without using niss, and it
60displays the number of moves at the end of the line.
61.
62The options for the
63.Ar solve
64command are the following:
65.
66.Bl -tag -width Ds
67.
68.It Fl m Ar min
69Only look for solution that are at least
70.Ar min
71moves long.
72.
73.It Fl M Ar MAX
74Only look for solution that are at most
75.Ar MAX
76moves long.
77.
78.It Fl s Ar n
79Try to find
80.Ar n
81solutions.
82.
83.It Fl a
84Print all solutions: some solutions are filtered out by default for some
85steps, for examples EOs that finish with F\(aq, with this options they are not.
86.
87.It Fl n
88Allow use of NISS.
89.
90.It Fl o
91Only find solutions that require the minimum number of moves.
92.
93.It Fl p
94Plain style: do not print the number of moves.
95.
96.It Fl v
97Verbose mode: print some information during the search and print each solution
98as it is found instead of only printing them all together at the end.
99.
100.
101.El
102.
103.It Nm steps
104List all available
105.Ar steps
106for the
107.Ar solve
108command.
109.
110.It Nm version
111Display version information.
112.
113.El
114.
115.Sh ENVIRONMENT
116Data is stored in the folder pointed to by
117.Nm $NISSYDATA.
118If that variable is unset the folder
119.Nm $XDG_DATA_HOME/nissy
120or
121.Nm $HOME/.nissy
122is used instead.
123.
124.Sh EXAMPLES
125.
126The command:
127.Dl nissy solve -v \(dqR\(aqU\(aqFD2L2FR2U2R2BD2LB2D\(aqB2L\(aqR\(aqBD2BU2LU2R\(aqU\(aqF\(dq
128.
129Returns:
130.Dl Found 0 solutions, searching depth 0...
131.Dl Found 0 solutions, searching depth 1...
132.Dl (some more lines)
133.Dl Found 0 solutions, searching depth 16...
134.Dl D2 F\(aq U2 D2 F\(aq L2 D R2 D F B2 R\(aq L2 F\(aq U\(aq D
135.Dl D2 F\(aq U2 D2 F\(aq L2 D R2 D F B2 R\(aq L2 F\(aq U\(aq D (16)
136.
137The command:
138.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
139.
140Returns:
141.Dl U B U\(aq B (4)
142.Dl U2 D2 B (B) (4)
143.Dl U2 F R2 F (4)
144.Dl U2 B U2 B (4)
145.Dl U2 B (U B) (4)
146.Dl U\(aq B U B (4)
147.
148.Sh AUTHORS
149.An Sebastiano Tronto Aq Mt sebastiano.tronto@gmail.com
150.
151.Sh SOURCE CODE
152Source code is available at
153.Lk https://github.com/sebastianotronto/nissy

Generated with cgit - Back to sebastiano.tronto.net