components/x11/cmap_alloc/src/cmap_alloc.1

   1 .\" Copyright (c) 1991, 2014, 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 .TH cmap_alloc 1 "2 May 2014"
  22 .IX cmap_alloc "" "\f3cmap_alloc\f1(1) \(em colormap utility" ""
  23 .IX "color" "defa" "color" "default colormap allocation \(em \f3cmap_alloc\f1(1)" ""
  24 .SH NAME
  25 cmap_alloc \- allocate default colormaps for non-default visuals
  26 .SH SYNOPSIS
  27 .B cmap_alloc
  28 [
  29 .B \-display
  30 .I display:n.screen
  31 ] [
  32 .B \-force
  33 ] [
  34 .B \-allscreens
  35 ]
  36 [
  37 .BI \-depth \ n
  38 ] [
  39 .B \-visual
  40 .I class
  41 ] [
  42 .B \-verbose
  43 ] [
  44 .B
  45 \-help
  46 ]
  47 .SH DESCRIPTION
  48 .LP
  49 .B cmap_alloc
  50 creates empty colormaps for non-default dynamic visuals that are suitable
  51 for use as default colormaps.  An X11 server has only one default colormap,
  52 and it is associated with the default visual.  Clients that need to access
  53 non-default visuals have to create their own colormaps.  This can lead
  54 to gratuitous colormap flashing if a lot of applications are running
  55 in non-default visuals.
  56 .B cmap_alloc
  57 will create colormaps that can be used by such applications as the default
  58 colormap for the given visual.
  59 Once the colormap has been created for a given visual, it will place
  60 the colormap's XID into the
  61 .SM RGB_DEFAULT_MAP
  62 property on the root window of the display.  Clients that need to access
  63 non-default dynamic visuals should search this property using
  64 .SM XGetRGBColormaps(3x11)
  65 for a suitable colormap to use.
  66 .SH OPTIONS
  67 .IP "\f3\-display \fIdisplay:n.screen\f1" 1i
  68 Indicates which X11 server to use.  The default is to use the value
  69 set in the
  70 .SM DISPLAY
  71 environment variable.
  72 .IP "\f3\-force\f1" 1i
  73 Create a colormap even if a suitable colormap is already listed in the
  74 .SM RGB_DEFAULT_MAP
  75 property.
  76 .IP "\f3\-allscreens\f1" 1i
  77 Create default colormaps for all screens of the display.  Without this
  78 option, colormaps will only be created for the default screen.
  79 .IP "\f3\-depth \fIn\f1" 1i
  80 Create default colormaps only for those visuals that have depth
  81 .I n.
  82 The default is to create colormaps for visuals of all depths
  83 .IP "\f3\-visual \fIclass\f1" 1i
  84 Create default colormaps only for those visuals that are of class
  85 .I class.
  86 Where
  87 .I class
  88 is one of the following:
  89 .SM GrayScale, PsuedoColor, DirectColor
  90 \.  The default is to create colormaps for all visual classes.
  91 .IP "\f3\-verbose\f1" 1i
  92 Print out diagnostic messages useful for debugging.
  93 .IP "\f3\-help\f1" 1i
  94 Print out a short usage message and exit.
  95 .SH "SEE ALSO"
  96 .BR XGetRGBColormaps (3x11),
  97 .BR xstdcmap (1) ,
  98 .BR cmap_compact (1)
  99 .sp
 100 .SH DIAGNOSTICS
 101 .TP 20n
 102 \f3can't open display ...\f1
 103 Error in connecting to the X11 server.  Check
 104 .SM DISPLAY
 105 environment variable.
 106 .TP 20n
 107 \f3unknown depth\f1
 108 Invalid depth specified for the \f3\-depth\f1 command line option
 109 .TP 20n
 110 \f3unknown visual class\f1
 111 Invalid visual class specified for the \f3\-visual\f1
 112 command line option