.TH d.text.freetype 1grass "" "GRASS 6.4.4" "Grass User's Manual"
.SH NAME
\fI\fBd.text\fR\fR  - Draws text in the active display frame on the graphics monitor using the current font.
.SH KEYWORDS
display, cartography
.SH SYNOPSIS
\fBd.text\fR
.br
\fBd.text help\fR
.br
\fBd.text\fR [\-\fBmpgbrsc\fR]  [\fBtext\fR=\fIstring\fR]   [\fBsize\fR=\fIfloat\fR]   [\fBcolor\fR=\fIstring\fR]   [\fBbgcolor\fR=\fIstring\fR]   [\fBline\fR=\fIinteger\fR]   [\fBat\fR=\fIx,y\fR]   [\fBalign\fR=\fIstring\fR]   [\fBrotation\fR=\fIfloat\fR]   [\fBlinespacing\fR=\fIfloat\fR]   [\fBfont\fR=\fIstring\fR]   [\fBpath\fR=\fIstring\fR]   [\fBcharset\fR=\fIstring\fR]   [\-\-\fBverbose\fR]  [\-\-\fBquiet\fR] 
.SS Flags:
.IP "\fB\-m\fR" 4m
.br
Use mouse to interactively place text
.IP "\fB\-p\fR" 4m
.br
Screen position in pixels ([0,0] is top left)
.IP "\fB\-g\fR" 4m
.br
Screen position in geographic coordinates
.IP "\fB\-b\fR" 4m
.br
Use bold text
.IP "\fB\-r\fR" 4m
.br
Use radians instead of degrees for rotation
.IP "\fB\-s\fR" 4m
.br
Font size is height in pixels
.IP "\fB\-c\fR" 4m
.br
Ignored (compatibility with d.text.freetype)
.IP "\fB\-\-verbose\fR" 4m
.br
Verbose module output
.IP "\fB\-\-quiet\fR" 4m
.br
Quiet module output
.PP
.SS Parameters:
.IP "\fBtext\fR=\fIstring\fR" 4m
.br
Text to display
.IP "\fBsize\fR=\fIfloat\fR" 4m
.br
Height of letters in percentage of available frame height
.br
Options: \fI0-100\fR
.br
Default: \fI5\fR
.IP "\fBcolor\fR=\fIstring\fR" 4m
.br
Text color, either a standard GRASS color or R:G:B triplet
.br
Default: \fIgray\fR
.IP "\fBbgcolor\fR=\fIstring\fR" 4m
.br
Text background color, either a standard GRASS color or R:G:B triplet
.IP "\fBline\fR=\fIinteger\fR" 4m
.br
The screen line number on which text will begin to be drawn
.br
Options: \fI1-1000\fR
.IP "\fBat\fR=\fIx,y\fR" 4m
.br
Screen position at which text will begin to be drawn (percentage, [0,0] is lower left)
.IP "\fBalign\fR=\fIstring\fR" 4m
.br
Text alignment
.br
Options: \fIll,lc,lr,cl,cc,cr,ul,uc,ur\fR
.br
Default: \fIll\fR
.IP "\fBrotation\fR=\fIfloat\fR" 4m
.br
Rotation angle in degrees (counter-clockwise)
.br
Default: \fI0\fR
.IP "\fBlinespacing\fR=\fIfloat\fR" 4m
.br
Line spacing
.br
Default: \fI1.25\fR
.IP "\fBfont\fR=\fIstring\fR" 4m
.br
Font name
.IP "\fBpath\fR=\fIstring\fR" 4m
.br
Path to font file
.IP "\fBcharset\fR=\fIstring\fR" 4m
.br
Text encoding (only applicable to TrueType fonts)
.PP
.SH DESCRIPTION
\fId.text.freetype\fR
draws text in the graphics monitor's active display frame using TrueType
fonts already installed on the user's system.
.br
.SS Parameter Notes:
.IP "\fBat=\fR\fIx,y\fR
.br
Locates the text at this screen position (percentage, [0,0] is bottom
left). If this option is omitted, 
the user will be prompted to use the mouse to specify the location.
.IP "\fBfont=\fR\fIname\fR
.br
Specifies a font listed in the GRASS 'freetypecap' definition file.
.IP "\fBcharset=\fR\fIname\fR
.br
Sets character encoding for input \fBtext\fR. (e.g. ISO-8859-1)
.IP "\fBcolor=\fR\fIname\fR
.br
Sets text color to \fIname\fR or \fIR:G:B triplet\fR.
It can also be a hexadecimal value of 0xRRGGBB
(deprecated).
.br
Options: red, orange, yellow, green, blue, indigo, 
violet, gray, white, and black
.br
Default: \fIgray\fR
.br
.IP "\fBsize=\fR\fIvalue\fR
.br
Sets text height in percent of available frame height.
.br
Default: 10
.IP "\fBalign=\fR\fIname\fR
.br
Aligns text in this way.
.br
Options: ll, lc, lr, cl, cc, cr, ul, uc, ur
.br
l?: Lower, c?: Vertically Centered, u?: Upper,
.br
?l: Left, ?c: Horizontally Centered, ?r: Right
.br
Default: \fIll\fR (Lower Left)
.br
.PP
.SS Command mode:
.SS Key
.IP "{REQUIRED}
.IP "[OPTIONAL]
.IP "THIS|orTHAT
.IP "+, - 
.br
Relative value
.IP "r, %, p
.br
Radian, Percentage, and Pixels respectively
.PP
.SS Commands
.IP "
.br
.F {font|path}[:charset] \fIfont\fR
.IP "
.br
.C {color_name|R:G:B} \fIcolor\fR (default: gray)
.IP "
.br
.S [+|-]size[p] \fIsize\fR (default: 5)
.IP "
.br
.B {0|1} \fIbold\fR (default: 0)
.IP "
.br
.A {ll|lc|lr|cl|cc|cr|ul|uc|ur} \fIalign\fR (default: ll)
.IP "
.br
.R [+|-]rotation[r] \fIrotation\fR (default: 0)
.IP "
.br
.I linespacing \fIlinespacing\fR (default: 1.1)
.IP "
.br
.X [+|-]x[%|p] \fIx-coord\fR
.IP "
.br
.Y [+|-]y[%|p] \fIy-coord\fR
.IP "
.br
.L {0|1} \fIlinefeed\fR (default: 1)
.IP "
.br
.E [+|-]east[%|p] \fIx-origin\fR
.IP "
.br
.N [+|-]north[%|p] \fIy-origin\fR
.IP "
.br
.. \fIdot\fR
.PP
To end input, press Ctrl-d on a blank line.
.br
.SH EXAMPLES
.SS Standard mode:
\fBd.text.freetype\fR text="GRASS GIS" \-g at=2107055,5603133 \(rs
.br
size=7 path=/usr/X11R6/lib/X11/fonts/TTF/luximb.ttf
.PP
.SS Command mode:
The following example prints three lines: "GRASS
d.text.freetype output",
\(dqSee test.input file", and 
\(dqfor more details.".
\fC
.DS
.br
\fBd.text.freetype \-c\fR
.br
.F /usr/X11R6/lib/X11/fonts/TTF/luximb.ttf:ISO-8859-1
.br
.S 20p
.br
.L 0
.br
GRASS 
.br
.C red
.br
 d.text.freetype
.br
.C gray
.br
 output
.br
.L 1
.br
See test.input file
.br
for more details.
.br
.DE
\fR
Command mode instructions may also be read directly from a text file:
.br
\fBd.text.freetype\fR \-c < test.input
.br
.SH DEFINITION FILE
To help users select fonts conveniently, the definition file,
$(GISBASE)/etc/freetypecap, is provided.  Its format is as follows:
\fC
.DS
.br
	font:fontpath:charset:description
.br
	*default_font:fontpath:charset:description
.br
.DE
\fR
See the file for examples.
.br
.SH SEE ALSO
\fId.text\fR
.br
\fId.font.freetype\fR
.br
\fId.font\fR
.br
\fId.title\fR
.br
\fId.where\fR
.br
.br
.SH AUTHOR
Huidae Cho
grass4u@gmail.com>
.PP
Updates by Hamish Bowman, NZ
.PP
\fILast changed: $Date: 2011-11-08 12:29:50 +0100 (Tue, 08 Nov 2011) $\fR
.PP
Full index
.PP
© 2003-2014 GRASS Development Team