Debian Codegraph @

texmf-dist/doc/man/man1/mpost.1

raw
1 .TH MPOST 1 "31 December 2018" "Web2C 2026"
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.10m'\\v'0.17v'E\\v'-0.17v'\\h'-0.06m'X\fP
12 .if n .ds TX TeX
13 .ie t .ds OX \fIT\h'-0.17m'\v'+0.21m'E\v'-0.21m'\h'-0.04m'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 .\"=====================================================================
22 .SH NAME
23 mpost, pmpost, upmpost \- MetaPost, a system for creating graphics
24 r-mpost, r-pmpost, r-upmpost \- restricted MetaPost
25 .SH SYNOPSIS
26 .B mpost
27 .RI [ options ]
28 .RI [ commands ]
29 .PP
30 .B mpost
31 .B --dvitomp
32 .IR dvifile [\fB.dvi\fP]
33 .RI [ mpxfile [\fB.mpx\fP]]
34
35 .\"=====================================================================
36 .SH DESCRIPTION
37 \*(MP interprets the \*(MP language and produces PostScript (EPS)
38 or Scalable Vector Graphics (SVG) pictures. The \*(MP language is similar
39 to Knuth's \*(MF with additional features for including
40 .BR tex (1)
41 or
42 .BR troff (1)
43 commands and accessing features of PostScript not found in \*(MF.
44 .PP
45 \*(MP is normally used with a set of basic macros, and it
46 will use its executable name as the name of the preload
47 file to use. For example, when called as
48 .B mpost
49 the
50 .I mpost.mp
51 file is used, which simply reads
52 .IR plain.mp .
53 When the
54 .B --ini
55 option is given, preloading does not happen.
56 .PP
57 The
58 .I commands
59 given on the command line to the \*(MP program are passed to it as the
60 first input line. (But it is often easier to type extended arguments
61 as the first input line, since UNIX shells tend to gobble up or
62 misinterpret \*(MP's favorite symbols, like semicolons, unless you
63 quote them.) The normal usage is to say
64 .I mpost figs
65 to process the file
66 .IR figs.mp .
67 The basename of
68 .I figs
69 becomes the ``jobname'',
70 and is used in forming output file names. If no file is named, the
71 jobname becomes
72 .IR mpout .
73 The default extension,
74 .IR .mp ,
75 can be overridden by specifying an extension explicitly.
76 .PP
77 When the
78 .B --dvitomp
79 option is given, \*(MP acts as DVI-to-MPX converter only.
80 See dvitomp (1) for details.
81 .PP
82 The
83 .B pmpost
84 program is a variant with Japanese support, and
85 .B upmpost
86 has Unicode-enabled Japanese support, analogous to ptex and uptex.
87 .PP
88 All three variants are also installed with an `r-' prefix, that is,
89 .BR r-mpost ,
90 .BR r-pmpost ,
91 .BR r-upmpost ,
92 which implicitly specify the
93 .B --restricted
94 option to make MetaPost safe to run on unknown input; the tex, makempx,
95 and editor commands are disabled.
96 .PP
97 This manual page is a mere skeleton. For a list of all command line
98 options, run
99 .BR --help .
100 .PP
101 The main documentation for this version of \*(MP can be found in the
102 User Manual that should have been installed along with the program and
103 is also available from https://tug.org/metapost.
104 .PP
105 The \*(MP language is similar to \*(MF, but the manual
106 assumes no knowledge of \*(MF. \*(MP does not have bitmap
107 output commands or \*(MF's online display mechanism.
108 .\"=====================================================================
109 .SH FILES
110 .TP
111 .I plain.mp
112 The standard preload file.
113 .TP
114 .I mfplain.mp
115 The \*(MF-compatible preload file.
116 .TP
117 .I $TEXMFMAIN/metapost/base/*.mp
118 The standard \*(MP macros included in the original distribution.
119 .TP
120 .I $TEXMFMAIN/metapost/support/*
121 Various tables for handling included
122 .I tex
123 and
124 .IR troff .
125 .TP
126 .I $TEXMFMAIN/metapost/support/trfonts.map
127 Table of corresponding font names for
128 .I troff
129 and PostScript.
130 .TP
131 .I psfonts.map
132 Table of corresponding font names for
133 .I tex
134 and PostScript.
135 .TP
136 .I $TEXMFMAIN/doc/metapost/*
137 The \*(MP manual and tutorial source, also including sample figures
138 .\"=====================================================================
139 .SH "SUGGESTED READING"
140 Donald E. Knuth,
141 .I "The \*(MF\^book"
142 (Volume C of
143 .IR "Computers & Typesetting" ).
144 .br
145 .I TUGboat
146 (the journal of the \*(TX Users Group).
147 .\"=====================================================================
148 .SH "SEE ALSO"
149 .BR dvitomp (1),
150 .BR epstopdf (1),
151 .BR mf (1),
152 .BR mptopdf (1),
153 .BR tex (1),
154 .br
155 .URL "https://tug.org/metapost/" "MetaPost home page" .
156 .\"=====================================================================
157 .SH AUTHORS
158 \*(MP was created by John D. Hobby, incorporating algorithms from
159 the \*(MF program by Donald E. Knuth.
160 .PP
161 Ulrik Vieth adapted \*(MP to take advantage of the advanced path
162 searching features in more recent versions of Web2C and worked towards
163 fully integrating \*(MP into the canonical Unix \*(TX distribution.
164 .PP
165 The primary author of the current \*(MP was Taco Hoekwater, with
166 assistance from Hans Hagen and many others. It is currently maintained
167 by Luigi Scarso.
168 .\"=====================================================================
169 .SH BUGS
170 The MetaPost home page is https://tug.org/metapost.