GRASS-Wiki - User contributions [en]

Ps.output

2011-03-21T19:21:15Z

⚠️Ejtizado: /* raster */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended type step [voffset height width] : Extended style of line for use mainly with rects. ''type'' = arrow, bar, circled_semi, double_bar, point, rombo, square, triangle, xcross, zigzag (you can use only the first char; and uppercase for filled version). ''step'' = (dimen). ''voffset'' = (dimen). ''height'' = (dimen). ''width'' = (dimen).

; baseline (y|n) : Work with the ''extended'' option to define if the baseline is drawn.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="4">
File:ps.out_linex_A.png|extended arrow 1mm
File:ps.out_linex_B.png|extended bar 1mm
File:ps.out_linex_C.png|extended circled_semi 1mm
File:ps.out_linex_D.png|extended double_bar 1mm
File:ps.out_linex_P.png|extended point 1mm
File:ps.out_linex_R.png|extended rombo 1mm
File:ps.out_linex_S.png|extended square 1mm
File:ps.out_linex_X.png|extended xcros 1mm
</gallery>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|l|s|S|f|F : Define the type of scalebar (I: inner, l: line, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:Ps.out_scalebar_l.png|scalebar l (downcase L)
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; hillshade yes|no : Use when draw a shaded raster to draw hillshade. See http://grass.osgeo.org/wiki/Ps.out_Making_maps#The_second_output

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

Ps.output

2011-03-21T19:18:49Z

⚠️Ejtizado: /* raster */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended type step [voffset height width] : Extended style of line for use mainly with rects. ''type'' = arrow, bar, circled_semi, double_bar, point, rombo, square, triangle, xcross, zigzag (you can use only the first char; and uppercase for filled version). ''step'' = (dimen). ''voffset'' = (dimen). ''height'' = (dimen). ''width'' = (dimen).

; baseline (y|n) : Work with the ''extended'' option to define if the baseline is drawn.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="4">
File:ps.out_linex_A.png|extended arrow 1mm
File:ps.out_linex_B.png|extended bar 1mm
File:ps.out_linex_C.png|extended circled_semi 1mm
File:ps.out_linex_D.png|extended double_bar 1mm
File:ps.out_linex_P.png|extended point 1mm
File:ps.out_linex_R.png|extended rombo 1mm
File:ps.out_linex_S.png|extended square 1mm
File:ps.out_linex_X.png|extended xcros 1mm
</gallery>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|l|s|S|f|F : Define the type of scalebar (I: inner, l: line, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:Ps.out_scalebar_l.png|scalebar l (downcase L)
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; hillshade yes|no : Use when draw a shaded raster to draw hillshade.

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

Ps.output

2011-03-21T19:06:06Z

⚠️Ejtizado: /* scalebar */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended type step [voffset height width] : Extended style of line for use mainly with rects. ''type'' = arrow, bar, circled_semi, double_bar, point, rombo, square, triangle, xcross, zigzag (you can use only the first char; and uppercase for filled version). ''step'' = (dimen). ''voffset'' = (dimen). ''height'' = (dimen). ''width'' = (dimen).

; baseline (y|n) : Work with the ''extended'' option to define if the baseline is drawn.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="4">
File:ps.out_linex_A.png|extended arrow 1mm
File:ps.out_linex_B.png|extended bar 1mm
File:ps.out_linex_C.png|extended circled_semi 1mm
File:ps.out_linex_D.png|extended double_bar 1mm
File:ps.out_linex_P.png|extended point 1mm
File:ps.out_linex_R.png|extended rombo 1mm
File:ps.out_linex_S.png|extended square 1mm
File:ps.out_linex_X.png|extended xcros 1mm
</gallery>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|l|s|S|f|F : Define the type of scalebar (I: inner, l: line, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:Ps.out_scalebar_l.png|scalebar l (downcase L)
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

File:Ps.out scalebar l.png

2011-03-21T19:04:28Z

⚠️Ejtizado: uploaded a new version of "File:Ps.out scalebar l.png"

Ps.output

2011-03-21T18:57:00Z

⚠️Ejtizado: /* scalebar */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended type step [voffset height width] : Extended style of line for use mainly with rects. ''type'' = arrow, bar, circled_semi, double_bar, point, rombo, square, triangle, xcross, zigzag (you can use only the first char; and uppercase for filled version). ''step'' = (dimen). ''voffset'' = (dimen). ''height'' = (dimen). ''width'' = (dimen).

; baseline (y|n) : Work with the ''extended'' option to define if the baseline is drawn.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="4">
File:ps.out_linex_A.png|extended arrow 1mm
File:ps.out_linex_B.png|extended bar 1mm
File:ps.out_linex_C.png|extended circled_semi 1mm
File:ps.out_linex_D.png|extended double_bar 1mm
File:ps.out_linex_P.png|extended point 1mm
File:ps.out_linex_R.png|extended rombo 1mm
File:ps.out_linex_S.png|extended square 1mm
File:ps.out_linex_X.png|extended xcros 1mm
</gallery>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|l|s|S|f|F : Define the type of scalebar (I: inner, l: line, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_l.png|scalebar l (downcase L)
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

File:Ps.out scalebar l.png

2011-03-21T18:55:21Z

⚠️Ejtizado:

Ps.output

2011-03-21T18:52:08Z

⚠️Ejtizado: /* scalebar */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended type step [voffset height width] : Extended style of line for use mainly with rects. ''type'' = arrow, bar, circled_semi, double_bar, point, rombo, square, triangle, xcross, zigzag (you can use only the first char; and uppercase for filled version). ''step'' = (dimen). ''voffset'' = (dimen). ''height'' = (dimen). ''width'' = (dimen).

; baseline (y|n) : Work with the ''extended'' option to define if the baseline is drawn.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="4">
File:ps.out_linex_A.png|extended arrow 1mm
File:ps.out_linex_B.png|extended bar 1mm
File:ps.out_linex_C.png|extended circled_semi 1mm
File:ps.out_linex_D.png|extended double_bar 1mm
File:ps.out_linex_P.png|extended point 1mm
File:ps.out_linex_R.png|extended rombo 1mm
File:ps.out_linex_S.png|extended square 1mm
File:ps.out_linex_X.png|extended xcros 1mm
</gallery>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|l|s|S|f|F : Define the type of scalebar (I: inner, l: line, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

Ps.output

2011-03-06T11:39:54Z

⚠️Ejtizado: /* line */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended type step [voffset height width] : Extended style of line for use mainly with rects. ''type'' = arrow, bar, circled_semi, double_bar, point, rombo, square, triangle, xcross, zigzag (you can use only the first char; and uppercase for filled version). ''step'' = (dimen). ''voffset'' = (dimen). ''height'' = (dimen). ''width'' = (dimen).

; baseline (y|n) : Work with the ''extended'' option to define if the baseline is drawn.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="4">
File:ps.out_linex_A.png|extended arrow 1mm
File:ps.out_linex_B.png|extended bar 1mm
File:ps.out_linex_C.png|extended circled_semi 1mm
File:ps.out_linex_D.png|extended double_bar 1mm
File:ps.out_linex_P.png|extended point 1mm
File:ps.out_linex_R.png|extended rombo 1mm
File:ps.out_linex_S.png|extended square 1mm
File:ps.out_linex_X.png|extended xcros 1mm
</gallery>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

File:Ps.out linex X.png

2011-03-06T11:37:46Z

⚠️Ejtizado:

Ps.output

2011-03-06T11:37:09Z

⚠️Ejtizado: /* line */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step voffset height width) : Extended style of line for use mainly with rects. ''type'' = arrow, bar, circled_semi, double_bar, point, rombo, square, triangle, xcross, zigzag (you can use only the first char; and uppercase for filled version). ''voffset'' = (dimen). ''step'' = (dimen). ''height'' = (dimen). ''width'' = (dimen).

; baseline (y|n) : Work with the ''extended'' option to define if the baseline is drawn.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="4">
File:ps.out_linex_A.png|extended arrow 1mm
File:ps.out_linex_B.png|extended bar 1mm
File:ps.out_linex_C.png|extended circled_semi 1mm
File:ps.out_linex_D.png|extended double_bar 1mm
File:ps.out_linex_P.png|extended point 1mm
File:ps.out_linex_R.png|extended rombo 1mm
File:ps.out_linex_S.png|extended square 1mm
File:ps.out_linex_X.png|extended xcros 1mm
</gallery>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

Ps.output

2011-03-06T11:35:57Z

⚠️Ejtizado: /* line */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step voffset height width) : Extended style of line for use mainly with rects. ''type'' = arrow, bar, circled_semi, double_bar, point, rombo, square, triangle, xcross, zigzag (you can use only the first char; and uppercase for filled version). ''voffset'' = (dimen). ''step'' = (dimen). ''height'' = (dimen). ''width'' = (dimen).

; baseline (y|n) : Work with the ''extended'' option to define if the baseline is drawn.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps.out_linex_A.png|extended arrow 1mm
File:ps.out_linex_B.png|extended arrow 1mm
File:ps.out_linex_C.png|extended arrow 1mm
File:ps.out_linex_D.png|extended arrow 1mm
File:ps.out_linex_P.png|extended arrow 1mm
File:ps.out_linex_R.png|extended arrow 1mm
File:ps.out_linex_S.png|extended arrow 1mm
File:ps.out_linex_X.png|extended arrow 1mm
</gallery>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

File:Ps.out linex S.png

2011-03-06T11:15:20Z

⚠️Ejtizado: Extended line S

Extended line S

File:Ps.out linex R.png

2011-03-06T11:14:49Z

⚠️Ejtizado: Extended line R

Extended line R

File:Ps.out linex P.png

2011-03-06T11:14:27Z

⚠️Ejtizado: Extended line P

Extended line P

File:Ps.out linex D.png

2011-03-06T11:14:02Z

⚠️Ejtizado: Extended line D

Extended line D

File:Ps.out linex C.png

2011-03-06T11:13:27Z

⚠️Ejtizado: Extended line C

Extended line C

File:Ps.out linex B.png

2011-03-06T11:13:06Z

⚠️Ejtizado: Extended line B

Extended line B

File:Ps.out linex A.png

2011-03-06T11:12:24Z

⚠️Ejtizado: Extended line

Extended line

Ps.output

2011-01-14T18:27:16Z

⚠️Ejtizado: /* line */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step voffset height width) : Extended style of line for use mainly with rects. ''type'' = arrow, bar, circled_semi, double_bar, point, rombo, square, triangle, xcross, zigzag (you can use only the first char; and uppercase for filled version). ''voffset'' = (dimen). ''step'' = (dimen). ''height'' = (dimen). ''width'' = (dimen).

; baseline (y|n) : Work with the ''extended'' option to define if the baseline is drawn.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:|extended arrow 1mm
File:|
File:|
</gallery>

<File:ps.out_linex_A.png>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

Ps.output

2011-01-14T17:50:16Z

⚠️Ejtizado: /* line */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line. ''type'' = bar, double_bar, line, mark, point, round, square, triangle, xcross.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:|
File:|
File:|
</gallery>

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

Ps.output

2011-01-14T17:48:20Z

⚠️Ejtizado: /* Command line flags */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create an output file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line. ''type'' = bar, double_bar, line, mark, point, round, square, triangle, xcross.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

Ps.output

2011-01-14T16:08:24Z

⚠️Ejtizado: /* rlegend */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Create output as EPS file for embedding into another ''ps.out'' map

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper position.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line. ''type'' = bar, double_bar, line, mark, point, round, square, triangle, xcross.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with {{cmd|r.support}}.

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; interline (dimen) : Vertical space between symbols (o to join symbols)

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder the items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

== Conversion to PDF ==

You can obtain good results with these settings:
ps2pdf14 -dPDFSETTINGS=/prepress -dEmbedAllFonts=true map.ps map.pdf

== Example for ps.output control script ==

This is the content of a ps.output control file:

<source lang="text">
paper A4
landscape y
end
maparea
height 12cm
border .8mm
color grey
end

grid
major 100000
width .1mm
color white
end
minor 50000
width .1mm
color white
style 1
end
font
name Univers
size 6
extend 1.2
color black
end
fcolor black
format +out
trim 3
end

raster ortho.r ortho.g ortho.b
end
</source>

[[Category: ps.map]]

Ps.output

2010-11-06T16:07:39Z

⚠️Ejtizado: /* line */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line. ''type'' = bar, double_bar, line, mark, point, round, square, triangle, xcross.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-06T16:02:48Z

⚠️Ejtizado: /* line */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line. ''type'' = bar, double_bar, semibar, mark, point, round, square, triangle, xcross.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-06T14:52:58Z

⚠️Ejtizado: /* vlines */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlines0.png|hline
File:ps_out_vlines1.png|line 0.05mm setrule 100:brown|.25mm
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

File:Ps out vlines1.png

2010-11-06T14:51:24Z

⚠️Ejtizado: vlines with extended setrule

vlines with extended setrule

Ps.output

2010-11-06T14:33:43Z

⚠️Ejtizado: /* palette */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; light (color text) :

; dark (color text) :

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; binary (color name) :

; sequential (color.1 color.2 number text) :

; qualitative (number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-06T11:37:22Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-06T11:36:32Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
File:ps_out_vareas5.png|vareas roadsmajor  cat 24,28,32,38,53  mirror 5 90 [and fill with pat cruz.eps]
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

File:Ps out vareas5.png

2010-11-06T11:34:03Z

⚠️Ejtizado: vareas with a vector of lines and mirror command

vareas with a vector of lines and mirror command

Ps.output

2010-11-06T11:20:40Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas4.png|fill  color indigo  limit 3mm
-|-
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

File:Ps out vareas4.png

2010-11-06T11:20:06Z

⚠️Ejtizado: vareas with fill limit

vareas with fill limit

Ps.output

2010-11-06T11:01:52Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
-|-
-|-
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-06T10:59:31Z

⚠️Ejtizado: /* line */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : Color of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

; extended (type step height width) : Extended style of line.

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-06T10:57:55Z

⚠️Ejtizado: /* line */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== fill ====

Define the characteristic of a fill area.

; color (color) : Fill color.

; pat (file) : Fill pattern.

; lwidth (dimen) : Line width of the fill pattern.

; scale (number) : Scale of the fill pattern.

; limit (dimen) : Limit the fill to the border with a width of ''dimen''.

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-06T10:54:12Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vareas0.png|fill  color indigo
File:ps_out_vareas3.png|fill  pat patterns/diag_up.eps
File:ps_out_vareas1.png|rgbcol - cat setrule 0-500:red A setrule 500-1000:green B setrule 1000-5000:blue C
File:ps_out_vareas2.png|island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-06T10:49:53Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color][|dimen] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. The fillcolor of the areas is set to ''color'' and the line width is set to ''dimen'' when ''column.2'' >= n1 and ''column.2'' < n2 (''column.2'' from ''rgbcol'').

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-06T10:47:38Z

⚠️Ejtizado: /* raster */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-01T19:37:30Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; mirror (dimen [number]) : The line is drawn as an area with a copy of the line placed with polar coordinates: ''dimen' and ''angle''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-01T00:48:11Z

⚠️Ejtizado: /* vlines */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Dynamic line color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-11-01T00:47:08Z

⚠️Ejtizado: /* vlines */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''Optional commands:''

; type line|boundary : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define dynamic color of lines from the database ''column.1'' or, optionally, conditional color to apply color from rule sof the datbase ''column.2''.

; setnorule (text) : Label in legend when default values and ''setcolor'' rules.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-10-31T15:31:30Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; type area|line : Default ''area''.

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''The next commands are optionals:''

; type boundary|line : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define the database ''column.1'' to take the lines colors and, optionally, a ''column.2'' of database to apply color from the rules (''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

; setnodata (text) : Label in legend when default values and ''setcolor'' rules.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-10-31T15:27:21Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; line : Block ''line''. Style of the boundary.

; fill : Block ''fill''. Style of the area.

; rgbcol (column.1 [column.2]) : Dynamic fill color in a ''column.1'' of the database, or conditional color from rules applied to ''column.2'' of the database.

; setnorule (text) : Text label when default conditions.

; setrule (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''The next commands are optionals:''

; type boundary|line : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define the database ''column.1'' to take the lines colors and, optionally, a ''column.2'' of database to apply color from the rules (''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

; setnodata (text) : Label in legend when default values and ''setcolor'' rules.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-10-28T20:53:27Z

⚠️Ejtizado: /* note */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; text (text) : Another roption to enter the same as inline note text;

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; line : Block ''line'' to set the style of the border line of the areas.

; pat (epsfile) : Pattern in a EPS file.

; pscale (number) : Scale of pattern.

; pwidth (dimen) : Width of the lines of pattern.

; fcolor (color.1|column.1|color.2 column.2) : Static fill ''color.1'', dynamic fill color in a ''column.1'' of the database, or default ''color.2'' with color data from ''column.2'' of the database to apply the rules (color in ''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

; setnorule (text) : Text label when default conditions.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''The next commands are optionals:''

; type boundary|line : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define the database ''column.1'' to take the lines colors and, optionally, a ''column.2'' of database to apply color from the rules (''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

; setnodata (text) : Label in legend when default values and ''setcolor'' rules.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-10-28T20:42:52Z

⚠️Ejtizado: /* font */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

; outline yes|no : Outline of the font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; line : Block ''line'' to set the style of the border line of the areas.

; pat (epsfile) : Pattern in a EPS file.

; pscale (number) : Scale of pattern.

; pwidth (dimen) : Width of the lines of pattern.

; fcolor (color.1|column.1|color.2 column.2) : Static fill ''color.1'', dynamic fill color in a ''column.1'' of the database, or default ''color.2'' with color data from ''column.2'' of the database to apply the rules (color in ''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

; setnorule (text) : Text label when default conditions.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''The next commands are optionals:''

; type boundary|line : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define the database ''column.1'' to take the lines colors and, optionally, a ''column.2'' of database to apply color from the rules (''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

; setnodata (text) : Label in legend when default values and ''setcolor'' rules.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-10-28T16:14:57Z

⚠️Ejtizado: /* draw */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Simple script language to draw predefined postscript code.

; draw [none|paper|maparea|free] :
''paper'': before any map feature is drawn (equivalent to place inside ''paper'' block); 
''maparea'' before the last elements of the map (equivalent to place inside ''mapare'' block) ; 
''none'': draw over all elements of the map but only in the map area; and 
''free'': after all map features are drawn in any place of the paper; and ''none''.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; line : Block ''line'' to set the style of the border line of the areas.

; pat (epsfile) : Pattern in a EPS file.

; pscale (number) : Scale of pattern.

; pwidth (dimen) : Width of the lines of pattern.

; fcolor (color.1|column.1|color.2 column.2) : Static fill ''color.1'', dynamic fill color in a ''column.1'' of the database, or default ''color.2'' with color data from ''column.2'' of the database to apply the rules (color in ''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

; setnorule (text) : Text label when default conditions.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''The next commands are optionals:''

; type boundary|line : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define the database ''column.1'' to take the lines colors and, optionally, a ''column.2'' of database to apply color from the rules (''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

; setnodata (text) : Label in legend when default values and ''setcolor'' rules.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-10-28T16:09:41Z

⚠️Ejtizado: /* maparea */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

; draw : Block ''draw''. Draw onto the map but before the grid lines, vpoints and vlabels are drawn; i.e. this map elements are drawn over the draw elements.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Draw predefined postscript code.

; draw [paper|free] : ''paper'': run before any map feature is drawn (equivalent to place inside ''paper'' block); and ''free'': run after all map features are drawn then it's draw over map but not clipped.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; line : Block ''line'' to set the style of the border line of the areas.

; pat (epsfile) : Pattern in a EPS file.

; pscale (number) : Scale of pattern.

; pwidth (dimen) : Width of the lines of pattern.

; fcolor (color.1|column.1|color.2 column.2) : Static fill ''color.1'', dynamic fill color in a ''column.1'' of the database, or default ''color.2'' with color data from ''column.2'' of the database to apply the rules (color in ''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

; setnorule (text) : Text label when default conditions.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''The next commands are optionals:''

; type boundary|line : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define the database ''column.1'' to take the lines colors and, optionally, a ''column.2'' of database to apply color from the rules (''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

; setnodata (text) : Label in legend when default values and ''setcolor'' rules.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-10-28T16:07:00Z

⚠️Ejtizado: /* scale */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Scale of the map.

Simple line command to define the scale of the map. The default is adjust map to the paper dimensions. If the remaining dimensions of the paper not permit the scale, ''ps.out'' adjust the scale to a new value that it fit in the paper.

; scale 1<tt>:</tt>(number) : Scale of map. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Draw predefined postscript code.

; draw [paper|free] : ''paper'': run before any map feature is drawn (equivalent to place inside ''paper'' block); and ''free'': run after all map features are drawn then it's draw over map but not clipped.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; line : Block ''line'' to set the style of the border line of the areas.

; pat (epsfile) : Pattern in a EPS file.

; pscale (number) : Scale of pattern.

; pwidth (dimen) : Width of the lines of pattern.

; fcolor (color.1|column.1|color.2 column.2) : Static fill ''color.1'', dynamic fill color in a ''column.1'' of the database, or default ''color.2'' with color data from ''column.2'' of the database to apply the rules (color in ''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

; setnorule (text) : Text label when default conditions.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''The next commands are optionals:''

; type boundary|line : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define the database ''column.1'' to take the lines colors and, optionally, a ''column.2'' of database to apply color from the rules (''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

; setnodata (text) : Label in legend when default values and ''setcolor'' rules.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-10-28T16:03:07Z

⚠️Ejtizado: /* paper */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Size of paper.

; paper [A0-6|B0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks, before any feature of the map is drawn (see ''draw'').

=== scale ===

Simple command to define the scale of the map (default adjust map to the paper dimensions).

; scale 1<tt>:</tt>(number) : Scale of map, if possible. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Draw predefined postscript code.

; draw [paper|free] : ''paper'': run before any map feature is drawn (equivalent to place inside ''paper'' block); and ''free'': run after all map features are drawn then it's draw over map but not clipped.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; line : Block ''line'' to set the style of the border line of the areas.

; pat (epsfile) : Pattern in a EPS file.

; pscale (number) : Scale of pattern.

; pwidth (dimen) : Width of the lines of pattern.

; fcolor (color.1|column.1|color.2 column.2) : Static fill ''color.1'', dynamic fill color in a ''column.1'' of the database, or default ''color.2'' with color data from ''column.2'' of the database to apply the rules (color in ''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

; setnorule (text) : Text label when default conditions.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''The next commands are optionals:''

; type boundary|line : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define the database ''column.1'' to take the lines colors and, optionally, a ''column.2'' of database to apply color from the rules (''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

; setnodata (text) : Label in legend when default values and ''setcolor'' rules.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]

Ps.output

2010-10-27T18:57:57Z

⚠️Ejtizado: /* vareas */

The '''ps.out''' try to update the standard postscript output of Grass adding new features to design borders, graticules, categorized legends, etc

'''This is in progress and not all features are yet uploaded in ''addons''. '''

== Command line flags ==

'''-d ''': Draw a 1x1 cm grid on paper to help the placement of the elements of the map.

'''-e''': Make an output file without the postscript header. Useful when is embebed into other ''ps.out'' map.

'''-g''': Use the extended PostScript of Ghostscript (for transparent colors only)

'''-s''': Draw the small digit in the coordinate numbers to lower instead upper possition.

<gallery caption="Sample gallery" widths="100px" heights="100px" perrow="3">
File:ps_out_grid.png|A4 paper with flag -d
File:ps_out_digit_upper.png|coordinate
File:ps_out_digit_lower.png|coordinate with flag -s
</gallery>

== Generic Instructions ==

=== Parameters ===

==== dimen ====

Define a dimension. Accepted units are:

*; ''unitless'' : e.g. 123. The dimension is the ''number'' by 1/72".

*; inch : e.g. 1.2inch.

*; milimeters : e.g. 2.3mm.

*; centimeters : e.g. 1.4cm.

*; percentage : e.g. 50%. The position is relative to the size and position of the map in the paper being ''0%'' the left or bottom corner.

==== color ====

Define a color. Accepted formats are:

*; standard GRASS name : e.g. indigo.

*; R<tt>:</tt>G<tt>:</tt>B : e.g. 200:123:90

*; user name : e.g. red5. Defined in ''palette'' block

All formats can add '$(0-1)' to define the opacity of the color (alpha channel); e.g., indigo$.75 or 200:120:120$.2

==== number ====

==== text ====

=== Blocks of instructions ===

A ''block'' begin with the keywords and finish with keyword ''end''

==== font ====

Define the characteristic of a font.

; name (text) : Name of font.

; size (dimen) : Size of font.

; extend (dimen): Expand the width of font.

; color (color) : Color of font.

==== line ====

Define the characteristic of a line.

; width (dimen) : Width of line.

; color (color) : COlor of line.

; style solid|dashed|dotted|dashdotted|(n1n2...) : Style of line.

; cap butt|round|extended_butt : Cap

==== frame ====

Define the characteristic of a frame.

; where (dimen.1 dimen.2) : Position of frame.

; offset (number.1 number.2) : Fine x and y adjust of the position of frame.

; ref right|left|center upper|lower|center : Position is relative to the ''ref''.

; border (dimen) : Width of the border line

; color (color) : Color of the border line.

; fcolor (color) : Fillcolor of the frame.

; rotate (dimen) : todo

==== legend ====

; lpos (number): Position in legend Codes: -1, no show in legend; 0 automatic position; > 0 horizontal position.

; cols (number.1 [number.2]): Organize legend in ''number.1'' cols with a optional span of ''number.2''

; interline (dimen): Set partial legend interline

== Map paper ==

=== paper ===

Base size of paper.

; paper [B0-6|A0-6|Legal|Ledger|Tabloid|Executive|Folio] : Type of paper (default A4).

; color (color) : Paper color.

; width (dimen), height (dimen) : Custom size of paper.

; left (dimen), right (dimen), top (dimen), bottom (dimen) : Custom margins (default 0.5" left and right, and 1" top and bottom).

; landscape yes|no : Paper orientation (default ''no'').

; font : Block ''font''. Set the default font of the map.

; draw : Block ''draw''. Free draw as watermarks before any feature of the map is drawn (see ''draw'').

=== scale ===

Simple command to define the scale of the map (default adjust map to the paper dimensions).

; scale 1<tt>:</tt>(number) : Scale of map, if possible. For example, ''scale 1:500000'' to rescale maparea dimensions.

=== maparea ===
Define specific dimensions of the map (default defined by command ''scale'')

; maparea : Define characteristics of the map area.

; border (dimen) : Width of the border map. Usefull with ''in'' and ''out'' formats of the ''grid'' and ''geogrid'', ignored in ''iho'' and ''can'' formats.

; color (color) : Border color-

; fcolor (color) : Fillcolor of the map area.

; width (dimen), height (dimen) : Dimensions of the map.

; top (dimen), bottom (dimen) : Position of the top-left corner of the map.

=== palette ===

testing

; palette

; wheel (number text) :

; monochrome (color number text) :

; complementary (color number text) :

; analogous (color number text) :

; gradient (color.1 color.2 number text) :

; diverging (color.1 color.2 number text) :

== Common elements ==

=== grid and geogrid ===

Draw a border around the map.

; grid|geogrid :

; format in|out|+out|can|iho : Type of border (see examples).

; major (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; minor (number|angle) : Block ''line''. Usually, ''number'' is merters and ''angle'' only in ''geogrid''.

; subminor (number) : ''number'' of subdivisons of the minor divisions.

; trim (number) : Cut trailing zeros.

; font : Block ''font''.

; fcolor (color) : Color of the border.

; cross (number) : Replace lines by cross

<gallery caption="Sample gallery" widths="200px" heights="150px" perrow="3">
File:ps_out_iho.png|format iho
File:ps_out_can.png|format can
File:ps_out_in.png |format in
File:ps_out_out.png|format +out
File:ps_out_out1.png|typical map border
File:ps_out_out2.png|typical map border with ''subminor 5'' and ''fcolor blue''
File:ps_out_out3.png|''cross 500'', ''fcolor indigo'', ''color 200:200:200'' in '''maparea'''
</gallery>

=== scalebar ===

Set a scalebar on the map. Maximun 5 scalebars in each map.

; scalebar I|s|S|f|F : Define the type of scalebar (I: inner, s/S: simple, f/F: fill).

; length (number) : Length of the scale.

; units meters|m|kilometers|km|feet|ft|miles|mil|nautical_miles|nm ([text]) : Unit of the length and ''text' to label the units.

; major (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; minor (number.1 [number.2]) : Define the ''number.1'' of subdivisions and each ''number.2'' set the labels.

; frame : Block ''frame''

; font : Block ''font''

; fcolor (color) : Fillcolor.

; height (dimen) : Height of the bar or ticks.

; zero yes|no : Set position relative to zero value of the scalebar.

<gallery caption="Scalerbar styles" widths="200px" heights="50px" perrow="3">
File:ps_out_scalebar_s.png|scalebar s
File:ps_out_scalebar_S.png|scalebar S
File:ps_out_scalebar_I.png|scalebar I (uppercase i)
File:ps_out_scalebar_f.png|scalebar f
File:ps_out_scalebar_F.png|scalebar F
File:ps_out_scalebar_3.png|Multiple scalebars zero centered with ''zero yes''
</gallery>

=== note ===
Write special text or free text on any place of the paper with frame (also ''draw'' permit write free-text in paper).

Maximun 20 notes by map.

; note <tt>:</tt>file|<tt>:</tt>maplimits|<tt>:</tt>dimen|<tt>:</tt>scale (text)|(text) : Type of note and text to show. When free text, use '|' to break lines and '.' as first character to center line.

; frame : Block ''frame''.

; font : Block ''font''.

; width (dimen) : Width of note.

; angle (number) : ''number'' of degrees to rotate (do not work fine).

<gallery caption="Note keywords and free text" widths="200px" heights="100px" perrow="3">
File:ps_out_note_ml.png |note :maplimits  frame [...] end
File:ps_out_note_dimen.png|note :dimen  frame [...] end
File:ps_out_note_scale.png|note :scale  frame [...] end
File:ps_out_note_free.png|note free text|in multiple lines  frame [...] end
File:ps_out_note_freec.png|note .free text|.in multiple [...]  frame [...] end
File:ps_out_note_scaler.png|note :scale scale  frame [...]  angle 90 end
</gallery>

=== draw ===

Draw predefined postscript code.

; draw [paper|free] : ''paper'': run before any map feature is drawn (equivalent to place inside ''paper'' block); and ''free'': run after all map features are drawn then it's draw over map but not clipped.

; --- :

<gallery caption="Sample gallery" widths="200px" heights="100px" perrow="3">
File:ps_out_north1.png |<source lang="text">north 700000 4700000</source>
File:ps_out_north2.png |north 5cm 16.5cm -
File:ps_out_maplimits.png|maplimits
File:ps_out_compass.png |compass 700000 4700000 10000 10.2345
</gallery>

== Raster maps ==

=== raster ===

Draw one or two raster maps on the maparea.

; raster (raster|raster.1 raster.2|raster.R raster.G raster.B|<tt>:</tt>group) : The ''raster'' value is the raster mapname, two raster maps ''raster.1'' or color and ''raster.2'' or shade to draw as relief map, three maps ''raster.R'', ''raster.G'' and ''raster.B'' to draw as RGB, or a groupname (leader by ':') with tree RGB maps.

''The next commands are optionals'':

; grey yes|no : Store and draw the rasters in grey scale (small size of file). The conversion follows the NTSC video standard.

; maskcell (raster.1 [raster.2]) : Set the ''raster.1'' map to use as mask (independent of the mask set in GRASS with [[r.mask]]) and, optionally, the ''raster.2'' map uses as background. The background ''raster.2'' is painted in grey scale (NTSC) and tinted with ''maskcolor''.

; maskcolor (color|none) : Set the ''color'' of the mask area. If a raster map as background is set then it's drawn with a scale white-maskcolor.

; outline : Block ''line''. Outline of categories.

; setcolor null|default|(number) (color) : Replace the color of the cat ''number'' area with a new color. Multiple ''setcolor'' are possibles.

The following gallery show the output of the commands inside the '''raster''' block (all mapnames are of type ''raster'').

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_raster1.png|<div>raster elevation end</div>
File:ps_out_raster2.png|<div>raster elevation elevation_shade end</div>
File:ps_out_raster3.png|<div>raster lsat5.5 lsat5.4 lsat5.3 end</div>
File:ps_out_raster_mask1.png|<div>raster elevation  maskcell urban_neg  maskcolor indigo end</div>
File:ps_out_raster_mask2.png|<div>raster elevation elevation_shade  maskcell urban_neg elevation end</div>
File:ps_out_raster_mask3.png|<div>raster lsat5.5 lsat5.4 lsat5.3  maskcell urban_neg elevation  maskcolor indigo end</div>
File:ps_out_raster_outline.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  outline   width .2mm  end end</div>
File:ps_out_raster_setcolor.png|<div>raster basin_50K elevation_shade  maskcell basin_50K  maskcolor white  setcolor 37 magenta end</div>
File:ps_out_raster_grey.png|<div>raster elevation  grey yes end</div>
</gallery>

== Vector maps ==

All vector map accept optionally the following commands:

; layer (number) : Layer number used with cats/where option.

; cats (n1,n2,...) : List of ''cat''s to show.

; where (text) : Argument of the SQL where clausule to filter the areas to show.

; masked yes|no : Masked or not by raster mask (default ''no'').

; label (text) : For description or title in ''vlegend''.

; legend [(number)]: Position in legend (-1, no legend) or enter in a block ''legend''.

=== vareas ===

Draw areas on the map. 
The areas always are drawn first, on the bottom of other type of maps.

; vareas (vector) : ''vector'' is a vector of areas, except when ''lwidth'' is different to zero that ''vector'' is a vector of lines.

''The next commands are optionals:''

; line : Block ''line'' to set the style of the border line of the areas.

; pat (epsfile) : Pattern in a EPS file.

; pscale (number) : Scale of pattern.

; pwidth (dimen) : Width of the lines of pattern.

; fcolor (color.1|column.1|color.2 column.2) : Static fill ''color.1'', dynamic fill color in a ''column.1'' of the database, or default ''color.2'' with color data from ''column.2'' of the database to apply the rules (color in ''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with label the ''text'' and title the text of the ''label''. Also, the fillcolor of the areas of the map with ''column'' >= n1 and ''column'' < n2 (''column'' from ''fcolor''), is set to ''color''.

; setnorule (text) : Text label when default conditions.

''Special commands:''

; island yes|no : Draw island as normal areas (fill as normal area then hide it).

; lwidth (dimen) : Line map draws as an area with a width = ''lwidth''.

<gallery caption="vareas: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vareas0.png| vareas geology   where GEO_NAME like 'Zb'   fcolor indigo  end
File:ps_out_vareas3.png|''with ...''  pat ../patterns/diag_up.eps  pscale .5
File:ps_out_vareas1.png|''with ...''  fcolor none cat  setrule 0-500:red A  setrule 500-1000:green B  setrule 1000-5000:blue C
File:ps_out_vareas2.png|''with ...''  island no
</gallery>

=== vlines ===

Draw lines on the map. The areas always are drawn second, after ''vareas'' and before ''vpoints''.

; vlines (vector) :

''vector'' is a vector of lines, except if ''type'' is boundary that ''vector'' is a vector of areas.

''The next commands are optionals:''

; type boundary|line : Draw boundaries of a vector of areas or lines of a vector of lines (default ''line'').

; line : Block ''line''. Normal line.

; hline : Block ''line''. Highlight line.

; offset (dimen) : Works with ''hline'' to offset from the center of ''line''.

; rgbcol (column.1 [column.2]) : Define the database ''column.1'' to take the lines colors and, optionally, a ''column.2'' of database to apply color from the rules (''setcolor'').

; setcolor (n1-n2[<tt>:</tt>color] text) : Make a item of a sublegend with ''text'' as label and title the text of the ''label''. Also, the color of the normal line with column >= n1 and column < n2 (column from rgbcol), is set to ''color''.

; setnodata (text) : Label in legend when default values and ''setcolor'' rules.

<gallery caption="vlines: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vlines0.png|''Effect of the ''hline'' block ...''  hline   width 1mm   color red  end
</gallery>

=== vpoints ===

Draw points on the map. The points always are drawn last, after ''vareas'' and ''vlines''.

; vpoints (vector) :

''vector'' is a vector of points, except when '''type''' is ''centroid'' or ''boundary'' that it is a vector of areas, or when '''type''' is ''line'' that it is a vector of lines.

''The next commands are optionals'':

; type centroid|line|boundary|point : Type of draw (default ''point'').

; symbol (epsfile) : Symbol to use (default: basic/circle).

; line : Block ''line''. Type of line in the symbol.

; fcolor (color): Static fillcolor of the symbol.

; offset (dimen) : Offset of the symbol.

; rotate (number|column) : Angle to rotate the symbol, static ''number'' or dynamic in a ''column'' of the database.

; size (number|column [number]) : Size of the symbol take from ''number'' or from a ''column'' of the database. In the last option, there is a optional ''number'' to define the static size of the symbol in the legend when the size of symbols are dynamic.

; scale (dimen.1 [dimen.2]) : Rescale the size of the symbol by the ''dimen.1'' and, optionally, add a ''dimen.2''. i.e., ''resize = dimen.1 * size + dimen.2''.

; setsize (n1-n2[<tt>:</tt>size] text) : Variable size of symbols from data in ''column'' of database set in ''size''.

''Special commands when type is line'':

; dist (dimen) : Define the distance in paper between symbol over the line.

; cline : Block ''line''. Type of line that connect symbols.

<gallery caption="vpoints: sample gallery" widths="150px" heights="150px" perrow="4">
File:ps_out_vpoints0.png|''Points with same size ...''  size 5
File:ps_out_vpoints1.png|''Points with dynamic size ...''  size PT 5  scale 0.01 2
File:ps_out_vpoints2.png|''Points with conditional size ...''  size PT  setrule 200-1000:3 < 1000  setrule 1000-2500:9 > 1000
File:ps_out_vpoints3.png|''Points on line ...''  type line  dist 1cm
</gallery>

=== vlabels ===

in progress

; vlabels none|(vector) :

; font :

; labelcol (column) :

; decimals (number) :

; circled yes|no :

; setrule (n1-n2 text)

<gallery caption="Sample gallery" widths="200px" heights="200px" perrow="3">
File:ps_out_vlabels0.png|vpoints firestations<br/n> [...]<br/n>end vlabels firestations<br/n> labelcol PUMPERS<br/n> font<br/n>  name Univers-Bold<br/n>  size 10<br/n>  color yellow<br/n> end<br/n>end
</gallery>

== Legend of the maps ==

=== rlegend ===

Legend of the raster map. The units ''meters'' in the gradient legend is set with [[r.support]].

; rlegend [text] : Text is the title of the legend.

; raster (raster) : the ''raster'' map to take the data of legend.

''The next commads are optionals'':

; titlefont : Block ''font'' for the legend header.

; font : Block ''font'' for the normal text.

; frame : Block ''frame''.

; swidth (dimen) : Width of the symbol area.

''For category legends''

; cols (number) [(number)] : Number of columns with symbols and separation between columns (default ''1'').

; nodata yes|no : Remove category ''no data''.

; order (n1,n2,...) : To reorder items.

''For gradient legends''

; height (dimen), width (dimen) : Dimension of the frame with the legend.

; vertical yes|no : Orientation of the gradient legend (default ''no'').

; range (n1 n2) : Manual set of the data range for legend.

; gradient yes|no : Forze draw gradient legend with category data.

; tick (dimen) : Length of the ticks.

; whiteframe (dimen) : Width of the white frame around the bar color.

<gallery caption="Sample gallery" widths="250px" heights="250px" perrow="3">
File:ps_out_rlegend.png|rlegend Zip Codes (wake)  raster zipcodes_wake  cols 2 0  swidth 8mm  order 20,10,30,22,34 end
File:ps_out_rlegend1.png|rlegend  raster elevation  height 8cm end
File:ps_out_rlegend2.png|rlegend  raster elevation  width 8cm  vertical no end
</gallery>

=== vlegend ===

Legend of the vector maps.

; vlegend [text] : Optional the title or head of the legend.

''The next commands are optionals'':

; title : Block ''font'' for title of legend.

; font : Block font for normal text of legend.

; frame :

; cols (number.1 [number.2]) : Distribution of the items in ''number.1'' cols. Optionaly, ''number.2'' of span between columns.

; swidth (dimen) : Symbol width.

; interline (dimen) : Space between lines.

<gallery caption="vlegend: sample gallery" widths="250px" heights="150px" perrow="3">
File:ps_output_vlegend0.png
</gallery>

[[Category: ps.map]]