File: pstext.html

package info (click to toggle)
gmt-doc 3.4-1.1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,756 kB
  • ctags: 1,800
  • sloc: makefile: 30
file content (290 lines) | stat: -rw-r--r-- 14,706 bytes parent folder | download | duplicates (2)
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<HTML>
<HEAD>
<TITLE>pstext</TITLE>
</HEAD>
<BODY>
<H1>pstext</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
       pstext - To plot text on maps


</PRE>
<H2>SYNOPSIS</H2><PRE>
       <B>pstext</B>  <I>textfile</I> <B>-J</B><I>parameters</I> <B>-R</B><I>west/east/south/north</I><B>[r]</B> <B>[</B>
       <B>-B</B><I>tickinfo</I> <B>]</B> <B>[</B> <B>-C</B><I>dx/dy</I> <B>]</B> <B>-D[j]</B><I>dx/dy</I><B>[v[</B><I>red/green/blue</I><B>]</B> <B>]</B>  <B>[</B>
       <B>-E</B><I>azimuth/elevation</I>  <B>]</B> <B>[</B> <B>-G</B><I>red/green/blue</I> <B>]</B> <B>[</B> <B>-H[</B><I>nrec</I><B>]</B> <B>]</B> <B>[</B>
       <B>-K</B> <B>]</B> <B>[</B> <B>-L</B> <B>]</B> <B>[</B> <B>-M[</B><I>flag</I><B>]</B> <B>]</B> <B>[</B> <B>-N</B> <B>]</B> <B>[</B> <B>-O</B> <B>]</B> <B>[</B> <B>-P</B> <B>]</B> <B>[</B> <B>-S</B><I>pen</I> <B>]</B>  <B>[</B>
       <B>-U[</B><I>/dx/dy/</I><B>][</B><I>label</I><B>]</B>       <B>]</B>       <B>[</B>       <B>-V</B>       <B>]</B>      <B>[</B>
       <B>-W[</B><I>red/green/blue</I><B>][o|O|c|C[</B><I>pen</I><B>]]</B> <B>]</B> <B>[</B> <B>-X</B><I>x-shift</I>  <B>]</B>  <B>[</B>  <B>-Y</B><I>y-</I>
       <I>shift</I> <B>]</B> <B>[</B> <B>-Z</B><I>zlevel</I> <B>]</B> <B>[</B> <B>-c</B><I>copies</I> <B>]</B> <B>[</B> <B>-:</B> <B>]</B>


