Update default theme to use features in FVWM 2.5.25+
[fvwm-themes.git] / doc / colorsets
blobfc43c298bb9352e68e8b738314730e4f184f4644
1                     COLORSETS USED BY FVWM-THEMES
3 This file includes the default colors@ component file (I, II, III and IV) and
4 some comments on where these colorsets are used (V and VI). fvwm-themes uses
5 internally colorsets 0 to 39, some colorsets are reserved for the future use.
6 So, a user can freely use colorsets starting from 40 (for example, in his
7 colors-extra@ component) if he ever needs any additional colorsets.
9 Colorset N |          Meaning           |           Usage Examples
10 -----------+----------------------------+-------------------------------------
11          0 | default                    | feedback windows, FvwmScroll
12          1 | inactive window            | window/icon titles, windows in Pager
13          2 | active window              | window/icon titles, windows in Pager
14          3 | inactive borders           | window borders (may copy 1)
15          4 | active borders             | window borders (may copy 2)
16          5 | inactive menu item         | menus (may have pixmap or gradient)
17          6 | active menu item           | menus (only bg/fg used)
18          7 | greyed menu item           | menus (only fg used)
19          8 | reserved                   | for the fvwm-themes future use
20          9 | reserved                   | for the fvwm-themes future use
21         10 | modules, default           | Button Bar, Pager, other modules
22         11 | modules, default hilight   | Button Bar
23         12 | modules, special           | gradient for IconMan/IconBox
24         13 | modules, swallowed apps    | bg, fg, sh, hi for xclock/xload etc.
25         14 | modules, default #2        | alternative for Pager, Button Bar
26         15 | modules, default hilight #2| alternative for Pager
27         16 | modules, balloons          | TaskBar, Pager
28         17 | modules, winlist, standard | item of IconMan, WinList, TaskBar
29         18 | modules, winlist, active   | --.--
30         19 | modules, winlist, iconified| --.--
31         20 | modules, winlist, pointed  | --.--
32         21 | modules, ident             | FvwmIdent
33         22 | modules, console           | FvwmConsole
34         23 | modules, transparent       | Button Bar
35         24 | modules, reserved          | for the fvwm-themes future use
36         25 | modules, reserved          | for the fvwm-themes future use
37         26 | reserved                   | for the fvwm-themes future use
38         27 | reserved                   | for the fvwm-themes future use
39         28 | reserved                   | for the fvwm-themes future use
40         29 | dynamical/temporary        | tools for choosing/previewing colors
41         30 | regular terminal           | xterm/rxvt or any other terminal
42         31 | admin terminal             | terminal for root (su)
43         32 | remote terminal            | terminal with ssh/rsh/telnet
44         33 | viewer terminal            | man, less, tail -f
45         34 | console application        | top, editor
46         35 | dialog main area           | FvwmScript, FvwmForm, xmessage
47         36 | dialog text area           | FvwmScript, FvwmForm, xmessage
48         37 | reserved                   | for the fvwm-themes future use
49         38 | reserved                   | for the fvwm-themes future use
50         39 | reserved                   | for the fvwm-themes future use
52 # ****************************************************************************
54 # I.   FVWM Colorsets (0 to 9)
55 #       I.1. Default Colorsets
56 #       I.2. Window Decorations
57 #       I.3. Menu Colorsets
59 # II.  Module Colorsets (10 to 29)
60 #       II.1. Common Colorsets
61 #       II.2. Window List Module Colorsets
62 #       II.3. Other Module Colorsets
63 #       II.4. External Colorsets
65 # III. Application Colorsets (30 to 35)
67 # IV.  Start/Stop functions
69 # V.   Module Configurations (under modules/)
71 # VI.  Miscellaneous Configurations
72
73 # ****************************************************************************
75 # ============================================================================
76 # I. FVWM Colorsets
77 # ============================================================================
79 # ----------------------
80 # I.1. Default Colorsets
81 # ----------------------
83 # for feedback windows (like geometry window and NoteMessage) and FvwmScroll
85 Colorset 0 fg black, bg #70A0A0
87 # -----------------------
88 # I.2. Window Decorations
89 # -----------------------
91 # The following colors are used in FvwmPager for the window colors
92 # and in a title bar of windows (shade/hilight colors, computed from
93 # the bg color, but might be specified directly by sh and hi).
94 # The title bar background is defined below using TitleStyle.
96 # window title, inactive and active
98 Colorset 1 fg black, bg rgb:88/7C/66, Plain, NoShape
99 Colorset 2 fg black, bg rgb:CC/BA/99, Plain, NoShape
101 # window borders, inactive and active
103 Colorset 3 fg black, bg rgb:88/7C/66, Plain, NoShape
104 Colorset 4 fg black, bg rgb:CC/BA/99, Plain, NoShape
106 # background for window title, buttons and border
108 DestroyFunc FuncFvwmDecorBackground
109 AddToFunc   FuncFvwmDecorBackground
110 + I TitleStyle ActiveUp   (Solid rgb:CC/BA/99 -- Raised)
111 + I TitleStyle ActiveDown (Solid rgb:CC/BA/99 -- Raised)
112 + I TitleStyle Inactive   (Solid rgb:88/7C/66 -- Raised)
113 + I TitleStyle ToggledActiveUp   (Solid rgb:CC/BA/99 -- Raised)
114 + I TitleStyle ToggledActiveDown (Solid rgb:CC/BA/99 -- Raised)
115 + I TitleStyle ToggledInactive   (Solid rgb:88/7C/66 -- Raised)
117 + I ButtonStyle All Pixmap 16x16/empty.xpm
118 + I ButtonStyle All -- UseTitleStyle
120 # -------------------
121 # I.3. Menu Colorsets
122 # -------------------
124 # inactive menu item fg+bg and menu face if any
126 Colorset 5 fg black, bg rgb:80/98/B0, Plain, NoShape
128 # active menu item fg+bg
130 Colorset 6 fg black, bg rgb:90/A9/C2, Plain, NoShape
132 # greyed menu item fg
134 Colorset 7 fg grey48, bg grey48, Plain, NoShape
136 # -------------------------------------------------
137 # Colorsets 8 and 9 are reserved for the future use.
139 # ============================================================================
140 # II. Module Colorsets
141 # ============================================================================
143 # ----------------------
144 # II.1. Common Colorsets
145 # ----------------------
147 # default for modules
148 # For FvwmButtons, FvwmPager, can be also used for FvwmIconMan, FvwmIconBox.
150 Colorset 10 fg black, bg rgb:80/A0/A0, Plain, NoShape
152 # default hilight for modules
153 # For hilighting a part of a button bar (some swallowed apps for example).
155 Colorset 11 fg black, bg white, Plain, NoShape
157 # special or funny: a gradient or a pixmap
158 # May be used in certain FvwmButtons, FvwmIconMan, FvwmIconBox.
160 Colorset 12 fg black, bg rgb:80/A0/A0, \
161         VGradient 20 rgb:80/A0/A0 rgb:C0/F0/F0, NoShape
163 # swallowed window: the hilight and shadow colors should be defined
164 # (-hd of xclock and -hl of xload use sh, and -hl of xclock uses hi)
166 Colorset 13 fg black, bg rgb:70/8C/8C, hi black, sh gray40, \
167         Plain, NoShape
169 # default #2
170 # FvwmPager or to get more colors in FvwmButtons, can be set to 10.
172 Colorset 14 fg black, bg rgb:80/A0/A0, Plain, NoShape
174 # default hilight #2
175 # FvwmPager or to get more colors in FvwmButtons, can be set to 11.
177 Colorset 15 fg black, bg rgb:C0/F0/F0, Plain, NoShape
179 # tips/balloons (TaskBar and FvwmPager)
181 Colorset 16 fg black, bg rgb:F0/F0/C0, Plain, NoShape
183 # ----------------------------------
184 # II.2. Window List Module Colorsets
185 # ----------------------------------
187 # standard item
188 Colorset 17 fg black, bg rgb:80/A0/A0, Plain, NoShape
190 # active item
191 Colorset 18 fg black, bg rgb:A0/C8/C8, Plain, NoShape
193 # iconified item
194 Colorset 19 fg white, bg rgb:60/78/78, Plain, NoShape
196 # pointed item
197 Colorset 20 fg black, bg rgb:88/AA/AA, Plain, NoShape
199 # ----------------------------
200 # II.3. Other Module Colorsets
201 # ----------------------------
203 # FvwmIdent
205 Colorset 21 fg black, bg bisque, Plain, NoShape
207 # FvwmConsole
209 Colorset 22 fg white, bg rgb:00/30/60, Plain, NoShape
211 # transparent
212 #Colorset 23 fg $[fg.cs10], bg $[bg.cs10], Transparent, Plain, NoShape
214 # ------------------------
215 # II.4. External Colorsets
216 # ------------------------
218 # ----------------------------
219 # reserved for modules@: 24-25
221 # ----------------------------------
222 # reserved for the future use: 26-28
224 # temporary colorset: 29, has no static definition, used dynamically
226 # ============================================================================
227 # III. Application Colorsets
228 # ============================================================================
230 # regular terminal (xterm, rxvt, Eterm)
232 Colorset 30 fg white, bg rgb:00/00/50, Plain, NoShape
234 # admin terminal (su xterm)
236 Colorset 31 fg white, bg rgb:00/50/50, Plain, NoShape
238 # remote terminal (ssh, telnet)
240 Colorset 32 fg white, bg rgb:50/00/00, Plain, NoShape
242 # viewer terminal (man, less, tail -f)
244 Colorset 33 fg white, bg rgb:00/50/00, Plain, NoShape
246 # application run in the terminal, text editor using ft-xrdb
248 Colorset 34 fg rgb:FF/FF/E8, bg rgb:30/48/48, Plain, NoShape
250 # dialog main background (FvwmScript, FvwmForm, xmessage, ft-xrdb)
252 Colorset 35 fg black, bg rgb:80/A0/80, Plain, NoShape
254 # dialog text area (FvwmScript, FvwmForm, xmessage, ft-xrdb)
256 Colorset 36 fg black, bg rgb:A0/C8/A0, Plain, NoShape
258 # --------------------------------------------------
259 # Colorsets 37 to 39 are reserved for the future use.
261 # ============================================================================
262 # IV. Start/Stop Functions:
263 # ============================================================================
265 # These functions are executed when you enter (Start) and when you leave
266 # (Stop) this component. For example, in colors@blackbox they are used to
267 # set/unset a good window "transparency" style ParentalRelativity/Opacity;
268 # in colors@cde and colors@luthien these functions are used for more things.
270 DestroyFunc FuncFvwmStartColors
271 AddToFunc   FuncFvwmStartColors
273 DestroyFunc FuncFvwmStopColors
274 AddToFunc   FuncFvwmStopColors
276 # ============================================================================
277 # V. Module Configurations (under modules/)
278 # ============================================================================
280 # The actual module configuration commands, including their colorset
281 # settings may be found in the theme directory modules/ in files named
282 # FvwmModule and FvwmModule-SubName.
284 # Examples:
286 # *FvwmPager-Single: Colorset * 14
287 # *FvwmPager-Single: HilightColorset * 15
288 # *FvwmPager-Single: WindowColorsets 1 2
289 # *FvwmPager-Single: BalloonColorset * 16
291 # *FvwmPager-Desker: Colorset * 14
292 # *FvwmPager-Desker: HilightColorset * 15
293 # *FvwmPager-Desker: WindowColorsets 1 2
294 # *FvwmPager-Desker: BalloonColorset * 16
296 # *FvwmIconMan: Colorset         12
297 # *FvwmIconMan: IconColorset     19
298 # *FvwmIconMan: PlainColorset    17
299 # *FvwmIconMan: SelectColorset   20
300 # *FvwmIconMan: FocusColorset    18
301 # *FvwmIconMan: FocusAndSelectColorset 20
303 # *FvwmButtons: Colorset 10
305 # *FvwmTaskBar: Colorset 17
306 # *FvwmTaskBar: FocusColorset 18
307 # *FvwmTaskBar: IconColorset 19
308 # *FvwmTaskBar: TipsColorset 16
310 # *FvwmWinList: Colorset 17
311 # *FvwmWinList: FocusColorset 18
312 # *FvwmWinList: IconColorset 19
314 # *FvwmIconBox: Colorset   12
315 # *FvwmIconBox: IconColorset 17
316 # *FvwmIconBox: IconHiColorset 18
318 # ============================================================================
319 # VI. Miscellaneous Configurations
320 # ============================================================================
322 # Application colorsets are used in menus@default and menus-programs@default,
323 # functions@default, functions-appbind@default and other components.
325 # Examples:
327 # Module FvwmConsole -fg $[fg.cs22] -bg $[bg.cs22]
328 # Exec exec xterm -fg $[fg.cs30] -bg $[bg.cs30]
329 # Exec exec xterm -fg $[fg.cs31] -bg $[bg.cs31] -e su -l
330 # Exec exec xterm -fg $[fg.cs32] -bg $[bg.cs32] -T "Remote" -e rsh tiger
331 # Exec exec xterm -fg $[fg.cs33] -bg $[bg.cs33] -T "File Viewer" -e less "$0"
332 # FvwmScript FvwmScript-ThemesCenter --text-colorset 36 --viewer-colorset 33
333 # FvwmScript FvwmScript-IconBrowser --text-colorset 36 --icon-colorset 10