Debian Codegraph @

texmf-dist/doc/man/man1/rubikrotation.1

raw
1 .\" copyright (c) 2014--2018 A Syropoulos and RWD Nickalls
2 .\" rubikrotation.1
3 .\" place this file in: /usr/share/man/man1/
4 ..
5 .TH rubikrotation.1
6 .SH NAME
7 .B rubikrotation (v5.0)
8 .SH AUTHORS
9 A. Syropoulos and R.W.D. Nickalls (25 February 2018)
10
11 dick[at]<nickalls><org>
12 asyropoulos[at]<yahoo><com>
13
14
15 .SH DESCRIPTION
16 .B rubikrotation
17 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
18 .PP
19 CTAN: mirror.ctan.org/macros/latex/contrib/rubik/
20 .PP
21 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).
22
23 If a configuration file exists (rubikrotation.cfg) then it will be automatically be read by rubikrotation.sty.
24
25 .SH COMMAND-LINE USE
26 rubikrotation [-h|--help|-v|--version] [-o <outfile>] -i <infile>
27
28 .B -h
29 displays the help info and exits.
30
31 .B -v
32 displays the version info and exits.
33
34 .B -i
35 defines the input filename.
36 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).
37
38 .B -o
39 defines the output filename.
40 If no output filename is given then the default filename rubikOUT.txt is used.
41
42 .SH SEE ALSO
43 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).
44
45 To view rubikrotation.pdf, type: texdoc rubikrotation
46
47 To view rubikrotationPL.pdf, type: texdoc rubikrotationPL
48
49 To view rubikcube.pdf, type: texdoc rubikcube
50
51 To view rubiktwocube.pdf, type: texdoc rubiktwocube
52
53 To view rubikexamples.pdf, type: texdoc rubikexamples
54
55 To view rubikpatterns.pdf, type: texdoc rubikpatterns
56
57 To view rubikpatternsLIST.pdf, type: texdoc rubikpatternsLIST
58
59 .SH BUGS
60 Please report bugs to Dick Nickalls or to Apostolos Syropoulos.
61