summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/rubikrotation.1
blob: 17a03ab2e01e68c2ff320fc0d7d4b57ae321b269 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.\" copyright (c) 2014--2018 A Syropoulos and RWD Nickalls
.\" rubikrotation.1
.\" place this file in: /usr/share/man/man1/
..
.TH rubikrotation.1 
.SH NAME
.B rubikrotation (v5.0)
.SH AUTHORS
A. Syropoulos and R.W.D. Nickalls (25 February 2018)

 dick[at]<nickalls><org>
 asyropoulos[at]<yahoo><com> 


.SH DESCRIPTION
.B rubikrotation
is a Perl script for processing Rubik cube rotations (3x3x3 and 2x2x2). It is part of the LaTeX rubikrotation package, and is typically CALLed by rubikrotation.sty, in response to the RubikRotation{} command: see the package manual (rubikrotation.pdf) for details. The rubikrotation package is part of the LaTeX Rubik `bundle'. The latest version can be downloaded from
.PP
CTAN: mirror.ctan.org/macros/latex/contrib/rubik/
.PP
rubikrotation reads Rubik state data and commands (sequence of rotations) from an input file, and writes the new state data to an output file. The input and output filenames can be  specified as command-line arguments (see: command-line use). 

If a configuration file exists (rubikrotation.cfg) then it will be automatically be read by rubikrotation.sty.

.SH COMMAND-LINE USE
rubikrotation  [-h|--help|-v|--version] [-o  <outfile>]  -i  <infile>

.B -h  
displays the help info and exits.

.B -v  
displays the version info and exits.

.B -i  
defines the input filename.
The default input filename set by  the rubikrotation package is rubikstate.dat, and this is generated by the LaTeX RubikRotation{} command (see the rubikrotation LaTeX package manual rubikrotation.pdf).  Note that the rubikrotation perl script expects the input file to have a certain structure, as described in rubikrotation.pdf and rubikrotationPL.pdf). 

.B -o  
defines the output filename.
If no output filename is given then the default filename rubikOUT.txt is used.

.SH SEE ALSO
The rubikrotation Perl script manual (rubikrotationPL.pdf), the rubikrotation LaTeX package manual (rubikrotation.pdf), examples (rubikexamples.pdf), the rubikcube LaTeX package manual (rubikcube.pdf), and the rubikpatterns LaTeX package manuals (rubikpatterns.pdf and rubikpatternsLIST.pdf). 

To view  rubikrotation.pdf, type:  texdoc rubikrotation

To view  rubikrotationPL.pdf, type:  texdoc rubikrotationPL

To view  rubikcube.pdf, type:  texdoc rubikcube

To view  rubiktwocube.pdf, type:  texdoc rubiktwocube

To view  rubikexamples.pdf, type:  texdoc rubikexamples

To view  rubikpatterns.pdf, type:  texdoc rubikpatterns

To view  rubikpatternsLIST.pdf, type:  texdoc rubikpatternsLIST

.SH BUGS
Please report bugs to Dick Nickalls or to Apostolos Syropoulos.