rgb/man/rgb.man

   1 .\" Copyright (c) 1994, 2008, Oracle and/or its affiliates. All rights reserved.
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software is furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice (including the next
  11 .\" paragraph) shall be included in all copies or substantial portions of the
  12 .\" Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20 .\" DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .TH rgb __appmansuffix__ __xorgversion__
  23 .IX "rgb" "" "\f3rgb\fP(1) \(em build colorname database" ""
  24 .IX "color" "build" "color" "building the colorname database \(em \f3rgb\fP(1)" ""
  25 .SH NAME
  26 rgb \- build the color name database
  27 .SH SYNOPSIS
  28 .B rgb
  29 [
  30 .I dbname
  31 ]
  32 .SH DESCRIPTION
  33 .B rgb
  34 reads from standard input lines of the form:
  35 .PP
  36 .nf
  37 .I
  38         red\ \ green\ \ blue\ \ \ \ \ \ name
  39 .fi
  40 .PP
  41 where
  42 .I red
  43 /
  44 .I green
  45 /
  46 .I blue
  47 are decimal values between the range 0 to 255, and
  48 .I name
  49 is a description of the color.
  50 .B rgb
  51 then builds a color name database in
  52 .B __RGB_DB_TYPE__
  53 format.  The color name database provides a mapping between ASCII color
  54 names and RGB color values.  It is useful for increasing the
  55 portability of color programs.  The input source for the database is
  56 in \fI__RGB_DB__.txt\fP.  \fIrgb.txt\fP
  57 is compiled into the __RGB_DB_TYPE__ files
  58 .IR "__RGB_DB_FILES__" .
  59 When the server first starts up, it consults the contents of these
  60 files to build an internal representation of their contents.  This
  61 internal representation is consulted to map color names to color
  62 values.
  63 .PP
  64 .B rgb
  65 uses the default color name database of \fI__RGB_DB__.txt\fP.
  66 .SH OPTIONS
  67 .IP "\fIdbname" 1i
  68 Color name database.
  69 .SH EXAMPLES
  70 example% rgb rgb < __RGB_DB__.txt
  71 .PP
  72 example% cat __RGB_DB__.txt
  73 .SH FILES
  74 .PD 0
  75 .TP 30
  76 .B __RGB_DB__.txt
  77 color name database source.
  78 Maps color names to RGB color values.
  79 .TP
  80 .B __RGB_DB_DIR__/__RGB_DB_FILES__
  81 __RGB_DB_TYPE__ files containing color name to RGB mapping.
  82 .PD
  83 .SH SEE ALSO
  84 .BR cat (1),
  85 .BR __RGB_DB_TYPE__ (3)