summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/eepic/fig2eepic/fig2epic.1
blob: a6bf42af4eedd2877ab66cd43c87e5bbf0a39363 (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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
.TH FIG2EPIC 1 "23 August 1988"
.SH NAME
fig2epic \- translates Fig intermediate code into EPIC or EEPIC macros
.SH SYNOPSIS
.B fig2epic
[
.B \-S
.I scale
] [
.B \-s
.I size
] [
.B \-m
.I mag
] [
.B \-F
.I fspec
] [
.B \-L
.I lang
] [
.B \-l
.I lwidth
] [
.B \-c
.I cfg-file
] [
.B \-v
] [
\fIfig-file\fR [ \fItex-file\fR ] ]
.SH DESCRIPTION
.I Fig2epic
translates fig objects in the named
.I fig-file
into EPIC or EEPIC macros and puts them in
.I tex-file.
If a file name is presented, it is assumed to be the input file (fig
output file). The output file
.I (tex-file),
if not presented, will be the stdout.
If the
.I fig-file
is not presented, input will be assumed to come from the stdin.
The output from fig2epic can be edited to change font sizes/types.
.LP
Fig (Facility for Interactive Generation of figures) is a screen-oriented
tool which allows the user to draw and manipulate objects interactively.
It runs under the Suntools/Sunview window environment.
Fig2epic is compatible with Fig versions 1.3 and 1.4.
.LP
EPIC is an enhancement to LaTeX picture drawing environment.
It was developed by Sunil Podar of Department of Computer Science
in S.U.N.Y at Stony Brook.
.LP
EEPIC is an extension to EPIC and LaTeX picture drawing
environment. It was written by Conrad Kwok of Division of
Computer Science at University of California, Davis.
.SH OPTIONS
.TP
.B \-S
Set the scale at which the figure is rendered to. This option
automatically set the magnification and default font to
.I scale
/ 12 and 
.I scale
-tt respectively. The font can be changed using \-F option.
The default is 12 and other valid options are 8, 9, 10 and 11.
.TP
.B \-s
Change the default font size to
.I size
.TP
.B \-m
Set the magnification at which the figure is rendered to
.I mag.
The default is 1.0 unless \-s option is used.
.TP
.B \-c
Use 
.I cfg-file
as the configuration file.
.TP
.B \-F
Set the font specification command which precedes every text object in the
picture to
.I fspec.
This option, if specified, overrides any font changing commands.
The default is none.
Note that no "\\" is required in the font name.
.TP
.B \-l
Use "\fB\\thicklines\fR" when width of the line is wider than 
.I lwidth.
The default is 2.
.TP
.B \-L
Use the specified language 
.I lang
in the output. Default is EEPIC. Other valid options are EPIC and
EEPIC-EMU. EEPIC-EMU is for use with EEPIC emulation package.
.TP
.B \-v
Include comment in the output file.

.SH LATEX MACROS
In order to include EPIC or EEPIC pictures into a document, it is
necssary to load the EPIC and EEPIC macros. It can be done by
including \fBEPIC\fR and \fBEEPIC\fR in \fB\\documentstyle\fR
option. See the EPIC or EEPIC manaul for details.

.SH Configuration File
All the defaults in fig2epic can be changed using configuration
file. When fig2pic is executed, it will look for the files
specified in \-c option if any, 
.I fig-file.cfg
(if
.I fig-file
is ended with ".fig", it will be replaced by ".cfg"), fig2epic.cfg
and $HOME/.fig2epic in the order specified above. The first
configuration file found will be used.

.TP
.I LowerLeftX
This specify X coordinate of the lower left hand corner of the Fig
picture. Default is 0.
.TP
.I LowerLeftY
This specify Y coordinate of the lower left hand corner in unitlength of the Fig
picture. Default is 0.
.TP
.I TopMargin
Set the distance in unitlength of the figure from the top of the
LaTeX picture box. Default is 5.
.TP
.I BottomMargin
Set the distance in unitlength of the figure from the bottom of the
LaTeX picture box. Default is 10.
.TP
.I SegmentLength
The maximum segment length in inch used in generating splines
(for EPIC) and arc (for EPIC and EEPIC-EMU). Default is 0.0625
inch.
.TP
.I TextFont
Set the font used for all text. This option overrides FontType
and FontSize. However, it is overrided by \-s, -S and -F options.
Note that no "\\" is required in the font name.
.TP
.I Magnification
Same as \-m option. Default is 1.0.
.TP
.I Verbose
Same as \-v. Default is FALSE
.TP
.I DotDistance
Dot distance in unitlength for dotted lines.
.TP
.I LineThick
Same as \-l. Default is 2.
.TP
.I Language
Same is -L. Default is EEPIC
.TP
.I DashScale
Scale the dash length. Default is 1.0.
.TP
.I EllipseCommand
Specify the command used in drawing an ellipse. Default is
ellipse for EEPIC or EEPIC-EMU. oval is always used for EPIC. Possible 
values are ellipse and oval.
.TP
.I UseBox
Specify whether fig2epic should generate \\framebox and/or
\\dashbox command
in the output file or not. Default is not to use the *box
command. Possible options are none, solid, dash and both.
.TP
.I DashType
This option is only used when EPIC option is selected. Valid options
are "Normal" (use dashline in drawing dash lines), "Economic"
(use drawline with -50 stretch in drawing dash lines) and
"Dotted" (use dotted lines to replace dash lines). Default is
"Normal". "Normal" option will use up TeX memory quickly if long
dash lines are drawn. If you get "TeX Capacity Exceed" error, you should
try the "Economic" or "Dotted" option.
.TP
.I FontType
Selects one of the following font types as the default--Roman,
Bold, Italics, Modern and Typewriter. Default is Typewriter.
.TP
.I FontSize
Selects default font size in points. Default is 12.

.SH "SEE ALSO"
fig(1),
EPIC manual,
EEPIC manual and TransFig manual
.SH AUTHOR
Conrad Kwok (kwok@iris.ucdavis.edu)
.br
University of California, Davis
.br
August 14, 1988
.sp
modified from fig2latex, fig2tex and f2p.