summaryrefslogtreecommitdiff
path: root/support/rumgraph/quickref.tex
blob: 2ceb89fc6b2855b32b5bcbdc137ffbe72cc17637 (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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
% This is QUICKREF.TEX, as of February 13, 1991 (Ki/Kr).
% RUMgraph Quick Reference
\documentstyle[11pt,refman,twoside]{article}

\frenchspacing

\input{rum}

\newcommand{\HWK}{H.$\!$-$\!$W$\!$.\ Kisker}
\newcommand{\RUMgraph}{\mbox{\RUMj{\sf graph}}}
\newcommand{\ADI}{{\sf ADI}}
\newcommand{\PCX}{{\sf PCX}}
\newcommand{\PXL}{{\sf PXL}}
\newcommand{\TFM}{{\sf TFM}}
%
\addtolength{\headheight}{1pt}
\setleftmarginwidth{1.0in}
%
\pagestyle{myheadings}

\begin{document}

\title{\RUMt{\sf graph} \ \ --- \ \ Quick Reference}

\author{
\HWK \and
Westf\"{a}lische Wilhelms-Universit\"{a}t \and
Universit\"{a}tsrechenzentrum \and
Einsteinstr. 60 \and
D-4400 M\"{u}nster \and
Germany \and
February 1991
}

\maketitle
\makeauthor

\maxipagerulefalse

\markboth{\RUMgraph}{\RUMgraph}

\marginlabel{\bf Purpose}
%
The program \RUMgraph\ converts monochrome grafic files to a \TeX\ \PXL\ file.
Each \PCX\ file is mapped to a character of the font.

\marginlabel{\bf Input}
%
To work properly \RUMgraph\ must be supplied with one or more \PCX\ files and
metric data for the characters of the font.

\marginlabel{\bf Output}
%
\RUMgraph\ will create several files as output:
%
\begin{itemize}
\item a \PXL\ file (containing the character maps),
\item a \TFM\ file (containing the metric data),
\item a \TeX\ file (containing \TeX\ commands related to the characters of the
font) and
\item a logfile (containing information about the program run).
\end{itemize}

\marginlabel{\bf Supported Grafic Formats}
%
\RUMgraph\ supports two grafic formats:
%
\begin{itemize}
\item \ADI\ printer file from AutoDesk and
\item the monochrome \PCX\ file from ZSoft.
\end{itemize}

\marginlabel{\bf Operating Systems}
%
\RUMgraph\ can run under MS-DOS Version 3.00 (or later) or OS/2 Version 1.00 (or
later).


\section*{\Large \bf Options}

\RUMgraph\ is called in the normal way:

{\sf \hspace*{.5in} RUMgraf\ \  option\ \ \ldots}

The term {\em option} starts with one of the characters {\tt /} or {\tt
-}, immediately followed by an alphabetic character -- the {\em option
name\/}. In most cases the option name is succeded by a string -- the
{\em option value\/}. Option name and value can be delimited by one of
the characters {\tt :} or {\tt =}; a blank however is not allowed. An
option value, which contains a blank (or other special characters), must
be surrounded by a pair of {\tt "} characters. Each option term which
does not start with a {\tt /} or {\tt -} is treated as a comment.

The option names are devided into three groups.

\begin{itemize}

\item The first group contains all parameters belonging to the entire font (e.g.
resolution).

\item The options of the second group describe a single character (e.g. metric
data). A set of options can be specified for each character of the font . Such a
set starts with a c option, which determines a specific character. All following
options of the second group up to the next c options will be related to this
character.

\item The third group consist of just one option -- the m option. This option
points to a so called {\em makefile} which contains additional option terms.

\end{itemize}

\subsection*{Group 1: Font Options}

\marginlabel{\bf /P} {\sf /P:}{\em ident\/}

The p option specifies an identification for several picture related files:

\begin{itemize}

\item the name of the \PXL\ file ({\sf ident.PXL}),

\item the name of the \TFM\ file ({\sf ident.TFM}),

\item the name of the \TeX\ files ({\sf ident.TEX}) and

\item the name of the logfile ({\sf ident.RGL}).

\end{itemize}

The value of {\sf ident} must consist of one to eight alphabetic
characters.

Example: {\sf /P:GLYPH}

\vspace*{.1in}

\marginlabel{\bf /R} {\sf /R:}{\em resolution\/}

The r option specifies the resolution of the bitmap.

Unit: dpi (= dots per inch)

Example: {\sf /R:300}


\subsection*{Group 2: Character Options}

\marginlabel{\bf /C} {\sf /C:}{\em character\/}

The c option starts a set of options for a specified character. All following
options of group 2 up to the next c option will be related to this character.
The option value can be an alphabetic character or a number from 0 to 127.

Examples: {\sf /C:A} or {\sf /C:65}

\vspace*{.1in}

\marginlabel{\bf /N} {\sf /N:}{\em name\/}

The n option can be used to generate a \TeX\ command for the created \TeX\ file.
In a \TeX\ document this command will insert the related character -- i.e. the
picture -- in the output. The name can consist of an arbitrary number of
alphabetic characters.

Example: {\sf /N:Aleph}

\vspace*{.1in}

\condbreak{2\baselineskip}
\marginlabel{\bf /T} {\sf /T:}{\em type\/}

The t option specifies the grafic format of the input file for the character
(\PCX\ or \ADI.

Example: {\sf /T:PCX}

\vspace*{.1in}

\marginlabel{\bf /F} {\sf /F:}{\em filename\/}

The f option determines the pathname of the file, which will be used for the
creation of the character.

Example: {\sf /F:aleph.pcx}

\vspace*{.1in}

\marginlabel{\bf /D /H /W}
{\sf /D:}{\em depth\/} {\sf /H:}{\em height\/} {\sf /W:}{\em width\/}

The metric data for the \TFM\ file will be determined by the d option ({\em
depth\/}), the h option ({\em height\/}) and the w option ({\em width\/}).
For each missing option a default value is defined. The width is set to the
x size of the input bitmap, the height is set to the y size of the bitmap and
the depth is assumed as zero.

Unit: pt ({\sf 1 inch = 72.72 pt})

Example: {\sf /W:20 /H:24 /D:8}

\vspace*{.1in}

\marginlabel{\bf /X /Y} {\sf /X:}{\em Xoffset\/} {\sf /Y:}{\em Yoffset\/}

The x and y options determine the reference point of the character bitmap in
the \PXL\ file. By default the x offset is assumed as zero and the y offset ist
set to the vertical size of the input bitmap. The horizontal and vertical size
are extracted directly from the input bitmap.

Unit: pixel

Example: {\sf /X:--5 /Y:22}

\vspace*{.1in}

\marginlabel{\bf /S} {\sf /S:}{\em count\/}

\RUMgraph\ can distribute large pictures to several characters of the font. The
s option sets the number of pieces, the picture is to be split.

Example: {\sf /S:10}


\vspace*{.1in}

\marginlabel{\bf /I} {\sf /I}

Specifying the i option will reverse the input bitmap.

Example: {\sf /I}

\vspace*{.1in}

\subsection*{Group 3: Makefile}

\marginlabel{\bf /M} {\sf /M:}{\em makefile\/}

The m option specifies a makefile which contains additional option terms.

Example: {\sf /M:Glyph.m}


\end{document}