diff options
author | fluxgen <fluxgen> | 2001-12-11 20:47:02 (GMT) |
---|---|---|
committer | fluxgen <fluxgen> | 2001-12-11 20:47:02 (GMT) |
commit | 18830ac9add80cbd3bf7369307d7e35a519dca9b (patch) | |
tree | 4759a5434a34ba317fe77bbf8b0ed9bb57bb6018 /doc/fluxbox.1.in | |
parent | 1523b48bff07dead084af3064ad11c79a9b25df0 (diff) | |
download | fluxbox-18830ac9add80cbd3bf7369307d7e35a519dca9b.zip fluxbox-18830ac9add80cbd3bf7369307d7e35a519dca9b.tar.bz2 |
Initial revision
Diffstat (limited to 'doc/fluxbox.1.in')
-rw-r--r-- | doc/fluxbox.1.in | 805 |
1 files changed, 805 insertions, 0 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in new file mode 100644 index 0000000..9fa1a7f --- /dev/null +++ b/doc/fluxbox.1.in | |||
@@ -0,0 +1,805 @@ | |||
1 | .\" | ||
2 | .\" Man page for Blackbox | ||
3 | .\" | ||
4 | .\" Copyright (c) 2000 by Wilbert Berendsen <wbsoft@xs4all.nl> | ||
5 | .\" | ||
6 | .\" This manual page may be freely distributed and modified. | ||
7 | .\" Parts of the text are taken from website and several README's | ||
8 | .\" by His Great Hughesness himself. Why reinvent wheels? | ||
9 | .\" | ||
10 | .\" Created with NEdit, tested with ``man'' and ``tkman.'' | ||
11 | .\" This manpage uses only standard groff and tmac.an macros. | ||
12 | .\" To all translators who didn't do manpages earlier (like me ;-): | ||
13 | .\" Read the Man-Page-Mini-HOWTO and the LDP manpage ``man 7 man'' | ||
14 | .\" There's all I needed to know about these macros. | ||
15 | .\" | ||
16 | .\" Updated for bb 0.61 at Sat Sep 9 06:56:04 CEST 2000 | ||
17 | .\" | ||
18 | .\" Changed to fluxbox by Henrik Kinnunen (fluxgen@linuxmail.org) | ||
19 | .\" | ||
20 | .\" ..define sort of <blockquote><pre> macro | ||
21 | .de EX | ||
22 | .ne 5 | ||
23 | .if n .sp 1 | ||
24 | .if t .sp .5 | ||
25 | .nf | ||
26 | .in +.5i | ||
27 | .. | ||
28 | .de EE | ||
29 | .fi | ||
30 | .in -.5i | ||
31 | .if n .sp 1 | ||
32 | .if t .sp .5 | ||
33 | .. | ||
34 | .TH blackbox 1 "October 4th, 2000" "0.61.1" | ||
35 | .SH NAME | ||
36 | blackbox \- a window manager for X11 | ||
37 | .SH SYNOPSIS | ||
38 | .BR blackbox " \-help | \-version" | ||
39 | .br | ||
40 | .B blackbox | ||
41 | .RI "[ \-rc" " rcfile " "] [ \-display" " display " ] | ||
42 | .SH DESCRIPTION | ||
43 | .\" | ||
44 | .\" Phirst Phew ParagraPhs taken from blackbox.alug.org | ||
45 | .\" | ||
46 | Blackbox is yet another addition to the list of window managers for the Open | ||
47 | Group's X Window System, Version 11 Release 6 and above. | ||
48 | Blackbox is built with C++, sharing no common code with any other window | ||
49 | manager (even though the graphics implementation is similar to that of Window | ||
50 | Maker). | ||
51 | .PP | ||
52 | From the time the first line of code was written, Blackbox has evolved around | ||
53 | one premise, minimalism. | ||
54 | It's not meant to be Eye Candy, nor the most Featureful, nor the most Adorned | ||
55 | for modelling the Widely acclaimed NeXT interface. | ||
56 | It is just meant to be | ||
57 | .BR fast . | ||
58 | .PP | ||
59 | Blackbox provides configurable window decorations, a root menu to launch | ||
60 | applications and a toolbar that shows the current workspace name, the focused | ||
61 | application name and the current time. | ||
62 | There is also a workspace menu to add or remove workspaces. The `slit' can be | ||
63 | used to dock small applications, e.g. most of the bbtools can use the slit. | ||
64 | .PP | ||
65 | Blackbox features a special kind of icon handling: When you minimize a window, | ||
66 | no icon appears; instead you can view all minimized applications in the `Icons' | ||
67 | submenu of the workspace menu. | ||
68 | Your desktop will never get cluttered with icons. As an alternative to icons | ||
69 | shaded windows are provided: A double click on the titlebar of a window will | ||
70 | shade it (i.e. the window will disappear, only the titlebar stays visible.) | ||
71 | .PP | ||
72 | Blackbox uses its own graphics class to render its images on the fly. | ||
73 | By using style files, you can determine at a great level how your desktop looks | ||
74 | like. | ||
75 | Currently KDE WM hints are not supported, but Blackbox is already prepared to | ||
76 | support the new window manager specification that is now being developed for | ||
77 | both Gnome and KDE2.0. | ||
78 | .SH OPTIONS | ||
79 | Blackbox supports the following commandline options: | ||
80 | .TP | ||
81 | .B \-help | ||
82 | Display command line options and compiled-in features, then exit. | ||
83 | .TP | ||
84 | .B \-version | ||
85 | Display version info and exit. | ||
86 | .TP | ||
87 | .BI \-rc \ rcfile | ||
88 | Use another rcfile than the default | ||
89 | .IR "~/.blackboxrc" . | ||
90 | .TP | ||
91 | .BI \-display \ display | ||
92 | Start Blackbox on the specified display. | ||
93 | Programs started by Blackbox will have the | ||
94 | .B DISPLAY | ||
95 | environment variable set to this value, too. | ||
96 | .SH RUNNING BLACKBOX | ||
97 | This program is usually started by the user's startup script, most times called | ||
98 | .IR ~/.xinitrc . | ||
99 | To run blackbox, modify the script by adding | ||
100 | .EX 0 | ||
101 | exec blackbox | ||
102 | .EE | ||
103 | as the last executed command of the script. | ||
104 | When Blackbox terminates, the X session will terminate too. | ||
105 | .PP | ||
106 | When started, Blackbox will try to find a default menufile in | ||
107 | .IR @pkgdatadir@/menu . | ||
108 | You can provide a system-wide menu for your users here. | ||
109 | .PP | ||
110 | On exit or restart, Blackbox will save user defaults in the file | ||
111 | .I ~/.blackboxrc | ||
112 | in the user's home directory. | ||
113 | Some resources in this file can be edited by hand. | ||
114 | .SH USING BLACKBOX | ||
115 | From version 0.60.x, Blackbox does no keyboard handling by itself; instead it | ||
116 | relies on an external program | ||
117 | .IR bbkeys (1) | ||
118 | for this. | ||
119 | So in this section we will discuss all mouse commands. | ||
120 | .SS Root window (background): | ||
121 | Right click (button 3) will pop up the root menu. | ||
122 | With this you can launch your applications. | ||
123 | You can customize this menu for your needs. | ||
124 | A middle click (button 2) pops up the workspace menu. | ||
125 | You can add or remove a workspace, view | ||
126 | applications running on all workspace, inspect your icons, and jump directly to | ||
127 | any workspace or application. | ||
128 | .PP | ||
129 | Left clicking (button 1) on an application in the Workspaces menu will bring | ||
130 | you to that workspace and raise/focus that application; | ||
131 | middle clicking (button 2) will warp the application to the current workspace. | ||
132 | .SS Toolbar: | ||
133 | The toolbar consists of three fields: a workspace name, window name of the | ||
134 | window that has currently focus, and a clock. | ||
135 | A left click on the toolbar will bring it to the foreground, a | ||
136 | middle click will hide it behind other windows (if AlwaysOnTop is not set), and | ||
137 | the right button brings up a little menu. | ||
138 | .PP | ||
139 | Using this menu you can enter a name for the current workspace (when finished, | ||
140 | press Enter). | ||
141 | Also you can choose the toolbar's position, whether or not it | ||
142 | should be always on top (i.e. it cannot be obscured by other windows), | ||
143 | and whether it should hide itself when the mouse moves away. | ||
144 | .PP | ||
145 | Note: In Blackbox versions below 0.60.0, a right click on the toolbar | ||
146 | immediately enters workspace name edit mode. | ||
147 | .SS Window Titlebar and Borders: | ||
148 | A left click on any place of the window's border, will raise it. | ||
149 | Dragging then moves the window. | ||
150 | Dragging the resize grips at the left-bottom and right-bottom | ||
151 | corners resizes the window. | ||
152 | Middle clicking on any place will immediately lower the window. | ||
153 | Right clicking on border or titlebar pops up the window menu, | ||
154 | containing these commands: | ||
155 | .TP | ||
156 | .B Send To... | ||
157 | Send window to another workspace. | ||
158 | When you select the workspace with the middle button, Blackbox will | ||
159 | send you along with the application to the selected workspace | ||
160 | .TP | ||
161 | .B Shade | ||
162 | Shade the window (display titlebar only) | ||
163 | .TP | ||
164 | .B Iconify | ||
165 | Iconify window. | ||
166 | The `icon' can be found in the `Icons' submenu of the workspace menu | ||
167 | .TP | ||
168 | .B Maximize | ||
169 | (Un)Maximize window. | ||
170 | When you click the middle button on this item, the | ||
171 | window will maximize only vertically | ||
172 | .TP | ||
173 | .B Raise | ||
174 | Raise window | ||
175 | .TP | ||
176 | .B Lower | ||
177 | Lower window | ||
178 | .TP | ||
179 | .B Stick | ||
180 | (Un)Stick window. | ||
181 | A stuck window will always be displayed in the current workspace | ||
182 | .TP | ||
183 | .B Kill Client | ||
184 | Kill (-SIGKILL) owner of window | ||
185 | .TP | ||
186 | .B Close | ||
187 | Close the application cleanly | ||
188 | .PP | ||
189 | When you doubleclick on the titlebar of a window, it will `shade', so | ||
190 | that only the titlebar stays visible. | ||
191 | Another double click will redisplay the window contents. | ||
192 | .SS Window Buttons: | ||
193 | The button at the left upper corner of a window is the Minimize button. | ||
194 | Clicking with any button causes the window to be iconified. | ||
195 | The rightmost button (with the X) closes the application. | ||
196 | The other button on the right (if present) maximizes the window in three ways: | ||
197 | Button 1 causes full screen maximization, button 2 maximizes the window only | ||
198 | vertically, and button 3 only horizontally. | ||
199 | .SS Any menu: | ||
200 | Clicking button 3 in a menu will popdown the menu. | ||
201 | Clicking button 1 on the titlebar of any (sub)menu and then dragging it somewhere | ||
202 | else will cause the menu to stay visible and not disappear when you click on | ||
203 | a menu item. | ||
204 | .SS Miscellaneous: | ||
205 | When you want to drag a window, but cannot see either the bottom handle or its | ||
206 | titlebar, you can press Alt + button 1 anywhere in the window and then | ||
207 | drag it around. | ||
208 | You can also use Alt + button 1 to raise a partially visible window. | ||
209 | Finally, Alt + button 2 lowers a window, and Alt + button 3 resizes the window. | ||
210 | .SH MENU FILE | ||
211 | A default menu file is installed in | ||
212 | .IR @pkgdatadir@/menu . | ||
213 | Of course this system-wide menu can be customized for all users at once. | ||
214 | But it is also possible to create a personal menu. | ||
215 | It is a convention to create a directory | ||
216 | .IR "~/.blackbox/" " (or " "~/blackbox/" ")" | ||
217 | in your home directory, and to create a menu file, e.g. | ||
218 | .I menu | ||
219 | in this directory, or copy the system-wide menu file to this location. | ||
220 | Next, we have to tell Blackbox to load our menu file instead of the default. | ||
221 | This is accomplished by adding (or changing) a resource value in the | ||
222 | .I ~/.blackboxrc | ||
223 | file e.g.: | ||
224 | .EX | ||
225 | session.menuFile: ~/.blackbox/menu | ||
226 | .EE | ||
227 | For this change to take effect, Blackbox has to be restarted. | ||
228 | Be sure that your menu is usable, then choose `Restart' from the default | ||
229 | Blackbox root menu. | ||
230 | .SS Menu syntax | ||
231 | The menu syntax is very simple and very effective. | ||
232 | There are upto three fields in a menu line. | ||
233 | They are of the form: | ||
234 | .EX | ||
235 | [tag] (label or filename) {command or filename} | ||
236 | .EE | ||
237 | The supported tags are as follows: | ||
238 | .TP | ||
239 | .B [begin] (label for root menu) | ||
240 | This tells Blackbox to start parsing the menu file. | ||
241 | This tag is required for Blackbox to parse your menu file. | ||
242 | If it cannot find it, the system default menu is used instead. | ||
243 | .TP | ||
244 | .B [end] | ||
245 | This tells Blackbox that it is at the end of a menu. | ||
246 | This can either be a submenu or the main root menu. | ||
247 | There must be at least one of these tags in your menu to correspond to the | ||
248 | required [begin] tag. | ||
249 | .TP | ||
250 | .B [exec] (label for command) {shell command} | ||
251 | Inserts a command item into the menu. | ||
252 | When you select the menu item from the menu, Blackbox runs `shell command.' | ||
253 | .TP | ||
254 | .B [exit] (label for exit) | ||
255 | Inserts an item that shuts down and exits Blackbox. | ||
256 | Any open windows are reparented to the root window before Blackbox exits. | ||
257 | .TP | ||
258 | .B [include] (filename) | ||
259 | Parses the file specified by | ||
260 | .I filename | ||
261 | inline with the | ||
262 | current menu. The filename can be the full path to a file or it can begin with | ||
263 | .IR ~/ , | ||
264 | which will be expanded into your home directory (e.g. | ||
265 | .EX | ||
266 | [include] (~/blackbox/stylesmenu) | ||
267 | .EE | ||
268 | will include | ||
269 | .I /home/bhughes/blackbox/stylesmenu | ||
270 | in my menu). | ||
271 | .TP | ||
272 | .B [nop] (label - optional) | ||
273 | Insert a non-operational item into the current menu. | ||
274 | This can be used to help format the menu into blocks or sections | ||
275 | if so desired. | ||
276 | .B [nop] | ||
277 | does accept a label, but it is not required, and a blank item will be used | ||
278 | if none is supplied. | ||
279 | .TP | ||
280 | .B [style] (label) {filename} | ||
281 | This tells Blackbox to insert an item that, when selected, reads style file | ||
282 | named | ||
283 | .I filename | ||
284 | and apply the new textures, colors and fonts to the current | ||
285 | running session. | ||
286 | .TP | ||
287 | .B [stylesdir] (directory name) | ||
288 | Reads all filenames from the specified directory, assuming that they are all | ||
289 | valid style files (directories are ignored), and creates menu items in the | ||
290 | current menu for every filename, that, when selected by the user, apply the | ||
291 | selected style file to the current session. | ||
292 | The labels that are created in the menu are the filenames of the style files. | ||
293 | .TP | ||
294 | .B [stylesmenu] (label) {directory name} | ||
295 | Creates a submenu entry with | ||
296 | .I label | ||
297 | (that is also the title of the new submenu), and inserts in that submenu all | ||
298 | filenames in the specified directory, assuming that they are all valid style | ||
299 | files (directories are ignored) in the same way as the | ||
300 | .B [stylesdir] | ||
301 | command does. | ||
302 | .IP | ||
303 | .RB Both\ [stylesdir] \ and\ [stylesmenu] | ||
304 | commands make it possible to install style files without editing your menu file. | ||
305 | .TP | ||
306 | .B [submenu] (label) {title for menu - optional} | ||
307 | This tells Blackbox to create and parse a new menu. | ||
308 | This menu is inserted as a submenu into the parent menu. | ||
309 | These menus are parsed recursively, so there is no limit to the number of levels | ||
310 | or nested submenus you can have. | ||
311 | The title for the new menu is optional, if none is supplied, | ||
312 | the new menu's title is the same as the item label. | ||
313 | An | ||
314 | .B [end] | ||
315 | tag is required to end the submenu. | ||
316 | .TP | ||
317 | .B [reconfig] (label) | ||
318 | When selected, this item rereads the current style and menu files and | ||
319 | apply any changes. | ||
320 | This is useful for creating a new style or theme, as you don't have to | ||
321 | constantly restart Blackbox every time you save your style. | ||
322 | However, Blackbox automagically rereads the menu whenever it changes. | ||
323 | .TP | ||
324 | .B [restart] (label) {shell command - optional} | ||
325 | This tells Blackbox to restart. | ||
326 | If `shell command' is supplied, it shuts down and runs the command (which is | ||
327 | commonly the name of another window manager). | ||
328 | If the command is omitted, Blackbox restarts itself. | ||
329 | .TP | ||
330 | .B [config] (label) | ||
331 | Inserts a Blackbox native submenu item, containing numerous configuration | ||
332 | options concerning window placement, focus style, window moving style etc. | ||
333 | .TP | ||
334 | .B [workspaces] (label) | ||
335 | This tells Blackbox to insert a link to the workspaces menu directly | ||
336 | into your menu. | ||
337 | This is handy for those users who can't access the | ||
338 | workspace menu directly (e.g. if you don't have a 3 button mouse, it's | ||
339 | rather hard to middle click to show the workspace menu). | ||
340 | .PP | ||
341 | Any line that starts with a `#' is considered a comment and ignored by Blackbox. | ||
342 | Also, in the labels/commands/filenames fields, | ||
343 | you can escape any character like so: | ||
344 | .EX | ||
345 | [exec] (\\(my cool\\) \\{XTERM\\}) {xterm -T \\"cool XTERM\\"} | ||
346 | .EE | ||
347 | Using `\\\\' inserts a literal back-slash into the label/command/filename field. | ||
348 | .SS Menu example | ||
349 | Now let's put together some things. | ||
350 | Here is a short example of a menu file: | ||
351 | .PP | ||
352 | .nf | ||
353 | # Blackbox menu file | ||
354 | [begin] (Blackbox 0.60.3) | ||
355 | [exec] (rxvt) {rxvt -ls} | ||
356 | [exec] (netscape) {netscape -install} | ||
357 | [exec] (The GIMP) {gimp} | ||
358 | [exec] (XV) {xv} | ||
359 | [submenu] (pine) | ||
360 | [exec] (inbox) {rxvt -name pine -e pine -i} | ||
361 | [exec] (new message) {rxvt -name pine -e pine ""} | ||
362 | [end] | ||
363 | [submenu] (Window Manager) | ||
364 | [exec] (Edit Menus) {nedit .blackbox/Menu} | ||
365 | [submenu] (Style) {Which Style?} | ||
366 | [stylesdir] (~/.blackbox/styles) | ||
367 | [stylesmenu] (Blackbox Styles) {@pkgdatadir@/styles} | ||
368 | [end] | ||
369 | [config] (Config Options) | ||
370 | [reconfig] (Reconfigure) | ||
371 | [restart] (Restart) | ||
372 | [end] | ||
373 | [exit] (Log Out) | ||
374 | [end] | ||
375 | # end of menu file | ||
376 | .fi | ||
377 | .SH STYLES | ||
378 | Blackbox enables you to use specialized files that contain | ||
379 | .IR X (1) | ||
380 | resources to specify colors, textures and fonts, and thus | ||
381 | the overall look of your window borders, menus and the toolbar. | ||
382 | .PP | ||
383 | The default installation of Blackbox provides some of these style files. | ||
384 | Usually they are put in | ||
385 | .IR @pkgdatadir@/styles . | ||
386 | You can study or edit these files to grasp how the Blackbox style mechanism | ||
387 | works. | ||
388 | You can use the | ||
389 | .BR [style] ", " [stylesdir] " and " [stylesmenu] | ||
390 | menu commands in your menu file to be able to select and change between styles | ||
391 | on the fly. | ||
392 | .PP | ||
393 | But you can also create a directory named | ||
394 | .I ~/.blackbox/styles | ||
395 | in your homedirectory and put your own style files here. | ||
396 | Of course you may choose any name for this directory, but many downloadable | ||
397 | themes will rely on the name | ||
398 | .I styles | ||
399 | (following the bb.themes.org naming scheme). | ||
400 | .PP | ||
401 | To understand how the style mechanism works, you should have a little knowledge | ||
402 | of how X resources work. | ||
403 | .PP | ||
404 | X resources consist of a key and a value. | ||
405 | The key is constructed of several smaller keys (sometimes referred to as | ||
406 | children), delimited by a period (`.'). | ||
407 | Keys may also contain a star (`*') to serve as a wildcard, which means that one | ||
408 | line of typed text will match several keys. | ||
409 | This is useful for styles that are based on one or two colors. | ||
410 | .PP | ||
411 | Blackbox allows you to configure it's three main components: the toolbar, the | ||
412 | menus and the window decorations. | ||
413 | .PP | ||
414 | The little window that shows the x-y position while dragging windows, borrows | ||
415 | ite style from the window's titlebar. | ||
416 | .PP | ||
417 | Here are some quick examples: | ||
418 | .EX | ||
419 | toolbar.clock.color: green | ||
420 | .EE | ||
421 | This sets the color resource of the toolbar clock to `green.' Another example: | ||
422 | .EX | ||
423 | menu*color: rgb:3/4/5 | ||
424 | .EE | ||
425 | This sets the color resource of the menu | ||
426 | .I and all of its `children' | ||
427 | to `rgb:3/4/5'. | ||
428 | (For a description of color names, see | ||
429 | .IR X (1).) | ||
430 | So this one also applies to | ||
431 | .IR menu.title.color " and " menu.frame.color . | ||
432 | And with | ||
433 | .EX | ||
434 | *font: -b&h-lucida-medium-r-normal-*-*-140-* | ||
435 | .EE | ||
436 | you set the font resource for all keys to this font name all at once. | ||
437 | (For information about the fonts installed on your system, you can use a program like | ||
438 | .IR xfontsel "(1), " gtkfontsel ", or " xlsfonts "(1).)" | ||
439 | .PP | ||
440 | Now, what makes Blackbox just so spectacular, is its ability to render textures | ||
441 | on the fly. | ||
442 | Texture descriptions are specified directly to the key that they | ||
443 | should apply to, e.g.: | ||
444 | .ta \w'toolbar.clock.colorTo:\ 'u | ||
445 | .EX | ||
446 | toolbar.clock: Raised Gradient Diagonal Bevel1 | ||
447 | toolbar.clock.color: rgb:8/6/4 | ||
448 | toolbar.clock.colorTo: rgb:4/3/2 | ||
449 | .EE | ||
450 | Don't worry, we will explain right now! | ||
451 | A texture description consists of up to five fields, which are as follows: | ||
452 | .TP | ||
453 | .B Flat / Raised / Sunken | ||
454 | gives the component either a flat, raised or sunken appearance. | ||
455 | .TP | ||
456 | .B Gradient / Solid | ||
457 | tells Blackbox to draw either a solid color or a gradiented texture. | ||
458 | .TP | ||
459 | .B Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid | ||
460 | Select one of these texture types. They only work when also | ||
461 | .B Gradient | ||
462 | is specified! | ||
463 | .TP | ||
464 | .B Interlaced | ||
465 | tells Blackbox to interlace the texture (darken every other line). | ||
466 | This option is most commonly used with gradiented textures, but from Blackbox | ||
467 | version 0.60.3 on, it also works in solid textures. | ||
468 | .TP | ||
469 | .B Bevel1 / Bevel2 | ||
470 | tells Blackbox which type of bevel to use. | ||
471 | Bevel1 is the default bevel. | ||
472 | The shading is placed on the edge of the image. | ||
473 | Bevel2 is an alternative. | ||
474 | The shading is placed one pixel in from the edge of the image. | ||
475 | .PP | ||
476 | Instead of a texture description, also the option | ||
477 | .B ParentRelative | ||
478 | is available, which makes the component appear as a part of its parent, e.g. | ||
479 | totally transparant. | ||
480 | .PP | ||
481 | All gradiented textures are composed of two color values: the | ||
482 | .IR color " and " colorTo " resources." | ||
483 | When | ||
484 | .B Interlaced | ||
485 | is used in | ||
486 | .B Solid | ||
487 | mode, the | ||
488 | .I colorTo | ||
489 | resource is used to find the interlacing color. | ||
490 | .PP | ||
491 | Well, here is the complete component list, also all components together with | ||
492 | which kind of value they can contain. | ||
493 | Comments are preceded with an exclamation sign (!), which is also used for | ||
494 | comments in Blackbox style c.q. X resource files. | ||
495 | .PP | ||
496 | .ta \w'window.button.unfocus.picColor:\ 'u | ||
497 | .nf | ||
498 | .\" | ||
499 | .\" The comments also to be translated! | ||
500 | .\" | ||
501 | ! The toolbar itself | ||
502 | toolbar: Texture | ||
503 | toolbar.color: Color | ||
504 | toolbar.colorTo: Color | ||
505 | |||
506 | ! The buttons on the toolbar | ||
507 | toolbar.button: Texture or \fIParentRelative\fR | ||
508 | toolbar.button.color: Color | ||
509 | toolbar.button.colorTo: Color | ||
510 | |||
511 | ! Color of the button arrows | ||
512 | toolbar.button.picColor: Color | ||
513 | |||
514 | ! Buttons in pressed state | ||
515 | toolbar.button.pressed: Texture \fI(e.g. Sunken)\fR or \fIParentRelative\fR | ||
516 | toolbar.button.pressed.color: Color | ||
517 | toolbar.button.pressed.colorTo: Color | ||
518 | |||
519 | ! Color of pressed button arrows | ||
520 | toolbar.button.pressed.picColor: Color | ||
521 | |||
522 | ! The toolbar workspace label | ||
523 | toolbar.label: Texture or \fIParentRelative\fR | ||
524 | toolbar.label.color: Color | ||
525 | toolbar.label.colorTo: Color | ||
526 | toolbar.label.textColor: Color | ||
527 | |||
528 | ! The toolbar window label | ||
529 | toolbar.windowLabel: Texture or \fIParentRelative\fR | ||
530 | toolbar.windowLabel.color: Color | ||
531 | toolbar.windowLabel.colorTo: Color | ||
532 | toolbar.windowLabel.textColor: Color | ||
533 | |||
534 | ! The toolbar clock | ||
535 | toolbar.clock: Texture or \fIParentRelative\fR | ||
536 | toolbar.clock.color: Color | ||
537 | toolbar.clock.colorTo: Color | ||
538 | toolbar.clock.textColor: Color | ||
539 | |||
540 | ! How the toolbar's text should be justified. | ||
541 | toolbar.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR | ||
542 | |||
543 | ! Font to be used for all toolbar components | ||
544 | toolbar.font: Font \fI(e.g. -*-helvetica-medium-r-normal-*-*-100-*)\fR | ||
545 | |||
546 | ! The menu titlebar | ||
547 | menu.title: Texture | ||
548 | menu.title.color: Color | ||
549 | menu.title.colorTo: Color | ||
550 | menu.title.textColor: Color | ||
551 | menu.title.font: Font | ||
552 | menu.title.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR | ||
553 | |||
554 | ! The menu frame | ||
555 | menu.frame: Texture | ||
556 | menu.frame.color: Color | ||
557 | menu.frame.colorTo: Color | ||
558 | menu.frame.textColor: Color | ||
559 | menu.frame.disableColor: Color | ||
560 | menu.frame.font: Font | ||
561 | menu.frame.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR | ||
562 | |||
563 | ! Bullets for submenu items | ||
564 | menu.bullet: \fIempty\fR, \fItriangle\fR, \fIsquare\fR, or \fIdiamond\fR | ||
565 | menu.bullet.position: \fIright\fR or \fIleft\fR | ||
566 | |||
567 | ! The highlighted menu item | ||
568 | menu.hilite: Texture (e.g. \fIRaised\fR) | ||
569 | menu.hilite.color: Color | ||
570 | menu.hilite.colorTo: Color | ||
571 | menu.hilite.textColor: Color | ||
572 | |||
573 | ! A focused window | ||
574 | window.title.focus: Texture | ||
575 | window.title.focus.color: Color | ||
576 | window.title.focus.colorTo: Color | ||
577 | |||
578 | ! An unfocused window | ||
579 | window.title.unfocus: Texture | ||
580 | window.title.unfocus.color: Color | ||
581 | window.title.unfocus.colorTo: Color | ||
582 | |||
583 | ! Window label | ||
584 | window.label.focus: Texture or \fIParentRelative\fR | ||
585 | window.label.focus.color: Color | ||
586 | window.label.focus.colorTo: Color | ||
587 | window.label.focus.textColor: Color | ||
588 | |||
589 | window.label.unfocus: Texture or \fIParentRelative\fR | ||
590 | window.label.unfocus.color: Color | ||
591 | window.label.unfocus.colorTo: Color | ||
592 | window.label.unfocus.textColor: Color | ||
593 | |||
594 | ! Handlebar | ||
595 | window.handle.focus: Texture | ||
596 | window.handle.focus.color: Color | ||
597 | window.handle.focus.colorTo: Color | ||
598 | |||
599 | window.handle.unfocus: Texture | ||
600 | window.handle.unfocus.color: Color | ||
601 | window.handle.unfocus.colorTo: Color | ||
602 | |||
603 | ! Resize grips | ||
604 | window.grip.focus: Texture | ||
605 | window.grip.focus.color: Color | ||
606 | window.grip.focus.colorTo: Color | ||
607 | |||
608 | window.grip.unfocus: Texture | ||
609 | window.grip.unfocus.color: Color | ||
610 | window.grip.unfocus.colorTo: Color | ||
611 | |||
612 | ! Window buttons | ||
613 | window.button.focus: Texture or \fIParentRelative\fR | ||
614 | window.button.focus.color: Color | ||
615 | window.button.focus.colorTo: Color | ||
616 | window.button.focus.picColor: Color | ||
617 | |||
618 | window.button.unfocus: Texture or \fIParentRelative\fR | ||
619 | window.button.unfocus.color: Color | ||
620 | window.button.unfocus.colorTo: Color | ||
621 | window.button.unfocus.picColor: Color | ||
622 | |||
623 | window.button.pressed: Texture (e.g. \fISunken\fR) | ||
624 | window.button.pressed.color: Color | ||
625 | window.button.pressed.colorTo: Color | ||
626 | |||
627 | ! Frame around window | ||
628 | window.frame.focusColor: Color | ||
629 | window.frame.unfocusColor: Color | ||
630 | |||
631 | ! Font and justification for window labels | ||
632 | window.font: Font | ||
633 | window.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR | ||
634 | |||
635 | ! Miscellaneous resources | ||
636 | |||
637 | ! A border can be drawn round all components | ||
638 | borderWidth: a number of pixels, e.g. \fI1\fR | ||
639 | borderColor: Color | ||
640 | |||
641 | bevelWidth: a number of pixels > 0 | ||
642 | handleWidth: a number of pixels > 0 | ||
643 | |||
644 | ! Width of the window frame (from version 0.61 on) | ||
645 | ! When not specified, frameWidth defaults to the value of bevelWidth | ||
646 | frameWidth: a number of pixels >= 0 | ||
647 | |||
648 | |||
649 | ! This command is executed whenever this style is selected. | ||
650 | ! Typically it sets the root window to a nice picture. | ||
651 | rootCommand: Shell command, e.g. \fIbsetroot -mod 4 4 -fg rgb: 5/6/6 -bg grey20\fR | ||
652 | |||
653 | ! Some of the bbtools read these old 0.51 resources | ||
654 | menuFont: Font | ||
655 | titleFont: Font | ||
656 | .fi | ||
657 | .PP | ||
658 | Now, this seems a long list, but remember, when you create your own style, you | ||
659 | can easily set lots of keys with a single command, e.g. | ||
660 | .EX | ||
661 | .ta \w'*unfocus.textColor:\ 'u | ||
662 | *color: slategrey | ||
663 | *colorTo: darkslategrey | ||
664 | *unfocus.color: darkslategrey | ||
665 | *unfocus.colorTo: black | ||
666 | *textColor: white | ||
667 | *unfocus.textColor: lightgrey | ||
668 | *font: lucidasans-10 | ||
669 | .EE | ||
670 | This sets already nice defaults for many components. | ||
671 | .SH THE SLIT | ||
672 | The slit is a special Blackbox window frame that can contain dockable | ||
673 | applications, e.g. the `bbtools.' | ||
674 | When applications are run in the slit they have no window borders of their own; | ||
675 | instead they are framed in the slit, and they are always visible in the current | ||
676 | workspace. | ||
677 | You can click button 3 on the edge of the slit window to get a menu to | ||
678 | determine its position, whether its contained applications should be grouped | ||
679 | horizontally or vertically and whether the slit should hide itself when the | ||
680 | mouse moves away. | ||
681 | .PP | ||
682 | Most dockable applications use the | ||
683 | .B -w | ||
684 | option to run in the slit. | ||
685 | For example, you could put in your | ||
686 | .IR ~/.xinitrc : | ||
687 | .EX | ||
688 | bbmail -w & | ||
689 | bbpager -w & | ||
690 | exec blackbox | ||
691 | .EE | ||
692 | Of course to use the slit you must have slit support compiled in. | ||
693 | .SH RESOURCE FILE | ||
694 | Usually the | ||
695 | .I ~/.blackboxrc | ||
696 | resource file is created and maintained bij Blackbox itself. | ||
697 | All options from the | ||
698 | .B [config] | ||
699 | menu (from 0.60.x on), the last selected style file, your workspace names and | ||
700 | so on are saved into this file. | ||
701 | However, there are some resources in it you might want to edit yourself: | ||
702 | .TP | ||
703 | .B session.menuFile: | ||
704 | This tells Blackbox where to look for its menu file. | ||
705 | .TP | ||
706 | .B session.screen0.toolbar.widthPercent: | ||
707 | This determines the amount (in %) of space the toolbar will take. | ||
708 | Default value is: | ||
709 | .IR 66 . | ||
710 | .TP | ||
711 | .B session.screen0.strftimeFormat: | ||
712 | This adjusts the way the current time is displayed in the toolbar. | ||
713 | The | ||
714 | .IR strftime (3) | ||
715 | format is used. | ||
716 | The default value is: | ||
717 | .IR "%I:%M %p" . | ||
718 | .TP | ||
719 | .B session.autoRaiseDelay: | ||
720 | Adjusts the delay (in ms) before focused windows will raise when using the | ||
721 | Autoraise option. | ||
722 | The default value is: | ||
723 | .IR 250 . | ||
724 | .TP | ||
725 | .B session.doubleClickInterval: | ||
726 | Adjust the delay (in ms) between mouse clicks for Blackbox to consider a double click. | ||
727 | Default value is: | ||
728 | .IR 250 . | ||
729 | .TP | ||
730 | .B session.screen0.edgeSnapThreshold: | ||
731 | When moving a window across your screen, Blackbox is able to have it `snap' to | ||
732 | the edges of the screen for easy placement. | ||
733 | This variable tells Blackbox the distance (in pixels) at which the window will | ||
734 | jump to the egde. | ||
735 | Default value is: | ||
736 | .IR 0 . | ||
737 | .TP | ||
738 | .B session.cacheMax: | ||
739 | This tells Blackbox how much memory (in Kb) it may use to store cached pixmaps on | ||
740 | the X server. | ||
741 | If your machine runs short of memory, you may lower this value. | ||
742 | Default value is | ||
743 | .IR 200 . | ||
744 | .TP | ||
745 | .B session.cacheLife: | ||
746 | This tells Blackbox how long (in minutes) unused pixmaps may stay in the X | ||
747 | server's memory. | ||
748 | Default value is | ||
749 | .IR 5 . | ||
750 | .TP | ||
751 | .B session.colorsPerChannel: | ||
752 | This tells Blackbox how many colors to take from the X server on pseudocolor | ||
753 | displays. A channel would be red, green, or blue. | ||
754 | Blackbox will allocate this variable ^ 3 colors and make them always available. | ||
755 | Value must be between 2 and 6. | ||
756 | When you run Blackbox on an 8-bit display, you must set this resource to 4. | ||
757 | Default value is | ||
758 | .IR 4. | ||
759 | .PP | ||
760 | When running Blackbox in a multiple desktop environment the | ||
761 | .B screen0 | ||
762 | key can also be | ||
763 | .B screen1, 2 | ||
764 | etc. for any appropriate desktop. | ||
765 | .SH ENVIRONMENT | ||
766 | .TP | ||
767 | .B HOME | ||
768 | Blackbox uses | ||
769 | .RB $ HOME | ||
770 | to find its | ||
771 | .I .blackboxrc | ||
772 | file, and to resolve stylefile and \-directory names. | ||
773 | .TP | ||
774 | .B DISPLAY | ||
775 | When no other display was given on the command line, Blackbox will start on the | ||
776 | display specified by this variable. | ||
777 | .SH AUTHOR and CREDITS | ||
778 | All of the code is written and maintained by Brad Hughes | ||
779 | .nh \" hyphenation off | ||
780 | (blackbox@alug.org) | ||
781 | .hy \" on again | ||
782 | and Jeff Raven | ||
783 | .nh | ||
784 | (jraven@psu.edu), | ||
785 | .hy | ||
786 | with contributions and patches merged from | ||
787 | many individuals around the world. | ||
788 | .PP | ||
789 | The Official Blackbox website: | ||
790 | .nh | ||
791 | .B http://blackbox.alug.org/ | ||
792 | .hy | ||
793 | .br | ||
794 | Many themes and other contributions: | ||
795 | .nh | ||
796 | .B http://bb.themes.org/ | ||
797 | .hy | ||
798 | .PP | ||
799 | This manpage was put together by Wilbert Berendsen | ||
800 | .nh | ||
801 | (wbsoft@xs4all.nl). | ||
802 | .hy | ||
803 | Numerous other languages will be available. | ||
804 | .SH SEE ALSO | ||
805 | .IR bsetroot (1), \ bbkeys (1) \" not there, yet ;-( | ||