man/man1/psign.1

.\" RCSid "$Id"
.TH PSIGN 1 10/9/97 RADIANCE
.SH NAME
psign - produce a RADIANCE picture from text.
.SH SYNOPSIS
.B psign
[
.B options
]
[
.B text
]
.SH DESCRIPTION
.I Psign
produces a RADIANCE picture of the given
.I text.
The output dimensions are determined by the character height, aspect
ratio, number of lines and line length.
(Also the character size if text squeezing is used.)\0
If no
.I text
is given, the standard input is read.
.TP 10n
.BI -cb " r g b"
Set the background color to
.I "r g b"
The default is white (1 1 1).
.TP
.BI -cf " r g b"
Set the foreground color to
.I "r g b"
The default is black (0 0 0).
.TP
.BR \-dr
Text reads to the right (default).
.TP
.BR \-du
Text reads upwards.
.TP
.BR \-dl
Text reads to the left (upside down).
.TP
.BR \-dd
Text reads downwards.
.TP
.BI -h \ cheight
Set the character height to
.I cheight.
The default is 32 pixels.
.TP
.BI -a \ aspect
Set the character aspect ratio (height/width) to
.I aspect.
The default value is 1.67.
.TP
.BI -x \ xsize
Set the horizontal image size to
.I xsize.
Use with
.I \-y
option (below) in place of the
.I \-h
specification to control output image size directly.
If the character aspect ratio
.I (\-a
option, above) is non-zero, then one of the specified x or y output
dimensions may be reduced to maintain this ratio.
If direction is right
.I (\-dr)
or left
.I (\-dl),
then it is not necessary to give the
.I \-y
option, since it can be computed from the character height
.I (\-h).
.TP
.BI -y \ ysize
Set the vertical image size to
.I ysize.
Use with the
.I \-x
option (described above).
If direction is up
.I (\-du)
or down
.I (\-dd),
then it is not necessary to give the
.I \-x
option, since it can be computed from the character height
.I (\-h).
.TP
.BI -s \ spacing
Set the intercharacter spacing to
.I spacing.
The magnitude of this value is multiplied by the character height over
the aspect ratio (ie. the character width) to compute the desired
distance between characters in the output.
The sign of the value, positive or negative, determines how this
ideal spacing is used in the actual placement of characters.
If
.I spacing
is positive, then the overall width of the line will not be affected,
nor will indentation of textual elements.
Thus, the text format will be mostly unaffected.
However, spacing between characters will reflect their relative size
for a more natural appearance.
If
.I spacing
is negative, characters will be squeezed together to meet the
spacing critereon, regardless of how it might affect the format of
the output.
The default value for
.I spacing
is zero, which is interpreted as uniformly spaced characters.
.TP
.BI -f \ fontfile
Load the font from
.I fontfile.
The default font is helvet.fnt
.SH EXAMPLE
To put a big "Hi!" on the terminal:
.IP "" .2i
psign -h 22 -a 1 -cb 0 0 0 -cf 1 1 1 Hi\\! | ttyimage
.SH ENVIRONMENT
RAYPATH         path to search for font files
.SH AUTHOR
Greg Ward
.SH BUGS
The entire bitmap is stored in memory, which can be a problem for
large and/or high-resolution signs.
.SH "SEE ALSO"
getinfo(1), pcompos(1), pfilt(1), ttyimage(1)
Revision:	1.1
Committed:	Tue Mar 11 19:20:21 2003 UTC (21 years, 2 months ago) by greg
Branch:	MAIN
CVS Tags:	rad3R5
Log Message:	Added documentation to repository
#	User	Rev	Content
1	greg	1.1	.\" RCSid "$Id"
2			.TH PSIGN 1 10/9/97 RADIANCE
3			.SH NAME
4			psign - produce a RADIANCE picture from text.
5			.SH SYNOPSIS
6			.B psign
7			[
8			.B options
9			]
10			[
11			.B text
12			]
13			.SH DESCRIPTION
14			.I Psign
15			produces a RADIANCE picture of the given
16			.I text.
17			The output dimensions are determined by the character height, aspect
18			ratio, number of lines and line length.
19			(Also the character size if text squeezing is used.)\0
20			If no
21			.I text
22			is given, the standard input is read.
23			.TP 10n
24			.BI -cb " r g b"
25			Set the background color to
26			.I "r g b"
27			The default is white (1 1 1).
28			.TP
29			.BI -cf " r g b"
30			Set the foreground color to
31			.I "r g b"
32			The default is black (0 0 0).
33			.TP
34			.BR \-dr
35			Text reads to the right (default).
36			.TP
37			.BR \-du
38			Text reads upwards.
39			.TP
40			.BR \-dl
41			Text reads to the left (upside down).
42			.TP
43			.BR \-dd
44			Text reads downwards.
45			.TP
46			.BI -h \ cheight
47			Set the character height to
48			.I cheight.
49			The default is 32 pixels.
50			.TP
51			.BI -a \ aspect
52			Set the character aspect ratio (height/width) to
53			.I aspect.
54			The default value is 1.67.
55			.TP
56			.BI -x \ xsize
57			Set the horizontal image size to
58			.I xsize.
59			Use with
60			.I \-y
61			option (below) in place of the
62			.I \-h
63			specification to control output image size directly.
64			If the character aspect ratio
65			.I (\-a
66			option, above) is non-zero, then one of the specified x or y output
67			dimensions may be reduced to maintain this ratio.
68			If direction is right
69			.I (\-dr)
70			or left
71			.I (\-dl),
72			then it is not necessary to give the
73			.I \-y
74			option, since it can be computed from the character height
75			.I (\-h).
76			.TP
77			.BI -y \ ysize
78			Set the vertical image size to
79			.I ysize.
80			Use with the
81			.I \-x
82			option (described above).
83			If direction is up
84			.I (\-du)
85			or down
86			.I (\-dd),
87			then it is not necessary to give the
88			.I \-x
89			option, since it can be computed from the character height
90			.I (\-h).
91			.TP
92			.BI -s \ spacing
93			Set the intercharacter spacing to
94			.I spacing.
95			The magnitude of this value is multiplied by the character height over
96			the aspect ratio (ie. the character width) to compute the desired
97			distance between characters in the output.
98			The sign of the value, positive or negative, determines how this
99			ideal spacing is used in the actual placement of characters.
100			If
101			.I spacing
102			is positive, then the overall width of the line will not be affected,
103			nor will indentation of textual elements.
104			Thus, the text format will be mostly unaffected.
105			However, spacing between characters will reflect their relative size
106			for a more natural appearance.
107			If
108			.I spacing
109			is negative, characters will be squeezed together to meet the
110			spacing critereon, regardless of how it might affect the format of
111			the output.
112			The default value for
113			.I spacing
114			is zero, which is interpreted as uniformly spaced characters.
115			.TP
116			.BI -f \ fontfile
117			Load the font from
118			.I fontfile.
119			The default font is helvet.fnt
120			.SH EXAMPLE
121			To put a big "Hi!" on the terminal:
122			.IP "" .2i
123			psign -h 22 -a 1 -cb 0 0 0 -cf 1 1 1 Hi\\! \| ttyimage
124			.SH ENVIRONMENT
125			RAYPATH path to search for font files
126			.SH AUTHOR
127			Greg Ward
128			.SH BUGS
129			The entire bitmap is stored in memory, which can be a problem for
130			large and/or high-resolution signs.
131			.SH "SEE ALSO"
132			getinfo(1), pcompos(1), pfilt(1), ttyimage(1)