summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man1/pgmramp.1
blob: 3fe0968ff356b44bb6c8ff5ef5ad54a2facb66a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
\
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
.\" Do not hand-hack it!  If you have bug fixes or improvements, please find
.\" the corresponding HTML page on the Netpbm website, generate a patch
.\" against that, and send it to the Netpbm maintainer.
.TH "Pgmramp User Manual" 0 "15 February 2014" "netpbm documentation"

.SH NAME

pgmramp - generate a grayscale ramp

.UN synopsis
.SH SYNOPSIS

\fBpgmramp\fP
{\fB-lr\fP|\fB-tb\fP|\fB-rectangle\fP|\fB-ellipse\fP|\fB-diagonal\fP}
[\fB-maxval=\fP\fImaxval\fP]
\fIwidth\fP \fIheight\fP
.PP
All options can be abbreviated to their shortest unique prefix.
You may use two hyphens instead of one to designate an option.  You
may use either white space or an equals sign between an option name
and its value.

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
Generates a graymap of the specified size containing a
black-to-white ramp.  These ramps are useful for multiplying with
other images, using \fBpamarith\fP.
.PP
The ramp is linear in brightness, not intensity.  I.e. the
gamma-corrected sample values in the PGM rise linearly with distance
from the corner of the image.  If you want a ramp that is linear in
light intensity, use \fBpnmgamma\fP with \fBpgmramp\fP.
.PP
Options let you choose the shape of the ramp (left to right, inside
out, etc.).  You can use \fBpamflip\fP to get more shapes.  For
example, the \fB-lr\fP option gives you a left to right ramp and

.nf
\f(CW
    $ pgmramp -lr 100 100 | pamflip -lr
\fP

.fi

gives you a right to left ramp.
.PP
To generate a simple ramp of all the values from 0 to maxval, and not
necessarily a graphic image, use
.BR "pamseq" (1)\c
\&.
.PP
\fBppmrainbow\fP does something similar to what \fBpgmramp\fP does,
but for color.  The image fades between two colors of your choice.


.UN options
.SH OPTIONS
.PP
In addition to the options common to all programs based on libnetpbm
(most notably \fB-quiet\fP, see 
.UR index.html#commonoptions
 Common Options
.UE
\&), \fBpgmramp\fP recognizes the following
command line options:
.PP
You must specify exactly one of the ramp type options.


.TP
\fB-lr\fP
A left to right ramp.  Black on the left; white on the right.

.TP
\fB-tb\fP
A top to bottom ramp.  Black on top; white on the bottom.

.TP
\fB-rectangle\fP
An outside-in rectangular ramp.  It is black around the edges and white
in the center.

.TP
\fB-ellipse\fP
An outside-in elliptical ramp.  It is black around the edge and white
in the center.

.TP
\fB-diagonal\fP
A ramp from top left corner diagonally down to bottom right.  Black at
the top left; white at the bottom right.
.sp
This option was new in Netpbm 10.66 (March 2014).

.TP
\fB-maxval=\fP\fImaxval\fP
     The maxval for the generated image.  Default is 255.
.sp
     This option was new in Netpbm 10.1 (June 2002).  Before that, the maxval
     is always 255.
     



.UN seealso
.SH SEE ALSO
.BR "\fBpamflip\fP" (1)\c
\&,
.BR "\fBpamarith\fP" (1)\c
\&,
.BR "\fBpnmgamma\fP" (1)\c
\&,
.BR "\fBpamseq\fP" (1)\c
\&,
.BR "\fBppmrainbow\fP" (1)\c
\&,
.BR "\fBpamgradient\fP" (1)\c
\&,
.BR "pgm" (5)\c
\&


.UN author
.SH AUTHOR

Copyright (C) 1989 by Jef Poskanzer.
.SH DOCUMENT SOURCE
This manual page was generated by the Netpbm tool 'makeman' from HTML
source.  The master documentation is at
.IP
.B http://netpbm.sourceforge.net/doc/pgmramp.html
.PP