summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man1/ppmwheel.1
blob: d641dd0d39f6202bac003172c42d42716fe72ce8 (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
\
.\" 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 "Ppmwheel User Manual" 0 "03 February 2019" "netpbm documentation"

.SH NAME
ppmwheel - make a PPM image of a color wheel

.UN synopsis
.SH SYNOPSIS

\fBppmwheel\fP
\fIdiameter\fP
[{\fB-huevalue\fP | \fB-huesaturation\fP}]
[\fB-maxval=\fP\fIN\fP]


.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBppmwheel\fP produces a PPM image of a color wheel of the
specified diameter inside a white square just large enough to hold it.
.PP
The color wheel is based on the HSV color model.  Hues are distributed
  angularly around the circle and the values and saturations are distributed
  radially.
.PP
You can generate three kinds of color wheel:

.IP \(bu
Hue-value: Select this with a \fB-huevalue\fP option.
.sp
The saturation is 100% everywhere.  The value goes from zero to 100%
  linearly, from the center of the wheel to the edge.  So the center is black.
.sp
Hence, the image consists of all of the secondary colors based on the
  red, green, and blue primary colors.  A secondary color is one that is
  composed of light of at most two of the three primary colors.

.IP \(bu
Hue-saturation: Select this with a \fB-huesaturation\fP option.
.sp
The value is 100% everywhere.  The saturation goes from zero to 100%
  linearly, from the center of the wheel to the edge.  So the center is white.

.IP \(bu
Ppmcirc: Select this by not specifying any other wheel type option.
.sp
The saturation is 100% everywhere.  The value is a strange function of
  the distance from the center, increasing as the square root of the distance
  until halfway out, then decreasing as the 8th root of the distance the rest
  of the way.  We don't know what the point of this is, but it is what the
  program Ppmcirc by Peter Kirchgessner in 1995 does, and was the only option
  in \fBppmwheel\fP from its inception in 2003 to 2019.
      



.UN arguments
.SH ARGUMENTS
.PP
You must specify one non-option argument: the radius of the color wheel
in pixels.
.PP
This is also the height and width of the output image.

  
.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
\&), \fBppmwheel\fP recognizes the following
command line options:


.TP
\fB-huevalue\fP
  
This selects a hue-value color wheel.
.sp
This option was new in Netpbm 10.86 (March 2019).

.TP
\fB-huesaturation\fP
  
This selects a hue-saturation color wheel.
.sp
This option was new in Netpbm 10.86 (March 2019).

.TP
\fB-maxval=\fP\fIN\fP
  
This selects the maxval for the image.  The default is 255.
.sp
This option was new in Netpbm 10.86 (March 2019).




.UN seealso
.SH SEE ALSO
.BR "ppmcie" (1)\c
\&,
.BR "ppmrainbow" (1)\c
\&,
.BR "ppm" (1)\c
\&

.UN history
.SH HISTORY
.PP
\fBppmwheel\fP was added to Netpbm in Release 10.14 (March 2003).


.UN author
.SH AUTHOR

Copyright (C) 1995 by Peter Kirchgessner
.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/ppmwheel.html
.PP