| 1 |
\ |
| 2 |
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source. |
| 3 |
.\" Do not hand-hack it! If you have bug fixes or improvements, please find |
| 4 |
.\" the corresponding HTML page on the Netpbm website, generate a patch |
| 5 |
.\" against that, and send it to the Netpbm maintainer. |
| 6 |
.TH "Ppmrough User Manual" 1 "20 August 2023" "netpbm documentation" |
| 7 |
|
| 8 |
.SH NAME |
| 9 |
ppmrough - create PPM image of a single color rectangle with ragged edges on a |
| 10 |
different color background |
| 11 |
|
| 12 |
.UN synopsis |
| 13 |
.SH SYNOPSIS |
| 14 |
|
| 15 |
\fBppmrough\fP |
| 16 |
|
| 17 |
[\fB-left \fP\fIpixels\fP] |
| 18 |
|
| 19 |
[\fB-right \fP\fIpixels\fP] |
| 20 |
|
| 21 |
[\fB-top \fP\fIpixels\fP] |
| 22 |
|
| 23 |
[\fB-bottom \fP\fIpixels\fP] |
| 24 |
|
| 25 |
[\fB-width \fP\fIpixels\fP] |
| 26 |
|
| 27 |
[\fB-height \fP\fIpixels\fP] |
| 28 |
|
| 29 |
[\fB-bg \fP\fIcolorspec\fP] |
| 30 |
|
| 31 |
[\fB-fg \fP\fIcolorspec\fP] |
| 32 |
|
| 33 |
[\fB-var \fP\fIpixels\fP] |
| 34 |
|
| 35 |
[\fB-randomseed \fP\fIseed\fP] |
| 36 |
|
| 37 |
[\fB-verbose\fP] |
| 38 |
.PP |
| 39 |
All options can be abbreviated to their shortest unique prefix. |
| 40 |
You may use two hyphens instead of one. You may separate an option |
| 41 |
name and its value with white space instead of an equals sign. |
| 42 |
|
| 43 |
.UN description |
| 44 |
.SH DESCRIPTION |
| 45 |
.PP |
| 46 |
This program is part of |
| 47 |
.BR "Netpbm" (1)\c |
| 48 |
\&. |
| 49 |
.PP |
| 50 |
\fBppmrough\fP generates a PPM image of the specified width and height. |
| 51 |
The image consists of a rectangle of the specified foreground color |
| 52 |
surrounded by borders of the specified size and background color, except |
| 53 |
that the boundary between the foreground rectangle and the borders is |
| 54 |
ragged. The ragged effect is random. |
| 55 |
.PP |
| 56 |
\fBppmrough\fP writes the PPM image to Standard Output. |
| 57 |
.PP |
| 58 |
The maxval of the output image is 255 (You can change this with |
| 59 |
\fBpamdepth\fP). |
| 60 |
.PP |
| 61 |
Use the options \fB-left\fP or \fB-right\fP, respectively, to make |
| 62 |
vertical borders, and \fB-top\fP or \fB-bottom\fP, respectively, to generate |
| 63 |
horizontal borders inside the image. The value of each of these options is |
| 64 |
the minimum width of the border on that edge. Beyond that minimum, the width |
| 65 |
at any given location on that edge is random, varying along the edge in a |
| 66 |
fractal kind of way. |
| 67 |
|
| 68 |
|
| 69 |
.PP |
| 70 |
Use the \fB-var\fP option to control the "raggedness" of |
| 71 |
the border. The lower its value, the smoother the border is. You |
| 72 |
can initialize the pseudo-random generator with the \fB-init\fP |
| 73 |
option. |
| 74 |
.PP |
| 75 |
You could use \fBppmrough\fP with \fBppmtopgm\fP to create a PGM |
| 76 |
transparency mask and use it to roughen up the edges of another image. |
| 77 |
|
| 78 |
.UN options |
| 79 |
.SH OPTIONS |
| 80 |
.PP |
| 81 |
In addition to the options common to all programs based on libnetpbm |
| 82 |
(most notably \fB-quiet\fP, see |
| 83 |
.UR index.html#commonoptions |
| 84 |
Common Options |
| 85 |
.UE |
| 86 |
\&), \fBppmrough\fP recognizes the following |
| 87 |
command line options: |
| 88 |
|
| 89 |
|
| 90 |
|
| 91 |
.TP |
| 92 |
\fB-width=\fP\fIpixels\fP |
| 93 |
This specifies the width of the image in pixels (default: 100). |
| 94 |
|
| 95 |
.TP |
| 96 |
\fB-height=\fP\fIpixels\fP |
| 97 |
This specifies the height of the image in pixels (default: 100). |
| 98 |
|
| 99 |
.TP |
| 100 |
\fB-left=\fP\fIpixels\fP |
| 101 |
.TP |
| 102 |
\fB-right=\fP\fIpixels\fP |
| 103 |
.TP |
| 104 |
\fB-top=\fP\fIpixels\fP |
| 105 |
.TP |
| 106 |
\fB-bottom=\fP\fIpixels\fP |
| 107 |
This option causes the program to create a left, right, top, or bottom |
| 108 |
border, respectively, at least \fIpixels\fP pixels wide, varying randomly |
| 109 |
beyond that. You may specify any combination of these. |
| 110 |
|
| 111 |
.TP |
| 112 |
\fB-bg=\fP\fIcolorspec\fP |
| 113 |
This is the background color, i.e. the color of the |
| 114 |
borders. \fIcolorspec\fP is as described for the |
| 115 |
.UR libnetpbm_image.html#colorname |
| 116 |
argument of the \fBpnm_parsecolor()\fP library routine |
| 117 |
.UE |
| 118 |
\&. Default is black. |
| 119 |
|
| 120 |
.TP |
| 121 |
\fB-fg=\fP\fIcolor\fP |
| 122 |
This specifies the foreground color, i.e. the color of the center of the |
| 123 |
mage -- everything but the borders. \fIcolorspec\fP is as described for the |
| 124 |
.UR libnetpbm_image.html#colorname |
| 125 |
argument of the \fBpnm_parsecolor()\fP library routine |
| 126 |
.UE |
| 127 |
\&. Default is white. |
| 128 |
|
| 129 |
.TP |
| 130 |
\fB-var=\fP\fIpixels\fP |
| 131 |
This specifies how ragged the borders are -- how much and how quickly its |
| 132 |
width varies along the image edge. Its specific meaning is complex, but the |
| 133 |
larger it is, the more the border varies. Zero means it does not vary at all |
| 134 |
-- the edge of the foreground is straight. |
| 135 |
.sp |
| 136 |
This must be a nonnegative integer. The default is 10. |
| 137 |
|
| 138 |
.TP |
| 139 |
\fB-randomseed=\fP\fIseed\fP |
| 140 |
Use this option to initialize the pseudo-random number generator |
| 141 |
with \fIseed\fP. |
| 142 |
.sp |
| 143 |
You can use this to cause the program to produce repeatable output. |
| 144 |
.sp |
| 145 |
Before Netpbm 10.61 (December 2012), this is called \fB-init\fP, |
| 146 |
and that still works. |
| 147 |
|
| 148 |
.TP |
| 149 |
\fB-verbose\fP |
| 150 |
Run \fBppmrough\fP in verbose mode. It reports all parameters on |
| 151 |
Standard Error. |
| 152 |
|
| 153 |
|
| 154 |
|
| 155 |
.UN seealso |
| 156 |
.SH SEE ALSO |
| 157 |
.BR "ppmmake" (1)\c |
| 158 |
\&, |
| 159 |
.BR "pamcat" (1)\c |
| 160 |
\&, |
| 161 |
.BR "ppmtopgm" (1)\c |
| 162 |
\&, |
| 163 |
.BR "ppm" (1)\c |
| 164 |
\&, |
| 165 |
|
| 166 |
.UN history |
| 167 |
.SH HISTORY |
| 168 |
.PP |
| 169 |
This program was added to Netpbm in Release 10.9 (September 2002). |
| 170 |
|
| 171 |
.UN author |
| 172 |
.SH AUTHOR |
| 173 |
|
| 174 |
Copyright (C) 2002 by Eckard Specht. |
| 175 |
.SH DOCUMENT SOURCE |
| 176 |
This manual page was generated by the Netpbm tool 'makeman' from HTML |
| 177 |
source. The master documentation is at |
| 178 |
.IP |
| 179 |
.B http://netpbm.sourceforge.net/doc/ppmrough.html |
| 180 |
.PP |