aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/co.txt39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/co.txt b/docs/co.txt
new file mode 100644
index 0000000..27c0b43
--- /dev/null
+++ b/docs/co.txt
@@ -0,0 +1,39 @@
1
2HELP PAGE FOR COMMAND co
3
4SYNTAX
5co [OPTIONS] [MOVES|$ID|@ID]
6
7DESCRIPTION
8Solves CO for a given scramble. A scramble can be given as last argument of the
9command, or an ID of a saved scramble can be provided. If none of the two is
10given, a prompt will ask the user to input a new scramble.
11
12OPTIONS
13axis={fb,rl,ud} Specify the axis for the CO. One to three axes can be given,
14 comma separated, no spaces.
15 Default: CO on any of the three axis (omitting the option is
16 the same as specifying axis=fb,rl,ud).
17b=N Specify a bound for the number of moves. N must be a number.
18 Default value: 20.
19h Show hidden COs.
20 Default, if an CO ending in e.g. F is shown, the equivalent
21 one ending in F' is hidden.
22i Ignore centers. By default the CO is aligned with centers.
23niss Use NISS.
24 Default: does not use NISS.
25n=N Specify a maximum number of COs to be output. N must be a
26 number.
27 Default value: 1.
28
29EXAMPLES
30co axis=fb $1
31 Finds one optimal CO on fb for the first saved scramble.
32
33co n=5 b=4 U R F
34 Finds up to 5 COs of length at most 4 for scramble U R F.
35
36co n=100 b=5 niss axis=fb,ud h R' U' F L R'U'F
37 Finds up to 100 COs of lenth at most 4, possibly using NISS, including
38 "hidden" COs, excluding the rl axis.
39

Generated with cgit - Back to sebastiano.tronto.net