.TH d.out.file 1grass "" "GRASS 6.4.2" "Grass User's Manual"
.SH NAME
\fI\fBd.out.file\fR\fR  - Saves the contents of the active display monitor to a graphics file.
.SH KEYWORDS
display, export
.SH SYNOPSIS
\fBd.out.file\fR
.br
\fBd.out.file help\fR
.br
\fBd.out.file\fR [-\fBbtcrm\fR] \fBoutput\fR=\fIstring\fR \fBformat\fR=\fIstring\fR  [\fBresolution\fR=\fIinteger\fR]   [\fBsize\fR=\fIwidth,height\fR]   [\fBcompression\fR=\fIinteger\fR]   [\fBquality\fR=\fIinteger\fR]   [\fBpaper\fR=\fIstring\fR]   [\fBps_level\fR=\fIinteger\fR]   [\fBcreateopt\fR=\fIstring\fR]   [\fBmetaopt\fR=\fIstring\fR]   [--\fBverbose\fR]  [--\fBquiet\fR] 
.SS Flags:
.IP "\fB-b\fR" 4m
.br
Set background color to black (white default)
.IP "\fB-t\fR" 4m
.br
Set transparent background
.IP "\fB-c\fR" 4m
.br
Use the Cario driver to render images
.IP "\fB-r\fR" 4m
.br
Set paper orientation to landscape (for PostScript output)
.IP "\fB-m\fR" 4m
.br
Do not crop away margins
.IP "\fB--verbose\fR" 4m
.br
Verbose module output
.IP "\fB--quiet\fR" 4m
.br
Quiet module output
.PP
.SS Parameters:
.IP "\fBoutput\fR=\fIstring\fR" 4m
.br
Name for output file (do NOT add extension)
.IP "\fBformat\fR=\fIstring\fR" 4m
.br
Graphics file format
.br
Options: \fIpng,ppm,tif,geotiff,jpg,bmp,ps,eps,svg,pdf\fR
.br
Default: \fIpng\fR
.IP "\fBresolution\fR=\fIinteger\fR" 4m
.br
Dimensions of output file versus current window size
.br
(same=1, double size=2, quadruple size=4)
.br
Default: \fI1\fR
.IP "\fBsize\fR=\fIwidth,height\fR" 4m
.br
Width and height of output image (overrides resolution setting)
.IP "\fBcompression\fR=\fIinteger\fR" 4m
.br
Compression for PNG files
.br
(0=none, 1=fastest, 9=most; lossless, only time vs. filesize)
.br
Options: \fI0-9\fR
.br
Default: \fI9\fR
.IP "\fBquality\fR=\fIinteger\fR" 4m
.br
File size/quality for JPEG files
.br
(10=smallest/worst, 100=largest/best)
.br
Options: \fI10-100\fR
.br
Default: \fI75\fR
.IP "\fBpaper\fR=\fIstring\fR" 4m
.br
Paper size for PostScript output
.br
Options: \fIa4,a3,a2,a1,a0,us-letter,us-legal,us-tabloid\fR
.br
Default: \fIa4\fR
.IP "\fBps_level\fR=\fIinteger\fR" 4m
.br
PostScript level (only limits functionality!)
.br
Options: \fI1-3\fR
.br
Default: \fI2\fR
.IP "\fBcreateopt\fR=\fIstring\fR" 4m
.br
GeoTIFF creation option(s)
.br
In the form of "NAME=VALUE", separate multiple entries with a comma.
.IP "\fBmetaopt\fR=\fIstring\fR" 4m
.br
GeoTIFF metadata key(s) and value(s) to add
.br
In the form of "META-TAG=VALUE", separate multiple entries with a comma.
.PP
.SH DESCRIPTION
\fI(GRASS Shell Script)\fR
.PP
\fI\fBd.out.file\fR\fR uses \fId.save\fR, the GRASS PNG or PostScript
driver, and gdal_translate to export the currently selected X display
monitor to a graphics file of several formats. Output image size can be set
prior to export.
.PP
PNG and PPM formats are supported directly by the GRASS PNG driver and
PostScript output is supported directly by the GRASS PS driver.
.PP
TIFF, GeoTIFF, JPEG, and BMP formats are supported by using gdal_translate
on PPM format files produced by the GRASS PNG driver. Different levels of
compression/quality are supported for JPEG files.
.PP
Graphic files are exported to the user's current working directory by
default, but different paths may be specified in the output field.
.PP
EPS files are not compatible with \fId.frame\fR, as it is not possible to nest
encapsulation. Only the first frame will be drawn. In these cases it is
recommended to output to regular PostScript format and then use a utility
like ps2epsi to convert to an EPS file.
Output from this module using the regular PostScript format may contain
subframes.
.PP
GeoTIFF export is provided as a convenience. For raster export
it is generally preferable to use the \fIr.out.gdal\fR or
\fIr.out.tiff\fR modules. The advantage of using \fId.out.file\fR
is that you can easily overlay multiple raster maps, vector maps,
and decorations into the GeoTIFF at the expense of resolution and
quality. If you wish to minimize the negative effects, use
\(dqg.region align=" or "g.region rast=", then
\(dqg.region -g" or "r.info -g" to discover the
raster rows and columns of the map, and feed these numbers into
\fId.out.file\fR's \fBsize\fR parameter as columns,rows.
.SH EXAMPLES
.SS Speafish dataset
\fC
.DS
.br
  g.region rast=slope -p
.br
  d.mon x0
.br
  d.rast slope
.br
  d.vect streams type=area,line
.br
  d.barscale at=0,94.5
.br
  d.out.file spearfish_pic format=png size=800,600
.br
  d.out.file spearfish_pic format=ps -r paper=a4
.br
.DE
\fR
.br
.SS Multi-pane PostScript output using a shaded relief map and 
d.frame.quarter
from the Wiki-Addons site
\fC
.DS
.br
  g.region rast=elevation.dem
.br
  r.shaded.relief map=elevation.dem shad=elev.shad_relf
.br
  d.mon x1
.br
  d.frame.quarter
.br
  d.frame uno
.br
  d.his h=elevation.dem i=elev.shad_relf brighten=50
.br
  echo "A" | d.text -b color=black size=10 at=93,5
.br
  d.frame dos
.br
  d.his h=slope i=elev.shad_relf brighten=40
.br
  echo "B" | d.text -b color=black size=10 at=93,5
.br
  d.frame tres
.br
  d.his h=landcover.30m i=elev.shad_relf brighten=55
.br
  echo "C" | d.text -b color=black size=10 at=93,5
.br
  d.frame cuatro
.br
  d.his h=trn.sites i=elev.shad_relf brighten=15
.br
  echo "D" | d.text -b color=black size=10 at=93,5
.br
  d.frame full_screen
.br
  d.out.file spearfish_4 format=ps -r paper=a4
.br
.DE
\fR
.SH SEE ALSO
\fI
d.frame,
d.mon,
d.out.png,
d.save,
g.region,
ps.map,
r.out.gdal,
r.out.tiff
\fR
.br
Cairo driver,
PNG driver,
PostScript driver,
HTML-map driver,
X driver
.br
GDAL Homepage
.SH AUTHORS
Michael Barton, Arizona State University
.br
Hamish Bowman, Otago University, New Zealand
.PP
\fILast changed: $Date: 2011-11-08 12:29:50 +0100 (Tue, 08 Nov 2011) $\fR
.PP
Full index
.PP
© 2003-2011 GRASS Development Team