-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathReadMe.rtf
142 lines (117 loc) · 7.79 KB
/
ReadMe.rtf
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
{\rtf1\ansi\ansicpg1252\cocoartf949\cocoasubrtf350
{\fonttbl\f0\fswiss\fcharset0 Optima-Regular;\f1\froman\fcharset0 Times-Roman;}
{\colortbl;\red255\green255\blue255;\red255\green0\blue0;}
\pard\tx565\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\f0\fs36 \cf0 AquaTerm
\b\fs24 \
\pard\tx565\tx1133\tx1700\tx2266\tx2833\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b0 \cf0 your friendly plotting front-end\
\pard\tx565\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b \cf0 \
Table of contents\
\pard\tx565\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b0 \cf0 1 What is AquaTerm?\
2 Who would use AquaTerm?\
3 How do I install AquaTerm?\
4 What gets installed where?\
5 Is AquaTerm and clients aware of the environment?\
6 What is in the Developer Extras folder?\
7 How can I find out more?\
8 How can I help in improving AquaTerm?\
9 License terms\
\pard\tx565\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b \cf0 \
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\cf0 1 What is AquaTerm?\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b0 \cf0 It is a small application that acts as an output device for other programs (command line applications, CLI) that need to render vector and bitmap graphics in windows. In order for that to work, the CLI need to be compiled with support for AquaTerm.\
\
Currently Gnuplot 4.x and programs based on PGPLOT and PLplot are or can be made AquaTerm aware.\
\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b \cf0 2 Who would use AquaTerm?
\b0 \
First and foremost, AquaTerm is of no or very little use by itself\'85 you need another application to provide input data.\
\
The target audience is a user of plotting applications such as Gnuplot (directly or indirectly) or homebrew command line tools who would like a native Mac OS X display option with PDF and EPS export functionality\
\
A developer who would like to provide graphics output on OS X for their application. The API is designed to fit well with procedural code, rather than OO-code.\
\
\b 3 How do I install AquaTerm?
\b0 \
An end user only need to double-click the installer package and follow the instructions. \
\
Developers also need the stuff in the Developer Extras folder, which can be dragged to a convenient location.\
\
\b 4 What gets installed where?
\b0 \
The installer will install the application AquaTerm in /Applications.\
It will place AquaTerm.framework in /Library/Frameworks. \
For backwards compatibility symlinks to shared lib and headers (located inside AquaTerm.framework) will be placed in /usr/local/lib and /usr/local/include/aquaterm.\
\pard\tx565\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\cf0 \
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b \cf0 5 Is AquaTerm and clients aware of the environment?\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b0 \cf0 Certainly. The following environment variables may be of interest:\
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
\cf0 \
General:\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b \cf0
\b0 AQUATERM_LOGLEVEL \'97 set in the range 0-4 to have increasing levels of logging to stdout, zero means no logging.\
\b
\b0 AQUATERM_PATH \'97 set this to have a specific copy of AquaTerm.app e.g. /Users/you/source/build/AquaTerm.app launched automatically from clients.\
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
\cf0 \
Clients:\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b \cf0
\b0 GNUTERM \'97 set this to "aqua" to make AquaTerm the default terminal in Gnuplot
\f1\fs20 \super \'86
\f0\fs24 \nosupersub \
\b
\b0 PGPLOT_DEV \'97 set this to "/AQT" to make AquaTerm default output in PGPLOT\
\
\f1\fs20 \super \'86
\f0 \nosupersub Aquaterm is already the default terminal in Gnuplot as of version 4.1, if it was built with aquaterm support.
\fs24 \
\
\b 6 What is in the Developer Extras folder?\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\i\b0 \cf2 The developer documentation is out of date, please use to the source code and mailing lists at http://sourceforge.net/mail/?group_id=39915 if you want the latest information.\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\i0 \cf0 \
Documentation for the Obj-C API is in AQTAdapter.html. \
\
The C API is unfortunately only documented by the header file aquaterm.h, but the calls are very similar to the methods described in AQTAdapter.html and it as a reference together with the C and Fortran examples should be enough to get you started. \
\
Examples of how to use AquaTerm from C, Python, and Fortran as well as a Perl module and an adapter for PGPLOT can be found in the adapters folder.\
\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\i \cf0 NB. The gnuplot adapter is part of gnuplot 4.x sources and the PLplot adapter is part of PLplot as of version 5.5.3
\i0 .\
\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b \cf0 7 How can I find out more?
\b0 \
Use the mailing lists and/or trackers at the project website: http://aquaterm.sourceforge.net\
\
\b 8 How can I help in improving AquaTerm?\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b0 \cf0 In many ways! Write code (core or adapters), write documentation, improve the website, test and report bugs, write supporting notes in email or sponsor the project with cash. \
\
\pard\tx285\tx1133\tx1700\tx2266\tx2832\tx3401\tx3967\tx4535\tx5102\tx5669\tx6235\tx6802\ql\qnatural
\b \cf0 9 License terms\
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
\b0 \cf0 Copyright \'a9 2001-2008, Per Persson, The AquaTerm project\
All rights reserved.\
\
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\
\
\'95 Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.\
\'95 Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.\
\'95 Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.\
\
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE\
}