diff options
Diffstat (limited to 'docs/htr.txt')
| -rw-r--r-- | docs/htr.txt | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/htr.txt b/docs/htr.txt new file mode 100644 index 0000000..7ed4d35 --- /dev/null +++ b/docs/htr.txt | |||
| @@ -0,0 +1,30 @@ | |||
| 1 | |||
| 2 | HELP PAGE FOR COMMAND htr | ||
| 3 | |||
| 4 | SYNTAX | ||
| 5 | htr [OPTIONS] [MOVES|$ID|@ID] | ||
| 6 | |||
| 7 | DESCRIPTION | ||
| 8 | Finds HTR for a given scramble. DR must be solved. A scramble can be given as | ||
| 9 | last argument of the command, or an ID of a saved scramble can be provided. If | ||
| 10 | none of the two is given, a prompt will ask the user to input a new scramble. | ||
| 11 | |||
| 12 | OPTIONS | ||
| 13 | from {ud|fb|rl} Allows to specify on which axis the DR is. This is usually | ||
| 14 | not needed, since nissy will automatically find it out. | ||
| 15 | b=N Specify a bound for the number of moves. N must be a number. | ||
| 16 | Default value: 20. | ||
| 17 | h Show hidden HTRs. | ||
| 18 | Default, if an HTR ending in e.g. R is shown, the equivalent | ||
| 19 | one ending in R' is hidden. | ||
| 20 | niss Use NISS. | ||
| 21 | Default: does not use NISS. | ||
| 22 | n=N Specify a maximum number of HTRs to be output. N must be a | ||
| 23 | number. | ||
| 24 | Default value: 1. | ||
| 25 | |||
| 26 | EXAMPLES | ||
| 27 | eo n=10 b=7 niss $1 | ||
| 28 | Finds up to 100 HTRs of lenth at most 7, possibly using NISS, including | ||
| 29 | "hidden" HTRs, for scramble $1. DR must be solved. | ||
| 30 | |||
