| 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 "Pammosaicknit User Manual" 1 "12 December 2010" "netpbm documentation" |
| 7 |
|
| 8 |
.SH NAME |
| 9 |
|
| 10 |
pammosaicknit - validate a mosaic knitting pattern |
| 11 |
|
| 12 |
.UN synopsis |
| 13 |
.SH SYNOPSIS |
| 14 |
.PP |
| 15 |
\fBpammosaicknit\fP [\fIin_netpbmfile\fP] |
| 16 |
|
| 17 |
.UN description |
| 18 |
.SH DESCRIPTION |
| 19 |
.PP |
| 20 |
This program is part of |
| 21 |
.BR "Netpbm" (1)\c |
| 22 |
\&. |
| 23 |
.PP |
| 24 |
\fBpammosaicknit\fP helps the user create |
| 25 |
.UR http://en.wikipedia.org/wiki/Slip-stitch_knitting#Mosaic_knitting |
| 26 |
mosaic knitting patterns |
| 27 |
.UE |
| 28 |
\&. The program inputs a black-and-white Netpbm image that |
| 29 |
describes a mosaic knitting pattern and outputs a color Netpbm image of the |
| 30 |
same pattern but with invalid runs shown in red. |
| 31 |
.PP |
| 32 |
A valid knitting pattern starts with a "black" row on the |
| 33 |
bottom and alternates "white" and "black" |
| 34 |
rows. A "black" row can contain any arrangement of black pixels |
| 35 |
but no more than three consecutive white pixels. A "white" row |
| 36 |
can contain any arrangement of white pixels but no more than three |
| 37 |
consecutive black pixels. Columns wrap horizontally, so a "white" |
| 38 |
row that both begins and ends with two black pixels is deemed to |
| 39 |
contain four consecutive black pixels. Because this is an invalid |
| 40 |
number for a "white" row, those four pixels will be recolored red |
| 41 |
in the output image. |
| 42 |
.PP |
| 43 |
For clarity, there are two shades of red in the output image. Dark |
| 44 |
red pixels indicate pixels that were black in the input image but |
| 45 |
which must contain one or more white pixels. Light red pixels indicate |
| 46 |
pixels that were white in the input image but which must contain one |
| 47 |
or more black pixels. |
| 48 |
.PP |
| 49 |
If the output image contains no red pixels, then the input image |
| 50 |
represents a valid mosaic knitting pattern. |
| 51 |
|
| 52 |
.UN options |
| 53 |
.SH OPTIONS |
| 54 |
.PP |
| 55 |
There are no command line options defined specifically |
| 56 |
for \fBpammosaicknit\fP, but it recognizes the options common to all |
| 57 |
programs based on libnetpbm (See |
| 58 |
.UR index.html#commonoptions |
| 59 |
Common Options |
| 60 |
.UE |
| 61 |
\&.) |
| 62 |
|
| 63 |
.UN arguments |
| 64 |
.SH ARGUMENTS |
| 65 |
.PP |
| 66 |
\fBpammosaicknit\fP's only argument, |
| 67 |
\fIin_netpbmfile\fP, is the name of an image file that represents a mosaic |
| 68 |
knitting pattern. If you don't specify |
| 69 |
\fIin_netpbmfile\fP, the program reads the image from Standard Input. |
| 70 |
|
| 71 |
|
| 72 |
.UN notes |
| 73 |
.SH NOTES |
| 74 |
.PP |
| 75 |
If the input image is not a black-and-white image, \fBpammosaicknit\fP |
| 76 |
converts it internally to black and white by thresholding each pixel's |
| 77 |
luminosity. The output image is always a color image containing at most four |
| 78 |
colors (black, white, dark red, light red). |
| 79 |
|
| 80 |
.UN seealso |
| 81 |
.SH SEE ALSO |
| 82 |
|
| 83 |
|
| 84 |
.IP \(bu |
| 85 |
.BR "pam" (1)\c |
| 86 |
\& |
| 87 |
|
| 88 |
|
| 89 |
.UN history |
| 90 |
.SH HISTORY |
| 91 |
.PP |
| 92 |
pammosaicknit was new in Netpbm 10.53 (December 2010). |
| 93 |
|
| 94 |
.UN author |
| 95 |
.SH AUTHOR |
| 96 |
.PP |
| 97 |
Copyright (C) 2010 Scott Pakin, |
| 98 |
\[email protected]\fP |
| 99 |
|
| 100 |
|
| 101 |
.UN index |
| 102 |
.SH Table Of Contents |
| 103 |
|
| 104 |
|
| 105 |
.IP \(bu |
| 106 |
.UR #synopsis |
| 107 |
SYNOPSIS |
| 108 |
.UE |
| 109 |
\& |
| 110 |
.IP \(bu |
| 111 |
.UR #description |
| 112 |
DESCRIPTION |
| 113 |
.UE |
| 114 |
\& |
| 115 |
.IP \(bu |
| 116 |
.UR #options |
| 117 |
OPTIONS |
| 118 |
.UE |
| 119 |
\& |
| 120 |
.IP \(bu |
| 121 |
.UR #arguments |
| 122 |
ARGUMENTS |
| 123 |
.UE |
| 124 |
\& |
| 125 |
.IP \(bu |
| 126 |
.UR #notes |
| 127 |
NOTES |
| 128 |
.UE |
| 129 |
\& |
| 130 |
.IP \(bu |
| 131 |
.UR #seealso |
| 132 |
SEE ALSO |
| 133 |
.UE |
| 134 |
\& |
| 135 |
.IP \(bu |
| 136 |
.UR #history |
| 137 |
HISTORY |
| 138 |
.UE |
| 139 |
\& |
| 140 |
.IP \(bu |
| 141 |
.UR #author |
| 142 |
AUTHOR |
| 143 |
.UE |
| 144 |
\& |
| 145 |
.SH DOCUMENT SOURCE |
| 146 |
This manual page was generated by the Netpbm tool 'makeman' from HTML |
| 147 |
source. The master documentation is at |
| 148 |
.IP |
| 149 |
.B http://netpbm.sourceforge.net/doc/pammosaicknit.html |
| 150 |
.PP |