~ubuntu-branches/debian/squeeze/maxima/squeeze

« back to all changes in this revision

Viewing changes to doc/man/maxima.1.in

  • Committer: Bazaar Package Importer
  • Author(s): Camm Maguire
  • Date: 2006-10-18 14:52:42 UTC
  • mto: (1.1.5 upstream)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20061018145242-vzyrm5hmxr8kiosf
ImportĀ upstreamĀ versionĀ 5.10.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH MAXIMA 1L "August 23, 2002"
 
1
.TH MAXIMA 1L "September 10, 2005"
2
2
.ds Ps P\s-2OST\s+2S\s-2CRIPT\s+2
3
3
.ds Ts T\s-2RAN\s+2S\s-2CRIPT\s+2
4
4
.if t .ds Te T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X
5
5
.if n .ds Te TeX
6
6
.if t .ds La L\\h'-0.36m'\\v'-0.15v'\\s-2A\\s+2\\h'-0.15m'\\v'0.15v'T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X
7
7
.if n .ds La LaTeX
8
 
.ds Fl "F\s-2RANZ\s+2\ L\s-2ISP\s+2
 
8
.ds Fl "F\s-2ranz\s+2\ L\s-2isp\s+2
9
9
.ds Ml "M\s-2ACLISP\s+2
10
 
.ds Cl "Common L\s-2ISP\s+2
11
 
.ds Li "L\s-2ISP\s+2
12
 
.ds Ky "GNU Common L\s-2ISP\s+2
 
10
.ds Cl "Common L\s-2isp\s+2
 
11
.ds Li "L\s-2isp\s+2
 
12
.ds Ky "GNU Common L\s-2isp\s+2
13
13
.ds Pr @prefix@
14
14
.ds Vr @VERSION@
15
15
 
16
16
.SH NAME
17
 
maxima \- Common LISP version of MACSYMA symbolic mathematics package
 
17
Maxima \- Common Lisp version of MACSYMA symbolic mathematics package
18
18
released under the GNU Public License
19
19
.LP
20
 
xmaxima \- A graphical version of maxima
 
20
Xmaxima \- A graphical version of Maxima
21
21
.SH SYNOPSIS
22
22
.B maxima
23
23
[\fIoptions\fR]
25
25
.B xmaxima 
26
26
[\fIoptions\fR]
27
27
.SH DESCRIPTION
28
 
.I Maxima
29
 
is a version of the MIT-developed MACSYMA system, modified to run under
 
