summaryrefslogtreecommitdiff
path: root/dviware/ln03/rmcs/ginotosix.hlp
blob: b43cca9140a591e7fe951e325710454775a9f6f8 (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
1 GINOTOSIX

Take a GINO psuedo-code file (produced using the SAVDRA driver) and create
a sixel file in a format suitable for import into a LaTeX .LN3 file. The
default action is to produce an image the same size and scale as the saved
picture, using segment 0. The output filename is made from the supplied
file-spec, with a type of .SIX. See the GINO documentation for more
information on SAVDRA and picture segments, and the LaTeX user guides for
more information on LaTeX.

Format:

      GINOTOSIX  file-spec

To import the image into a LaTeX document, the \documentstyle option
"graphics" should be used, and the command 

      \gino(width,height){file-spec}

inserted at the point where the image is wanted.  `width' and `height' 
MUST be specified explicitly as lengths, e.g.

      \gino(150mm,100mm){FRED.SIX}

This program was written by Sqn Ldr Jon Baggott (2 MESE). As he has left
the college, any problems should be directed towards Brian Hamilton Kelly
(SEES).

N.B. This command is NOT available by default; see Limitations below.  

2 Parameters


file-spec

  Specifies the name of the SAVDRA file. The default file type is .PIC
  Wildcard characters are not allowed in the file specification.


2 Command_Qualifiers


/SIZE

  /SIZE=(option[,...])

  Specifies the size (in millimetres) of the sixel image. If the qualifier
  is not used, the default action is to copy the window size (or the paper
  size if windowing is not in effect) of the saved picture segment.

  WIDTH:n   specifies the width in mm of the sixel image.
            Defaults to the saved width.

  HEIGHT:n  specifies the height in mm of the sixel image.
            Defaults to the saved height.

  If only one option is specified, the parentheses may be omitted.

  NOTE:     if this qualifier is used in conjunction with the /SCALE
            qualifier, the action is first to scale, then window the
            image. If the /SCALE qualifier is not given, the image is
            scaled to fit the size specified. 


/FORMFEED

  /FORMFEED
  /NOFORMFEED (default)

  Instructs GINOTOSIX to append a formfeed to the end of the sixel file.
  This allows the output file to be queued direct to a LN03 laser printer
  for previewing. A formfeed must NOT be included if the file is to be
  included in a LaTeX document. 


/SCALE

  /SCALE=x

  Scale the stored image by a factor of x. The default scale factor is 1.0.

  NOTE:     if this qualifier is used in conjunction with the /SIZE
            qualifier, the action is to first scale, then window the
            image. If the /SIZE qualifier is not given, the stored size is
            scaled to produce the image size.


/SEGMENT

  /SEGMENT=n

  Specifies the picture segment number in the SAVDRA file to use for
  producing the image. The default value is 0. is not specified, the
  maximum record length specified for the input file is used. 


/OUTPUT

  /OUTPUT=output-file-spec

  Controls where the sixel file is written. The specification of
  an output file is determined as follows:

      NODE      - if the node is not specified, the current node is
                  used. 

      DEVICE    - if the device is not specified, the current default
                  device is used. 

      DIRECTORY - if the directory is not specified, the current
                  default directory is used. 

      NAME      - if the file name is not specified or is an asterisk
                  wildcard, the name of the current input file is
                  used. 

      TYPE      - if the file type is not specified, or is an asterisk
                  wildcard, the type of the file is set to .SIX

      VERSION   - if the file version is not specified or is an
                  asterisk wildcard, a version number of 0 is used. If
                  a file with the same name and version number exists,
                  GINOTOSIX will issue a (FORTRAN!) error message. 
      

  NOTE:  Wildcard characters are not permitted in the directory
         specification.


2 Limitations

GINOTOSIX only becomes available by defining it as a DCL command.
To do this, you MUST execute the DCL command

      SET COMMAND TEX$EXE:GINOTOSIX

(just once) some time before issuing the GINOtosix command.  If you use 
this facility regularly, you may care to put the SET COMMAND in your 
LOGIN.COM file (somewhere after invoking @SYS$COM:LATEX).


GINOTOSIX was written in VAX FORTRAN and uses GINO routines. Some errors
are therefore trapped by FORTRAN or by GINO, rather than being handled
correctly. 

A scratch file is written and deleted in the default directory using the
name "GINOTOSIX.TMP". Write access to the current default directory is 
therefore required. 


2 Examples


1.   $ GINOTOSIX FRED

GINOTOSIX will read the file FRED.PIC, and produce a file FRED.SIX from
segment 0. The size of the sixel image will be the same as the saved
picture. 


2.   $ GINOTOSIX/SCALE=0.5/OUTPUT=DISK$SCRATCH:[FRED]GRAPH.INC FRED.GNO

GINOTOSIX will read FRED.GNO, and produce a half-size image in
DISK$SCRATCH:[FRED]GRAPH.INC.


3.   $ GINOTOSIX/SIZE=(WIDTH:150,HEIGHT:100) FRED/SEGMENT=1/FORMFEED

GINOTOSIX will read segment 1 of FRED.PIC, and uniformly scale the image
to fit in a box 150mm wide and 100mm high. A formfeed will be appended to
the end of the output file (FRED.SIX).