</PRE>
<H2>DESCRIPTION</H2><PRE>
       <B>pstext</B>  plots textstrings of variable size, font type, and
       orientation.  Various map projections are  provided,  with
       the  option  to  draw  and  annotate  the  map boundaries.
       <I>PostScript</I> code is written to standard output. Greek char
       acters,  subscript,  superscript,  and small caps are sup
       ported as follows: The sequence  @~  toggles  between  the
       selected  font and Greek (Symbol).  @%<I>no</I>% sets the font to
       <I>no</I>; @%% resets the font to the starting font,  @-  toggles
       subscripts  on/off,  @+ toggles superscript on/off, and @#
       toggles small caps on/off. @@ prints the @ sign.  @e,  @o,
       @a,  @E, @O, @A give the accented Scandinavian characters.
       Composite characters (overstrike) may  be  indicated  with
       the  @!&lt;char1&gt;&lt;char2&gt;  sequence,  which will print the two
       characters on top of each other. To learn the octal  codes
       for  symbols  not  available  on  the  keyboard  and  some
       accented  European  characters,  see  Section   4.16   and
       Appendix  F  in  the <B><A HREF="GMT.html">GMT</A></B> Technical Reference and Cookbook.
       Note that WANT_EURO_FONT must be set to TRUE in your .gmt
       defaults  file  in  order  to use the accented characters.
       Using the <B>-W</B> option, a colored  rectangle  underlying  the
       text  may  be  plotted  (Does  not  work  for strings with
       sub/super  scripts,  symbols,  or  composite   characters,
       except in paragraph mode (<B>-M</B>)).

       <I>textfile</I>
              This  file  contains  1 or more records with (<I>x,</I> <I>y,</I>
              <I>size,</I> <I>angle,</I> <I>fontno,</I> <I>justify,</I> <I>text</I>).  If no file is
              given,  <B>pstext</B>  will  read standard input.  <I>size</I> is
              text size in points, <I>angle</I> is measured  in  degrees
              counter-clockwise  from horizontal, <I>fontno</I> sets the
              font type, <I>justify</I> sets the alignment.   If  <I>fontno</I>
              is  not  an  integer,  then  it  is  taken  to be a
              textstring with the desired fontname. See the  <B>gmt</B>
              <B>defaults</B> man page for names and numbers of avaiable
              fonts (or run <B>pstext</B> <B>-L</B>). The alignment  refers  to
              the part of the textstring that will be mapped onto
              the (<I>x,y</I>) point. Choose a 2  character  combination
              of L, C, R (for left, center, or right) and T, M, B
              for top, middle, or  bottom.  e.g.,  BL  for  lower
              left.
              1:xxxxx, or width in UNIT  (upper  case  modifier).
              UNIT  is  cm,  inch,  or  m,  depending on the MEA
              SURE_UNIT setting in .<A HREF="gmtdefaults.html">gmtdefaults</A>, but this can  be
              overridden  on the command line by appending the c,
              i, or m to the scale/width value.

              <B>CYLINDRICAL</B> <B>PROJECTIONS:</B>

              <B>-Jc</B><I>lon0/lat0/scale</I> (Cassini)
              <B>-Jj</B><I>lon0/scale</I> (Miller)
              <B>-Jm</B><I>scale</I> (Mercator - Greenwich and Equator as  ori
              gin)
              <B>-Jm</B><I>lon0/lat0/scale</I>  (Mercator  -  Give meridian and
              standard parallel)
              <B>-Joa</B><I>lon0/lat0/azimuth/scale</I>  (Oblique  Mercator   -
              point and azimuth)
              <B>-Job</B><I>lon0/lat0/lon1/lat1/scale</I>  (Oblique  Mercator -
              two points)
              <B>-Joc</B><I>lon0/lat0/lonp/latp/scale</I> (Oblique  Mercator  -
              point and pole)
              <B>-Jq</B><I>lon0/scale</I>  (Equidistant  Cylindrical Projection
              (Plate Carree))
              <B>-Jt</B><I>lon0/scale</I> (TM - Transverse Mercator, with Equa
              tor as y = 0)
              <B>-Jt</B><I>lon0/lat0/scale</I>  (TM  - Transverse Mercator, set
              origin)
              <B>-Ju</B><I>zone/scale</I> (UTM - Universal Transverse Mercator)
              <B>-Jy</B><I>lon0/lats/scale</I> (Basic Cylindrical Projection)

              <B>AZIMUTHAL</B> <B>PROJECTIONS:</B>

              <B>-Ja</B><I>lon0/lat0/scale</I> (Lambert).
              <B>-Je</B><I>lon0/lat0/scale</I> (Equidistant).
              <B>-Jf</B><I>lon0/lat0/horizon/scale</I> (Gnomonic).
              <B>-Jg</B><I>lon0/lat0/scale</I> (Orthographic).
              <B>-Js</B><I>lon0/lat0/</I>[<I>slat/</I>]<I>scale</I> (General Stereographic)

              <B>CONIC</B> <B>PROJECTIONS:</B>

              <B>-Jb</B><I>lon0/lat0/lat1/lat2/scale</I> (Albers)
              <B>-Jd</B><I>lon0/lat0/lat1/lat2/scale</I> (Equidistant)
              <B>-Jl</B><I>lon0/lat0/lat1/lat2/scale</I> (Lambert)

              <B>MISCELLANEOUS</B> <B>PROJECTIONS:</B>

              <B>-Jh</B><I>lon0/scale</I> (Hammer)
              <B>-Ji</B><I>lon0/scale</I> (Sinusoidal)
              <B>-Jk</B>[<B>f|s</B>]<I>lon0/scale</I> (Eckert IV (f) and VI (s))
              <B>-Jn</B><I>lon0/scale</I> (Robinson)
              <B>-Jr</B><I>lon0/scale</I> (Winkel Tripel)
              <B>-Jv</B><I>lon0/scale</I> (Van der Grinten)
              <B>-Jw</B><I>lon0/scale</I> (Mollweide)

              <B>-Jp</B>[<B>a</B>]<I>scale</I>[<I>/origin</I>]  (polar (theta,r) coordinates,
              optional <B>a</B> for azimuths and offset theta [0])
              <B>-Jx</B><I>x-scale</I>[<B>l|p</B><I>pow</I>][<I>/y-scale</I>[<B>l|p</B><I>pow</I>]] (Linear,  log,
              and power scaling)
              More  details  can  be  found in the <B><A HREF="psbasemap.html">psbasemap</A></B> man
              pages.

       <B>-Jz</B>    Sets the vertical scaling (for 3-D maps). Same syn
              tax as <B>-Jx</B>.

       <B>-R</B>     <I>west,</I>  <I>east,</I> <I>south,</I> and <I>north</I> specify the Region of
              interest. To specify boundaries in degrees and min
              utes  [and  seconds],  use  the  dd:mm[:ss] format.
              Append <B>r</B> if lower left and upper right map  coordi
              nates are given instead of wesn.


