summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/rubik/rubikrotation.1
blob: c3c8c655b020682da0651d250c75df6328ced1da (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
.\" copyright (c) 2014--2017 A Syropoulos and RWD Nickalls
.\" rubikrotation.1
.\" place this file in: /usr/share/man/man1/
..
.TH rubikrotation.1 
.SH NAME
.B rubikrotation (v4.0)
.SH AUTHORS
A. Syropoulos and R.W.D. Nickalls (3rd March 2017)

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


.SH DESCRIPTION
.B rubikrotation
is a Perl script for processing Rubik cube rotations. It is part of the LaTeX rubikrotation package, and is typically CALLed by rubikrotation.sty. See the package manual for full details (type at the commandline: texdoc rubikrotation). Both the rubikrotation and rubikcube packages are 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 configuration data and instructions from an input file, and writes the new configuration data to an output file. The input and output filenames can be  specified as command-line arguments (see: command-line use). 

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

.B -h  
displays the help 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  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.