From 43a15840f61150d84a4313db68f62147a511f03f Mon Sep 17 00:00:00 2001 From: Paul Tagliamonte Date: Sun, 27 May 2012 13:02:57 -0400 Subject: Minor changes to the grammar in the man-page. --- doc/asciidoc/fluxbox-style.txt | 118 +++++++++++++++++++++-------------------- 1 file changed, 61 insertions(+), 57 deletions(-) diff --git a/doc/asciidoc/fluxbox-style.txt b/doc/asciidoc/fluxbox-style.txt index c41937e..7c35e15 100644 --- a/doc/asciidoc/fluxbox-style.txt +++ b/doc/asciidoc/fluxbox-style.txt @@ -30,10 +30,10 @@ the 'System Styles' menu under your main fluxbox(1) menu. fluxbox(1) uses its own graphics class to render its images on the fly. By using styles you can determine, at a great level of configurability, what your -desktop will look like. Since fluxbox(1) was derived from blackbox many often +desktop will look like. Since fluxbox(1) was derived from blackbox(1) many often wonder if old themes will work on the latest releases of fluxbox(1). Well they basically do, but you will have to tune them since the fluxbox(1) code has -changed quite a bit since the initial grab. +changed quite a bit since the initial fork. STRUCTURE --------- @@ -89,10 +89,10 @@ Output of a packaged style should look like the following: .fluxbox/styles/YourStyle/pixmaps/stick.xpm ... -Of course, all of these are just preferences, fluxbox(1) allows for the -customization of many things, including how you handle your styles. Just -remember, however, that if you plan to distribute your style you may find -some community bickering if you don't follow practices. :) +All of this is just best practice, fluxbox(1) allows youto "bend" the rules +fairly far. Keep in mind that following the advice suggested here is strongly +suggested if you wish to distribute your style to others. Themes that break +policy are usually subject to critique from members of the community. CREATING YOUR STYLE ------------------- @@ -101,36 +101,37 @@ the toolbar, menus, slit and window decorations. Remember that you can customize the slit with its own directives, otherwise the slit will take the appearance of the toolbar. -Here are some quick examples to illustrate basic syntax: +Here are some quick examples to illustrate the style's basic syntax: toolbar.clock.color: green -This sets the color resource of the toolbar clock to 'green'. Another example: +This next example sets the color resource of the toolbar clock to 'green': menu*color: rgb:3/4/5 -This sets the color resource of the menu and all of its 'children' to -`rgb:3/4/5'. (For a description of color names, see X(1).) So this one also -applies to 'menu.title.color' and 'menu.frame.color'. And with +The following sets the color resource of the menu and all of its 'children' to +`rgb:3/4/5' -- that is to say this directive applies to both 'menu.title.color' +and 'menu.frame.color'. For a complete description of color names, see the X(1) +manpage's section on this topic. *font: -b&h-lucida-medium-r-normal-*-*-140-* -you set the font resource for all keys to this font name all at once (For -information about the fonts installed on your system, you can use a -program like xfontsel(1), gtkfontsel, or xlsfonts(1).) +Now, if we examine this line further, you will notice that it sets the font +resource for all keys to this font name all at once (For information about the +fonts installed on your system, you can use a program like xfontsel(1), +gtkfontsel, or xlsfonts(1).) you will also notice the wildcard (*) before font. +In a Fluxbox style you can set a value with a wildcard. This means that every +font in the style will be what is specified. You can do this with any +component/value. -In the last example you will notice the wildcard (*) before font. In a Fluxbox -style you can set a value with a wildcard. The example means that every font -in the style will be what is specified. You can do this with any -component/value. For example if you wanted all of the text to be one color you -would do: +For example, if you wanted all of the text to be one color you would do: *textColor: rgb:3/4/5 This means that you can setup a very simple style with very few properties. -See the EXAMPLES below for an example of this in practice. fluxbox(1) also allows -you to override wildcards in your style. Lets take our example above and add -an override for the toolbar.clock.textColor component: +See the EXAMPLES below for an example of this in practice. fluxbox(1) also +allows you to override wildcards in your style. Lets take our example above and +add an override for the toolbar.clock.textColor component: *textColor: rgb:3/4/5 toolbar.clock.textColor: rgb:255/0/0 @@ -138,10 +139,11 @@ an override for the toolbar.clock.textColor component: With that all of the text will be 'rgb:3/4/5' except the toolbar clock text which will be 'rgb:255/0/0'. -Now what makes fluxbox(1) so spectacular is its ability to render textures on the -fly. A texture is a fillpattern that you see on some styles. Texture -descriptions are specified directly to the key that they should apply to, -e.g.: +Now what makes fluxbox(1) so spectacular is its ability to render textures on +the fly. A texture is a fillpattern that you see on some styles. Texture +descriptions are specified directly to the key that they should apply to. + +For example: toolbar.clock: Raised Gradient Diagonal Bevel1 toolbar.clock.color: rgb:8/6/4 @@ -187,34 +189,35 @@ All gradiented textures are composed of two color values: the 'color' and 'colorTo' resources. When *Interlaced* is used in *Solid* mode, the 'colorTo' resource is used to find the interlacing color. -A WORD ABOUT FONTS ------------------- -We should comment about fonts before we move on to the complete component -list. fluxbox(1) supports different options for text. These options currently -include bold, halo and shadow. To set these do this: fontname-size:options for -any of the font components in the style file. For example: - - menu.title.font: sans-8:bold,shadow +FONT EFFECTS +------------ +In addition to specifying the typeface and weight (such as bold) via the +font rendering engine (such as Xft) by passing extra options to the font +attribute, fluxbox(1) supports some additional font styles (such as 'halo' and +'shadow') which may be passed into the 'effect' attribute. -The latest versions of fluxbox(1) (> 0.9.8) also support different values for -these text options. The possibilities are as follows: +For example, the following will set a menu's title string to 8 point sans font, +bolded, with a green drop shadow: - -------- - Shadow color= offsetx= offsety= Halo color= - -------- + menu.title.font: sans-8:bold + menu.title.effect: shadow + menu.title.shadow.color: green + menu.title.shadow.x: 3 + menu.title.shadow.y: 3 -For the case of completeness, here are some real world examples: +Or, to claify this point further, the following example demonstrates how to set +this same text to an 8 point sans font, bolded with a green halo rather then a +shaddow: - *.font: Verdana-10:bold,shadow:offsetx=2;offsety=4;color=green - *.font: Verdana-10:halo:color=blue + menu.title.font: sans-8:bold + menu.title.effect: halo + menu.title.halo.color: green -Of course this could all be placed on one line. Also note that for the offset -options, negative integers are allowed. FONT PROBLEMS ~~~~~~~~~~~~~ If you have problems installing fonts or getting them to work, you should read -the docs page at xfree.org. Here is a link to one of these: +the docs page at xfree.org, found at: http://xfree.org/4.3.0/fonts2.html#3[] FULL COMPONENT LIST @@ -229,8 +232,8 @@ used. This allows the user the ease of changing different components. WINDOW OPTIONS -------------- -Many, many things you can do with window design in fluxbox(1), below are your -options. Have fun. +Much like cats, there are many ways to skin fluxbox(1). To help you figure out +how to scratch your itch, a comprehensive list of options follows. Have fun! ----------------------------------------- window.bevelWidth: @@ -357,13 +360,13 @@ change the user's background, then use `background: none'. The options `centered', `aspect', `tiled', and `fullscreen' require the `background.pixmap' resource to contain a valid file name. The `random' option requires `background.pixmap' to contain a valid directory name. For these options, -*fluxbox(1)* will call *fbsetbg(1)* to set the background. The options `gradient', -`solid', and `mod' all require `background.color' to be set. `gradient' and -`mod' both require `background.colorTo'. `mod' requires `background.modX' and -`background.modY' to be set as well. These options will be passed to -*fbsetroot(1)* to set the background. The special option `unset' is for use in -user overlay files only. It specifies that fbsetbg should never be run (by -default, even when `none' is set in the overlay, fluxbox will try to run +*fluxbox(1)* will call *fbsetbg(1)* to set the background. The options +`gradient', `solid', and `mod' all require `background.color' to be set. +`gradient' and `mod' both require `background.colorTo'. `mod' requires +`background.modX' and `background.modY' to be set as well. These options will be +passed to *fbsetroot(1)* to set the background. The special option `unset' is +for use in user overlay files only. It specifies that fbsetbg should never be +run (by default, even when `none' is set in the overlay, fluxbox will try to run ``fbsetbg -z'' to restore the last wallpaper). background: centered|aspect|tiled|fullscreen|random|solid|gradient |mod|none|unset @@ -489,9 +492,10 @@ You can find a lot of styles here: http://tenr.de/ This manpage was composed from various resources including the official documentation, fluxbox(1) man page and numerous other resources by Curt "Asenchi" Micol. If you notice any errors or problems with this page, please -contact him here: and using the great contributions of -. Numerous other languages could be available -if someone jumps in. +contact him at: and using the great contributions of +. Minor edits to fix grammar were made by +Paul Tagliamonte . Numerous other languages could be +available if someone jumps in. SEE ALSO -------- -- cgit v0.11.2