</PRE>
<H2>OPTIONS</H2><PRE>
       No  space between the option flag and the associated argu
       ments.

       <B>-B</B>     Sets map boundary tickmark intervals. See <B><A HREF="psbasemap.html">psbasemap</A></B>
              for details.

       <B>-C</B>     Sets  the  clearance  between the text and the sur
              rounding box [0.15<B>c</B>/0.15<B>c</B> (or 0.05<B>i</B>/0.05<B>i</B>)].   Only
              used if <B>-W</B> is specified.

       <B>-D</B>     Offsets  the text from the projected (<I>x,y</I>) point by
              <I>dx,dy</I> [0/0].  Use <B>-Dj</B> to offset the text away  from
              the  point  instead (i.e. the text's justification'
              will determine the  direction  of  the  shift).  In
              paragraph  mode  (<B>-M</B>),  one may append <B>v</B> which will
              draw a line from the original point to the  shifted
              point.  Optionally append a <I>pen</I> for this line.

       <B>-E</B>     Sets  the  viewpoint's  azimuth  and elevation (for
              perspective view) [180/90].'  (Not implemented  for
              paragraph mode).

       <B>-G</B>     Sets  the  gray-shade (0-255) or color (r/g/b, each
              0-255) used  for  drawing  the  text.  [Default  is
              black]

       <B>-H</B>     Input  file(s)  has  Header  record(s).  Number  of
              header records can be changed by editing your .gmt
              defaults  file.  If  used,  <B><A HREF="GMT.html">GMT</A></B> default is 1 header
              record.

       <B>-K</B>     More  <I>PostScript</I>  code  will  be   appended   later
              [Default terminates the plot system].


       <B>-M</B>     Paragraph mode.  Files  must  be  multiple  segment
              files.  Segments  are separated by a special record
              whose first character  must  be  <I>flag</I>  [Default  is
              '&gt;'].   Starting  in  the  3rd column, we expect to
              find information pertaining to the typesetting of a
              text paragraph (the remaining lines until next seg
              ment header).  The information  expected  is  (x  y
              size  angle  fontno justify linespace parwidth par
              just), where <I>x</I> <I>y</I>  <I>size</I>  <I>angle</I>  <I>fontno</I>  <I>justify</I>  are
              defined above, while <I>linespace</I> and <I>parwidth</I> are the
              linespacing and paragraph width, respectively.  The
              justification  of the text paragraph is governed by
              <I>parjust</I> which may be <B>l</B>(eft), <B>c</B>(enter), <B>r</B>(ight),  or
              <B>j</B>(ustified).  The segment header is followed by one
              or more lines with paragraph text. Text may contain
              the  escape  sequences  discussed  above as well as
              three more: @;<I>r/g/b</I>; changes the  font  color  (@;;
              resets  it),  @:<I>size</I>:  changes  the  font size (@::
              resets it), and @_ toggles underline on/off.  Sepa
              rate paragraphs with a blank line.

       <B>-N</B>     Do  NOT  clip  text at map boundaries [Default will
              clip].

       <B>-O</B>     Selects Overlay plot mode  [Default  initializes  a
              new plot system].

       <B>-P</B>     Selects  Portrait  plotting  mode  [<B><A HREF="GMT.html">GMT</A></B>  Default is
              Landscape, see gmtdefaults to change this].

       <B>-S</B>     Draw text outline.  Append  pen  attributes.   (Not
              implemented for paragraph mode).

       <B>-U</B>     Draw Unix System time stamp on plot. User may spec
              ify where the lower left corner of the stamp should
              fall  on  the page relative to lower left corner of
              plot. Optionally, append a label, or <B>c</B> (which  will
              plot  the  command  string.).  The  GMT  parameters
              UNIX_TIME and UNIX_TIME_POS can affect the  appear
              ance; see the <B><A HREF="gmtdefaults.html">gmtdefaults</A></B> man page for details.

       <B>-V</B>     Selects  verbose  mode,  which  will  send progress
              reports to stderr [Default runs "silently"].

       <B>-W</B>     Paint a rectangle  beneath  the  text  string.  Set
              color [Default is no fill].  Append <B>o</B> to draw rect
              angle outline, add a <I>pen</I> to specify pen  attributes
              [1/0/0/0].   Choose  upper  case <B>O</B> to get a rounded
              rectangle (only in paragraph mode).   Choose  lower
              case  <B>c</B>  to  get a concave rectangle (only in para
              graph mode).  Choose upper case <B>C</B> to get  a  convex
              <B>a</B> for absolute coordinates; the  default  (<B>r</B>)  will
              reset plot origin.

       <B>-Z</B>     For  3-D  projections:  Sets  the  z-level  of  the
              basemap [0].  (Not implemented for paragraph mode).

       <B>-:</B>     Toggles  between  (longitude,latitude)  and  (lati
              tude,longitude) input/output. [Default  is  (longi
              tude,latitude)].  Applies to geographic coordinates
              only.

       <B>-c</B>     Specifies the number of plot copies. [Default is 1]


