summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/mpost.1
blob: fc66630751d1da79db126044217e370868a6f1f6 (plain)
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
.TH MPOST 1 "31 December 2018" "Web2C 2021"
.\"=====================================================================
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.if n .ds MP MetaPost
.if t .ds MP MetaPost
.if n .ds MF Metafont
.if t .ds MF Metafont
.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
.if n .ds TX TeX
.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP
.el .ds OX TeX
.\" BX definition must follow TX so BX can use TX
.if t .ds BX \fRB\s-2IB\s0\fP\*(TX
.if n .ds BX BibTeX
.\" LX definition must follow TX so LX can use TX
.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
.if n .ds LX LaTeX
.if n .ds WB Web
.if t .ds WB W\s-2EB\s0
.\"=====================================================================
.SH NAME
mpost, pmpost, upmpost \- MetaPost, a system for creating graphics
r-mpost, r-pmpost, r-upmpost \- restricted MetaPost
.SH SYNOPSIS
.B mpost
.RI [ options ]
.RI [ commands ]
.PP
.B mpost 
.B --dvitomp
.IR dvifile [\fB.dvi\fP]
.RI [ mpxfile [\fB.mpx\fP]]

.\"=====================================================================
.SH DESCRIPTION
\*(MP interprets the \*(MP language and produces PostScript (EPS)
or Scalable Vector Graphics (SVG) pictures.  The \*(MP language is similar 
to Knuth's \*(MF with additional features for including
.BR tex (1)
or
.BR troff (1)
commands and accessing features of PostScript not found in \*(MF. 
.PP
\*(MP is normally used with a set of basic macros, and it 
will use its executable name as the name of the preload 
file to use.   For example, when called as
.B mpost
the
.I mpost.mp
file is used, which simply reads
.IR plain.mp .
When the
.B --ini
option is given, preloading does not happen.  
.PP
The
.I commands
given on the command line to the \*(MP program are passed to it as the
first input line.  (But it is often easier to type extended arguments
as the first input line, since UNIX shells tend to gobble up or
misinterpret \*(MP's favorite symbols, like semicolons, unless you
quote them.) The normal usage is to say
.I mpost figs
to process the file
.IR figs.mp .
The basename of
.I figs
becomes the ``jobname'',
and is used in forming output file names.  If no file is named, the
jobname becomes
.IR mpout .
The default extension,
.IR .mp ,
can be overridden by specifying an extension explicitly.
.PP
When the
.B --dvitomp
option is given, \*(MP acts as DVI-to-MPX converter only.
See dvitomp (1) for details.
.PP
The
.B pmpost 
program is a variant with Japanese support, and
.B upmpost
has Unicode-enabled Japanese support, analogous to ptex and uptex.
.PP
All three variants are also installed with an `r-' prefix, that is,
.BR r-mpost ,
.BR r-pmpost ,
.BR r-upmpost ,
which implicitly specify the
.B --restricted
option to make MetaPost safe to run on unknown input; the tex, makempx,
and editor commands are disabled.
.PP
This manual page is a mere skeleton.  For a list of all command line
options, run
.BR --help .
.PP
The main documentation for this version of \*(MP can be found in the
User Manual that should have been installed along with the program and
is also available from https://tug.org/metapost.
.PP
The \*(MP language is similar to \*(MF, but the manual
assumes no knowledge of \*(MF.  \*(MP does not have bitmap
output commands or \*(MF's online display mechanism.
.\"=====================================================================
.SH FILES
.TP
.I plain.mp
The standard preload file.
.TP
.I mfplain.mp
The \*(MF-compatible preload file. 
.TP
.I $TEXMFMAIN/metapost/base/*.mp
The standard \*(MP macros included in the original distribution.
.TP
.I $TEXMFMAIN/metapost/support/*
Various tables for handling included
.I tex
and
.IR troff .
.TP
.I $TEXMFMAIN/metapost/support/trfonts.map
Table of corresponding font names for
.I troff 
and PostScript.
.TP
.I psfonts.map
Table of corresponding font names for
.I tex
and PostScript.
.TP
.I $TEXMFMAIN/doc/metapost/*
The \*(MP manual and tutorial source, also including sample figures
.\"=====================================================================
.SH "SUGGESTED READING"
Donald E. Knuth,
.I "The \*(MF\^book"
(Volume C of
.IR "Computers and Typesetting" ),
Addison-Wesley, 1986, ISBN 0-201-13445-4.
.br
.I TUGboat
(the journal of the \*(TX Users Group).
.\"=====================================================================
.SH "SEE ALSO"
.BR dvitomp (1),
.BR epstopdf (1),
.BR mf (1),
.BR mptopdf (1),
.BR tex (1),
.br
.URL "https://tug.org/metapost/" "MetaPost home page" .
.\"=====================================================================
.SH AUTHORS
\*(MP was created by John D. Hobby, incorporating algorithms from 
\*(MF by Donald E. Knuth.  It was originally implemented on Unix,
incorporating system-dependent routines from
.BR web2c ,
while not relying on it except for the actual \*(WB-to-C translator.
.PP
Ulrik Vieth adapted \*(MP to take advantage of the advanced path 
searching features in more recent versions of
.B web2c
and worked towards fully integrating \*(MP into the canonical Unix 
\*(TX distribution.
.PP
The primary author of the current \*(MP was Taco Hoekwater, with
assistance from Hans Hagen and many others.  It is currently maintained
by Luigi Scarso.
.\"=====================================================================
.SH BUGS
The MetaPost home page is https://tug.org/metapost.