summaryrefslogtreecommitdiff
path: root/macros/generic/psbox/psbREAD.ME
blob: be159af8ce1b6b7eb0d54ad4d64ea3bb0c5d3470 (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
%                           PSBOX READ-ME
%                           -------------
% WHAT IS IT:
% psbox is a set of machine-independent TeX macros to
% 1) allow (Encapsulated) PostScript figure inclusion in all versions
%    of TeX (Plain, LaTeX) on all machines using a PostScript printer
% 2) facilitate the communication (e-mail, ftp, ...) of all the files
%    (text, macros, figs) needed to reproduce a TeX document by grouping
%    them together into a single, TeXable file.
%
% HOW TO GET IT TO WORK:
% 1) get the file psboxall.tex by one of the following ways:
%    -from outside CERN: ftp cs.nyu.edu(=128.122.140.24):pub/TeX/psbox/
%    -(if all else fails) send me a mail (orloff@surya11.cern.ch);
% 2) tex psboxall.tex: this will produce a complete documentation dvi and a
%    set of files, including the raw macros named psbox.tex;
% 3) adapt your psbox.tex to your system by uncommenting the appropriate
%    %\psfor...-line at the end of the file;
% 4) put it in your TeX Inputs directory
%
% MAJOR COMMANDS:
% \psbox{fname.eps}
%    makes a box having the right size to enclose the figure fname.eps;
% \psboxto(xdim;ydim){fn.eps}
%    makes a box of the given size and rescales fn.eps so that it just fits;
% \psboxto(\hsize;0pt){fn.eps}
%    has the maximal width & a height computed from a uniformal rescaling;
% \centinsert{\pscaption{\psbox{fn.eps}}{Fig 1: the caption...}}
%    recommended way to include a graphics between 2 paragraphs;
% \begin{figure}[hbt]\begin{center}\mbox{\psbox{fn.eps}}\caption{Fig 1:}
% \end{figure}
%    recommended way in LaTeX;
% \autojoin
%    makes a single file called psbjoint.tex containing the currently tex'd
%    file plus all the files (macros & figs) included since the \input of
%    psbox.tex. Texing psbjoint.tex will split it into all these files with
%    their original names (so think of PC's:12345678.123!!) and tex the
%    first one (generally the one that issued \autojoin).