beta-0.89.2
[luatex.git] / source / texk / web2c / man / mpost.man
blob924666fbf117e4d9e530f2a5ee98389d7d5d9361
1 .TH MPOST 1 "16 June 2015" "Web2C @VERSION@"
2 .\"=====================================================================
3 .de URL
4 \\$2 \(laURL: \\$1 \(ra\\$3
5 ..
6 .if \n[.g] .mso www.tmac
7 .if n .ds MP MetaPost
8 .if t .ds MP MetaPost
9 .if n .ds MF Metafont
10 .if t .ds MF Metafont
11 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
12 .if n .ds TX TeX
13 .ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP
14 .el .ds OX TeX
15 .\" BX definition must follow TX so BX can use TX
16 .if t .ds BX \fRB\s-2IB\s0\fP\*(TX
17 .if n .ds BX BibTeX
18 .\" LX definition must follow TX so LX can use TX
19 .if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
20 .if n .ds LX LaTeX
21 .if n .ds WB Web
22 .if t .ds WB W\s-2EB\s0
23 .\"=====================================================================
24 .SH NAME
25 mpost \- MetaPost, a system for creating graphics
26 .SH SYNOPSIS
27 .B mpost
28 .RI [ options ]
29 .RI [ commands ]
30 .PP
31 .B mpost 
32 .B --dvitomp
33 .IR dvifile [\fB.dvi\fP]
34 .RI [ mpxfile [\fB.mpx\fP]]
36 .\"=====================================================================
37 .SH DESCRIPTION
38 \*(MP interprets the \*(MP language and produces PostScript (EPS)
39 or Scalable Vector Graphics (SVG) pictures.  The \*(MP language is similar 
40 to Knuth's \*(MF with additional features for including
41 .BR tex (1)
43 .BR troff (1)
44 commands and accessing features of PostScript not found in \*(MF. 
45 .PP
46 \*(MP is normally used with some preloaded macros, and it 
47 will use its executable name as the name of the preload 
48 file to use.   For example, when called as
49 .B mpost
50 the
51 .I mpost.mp
52 file is used, which is identical to
53 .I plain.mp.
54 When the
55 .B --ini
56 option is given, preloading does not happen.  
57 .PP
58 The
59 .I commands
60 given on the command line to the \*(MP program are passed to it as the
61 first input line.  (But it is often easier to type extended arguments
62 as the first input line, since UNIX shells tend to gobble up or
63 misinterpret \*(MP's favorite symbols, like semicolons, unless you
64 quote them.) The normal usage is to say
65 .I mpost figs
66 to process the file
67 .IR figs.mp .
68 The basename of
69 .I figs
70 becomes the ``jobname'',
71 and is used in forming output file names.  If no file is named, the
72 jobname becomes
73 .IR mpout .
74 The default extension,
75 .IR .mp ,
76 can be overridden by specifying an extension explicitly.
77 .PP
78 When the
79 .B --dvitomp
80 option is given, \*(MP acts as DVI-to-MPX converter only.
81 See dvitomp (1) for details.
82 .PP
83 This manual page is not meant to be exhaustive.  The complete
84 documentation for this version of \*(MP can be found in the
85 User Manual that should have been installed along with the program and
86 is also available from http://tug.org/metapost.
87 See the FILES section below.
88 .PP
89 The \*(MP language is similar to \*(MF, but the manual
90 assumes no knowledge of \*(MF.  \*(MP does not have bitmap
91 output commands or \*(MF's online display mechanism.
93 .\"=====================================================================
94 .SH FILES
95 .TP
96 .I plain.mp
97 The standard preload file.
98 .TP
99 .I mfplain.mp
100 The \*(MF-compatible preload file. 
102 .I $TEXMFMAIN/metapost/base/*.mp
103 The standard \*(MP macros included in the original distribution.
105 .I $TEXMFMAIN/metapost/support/*
106 Various tables for handling included
107 .I tex
109 .IR troff .
111 .I $TEXMFMAIN/metapost/support/trfonts.map
112 Table of corresponding font names for
113 .I troff 
114 and PostScript.
116 .I psfonts.map
117 Table of corresponding font names for
118 .I tex
119 and PostScript.
121 .I $TEXMFMAIN/doc/metapost/*
122 The \*(MP manual and tutorial source, also including sample figures
123 .\"=====================================================================
124 .SH "SUGGESTED READING"
125 Donald E. Knuth,
126 .I "The \*(MF\^book"
127 (Volume C of
128 .IR "Computers and Typesetting" ),
129 Addison-Wesley, 1986, ISBN 0-201-13445-4.
131 .I TUGboat
132 (the journal of the \*(TX Users Group).
133 .\"=====================================================================
134 .SH "SEE ALSO"
136 .BR dvitomp (1),
137 .BR epstopdf (1),
138 .BR mf (1),
139 .BR mptopdf (1),
140 .BR tex (1),
142 .URL "http://foundry.supelec.fr/gf/project/metapost/" "MetaPost source code" .
144 .URL "http://tug.org/metapost/" "MetaPost home page" .
145 .\"=====================================================================
146 .SH AUTHORS
147 \*(MP was designed by John D. Hobby, incorporating algorithms from 
148 \*(MF by Donald E. Knuth.  It was originally implemented on Unix,
149 incorporating system-dependent routines from
150 .BR web2c ,
151 while not relying on it except for the actual \*(WB-to-C translator.
153 The primary author of the current \*(MP was Taco Hoekwater, with
154 assistance from Hans Hagen and many others.  It is currently maintained
155 by Luigi Scarso.
157 Ulrik Vieth adapted \*(MP to take advantage of the advanced path 
158 searching features in more recent versions of
159 .B web2c
160 and worked towards fully integrating \*(MP into the canonical Unix 
161 \*(TX distribution.
162 .\"=====================================================================
163 .SH BUGS
164 The MetaPost home page is http://tug.org/metapost.