</PRE>
<H2>EXAMPLES</H2><PRE>
       To plot the outlines of the textstrings stored in the file
       text.d on a Mercator plot with the  given  specifications,
       try

       pstext  text.d  <B>-R</B>-30/30/-10/20  <B>-Jm</B>0.1<B>i</B>  <B>-P</B>  <B>-B</B>5 <B>-S</B>0.5<B>p</B> &gt;
       plot.ps

       To add a typeset figure caption for a 3-inch  wide  illus
       tration, try

       pstext <B>-R</B>0/3/0/5 <B>-JX</B>3<B>i</B> <B>-O</B> <B>-H</B> <B>-M</B> <B>-N</B> &lt;&lt; EOF &gt;&gt; figure.ps
       This is an optional header record
       &gt; 0 -0.5 12 0 4 LT 13p 3i j
       @%5%Figure  1.@%%  This illustration shows nothing useful,
       but it still needs
       a figure caption. Highlighted in @;255/0/0;red@;; you  can
       see the locations
       of  cities where it is @_impossible@_ to get any good Thai
       food; these are to be avoided.
       EOF


</PRE>
<H2>BUGS</H2><PRE>
       Except for paragraph mode, the horizontal justification of
       surrounding  rectangles  does not work when Greek symbols,
       sub- and superscripts,  and/or  composite  characters  are
       imbedded  in  the textstring. In paragraph mode, the pres
       ence of composite characters and  other  escape  sequences
       may lead to unfortunate word splitting.  Finally, the out
       line option does not work with the escape sequences.
       The <B>-N</B> option does not adjust the BoundingBox  information
       so you may have to post-process the PostScript outout with
       epstool or ps2epsi to obtain a correct BoundingBox.


</PRE>
<H2>SEE ALSO</H2><PRE>
       <I>gmt</I>(l), <I><A HREF="psbasemap.html">psbasemap</A></I>(l)



</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>
<body bgcolor="#ffffff">