From a46a4aef08abaf548437b688c38d9e5eb99f7eb8 Mon Sep 17 00:00:00 2001 From: Mathias Gumz Date: Mon, 5 Jan 2015 16:52:06 +0100 Subject: Documentation: white-spaces and minor formatting --- doc/asciidoc/client-patterns.txt | 92 ++++++++-------- doc/asciidoc/fbsetbg.txt | 4 +- doc/asciidoc/fbsetroot.txt | 2 +- doc/asciidoc/fluxbox-apps.txt | 116 ++++++++++---------- doc/asciidoc/fluxbox-menu.txt | 206 +++++++++++++++++----------------- doc/asciidoc/fluxbox.txt | 232 +++++++++++++++++++-------------------- doc/asciidoc/startfluxbox.txt | 22 ++-- doc/fbrun.1.in | 5 - doc/fluxbox-menu.5.in | 2 +- doc/fluxbox.1.in | 6 +- doc/startfluxbox.1.in | 8 +- 11 files changed, 345 insertions(+), 350 deletions(-) diff --git a/doc/asciidoc/client-patterns.txt b/doc/asciidoc/client-patterns.txt index ed1229d..bfcf1fc 100644 --- a/doc/asciidoc/client-patterns.txt +++ b/doc/asciidoc/client-patterns.txt @@ -1,5 +1,5 @@ A 'pattern' looks like this::: - *(*['propertyname'[!]=]'regexp'*)* ... + *(*['propertyname'[!]=]'regexp'*)* ... Match definitions are enclosed in parentheses *(*...*)*, and if no 'propertyname' is given then *Name* is assumed. The 'regexp' can contain any @@ -16,71 +16,71 @@ You can use *=* to test for equality or *!=* to test for inequality. The following values are accepted for 'propertyname'::: *Name*;; - A string, corresponding to the CLASSNAME property (The first field of - WM_CLASS from the output of the *xprop(1)* utility). + A string, corresponding to the CLASSNAME property (The first field of + WM_CLASS from the output of the *xprop(1)* utility). *Class*;; - A string, corresponding to the CLASSCLASS property (The second field of - WM_CLASS from the output of the *xprop(1)* utility). + A string, corresponding to the CLASSCLASS property (The second field of + WM_CLASS from the output of the *xprop(1)* utility). *Title*;; - A string, corresponding to the window title (WM_NAME from *xprop(1)*). + A string, corresponding to the window title (WM_NAME from *xprop(1)*). *Role*;; - A string, corresponding to the ROLE property (WM_WINDOW_ROLE from - *xprop(1)*). + A string, corresponding to the ROLE property (WM_WINDOW_ROLE from + *xprop(1)*). *Transient*;; - Either *yes* or *no*, depending on whether the window is transient - (typically, a popup dialog) or not. + Either *yes* or *no*, depending on whether the window is transient + (typically, a popup dialog) or not. *Maximized*;; - Either *yes* or *no*, depending on whether the window is maximized or - not. + Either *yes* or *no*, depending on whether the window is maximized or + not. *MaximizedHorizontal*;; - Either *yes* or *no*, depending on whether the window is maximized - horizontally or not. + Either *yes* or *no*, depending on whether the window is maximized + horizontally or not. *MaximizedVertical*;; - Either *yes* or *no*, depending on whether the window is maximized - vertically or not. + Either *yes* or *no*, depending on whether the window is maximized + vertically or not. *Minimized*;; - Either *yes* or *no*, depending on whether the window is minimized - (iconified) or not. + Either *yes* or *no*, depending on whether the window is minimized + (iconified) or not. *Fullscreen*;; - Either *yes* or *no*, depending on whether the window is fullscreen or - not. + Either *yes* or *no*, depending on whether the window is fullscreen or + not. *Shaded*;; - Either *yes* or *no*, depending on whether the window is shaded or - not. + Either *yes* or *no*, depending on whether the window is shaded or + not. *Stuck*;; - Either *yes* or *no*, depending on whether the window is sticky (on - all workspaces) or not. + Either *yes* or *no*, depending on whether the window is sticky (on + all workspaces) or not. *FocusHidden*;; - Either *yes* or *no*, depending on whether the window has asked to be - left off the focus list (or, the alt-tab list), or not. + Either *yes* or *no*, depending on whether the window has asked to be + left off the focus list (or, the alt-tab list), or not. *IconHidden*;; - Either *yes* or *no*, depending on whether the window has asked to be - left off the icon list (or, the taskbar), or not. + Either *yes* or *no*, depending on whether the window has asked to be + left off the icon list (or, the taskbar), or not. *Urgent*;; - Either *yes* or *no*, depending on whether the window has the urgent - hint set. + Either *yes* or *no*, depending on whether the window has the urgent + hint set. *Workspace*;; - A number corresponding to the workspace number to which the window is - attached. The first workspace here is *0*. You may also use *[current]* to - match the currently visible workspace. + A number corresponding to the workspace number to which the window is + attached. The first workspace here is *0*. You may also use *[current]* to + match the currently visible workspace. *WorkspaceName*;; - A string corresponding to the name of the workspace to which the - window is attached. + A string corresponding to the name of the workspace to which the + window is attached. *Head*;; - The number of the display head to which the window is attached. You - may match this against the special value *[mouse]* which refers to the - head where the mouse pointer currently resides. + The number of the display head to which the window is attached. You + may match this against the special value *[mouse]* which refers to the + head where the mouse pointer currently resides. *Layer*;; - The string name of the window's layer, which is one of - *AboveDock*, *Dock*, *Top*, *Normal*, *Bottom*, *Desktop* + The string name of the window's layer, which is one of + *AboveDock*, *Dock*, *Top*, *Normal*, *Bottom*, *Desktop* *Screen*;; - The number of the currently used 'screen'. If the setup of the - running xserver involves independent screens ('not Xinerama'), the $DISPLAY - environment contains something like ':0.1' or ':1.0'. The part after the - dot ('.') is the number of the screen. + The number of the currently used 'screen'. If the setup of the + running xserver involves independent screens ('not Xinerama'), the $DISPLAY + environment contains something like ':0.1' or ':1.0'. The part after the + dot ('.') is the number of the screen. *@XPROP*;; - A string, corresponding to any xproperty (Use either the *xprop(1)* - utility or the 'SetXProp' command to set a xproperty to a window) + A string, corresponding to any xproperty (Use either the *xprop(1)* + utility or the 'SetXProp' command to set a xproperty to a window) .Matches any windows with the CLASSNAME of "xterm" .......... diff --git a/doc/asciidoc/fbsetbg.txt b/doc/asciidoc/fbsetbg.txt index c50f00b..8541b87 100644 --- a/doc/asciidoc/fbsetbg.txt +++ b/doc/asciidoc/fbsetbg.txt @@ -92,11 +92,11 @@ EXAMPLES To use *feh(1)* as wallpapersetter and set *wallpapper.jpg* from the current directory as wallpaper. - $ wpsetters=feh fbsetbg wallpaper.jpg + $ wpsetters=feh fbsetbg wallpaper.jpg Recall the last set wallpaper on display *:0.0* with the stored options. - $ DISPLAY=:0.0 fbsetbg -l + $ DISPLAY=:0.0 fbsetbg -l BUGS ---- diff --git a/doc/asciidoc/fbsetroot.txt b/doc/asciidoc/fbsetroot.txt index 73ba16b..cff58ba 100644 --- a/doc/asciidoc/fbsetroot.txt +++ b/doc/asciidoc/fbsetroot.txt @@ -51,7 +51,7 @@ Creates a modula pattern. You must specify *-bg* and *-fg* colors. Renders the specified texture string to the root window. + 'texturestring' may be one of:;; - *Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / + *Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid* + Select one of these texture types, they only apply when *-gradient* is diff --git a/doc/asciidoc/fluxbox-apps.txt b/doc/asciidoc/fluxbox-apps.txt index c4164cc..08bc681 100644 --- a/doc/asciidoc/fluxbox-apps.txt +++ b/doc/asciidoc/fluxbox-apps.txt @@ -43,7 +43,7 @@ APP SECTIONS *[app]* sections provide settings for individual application windows. These sections begin with a line of the format::: - *[app]* *(*'pattern'*)* *{*'count'*}* + *[app]* *(*'pattern'*)* *{*'count'*}* The 'pattern' can be one or more patterns which match windows. For more details, see *CLIENT PATTERNS*. If you specify more than one 'pattern', they @@ -57,7 +57,7 @@ This opening *[apps]* line is followed by any number of settings for the application. See *SETTINGS* for more details. Each of these sections ends with the single line::: - *[end]* + *[end]* GROUP SECTIONS -------------- @@ -65,7 +65,7 @@ The primary purpose of *[group]* sections is to group windows together. All windows in a group will be tabbed together automatically. These sections begin with a line of the format::: - *[group]* *(*'pattern'*)* + *[group]* *(*'pattern'*)* Where the 'pattern' item is optional. If specified, this pattern must match for the group to take effect. It is common to use non-window-specific patterns such @@ -76,13 +76,13 @@ the *[app]* section detailed above in *APP SECTIONS*, but do not contain any settings and do not have an associated *[end]* line. Like this::: - *[app]* *(*'pattern'*)* + *[app]* *(*'pattern'*)* This section may also contain settings that are applied to every window in the group. See the *SETTINGS* section for details. As with *[app]* sections, each of these sections ends with the single line::: - *[end]* + *[end]* SETTINGS -------- @@ -90,34 +90,34 @@ These settings may be stored in the `apps' file. A settings line must appear inside either an *[app]* or *[group]* section. The general format is::: - *[*'setting'*]* *{*'value'*}* + *[*'setting'*]* *{*'value'*}* All allowed values are described below, except for 'bool' which can simply have the value *yes* or *no*, which enables or disables the associated setting, respectively. *[Workspace]* {'number'}:: - Forces the application to open on the 'number' workspace specified. - Workspaces are set by number, beginning with 0. + Forces the application to open on the 'number' workspace specified. + Workspaces are set by number, beginning with 0. *[Jump]* {'bool'}:: - Changes the active workspace to the remembered one when the application is - opened. This is only useful when used in conjunction with '[Workspace]'. See - *EXAMPLES*. + Changes the active workspace to the remembered one when the application is + opened. This is only useful when used in conjunction with '[Workspace]'. See + *EXAMPLES*. *[Head]* {'number'}:: - Forces the application to open on the 'number' head specified (Xinerama - only). + Forces the application to open on the 'number' head specified (Xinerama + only). *[Layer]* {'number'}:: - Specify the layer to open the window on (by number). Each layer has a - number. The named ones are: 2-AboveDock, 4-Dock, 6-Top, 8-Normal, 10-Bottom, - 12-Desktop. + Specify the layer to open the window on (by number). Each layer has a + number. The named ones are: 2-AboveDock, 4-Dock, 6-Top, 8-Normal, 10-Bottom, + 12-Desktop. *[Dimensions]* {'width[%]' 'height[%]'}:: - Opens the application with the specified 'width' and 'height', in pixels. - If the value is given in percent, then the window size will be based on - the current screen's size. + Opens the application with the specified 'width' and 'height', in pixels. + If the value is given in percent, then the window size will be based on + the current screen's size. *[Position]* ('anchor') {'X[%]' 'Y[%]'}:: Position the application at a particular spot. By default the upper-left corner @@ -133,18 +133,18 @@ percent, then the coordinates will be based on the current screen's size. Specify the decoration state. There are several predefined 'value' sets:;; + -- - *NORMAL*;; - Standard decorations - *NONE*;; - No decorations - *BORDER*;; - Like NONE except keep the X window border - *TAB*;; - Like BORDER except keep external tabs (if enabled) - *TINY*;; - Titlebar with only an iconify button - *TOOL*;; - Titlebar only + *NORMAL*;; + Standard decorations + *NONE*;; + No decorations + *BORDER*;; + Like NONE except keep the X window border + *TAB*;; + Like BORDER except keep external tabs (if enabled) + *TINY*;; + Titlebar with only an iconify button + *TOOL*;; + Titlebar only -- + @@ -153,58 +153,58 @@ The 'value' may also be a bitmask for finer-grained control. The bits are, from Button, Close Button, Menu Button, Sticky Button, Shade Button, External Tabs, Focus Enabled. *[Shaded]* {'bool'}:: - Whether the window is Shaded (rolled-up) or not. + Whether the window is Shaded (rolled-up) or not. *[Tab]* {'bool'}:: - Whether the window has tabs enabled. + Whether the window has tabs enabled. *[FocusNewWindow]* {'bool'}:: - If enabled, a new window will grab X focus as soon as it is opened. - If disabled, a new window will not grab X focus as soon as it is opened. + If enabled, a new window will grab X focus as soon as it is opened. + If disabled, a new window will not grab X focus as soon as it is opened. *[FocusHidden]* {'bool'}:: - If enabled, the window will not appear in 'NextWindow'/'PrevWindow' lists. + If enabled, the window will not appear in 'NextWindow'/'PrevWindow' lists. *[IconHidden]* {'bool'}:: - If enabled, the window will not appear in the icon area of the toolbar. + If enabled, the window will not appear in the icon area of the toolbar. *[Hidden]* {'bool'}:: - A shortcut for setting both *FocusHidden* and *IconHidden* at the same time. + A shortcut for setting both *FocusHidden* and *IconHidden* at the same time. *[Sticky]* {'bool'}:: - Specify if an application should be sticky (shown on all workspaces) or not. + Specify if an application should be sticky (shown on all workspaces) or not. *[Minimized]* {'bool'}:: - Application should start minimized + Application should start minimized *[Maximized]* {'value'}:: Application should start maximized. 'value' may be:;; + -- - *yes*;; - Fully maximized - *horz*;; - Horizontally maximized - *vert*;; - Vertically maximized - *no*;; - Not maximized + *yes*;; + Fully maximized + *horz*;; + Horizontally maximized + *vert*;; + Vertically maximized + *no*;; + Not maximized -- *[Fullscreen]* {'bool'}:: - Application should start in fullscreen mode (fully maximized without any - decorations). + Application should start in fullscreen mode (fully maximized without any + decorations). *[Close]* {'bool'}:: - Save settings on close. By default, application settings are not updated when - a window is closed. + Save settings on close. By default, application settings are not updated when + a window is closed. *[Alpha]* {'value' ['value']}:: - Set the alpha value for this window. If two values are given, they - correspond to the focused and unfocused transparency, respectively. One - number only will be used for both values. 'value' is an integer between 0 - and 255. + Set the alpha value for this window. If two values are given, they + correspond to the focused and unfocused transparency, respectively. One + number only will be used for both values. 'value' is an integer between 0 + and 255. CLIENT PATTERNS --------------- @@ -213,12 +213,12 @@ include::client-patterns.txt[] FILES ----- *~/.fluxbox/apps*:: - This is the default location for the application settings. + This is the default location for the application settings. RESOURCES --------- *session.appsFile:* 'location':: - This may be set to override the location of the application settings. + This may be set to override the location of the application settings. EXAMPLES -------- diff --git a/doc/asciidoc/fluxbox-menu.txt b/doc/asciidoc/fluxbox-menu.txt index eecdf98..925b80e 100644 --- a/doc/asciidoc/fluxbox-menu.txt +++ b/doc/asciidoc/fluxbox-menu.txt @@ -77,114 +77,114 @@ detailed below. Structural Tags ~~~~~~~~~~~~~~~ *[begin]* ('title');; - This tells fluxbox to start parsing the menu file. This tag is required for - fluxbox to read your menu file. If it cannot find it, the system default menu - is used in its place. The 'title' appears at the top of the menu. And *[end]* - tag is required to end the menu. + This tells fluxbox to start parsing the menu file. This tag is required for + fluxbox to read your menu file. If it cannot find it, the system default menu + is used in its place. The 'title' appears at the top of the menu. And *[end]* + tag is required to end the menu. *[submenu]* ('label') {'title'} <'icon'>;; - This tells fluxbox to create and parse a new menu, which is inserted as a - submenu into the parent menu. These menus are parsed recursively, so there is - no limit to the number of levels or nested submenus you can have. The 'label' - is the text that will appear in the parent menu, and the 'title' is shown at - the top of the submenu. If omitted, the 'title' will be the same as the - 'label'. An *[end]* tag is required to end the submenu. + This tells fluxbox to create and parse a new menu, which is inserted as a + submenu into the parent menu. These menus are parsed recursively, so there is + no limit to the number of levels or nested submenus you can have. The 'label' + is the text that will appear in the parent menu, and the 'title' is shown at + the top of the submenu. If omitted, the 'title' will be the same as the + 'label'. An *[end]* tag is required to end the submenu. *[end]*;; - This tells fluxbox that it is at the end of a menu. This can either be a - *[submenu]* or the *[begin]* tag of the main root menu. There must be at - least one of these tags in your menu to correspond to the required *[begin]* - tag, and one for each *[submenu]*. + This tells fluxbox that it is at the end of a menu. This can either be a + *[submenu]* or the *[begin]* tag of the main root menu. There must be at + least one of these tags in your menu to correspond to the required *[begin]* + tag, and one for each *[submenu]*. *[encoding]* {'encoding'};; - This begins an *[encoding]* section and specifies the string encoding of - all strings until the matching *[endencoding]* tag. For a list of available - encodings on your system, run *iconv -l*. + This begins an *[encoding]* section and specifies the string encoding of + all strings until the matching *[endencoding]* tag. For a list of available + encodings on your system, run *iconv -l*. *[endencoding]*;; - This ends an *[encoding]* section. + This ends an *[encoding]* section. *[include]* ('path');; - Parses the file specified by filename inline with the current menu. The - 'path' can be the full path to a file or it can begin with *~/*, which will - be expanded into your home directory. If 'path' is a directory, then all - files in that directory are included. + Parses the file specified by filename inline with the current menu. The + 'path' can be the full path to a file or it can begin with *~/*, which will + be expanded into your home directory. If 'path' is a directory, then all + files in that directory are included. *[separator]*;; - This will create a nice separation line. Useful for splitting up sections in - a ``pretty'' way. The optional 'comment' is not displayed, but can be useful - for internal documentation or script parsing of menu files. + This will create a nice separation line. Useful for splitting up sections in + a ``pretty'' way. The optional 'comment' is not displayed, but can be useful + for internal documentation or script parsing of menu files. *[nop]* ('label') <'icon'>;; - Insert a non-operational item into the current menu. This is much like - *[separator]*, but instead of a line, it inserts a 'label'. This can be used - to help format the menu into blocks or sections if so desired. The 'label' is - optional, and if omitted a blank item will be inserted. + Insert a non-operational item into the current menu. This is much like + *[separator]*, but instead of a line, it inserts a 'label'. This can be used + to help format the menu into blocks or sections if so desired. The 'label' is + optional, and if omitted a blank item will be inserted. Applications ~~~~~~~~~~~~ *[exec]* ('label') {'command...'} <'icon'>;; - Inserts a command item into the menu. When you select the menu item from the - menu, fluxbox runs 'command...' in your *$SHELL* (or /bin/sh if $SHELL is not - set). You can use this to launch applications, run shell scripts, etc. Since - all arguments are passed verbatim to the shell, you can use environment - variables, pipes, or anything else the shell can do. Note that processes only - see environment variables that were set before fluxbox started (such as in - ~/.fluxbox/startup). + Inserts a command item into the menu. When you select the menu item from the + menu, fluxbox runs 'command...' in your *$SHELL* (or /bin/sh if $SHELL is not + set). You can use this to launch applications, run shell scripts, etc. Since + all arguments are passed verbatim to the shell, you can use environment + variables, pipes, or anything else the shell can do. Note that processes only + see environment variables that were set before fluxbox started (such as in + ~/.fluxbox/startup). Fluxbox Functions ~~~~~~~~~~~~~~~~~ *[config]* ('label') <'icon'>;; - Inserts a fluxbox native submenu item, containing numerous configuration - options concerning window placement, focus style, window moving style, etc. - See *Configuration Menu* in *fluxbox(1)* for details. + Inserts a fluxbox native submenu item, containing numerous configuration + options concerning window placement, focus style, window moving style, etc. + See *Configuration Menu* in *fluxbox(1)* for details. *[reconfig]* ('label') <'icon'>;; - When selected this item re-reads the current style and menu files and applies - any changes. This is useful for creating a new style or theme, as you don't - have to constantly restart fluxbox every time you save your style. However, - fluxbox automatically rereads the menu whenever it changes. + When selected this item re-reads the current style and menu files and applies + any changes. This is useful for creating a new style or theme, as you don't + have to constantly restart fluxbox every time you save your style. However, + fluxbox automatically rereads the menu whenever it changes. *[restart]* ('label') {'command'} <'icon'>;; - This tells fluxbox to restart. If 'command' is supplied, it shuts down and - runs the command (which is commonly the name of another window manager). If - 'command' is omitted, fluxbox restarts itself. + This tells fluxbox to restart. If 'command' is supplied, it shuts down and + runs the command (which is commonly the name of another window manager). If + 'command' is omitted, fluxbox restarts itself. *[exit]* ('label') <'icon'>;; - Inserts an item that shuts down and exits fluxbox. Any open windows are - reparented to the root window before fluxbox exits. + Inserts an item that shuts down and exits fluxbox. Any open windows are + reparented to the root window before fluxbox exits. *[style]* ('label') {'filename'} <'icon'>;; - This tells fluxbox to insert an item that, when selected, reads style file - named filename and apply the new textures, colors and fonts to the current - running session. + This tells fluxbox to insert an item that, when selected, reads style file + named filename and apply the new textures, colors and fonts to the current + running session. *[stylesmenu]* ('directory') <'icon'>;; - Reads all filenames from the specified directory, assuming that they are all - valid style files, and creates inline menu items in the current menu for - every filename, that, when selected by the user will apply the selected style - file to the current session. The labels that are created in the menu are the - filenames of the style files. + Reads all filenames from the specified directory, assuming that they are all + valid style files, and creates inline menu items in the current menu for + every filename, that, when selected by the user will apply the selected style + file to the current session. The labels that are created in the menu are the + filenames of the style files. *[stylesdir]* ('label') {'directory'} <'icon'>;; - Creates a submenu entry with 'label' (that is also the title of the new - submenu), and inserts in that submenu all filenames in the specified - 'directory', assuming that they are all valid style files (directories are - ignored) in the same way as the *[stylesdir]* command does. Both - *[stylesdir]* and *[stylesmenu]* commands make it possible to install style - files without editing your init file. + Creates a submenu entry with 'label' (that is also the title of the new + submenu), and inserts in that submenu all filenames in the specified + 'directory', assuming that they are all valid style files (directories are + ignored) in the same way as the *[stylesdir]* command does. Both + *[stylesdir]* and *[stylesmenu]* commands make it possible to install style + files without editing your init file. *[wallpapers]* ('directory') {'command'} <'icon'>;; - This inserts a menu item to set the wallpaper for each file in the given - directory. The 'command' is optional, and defaults to *fbsetbg*. + This inserts a menu item to set the wallpaper for each file in the given + directory. The 'command' is optional, and defaults to *fbsetbg*. *[workspaces]* ('label') <'icon'>;; - This tells fluxbox to insert a link to the workspaces menu directly into your - menu. See *Workspace Menu* in *fluxbox(1)* for details. + This tells fluxbox to insert a link to the workspaces menu directly into your + menu. See *Workspace Menu* in *fluxbox(1)* for details. *[*'command'*]* ('label') <'icon'>;; - In addition to the commands above, any legal keys file 'command' may be used - as a menu item. See *fluxbox-keys(5)* for more information. + In addition to the commands above, any legal keys file 'command' may be used + as a menu item. See *fluxbox-keys(5)* for more information. WINDOW MENU ----------- @@ -195,79 +195,79 @@ labels, commands, or icons. The available tags in this menu are: *[shade]*;; - Provides a menu item to shade or unshade (or, roll-up) the window. This is - equivalent to the shade titlebar button. + Provides a menu item to shade or unshade (or, roll-up) the window. This is + equivalent to the shade titlebar button. *[stick]*;; - Provides a menu item to stick or unstick the window. Stuck windows are - displayed on all workspaces. This is equivalent to the stick titlebar button. + Provides a menu item to stick or unstick the window. Stuck windows are + displayed on all workspaces. This is equivalent to the stick titlebar button. *[maximize]*;; - Provides a menu item to maximize or unmaximize the window, equivalent to the - maximize titlebar button. The button with which you click alters the - behaviour of this item as follows: + Provides a menu item to maximize or unmaximize the window, equivalent to the + maximize titlebar button. The button with which you click alters the + behaviour of this item as follows: - * Button 1 (Un)Maximize as normal. - * Button 2 (Un)Maximize window vertically. - * Button 3 (Un)Maximize window horizontally. + * Button 1 (Un)Maximize as normal. + * Button 2 (Un)Maximize window vertically. + * Button 3 (Un)Maximize window horizontally. *[iconify]*;; - Provides a menu item to iconify (or, minimize) the window, equivalent to the - iconify titlebar button. + Provides a menu item to iconify (or, minimize) the window, equivalent to the + iconify titlebar button. *[close]*;; - Closes the window gracefully, equivalent to the titlebar button. + Closes the window gracefully, equivalent to the titlebar button. *[kill]*;; - Kills the window's process, like *xkill(1)*. + Kills the window's process, like *xkill(1)*. *[raise]*;; - Raise the window to the top of the stack within its layer. + Raise the window to the top of the stack within its layer. *[lower]*;; - Lower the window to the bottom of the stack within its layer. + Lower the window to the bottom of the stack within its layer. *[settitledialog]*;; - Opens a dialog which can be used to set the window's title. Some applications - may re-set their own title from time-to-time, wiping out your setting. + Opens a dialog which can be used to set the window's title. Some applications + may re-set their own title from time-to-time, wiping out your setting. *[sendto]*;; - Sends the window to a different workspace. When you select the workspace with - a middle-click, fluxbox will also change to the new workspace. A regular - click only sends the window. + Sends the window to a different workspace. When you select the workspace with + a middle-click, fluxbox will also change to the new workspace. A regular + click only sends the window. *[layer]*;; - Adds a ``Layer...'' submenu which lets you change the layer of this window. + Adds a ``Layer...'' submenu which lets you change the layer of this window. *[alpha]*;; - Adds a ``Transparency...'' submenu which lets you change the focused and - unfocused transparency of this window. + Adds a ``Transparency...'' submenu which lets you change the focused and + unfocused transparency of this window. *[extramenus]*;; - Adds the ``Remember...'' menu item, which allows you to specify which - settings should be stored in the `apps' file (See *fluxbox-apps(5)* for more - details). + Adds the ``Remember...'' menu item, which allows you to specify which + settings should be stored in the `apps' file (See *fluxbox-apps(5)* for more + details). *[separator]*;; - Adds a horizontal line to the menu + Adds a horizontal line to the menu FILES ----- *~/.fluxbox/menu*:: - This is the default location for the user's root menu. + This is the default location for the user's root menu. *@pkgdatadir@/menu*:: - This is the system-wide root menu file. It will be used if the user's root - menu is missing or unparseable. + This is the system-wide root menu file. It will be used if the user's root + menu is missing or unparseable. *~/.fluxbox/windowmenu*:: - This is the user's window menu definition file + This is the user's window menu definition file *@pkgdatadir@/menu*:: - This is the default window menu. If the user does not have this file, it will - be copied to *~/.fluxbox/windowmenu* on fluxbox startup. + This is the default window menu. If the user does not have this file, it will + be copied to *~/.fluxbox/windowmenu* on fluxbox startup. RESOURCES --------- *session.menuFile:* 'location':: - This may be set to override the location of the user's root menu. + This may be set to override the location of the user's root menu. ENVIRONMENT ----------- diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt index 23a73d9..48041c6 100644 --- a/doc/asciidoc/fluxbox.txt +++ b/doc/asciidoc/fluxbox.txt @@ -300,19 +300,19 @@ item with the items detailed below: *Configure*:: The next level under this menu is where you can set certain resources and really begin to customize the look and feel of your desktop. See the - *Configure Menu* section below for more details. + *Configure Menu* section below for more details. *System Styles*:: - This is where the standard styles are listed. You can select one of these by - clicking on it, and it will be applied immediately. System styles are - located in *@pkgdatadir@/styles/* upon a default install. Remember that you - can confirm this with fluxbox -i. + This is where the standard styles are listed. You can select one of these by + clicking on it, and it will be applied immediately. System styles are + located in *@pkgdatadir@/styles/* upon a default install. Remember that you + can confirm this with fluxbox -i. *User Styles*::: - This is where your custom styles are listed. It will list any styles from - *~/.fluxbox/styles/*, which may be styles you grab from the Internet, or - your own custom styles, provided you follow the standards described in - *fluxbox-style(5)*. + This is where your custom styles are listed. It will list any styles from + *~/.fluxbox/styles/*, which may be styles you grab from the Internet, or + your own custom styles, provided you follow the standards described in + *fluxbox-style(5)*. *Workspace List*::: This is the same as the *Workspace Menu* detailed below. @@ -330,21 +330,21 @@ item with the items detailed below: *Fluxbox Command*::: A little Commandline will popup where you can enter a fluxbox command. These - commands are the same as those detailed in *fluxbox-keys(5)*. + commands are the same as those detailed in *fluxbox-keys(5)*. *Reload config*::: Use this to reload the fluxbox configuration files. You must do this after - editing the `keys' file, `init' file, or the current style. + editing the `keys' file, `init' file, or the current style. *Restart*::: Restart the whole darn thing. This starts a completely new fluxbox process, rereads files and redraws all graphical elements. Running applications will remain open, however, and restored to the same workspaces they were - previously in once fluxbox returns. + previously in once fluxbox returns. *Exit*::: Exits fluxbox, which in turn either shuts down the X Window server or - returns you to the graphical login screen. + returns you to the graphical login screen. Configuration Menu ~~~~~~~~~~~~~~~~~~ @@ -355,25 +355,25 @@ faster way to change the most common settings. All changes take effect immediately. *Focus Model*::: - Lets you configure the window focus model. For details, see *FOCUS MODEL*, - below. + Lets you configure the window focus model. For details, see *FOCUS MODEL*, + below. *Maximize Options*::: Lets you configure what happens when you maximize a window. The four options are: + -- - *Full Maximization*:;; - Normally, a maximized window will not overlap the toolbar, slit, or any - docked windows (like panels). Enabling this option allows maximized - windows to be as large as the actual screen resolution. - *Ignore Resize Increment*:;; - Normally, terminal windows specify a ``resize increment'' which mean - fluxbox will only resize the window to an even multiple of the character - size. Enabling this option will ignore this specification when maximizing. - *Disable Moving* / *Disable Resizing*:;; - Normally, maximized windows can still be moved and resized. Enabling these - options prevents these behaviour. + *Full Maximization*:;; + Normally, a maximized window will not overlap the toolbar, slit, or any + docked windows (like panels). Enabling this option allows maximized + windows to be as large as the actual screen resolution. + *Ignore Resize Increment*:;; + Normally, terminal windows specify a ``resize increment'' which mean + fluxbox will only resize the window to an even multiple of the character + size. Enabling this option will ignore this specification when maximizing. + *Disable Moving* / *Disable Resizing*:;; + Normally, maximized windows can still be moved and resized. Enabling these + options prevents these behaviour. -- *Tab Options*::: @@ -386,8 +386,8 @@ options are: *Toolbar*::: This menu can also be found by right-clicking any non-icon part of the - toolbar. Find more information about this menu's options in the *Toolbar - Menu* section, below. + toolbar. Find more information about this menu's options in the *Toolbar + Menu* section, below. *Transparency*::: This sets the default transparency for a focused windows, unfocused window and @@ -408,7 +408,7 @@ titlebars, not window contents. *Workspace Warping*::: If enabled, you can drag windows from one workspace to another. The previous - workspace is to the left, the next workspace is to the right. + workspace is to the left, the next workspace is to the right. Window Menu ~~~~~~~~~~~ @@ -440,9 +440,9 @@ By default, this menu contains: * Button 3 (Un)Maximize window horizontally. *Iconify*::: - Iconify (or minimize) a window. The `icon' can be found in the Icons submenu - of the workspace menu as well as in the toolbar (if a Toolbar mode showing - Icons is selected). + Iconify (or minimize) a window. The `icon' can be found in the Icons submenu + of the workspace menu as well as in the toolbar (if a Toolbar mode showing + Icons is selected). *Raise*::: Raise the window above all others in the same layer. @@ -455,7 +455,7 @@ By default, this menu contains: *Transparency*::: Change this window's transparency, overriding the defaults from the - *Configuration Menu*. + *Configuration Menu*. *Remember...*::: Specify which window settings should be stored in the `apps' file and @@ -465,36 +465,36 @@ Specifically the setting you may store are: + -- *Workpace:*;; - Open this in the same workspace as where the window currently resides. + Open this in the same workspace as where the window currently resides. *Jump to workspace:*;; - When *Workspace* is selected, fluxbox will jump to the appropriate workspace - when this window is opened there. If not selected, the window will open in - the background. + When *Workspace* is selected, fluxbox will jump to the appropriate workspace + when this window is opened there. If not selected, the window will open in + the background. *Head*:;; - For xinerama users only, start this window on the current head (or screen). + For xinerama users only, start this window on the current head (or screen). *Dimensions*:;; - Record the current window height and width. + Record the current window height and width. *Position*:;; - Record the current X and Y coordinates of the window. + Record the current X and Y coordinates of the window. *Sticky*:;; - Record whether the window is on all desktops, or not. + Record whether the window is on all desktops, or not. *Decorations*:;; - Record the current set of decorations (title bar, grips, tabs, etc) on the window. + Record the current set of decorations (title bar, grips, tabs, etc) on the window. *Shaded*:;; - Record whether the window is shaded (or rolled-up) or not. + Record whether the window is shaded (or rolled-up) or not. *Minimized*:;; - Record whether the window is iconified (or minimized) or not. + Record whether the window is iconified (or minimized) or not. *Maximized*:;; - Record whether the window is maximized or not. + Record whether the window is maximized or not. *Fullscreen*:;; - Record whether the window is in fullscreen mode or not. + Record whether the window is in fullscreen mode or not. *Transparency*:;; - Record the current *Transparency* settings. + Record the current *Transparency* settings. *Layer*:;; - Record the current layer. + Record the current layer. *Save on close*:;; - If selected, any of the above items which are also selected will be updated - with the window's current values as it is closed. + If selected, any of the above items which are also selected will be updated + with the window's current values as it is closed. -- + @@ -513,24 +513,24 @@ background. This menu contains entries to explore the currently defined workspaces, windows, and add/remove/rename workspaces. *Icons*::: - This menu shows any iconified (or, minimized) windows. Clicking on a window - in this menu will raise it on the current workspace. + This menu shows any iconified (or, minimized) windows. Clicking on a window + in this menu will raise it on the current workspace. 'Workspaces'::: - The next section provides one submenu per workspace. Middle-clicking on a - workspace name will take you to that workspace. The submenu contains a list - of all open windows on that workspace. Clicking on a window name will take - you to that window and raise it, changing the active workspace if necessary. + The next section provides one submenu per workspace. Middle-clicking on a + workspace name will take you to that workspace. The submenu contains a list + of all open windows on that workspace. Clicking on a window name will take + you to that window and raise it, changing the active workspace if necessary. *New Workspace*::: - This entry adds a new workspace to the end of the list of current workspaces. + This entry adds a new workspace to the end of the list of current workspaces. *Edit current workspace name*::: - Pops up a dialog to enter a new name for the current workspace. + Pops up a dialog to enter a new name for the current workspace. *Remove Last*::: - Remove the last workspace in the list. Any windows currently open there will - be sent to the next-to-last workspace. + Remove the last workspace in the list. Any windows currently open there will + be sent to the next-to-last workspace. TOOLBAR ------- @@ -596,18 +596,18 @@ All changes take effect immediately. Here are the settings: If this is enabled the toolbar will disappear after a defined time when the mouse pointer leaves the toolbar. It will slide in when the cursor hits the remaining edge of the toolbar. See the *session.autoRaiseDelay* resource for - the delay time. + the delay time. *Toolbar width percentage*::: - Sets the width of the toolbar in a percentage of your total screen size. Use - the left mouse button to decrease and the right mouse-button to increase the - value. The value can be from 1-100. + Sets the width of the toolbar in a percentage of your total screen size. Use + the left mouse button to decrease and the right mouse-button to increase the + value. The value can be from 1-100. *Maximize Over*::: - Enabling this option will allow windows to maximize over the toolbar. With - this switched on they will only expand to the edge of the bar. This option - may be overridden by the ``Full Maximization'' from the *Configuration - Menu*. If that option is enabled, this option will have no effect.. + Enabling this option will allow windows to maximize over the toolbar. With + this switched on they will only expand to the edge of the bar. This option + may be overridden by the ``Full Maximization'' from the *Configuration + Menu*. If that option is enabled, this option will have no effect.. *Layer...*::: This sets the layer on which the toolbar is set. With this you can set the @@ -629,19 +629,19 @@ The first section outlines what types of windows will be shown in the iconbar: + -- *None*:;; - Will not show any windows + Will not show any windows *Icons*:;; - Shows windows from all workspaces that are iconified (or, minimized) + Shows windows from all workspaces that are iconified (or, minimized) *NoIcons*:;; - Shows windows from all workspaces that are not iconified + Shows windows from all workspaces that are not iconified *WorkspaceIcons*:;; - Shows windows from the current workspace that are iconified + Shows windows from the current workspace that are iconified *WorkspaceNoIcons*:;; - Shows windows from the current workspace that are not iconified + Shows windows from the current workspace that are not iconified *Workspace*:;; - Shows all windows (iconified or not) from the current workspace + Shows all windows (iconified or not) from the current workspace *All Windows*:;; - Shows all windows (iconified or not) from all workspaces + Shows all windows (iconified or not) from all workspaces -- + @@ -651,11 +651,11 @@ resource: + -- *Left*:;; - All icons will be left-aligned with the width set in the `init' file + All icons will be left-aligned with the width set in the `init' file *Relative*:;; - All icons will be sized evenly to fill the iconbar completely + All icons will be sized evenly to fill the iconbar completely *Right*:;; - All icons will be right-aligned with the width set in the `init' file + All icons will be right-aligned with the width set in the `init' file -- + @@ -699,16 +699,16 @@ one of the first two and one of the last two. They are: There are three more settings in the ``Focus Model'' menu: *Focus New Windows*::: - If enabled, a new window will grab X focus as soon as it is opened. + If enabled, a new window will grab X focus as soon as it is opened. *Auto Raise*:: - If enabled, focusing on a new window will automatically raise that window - above all others within its layer. When disabled, you must explicitly raise a - focused window using the window menu, keybinding, or *Click Raises*. + If enabled, focusing on a new window will automatically raise that window + above all others within its layer. When disabled, you must explicitly raise a + focused window using the window menu, keybinding, or *Click Raises*. *Click Raises*:: - If enabled, clicking anywhere on a window will raise it above all others - within its layer. + If enabled, clicking anywhere on a window will raise it above all others + within its layer. TAB OPTIONS ----------- @@ -726,7 +726,7 @@ tabs. Inside of it there are three main options: *Maximize Over*::: When this option is on, maximizing a window will disregard the size and location of external tabs, which means they may be pushed out of the screen - entirely. + entirely. *External Tab Width*::: This specifies in pixels the width of external tabs. @@ -786,14 +786,14 @@ All changes take effect immediately. Here are the settings: If this is enabled the slit will disappear after a defined time when the mouse pointer leaves the slit. It will slide in when the cursor hits the remaining edge of the slit. See the *session.autoRaiseDelay* resource for - the delay time. + the delay time. *Maximize Over*::: - Enabling this option will allow windows to maximizing over the slit. With - this switched off they will only expand to the edge of the slit. This - option may be overridden by the ``Full Maximization'' from the - *Configuration Menu*. If that option is enabled, this option will have no - effect.. + Enabling this option will allow windows to maximizing over the slit. With + this switched off they will only expand to the edge of the slit. This + option may be overridden by the ``Full Maximization'' from the + *Configuration Menu*. If that option is enabled, this option will have no + effect.. *Alpha*::: This sets the alpha value for the slit. Use the left mouse button to @@ -802,11 +802,11 @@ All changes take effect immediately. Here are the settings: *Clients*::: This submenu lets you reorder the the applications running in the - slit. You are able to hide apps from the slit by unselecting them in the - list showing. This will not kill the app. You can make them re-appear by - selecting them in the list. The "Save SlitList" option saves the new order - to you slitlist located in *~/.fluxbox/slitlist*. See the next section for - details. + slit. You are able to hide apps from the slit by unselecting them in the + list showing. This will not kill the app. You can make them re-appear by + selecting them in the list. The "Save SlitList" option saves the new order + to you slitlist located in *~/.fluxbox/slitlist*. See the next section for + details. Slitlist File ~~~~~~~~~~~~~ @@ -889,8 +889,8 @@ These allow users to place the slit and toolbar where they like. + -- Possible options are:;; - *BottomLeft* *BottomCenter* *BottomRight* *LeftBottom* *LeftCenter* *LeftTop* - *RightBottom* *RightCenter* *RightTop* *TopLeft* *TopCenter* *TopRight* + *BottomLeft BottomCenter BottomRight LeftBottom LeftCenter LeftTop + RightBottom RightCenter RightTop TopLeft TopCenter TopRight* -- + Slit default: *RightBottom* @@ -930,8 +930,8 @@ They may be specified in any order, delimited by the *,* character. They will appear in the order given. + Possible tools:;; -*clock* *iconbar* *nextwindow* *prevwindow* *nextworkspace* *prevworkspace* -*systemtray* *workspacename* +*clock iconbar nextwindow prevwindow nextworkspace prevworkspace +systemtray workspacename* + Default:;; *workspacename, prevworkspace, nextworkspace, iconbar, prevwindow, nextwindow, @@ -1178,7 +1178,7 @@ may specify any number, space-delimited. + -- The available options are:;; - *Close* *Maximize* *MenuIcon* *Minimize* *Shade* *Stick* *LHalf* *RHalf* + *Close Maximize MenuIcon Minimize Shade Stick LHalf RHalf* -- + Default left: *Stick* @@ -1194,33 +1194,33 @@ files. This is where you can specify different files. Most of the defaults will be located in the user's *~/.fluxbox* directory. *session.appsFile*: 'location':: - Location of persistent application settings, or the `apps' file. See the - *Remember...* item in the *Window Menu* section above or *fluxbox-apps(5)* - for details. + Location of persistent application settings, or the `apps' file. See the + *Remember...* item in the *Window Menu* section above or *fluxbox-apps(5)* + for details. *session.groupFile*: 'location':: - Deprecated, auto-grouping is now done in the `apps' file, see - *fluxbox-apps(5)* for details. + Deprecated, auto-grouping is now done in the `apps' file, see + *fluxbox-apps(5)* for details. *session.keyFile*: 'location':: - Location of the keyboard mapping settings, or the `keys' file. - See *fluxbox-keys(5)* for details. + Location of the keyboard mapping settings, or the `keys' file. + See *fluxbox-keys(5)* for details. *session.menuFile*: 'location':: - Location of the Root Menu file. - See *fluxbox-menu(5)* for details. + Location of the Root Menu file. + See *fluxbox-menu(5)* for details. *session.slitlistFile*: 'location':: - Location of the file used to remember slit client ordering. - See *SLIT* above for details. + Location of the file used to remember slit client ordering. + See *SLIT* above for details. *session.styleFile*: 'location':: - Location of the currently selected style. - See *fluxbox-style(5)* for details. + Location of the currently selected style. + See *fluxbox-style(5)* for details. *session.styleOverlay*: 'location':: - Location of the style overlay file. - See *fluxbox-style(5)* for details. + Location of the style overlay file. + See *fluxbox-style(5)* for details. *session.screen0.windowMenu*: 'location':: This optionally specifies the location of a user-defined window menu. If left diff --git a/doc/asciidoc/startfluxbox.txt b/doc/asciidoc/startfluxbox.txt index ef537aa..0d020b1 100644 --- a/doc/asciidoc/startfluxbox.txt +++ b/doc/asciidoc/startfluxbox.txt @@ -4,7 +4,7 @@ Jim Ramsay v1.3.5, 13 February 2013 :man source: startfluxbox.txt :man version: {revision} -:man manual: Fluxbox Manual +:man manual: Fluxbox Manual NAME ---- @@ -25,9 +25,9 @@ doesn't exist it will be generated. FILES ----- *~/.fluxbox/startup*:: - This file contains all commands that should be executed before fluxbox is - started. The initial file contains helpful comments for beginners. It also - starts fluxbox. + This file contains all commands that should be executed before fluxbox is + started. The initial file contains helpful comments for beginners. It also + starts fluxbox. EXAMPLES -------- @@ -63,14 +63,14 @@ fluxbox* line above to something like this: .... exec fluxbox & fbpid=$! - -sleep 1 -{ - xsetroot -cursor_name left_ptr -fg white -bg black & - ipager & - gkrellm2 & + +sleep 1 +{ + xsetroot -cursor_name left_ptr -fg white -bg black & + ipager & + gkrellm2 & } & - + wait $fbpid .... So xsetroot, ipager, and gkrellm2 will all be started after fluxbox, after diff --git a/doc/fbrun.1.in b/doc/fbrun.1.in index 8dfb443..4cfff03 100644 --- a/doc/fbrun.1.in +++ b/doc/fbrun.1.in @@ -94,11 +94,6 @@ Background color\&. The default is Text font name .RE .PP -\fB\-na\fR -.RS 4 -Disable font antialias -.RE -.PP \fB\-hf\fR \fIfilename\fR .RS 4 History file to load\&. The default is diff --git a/doc/fluxbox-menu.5.in b/doc/fluxbox-menu.5.in index 86737d6..204403d 100644 --- a/doc/fluxbox-menu.5.in +++ b/doc/fluxbox-menu.5.in @@ -1,7 +1,7 @@ '\" t .\" Title: fluxbox-menu .\" Author: Jim Ramsay -.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Generator: DocBook XSL Stylesheets v1.78.1 .\" Date: 13 February 2013 .\" Manual: Fluxbox Manual .\" Source: fluxbox-menu.txt diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in index 7934410..beaedb3 100644 --- a/doc/fluxbox.1.in +++ b/doc/fluxbox.1.in @@ -1454,7 +1454,7 @@ These allow users to place the slit and toolbar where they like\&. .PP Possible options are: .RS 4 -\fBBottomLeft\fR\fBBottomCenter\fR\fBBottomRight\fR\fBLeftBottom\fR\fBLeftCenter\fR\fBLeftTop\fR\fBRightBottom\fR\fBRightCenter\fR\fBRightTop\fR\fBTopLeft\fR\fBTopCenter\fR\fBTopRight\fR +\fBBottomLeft BottomCenter BottomRight LeftBottom LeftCenter LeftTop RightBottom RightCenter RightTop TopLeft TopCenter TopRight\fR .RE .sp Slit default: @@ -1504,7 +1504,7 @@ character\&. They will appear in the order given\&. .PP Possible tools: .RS 4 -\fBclock\fR\fBiconbar\fR\fBnextwindow\fR\fBprevwindow\fR\fBnextworkspace\fR\fBprevworkspace\fR\fBsystemtray\fR\fBworkspacename\fR +\fBclock iconbar nextwindow prevwindow nextworkspace prevworkspace systemtray workspacename\fR .RE .PP Default: @@ -1899,7 +1899,7 @@ The buttons or icons to place in the titlebar of decorated windows\&. You may sp .PP The available options are: .RS 4 -\fBClose\fR\fBMaximize\fR\fBMenuIcon\fR\fBMinimize\fR\fBShade\fR\fBStick\fR\fBLHalf\fR\fBRHalf\fR +\fBClose Maximize MenuIcon Minimize Shade Stick LHalf RHalf\fR .RE .sp Default left: diff --git a/doc/startfluxbox.1.in b/doc/startfluxbox.1.in index 46c16eb..7a01583 100644 --- a/doc/startfluxbox.1.in +++ b/doc/startfluxbox.1.in @@ -1,7 +1,7 @@ '\" t .\" Title: startfluxbox .\" Author: Jim Ramsay -.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Generator: DocBook XSL Stylesheets v1.78.1 .\" Date: 13 February 2013 .\" Manual: Fluxbox Manual .\" Source: startfluxbox.txt @@ -90,9 +90,9 @@ fbpid=$! sleep 1 { - xsetroot \-cursor_name left_ptr \-fg white \-bg black & - ipager & - gkrellm2 & + xsetroot \-cursor_name left_ptr \-fg white \-bg black & + ipager & + gkrellm2 & } & wait $fbpid -- cgit v0.11.2