Debian Codegraph @

texmf-dist/doc/latex/mathspic/README.txt

raw
1 %% readme.txt
2 %% for mathsPIC (version 1.13)
3
4 Name:- mathsPIC (Perl version)
5 Authors:- A. Syropoulos ([email protected])
6 and R.W.D. Nickalls ([email protected])
7 Date:- April 26, 2010
8
9 (1) INTRODUCTION
10 -----------------
11 MathsPIC is an open-source `filter' program for the PiCTeX graphics package, which enables complicated drawings/diagrams to be constructed very easily (allows the flexible use of LaTeX commands, relative addressing, macros, libraries, and perl programs).
12
13 MathsPIC is a Perl program which processes an input script file (containing mathsPIC, TeX, LaTeX, and PiCTeX commands) into a .tex file which can be processed in the usual way (by TeX or LaTeX) to generate the final graphic. Please read the comprehensive manual for details of commands, usage, examples, installation etc.
14
15 MathsPIC will run on any platform having a working Perl and TeX/LaTeX installation. However, there may of course be minor differences regarding installation and usage between platforms.
16
17 MathsPIC has been well tested using a Solaris x86 box and GNU/Linux which the authors are familiar with. Feedback regarding installation and usage on other platforms will be greatly appreciated, and included in future manuals.
18
19 For details see the manual (mp1manual*.pdf).
20
21 (2) HISTORY
22 -----------
23 MathsPIC was originally an MS-DOS program (September 1999). mathsPIC was implemented in Perl in order to (a) greatly improve its utility, and (b) to make it available to the wide range of platforms which run Perl. An early version of the Perl mathsPIC was presented at the TUG2000 conference (Oxford, UK).
24
25 (3) REQUIRED SYSTEMS
26 --------------------
27 -perl (an interpreter for the perl language, see http://www.perl.com)
28
29
30 (4) PACKAGE FILES
31 ------------------
32 The following files are included in the mathsPIC package.
33
34
35 grabtexdata.pl % Perl program used in Chapter 8 (Accessing TeX parameters)
36 HELP.TXT % text version of the Unix manpage
37 mathspic113.pl % mathsPIC program version 1.13 (perl)
38 mathspic.sty % style option
39 mathspic.1 % unix/Linux manpage file
40 mathspic.sh % example BASH file for running the program
41 MATHSPIC.BAT % example batch file (MS-Windows)
42 mathsPICmanual.pdf % manual
43 mathsPICmanual.zip % manual--all the LaTeX and figure files
44 mathsPICfigures.zip % all the .m and .pl files described in the manual
45 mathspic.lib % example library file of macros
46 README.txt % this file
47 sourcecode.pdf % source code
48 sourcecode.html % source code
49 sourcecode.nw % source code (noweb)
50
51
52
53 (5) INSTALLATION (Unix/Linux)
54 -----------------------------
55 Four files need to be placed in specific locations as follows
56 (see also USAGE regarding the BASH script file)
57
58 (a) mathsPIC program (mathspic113.pl)
59 This needs to be placed where your shell can find it
60 (typically: /usr/local/bin)
61
62 (b) mathsPIC BASH script (mathspic.sh)
63 This needs to be placed where your shell can find it
64 (typically: /usr/local/bin)
65
66 (c) LaTeX package (mathspic.sty)
67 This needs to be placed with the other style options
68 (typically: /usr/share/texmf/tex/latex/base/).
69
70 (d) manpage (mathspic.1)
71 place this file in the /man1/ directory
72 (typically: /usr/share/man/man1/)
73
74 An alternative to using the shell script (BASH file) is simply to make the
75 perl script file (mathspic.pl) `executable', as follows:
76 Just copy the file mathspic.pl to a directory where the shell
77 can find it (typically /usr/local/bin) and then
78 (1) rename the file --> mathspic.
79 (2) make the file `executable' (e.g., by issuing the command <chmod 755 mathspic> ).
80
81
82 (6) USAGE (see manual for full details)
83 ----------------------------------------
84 In Unix/Linux one way of running mathsPIC is to type the following at the command-line (options are shown in square brackets). Note this requires both the perl program (mathspic.pl) and the input file to be in the same directory.
85
86 Syntax:
87 perl mathspic113.pl [-b] [-c] [-h] infile [-o outfile]
88
89 Options:
90 -b enables bell/sound if errors are detected
91 -c disables writing of comments to output file
92 -o to be followed by the <outfile>
93 -h displays help info
94
95 However, it is generally much more convenient to run mathsPIC via a batch file, since we can then run mathsPIC from any directory.
96
97 For example (Unix/Linux) rename the example BASH file <mathspic.sh> to <mathspic>. Now change the user permissions to make it a read/write/executable file ($ chmod 755 mathspic). Finally, copy the file to a place where your shell will find it, typically the directory /usr/local/bin/. Now you will be able to run mathsPIC from the command-line in any directory using the command:-
98
99 mathspic [-b] [-c] [-h] infile [-o outfile]
100
101 MS-Windows users can use the example MATHSPIC.BAT file similarly.
102
103 (7) LICENSE (LPPL):
104 -------------
105 This program is free software; you can redistribute it and/or modify it under the terms of the LaTeX Project Public License.
106
107 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
108 -----------------
109 End of README.txt
110 -----------------
111
112
113
114 =========================
115