28
Maxima is a version of the MIT-developed MACSYMA system, modified to run under
30
29
\*(Cl.  It is an interactive expert system and programming environment
31
30
for symbolic and numerical mathematical manipulation.  Written in
32
31
\*(Li, it allows differentiation, integration, solution of linear or
35
34
tensor manipulations, and two- and three-dimensional graphics.
36
35
Procedures may be written using an ALGOL-like syntax, and both
37
36
\*(Li-like functions and pattern matching facilities are provided.
38
 
Files containing
39
 
.I maxima
 
37
Files containing Maxima
40
38
objects may be read from and written to disk files. Pre-written
41
 
.I maxima
42
 
commands may be read from a file and executed, allowing batch-mode
 
39
Maxima commands may be read from a file and executed, allowing batch-mode
43
40
use.
44
41
.SH OPTIONS
45
42
.TP
46
43
\fB\-b\fR \fIfile\fR, \fB\-\-batch=\fR\fIfile\fR
47
 
 Process \fIfile\fR in maxima batch mode.
 
44
Process \fIfile\fR in noninteractive mode.
48
45
.TP
49
46
\fB\-\-batch-lisp=\fR\fIfile\fR
50
 
 Process lisp file \fIfile\fR in batch mode.
 
47
Process Lisp file \fIfile\fR in noninteractive mode.
51
48
.TP
52
49
\fB\-\-batch-string=\fR\fIstring\fR
53
 
 Process \fIstring\fR in maxima batch mode.
 
50
Process \fIstring\fR in noninteractive mode.
 
51
.TP
 
52
\fB\-d\fR, \fB\-\-directories\fR
 
53
Display Maxima directory information.
 
54
.TP
 
55
\fB\-g\fR, \fB\-\-enable\-lisp\-debugger\fR
 
56
Enable Lisp debugger.
54
57
.TP
55
58
\fB\-h\fR, \fB\-\-help\fR
56
 
 Display a brief usage summary.
 
59
Display a brief usage summary.
57
60
.TP
58
61
\fB\-l\fR \fIlisp\fR, \fB\-\-lisp=\fR\fIlisp\fR 
59
 
Use lisp implementation \fIlisp\fR. Use \fB\-\-list-avail\fR to see the
 
62
Use Lisp implementation \fIlisp\fR. Use \fB\-\-list-avail\fR to see the
60
63
list of possible values.
61
64
.TP
 
65
\fB\-\-list-avail\fR
 
66
List the available Lisp and Maxima versions.
 
67
.TP
62
68
\fB\-p\fR \fIlisp_file\fR, \fB\-\-preload-lisp=\fR\fIlisp_file\fR
63
 
 Preload \fIlisp_file\fR.
 
69
Preload \fIlisp_file\fR.
64
70
.TP
65
71
\fB\-r\fR \fIstring\fR, \fB\-\-run-string=\fR\fIstring\fR
66
 
Process \fIstring\fR in maxima interactive mode.
 
72
Process \fIstring\fR in interactive mode.
 
73
.TP
 
74
\fB\-s\fR \fIport\fR, \fB\-\-server=\fR\fIport\fR
 
75
Start Maxima server on \fIport\fR.
67
76
.TP
68
77
\fB\-u\fR \fIversion\fR, \fB\-\-use-version=\fR\fIversion\fR 
69
 
Launch maxima version \fIversion\fR. Use \fB\-\-list-avail\fR to see
 
78
Launch Maxima version \fIversion\fR. Use \fB\-\-list-avail\fR to see
70
79
the list of possible values.
71
80
.TP
72
81
\fB\-v\fR, \fB\-\-verbose\fR
73
 
Print extra information from the maxima wrapper script.
 
82
Print extra information from the Maxima wrapper script.
74
83
.TP
75
84
\fB\-\-version\fR
76
85
Print the (default) installed version.
80
89
.I maxima
81
90
prints a startup message, then a command line prompt:
82
91
.LP
83
 
.B (C1)
 
92
.B (%i1)
84
93
.LP
85
 
All
86
 
.I maxima
87
 
commands must be concluded with either:
 
94
All Maxima commands must be concluded with either:
88
95
.TP
89
96
1)
90
 
a semi-colon (in which case the result of the command is echoed on a display
 
97
a semicolon (in which case the result of the command is echoed on a display
91
98
line, prefaced by
92
 
.B D
 
99
.B %o
93
100
with an appended sequence number), or
94
101
.TP
95
102
2)
97
104
.LP
98
105
.SH EXAMPLE
99
106
.LP
100
 
(C1) diff(sin(x),x);
101
 
.LP
102
 
(D1)                         COS(x)
103
 
.LP
104
 
(C2) integrate(d1,x);
105
 
.LP
106
 
(D2)                         SIN(x)
 
107
(%i1) diff(sin(x),x);
 
108
.LP
 
109
(%o1)                         cos(x)
 
110
.LP
 
111
(%i2) integrate(%o1,x);
 
112
.LP
 
113
(%o2)                         sin(x)
107
114
.LP
108
115
The user types in commands which create
109
 
.I "maxima objects"
 
116
.I "Maxima objects"
110
117
(such as functions and system variables) and which manipulate these objects.
111
118
.LP
112
 
On UNIX it may be preferable to run maxima under Gnu Emacs or XEmacs.
 
119
On UNIX it may be preferable to run Maxima under Gnu Emacs or XEmacs.
113
120
You can do this by invoking shell mode in
114
121
.IR emacs ,
115
122
and then invoking
126
133
is that it provides a complete history of input/output.
127
134
If you execute the command
128
135
.IP
129
 
.B display2d:false
 
136
.B display2d: false
130
137
.LP
131
138
you will be able to use your output as input,
132
139
by simply killing and yanking.
133
140
.LP
134
 
\*(Li is built into
135
 
.I maxima.
136
 
The function to_lisp() enters the lisp read-eval-print loop. The
 
141
\*(Li is built into Maxima.
 
142
The function to_lisp() enters the Lisp read-eval-print loop. The
137
143
\*(Li function (run) may be used to return to Maxima. Alternatively,
138
144
single \*(Li commands may be invoked by starting a command line with
139
145
\fB:lisp\fR. 
140
146
.SH BUILT-IN HELP
141
 
Extensive on-line documentation is built in to the system.
 
147
The reference manual can be accessed from the Maxima input prompt.
142
148
A description of a given command can be obtained by typing the command
143
149
.LP
144
150
\fBdescribe(command);\fR
148
154
\fB ? command\fR
149
155
.LP
150
156
searches the list of functions for the string \fIcommand\fR.
151
 
Demonstration files provide complete examples of problems solved with
152
 
.IR maxima ,
 
157
Demonstration files provide complete examples of problems solved with Maxima,
153
158
and may be accessed with the command
154
159
\fBdemo(command);\fR.
155
160
A library of user-contributed command files is also provided (the
156
161
.IR "share library" ),
157
162
directed toward a variety of problems.
158
163
.SH OTHER DOCUMENTATION
159
 
Full documentation is provided in both info and html formats.
 
164
The reference manual is provided in both info and html formats.
160
165
.SH COMMAND PRIMER
161
166
.LP
162
167
This list includes only commands which the beginner might find
163
 
useful to know about prior to studying the on-line primer and
164
 
the printed reference manuals.
 
168
useful to know about prior to studying the reference manual
 
169
and other texts.
165
170
.TP
166
171
.B batch("myfile");
167
172
Execute the contents of file
168
173
.IR myfile ,
169
 
which is assumed to contain
170
 
.I maxima
171
 
commands.
 
174
which is assumed to contain Maxima commands.
172
175
.TP
173
176
.B closefile("myfile");
174
177
Close session file opened by a writefile command (see below).
176
179
.B demo("myfile");
177
180
Execute the contents of file
178
181
.IR myfile ,
179
 
which is assumed to contain
180
 
.I maxima
 
182
which is assumed to contain Maxima
181
183
commands, one line at a time.
182
184
.TP
183
185
.B ev(infolists);
192
194
.B kill(objectlist);
193
195
Eliminate the object(s) contained within parentheses;
194
196
.I kill(all)
195
 
Delete all objects created by the user, restoring
196
 
.I maxima
 
197
Delete all objects created by the user, restoring Maxima
197
198
to its initial state.
198
199
.TP
199
200
.B quit();
200
 
Leave
201
 
.IR maxima .
 
201
Leave Maxima.
202
202
.TP
203
203
.B reset();
204
 
Reset all
205
 
.I maxima
206
 
control parameters to their default states.
 
204
Reset all Maxima control parameters to their default states.
207
205
.TP
208
206
.B values;
209
207
Print a list of the names of currently assigned scalar values.
213
211
.IR myfile ;
214
212
only one file at a time can be open, and the
215
213
.I closefile
216
 
command must be invoked prior to leaving
217
 
.I maxima
 
214
command must be invoked prior to leaving Maxima
218
215
to flush the buffer.
219
216
.SH PLOTTING COMMANDS
220
217
Maxima is capable of producing 2- and 3-dimensional plots. Here is a
221
218
simple 2-dimensional example
222
219
.LP
223
 
.B plot2d(sin(x),[x,-2*%pi,2*%pi]);
 
220
.B plot2d (sin(x), [x, -2*%pi, 2*%pi]);
224
221
.LP
225
222
and a simple 3-dimensional example
226
223
.LP
227
 
.B plot3d(2^(-u^2+v^2),[u,-5,5],[v,-7,7]);
228
 
.LP
229
 
By default plotting is done by a TCL/Tk application supplied with
230
 
Maxima. If gnuplot is available, it can be used by setting a plot
231
 
option as follows
232
 
.LP
233
 
.B set_plot_option([PLOT_FORMAT,gnuplot]);
234
 
.LP
235
 
For more information, see "? plot".
 
224
.B plot3d (2^(-u^2 + v^2), [u, -5, 5], [v, -7, 7]);
 
225
.LP
 
226
By default plots are made by the
 
227
.I
 
228
gnuplot
 
229
plotting package.
 
230
Plots can be made by other means; see "? plot_options".
 
231
For more information about plotting, see "? plot".
236
232
.SH FILES
237
233
.TP 1.0i
238
234
.I \*(Pr/lib/maxima/\*(Vr/binary-\fIlisp\fR
278
274
\fBMAXIMA_PREFIX\fR
279
275
Maxima looks for its input files in the directory configured at
280
276
compile time, \*(Pr. Maxima can be relocated to a different directory
281
 
as long as the maxima script maintains the same relative position with
282
 
respect to the Maxima input files. If, for some reason, the maxima
 
277
as long as the
 
278
.I maxima
 
279
script maintains the same relative position with
 
280
respect to the Maxima input files. If, for some reason, the
 
281
.I maxima
283
282
script needs to be relocated independently, \fBMAXIMA_PREFIX\fR needs to be
284
283
set to point to the top of the tree holding the input files.
285
284
.TP
288
287
included only for backward compatibility with older versions of Maxima.
289
288
.LP
290
289
Maxima uses several other environment variables for communication
291
 
between the maxima script and the lisp image. All such variables start
 
290
between the
 
291
.I maxima
 
292
script and the lisp image. All such variables start
292
293
with \fIMAXIMA_\fR. They should not need to be modified by the user.
293
294
.SH CUSTOMIZATION FILES
294
295
.TP
295
296
\fBmaximarc\fR
296
 
\fBmaximarc\fR is sourced by the maxima script at startup. It should
 
297
\fBmaximarc\fR is sourced by the
 
298
.I maxima
 
299
script at startup. It should
297
300
be located in \fB$MAXIMA_USERDIR\fR (see above). \fBmaximarc\fR can be
298
301
used, \fIe.g.\fR, to change the user's default lisp implementation
299
302
choice to CMUCL by including the line "MAXIMA_LISP=cmucl".
300
303
.TP
301
304
\fBmaxima-init.lisp\fR
302
 
At startup, maxima will load the lisp file \fBmaxima-init.lisp\fR if it is
303
 
found in the search path.
 
305
At startup, Maxima will load the lisp file \fBmaxima-init.lisp\fR if
 
306
it is found in the search path. For user customization,
 
307
\fBmaxima-init.lisp\fR should be placed in the \fB$MAXIMA_USERDIR\fR
 
308
(see above). Since Maxima typically has a system
 
309
\fBmaxima-init.lisp\fR in the Maxima share directory, the user may
 
310
want to copy the contents of the system \fBmaxima-init.lisp\fR into
 
311
his/her custom file.
304
312
.TP
305
313
\fBmaxima-init.mac\fR
306
 
At startup, maxima will load the maxima file \fBmaxima-init.mac\fR if it is
307
 
found in the search path.
 
314
At startup, Maxima will load the file \fBmaxima-init.mac\fR if
 
315
it is found in the search path.  For user customization,
 
316
\fBmaxima-init.mac\fR should be placed in the \fB$MAXIMA_USERDIR\fR
 
317
(see above).
308
318
.SH REFERENCES
309
319
Old Reference:  
310
320
.I "MACSYMA Reference Manual"
317
327
Newer references: 
318
328
.I http://maxima.sourceforge.net
319
329
.SH BUGS
320
 
.I Maxima
321
 
is a complex system. It includes both known and unknown bugs.
 
330
Maxima is a complex system. It includes both known and unknown bugs.
322
331
Use at your own risk. The Maxima bug database is available at
323
332
.LP
324
333
http://sourceforge.net/tracker/?atid=104933&group_id=4933&func=browse