bug.n/src/doc/configuration.t2t

347 lines
14 KiB
Text
Raw Normal View History

2011-07-27 17:43:34 +00:00
%!encoding: utf-8
2011-07-27 17:43:34 +00:00
%!options(html): --css-sugar -o configuration.html
%!style(html): http://bugn.berlios.de/styles.css
%!preproc(html): '%%html: ' ''
%!postproc(html): '<HEAD>' '<HEAD>\n<TITLE>berliOS project: bug.n -- Configuration</TITLE>'
%!postproc(html): '<HEAD>' '<HEAD>\n<LINK REL="icon" HREF="http://bugn.berlios.de/images/bugn.ico" />'
%!postproc(html): '<HEAD>' '<HEAD>\n<META NAME="author" CONTENT="joten" />'
%!postproc(html): '<HEAD>' '<HEAD>\n<META NAME="keywords" CONTENT="AutoHotkey, joten, bug.n, tiling, window management" />'
%!postproc(html): '<HEAD>' '<HEAD>\n<META NAME="description" CONTENT="bug.n - Tiling Window Manager" />'
%!postproc(html): '<TD><IMG ALIGN="middle" SRC="bugn.png"' '<TD ID="bugn"><IMG ALIGN="middle" SRC="http://bugn.berlios.de/images/bugn.png"'
%!postproc(html): ' -- ' ' &ndash; '
%!postproc(html): 'config.png"' 'http://bugn.berlios.de/images/config.png"'
%!postproc(html): 'jn.png"' 'http://bugn.berlios.de/images/jn.png"'
%!postproc(html): '%%LINK_hotkeys' '<A HREF="https://developer.berlios.de/docman/display_doc.php?docid=2054&group_id=12477">bug.n/hotkeys</A>'
%!postproc(html): '\(c\)' '&copy;'
2011-07-27 17:43:34 +00:00
%!options(txt): -o configuration.txt
%!preproc(txt): '%%txt: ' ''
%!postproc(txt): '%%LINK_hotkeys' 'doc/hotkeys.txt'
%!postproc(txt): '<DIV ID="frame">' ''
%!postproc(txt): '<BR>' ''
''' <DIV ID="frame">
%%html: ''' <DIV CLASS="header">
%%html: | [bugn.png] | bug.n -- Configuration | [config.png]
%%txt: =bug.n -- Configuration=
%%html: ------------------------------------------------------------------------
%%html: ''' </DIV>
2011-07-27 17:43:34 +00:00
=== bug.n GUI ===
: **Config_showBar**=1
If false (=0), the bar is hidden. It can be made visible or hidden by
hotkey (see below).
2011-07-27 17:43:34 +00:00
: **Config_horizontalBarPos**=left
The horizontal position of the bar: center, left or right side of the
monitor or an offset in pixel (px) from the left (>= 0) or right (< 0).
: **Config_verticalBarPos**=top
The vertical position of the bar: top or bottom of the monitor,
tray = sub-window of the task bar.
: **Config_barWidth**=100%
The width of the bar in pixel (px) or with a per cent sign (%) as a
percentage.
: **Config_singleRowBar**=1
If false, the bar will have to rows, one for the window title and one
for all other GUI controls.
: **Config_spaciousBar**=0
If true, the height of the bar will be set to a value equal to the
height of an edit control, else it will be set to the text height.
2011-07-27 17:43:34 +00:00
: **Config_fontName**=Lucida Console
A monospace font is preferable for bug.n to calculate the correct width
of the bar and its elements (sub-windows).
: **Config_fontSize**=<fontsize_captiontext>
2011-07-27 17:43:34 +00:00
Font size in pixel. The default value is retrieved from the "Window
Color and Appearance" settings for the "Active Title Bar".
: **Config_normBgColor**=<COLOR_MENU>;<COLOR_INACTIVECAPTION>;<COLOR_GRADIENTINACTIVECAPTION>;Red;<COLOR_GRADIENTINACTIVECAPTION>
The normal background color of the following bar elements:
1. inactive views, title and time
2. the layout symbol, the any-text (i. a. date) and the button for the
command GUI (#!).
3. the progress bar indicating a charging or full battery
4. the progress bar indicating a discharging battery with a remaining
charge of less than ten percent
5. the progress bar indicating a charging battery
The default values are retrieved from the "Window Color and Appearance"
settings.
: **Config_normFgColor**=<COLOR_MENUTEXT>;Default;<COLOR_INACTIVECAPTION>;<COLOR_INACTIVECAPTIONTEXT>;<COLOR_HIGHLIGHT>;White;Default;<COLOR_INACTIVECAPTION>
The normal foreground color of the following bar elements:
1. the text of inactive views, title and time
2. the text of the layout symbol, a full battery, the any-text (i. a.
date) and the button for the command GUI (#!)
3. the progress bar indicating a charging battery?
4. the text indicating a discharging battery
5. the progress bar indicating a discharging battery
6. the text indicating a discharging battery with a remaining charge of
less than ten percent?
7. the text indicating a charging battery?
8. the progress bar indicating an inactive view and a charging battery?
The default values are retrieved from the "Window Color and Appearance"
settings.
: **Config_selBgColor**=<COLOR_GRADIENTACTIVECAPTION>
The background color of a progress bar indicating an active view.
The default values are retrieved from the "Window Color and Appearance"
settings.
: **Config_selFgColor**=<COLOR_CAPTIONTEXT>;<COLOR_ACTIVECAPTION>
1. The text color and
2. the foreground color of a progress bar indicating an active view.
The default values are retrieved from the "Window Color and Appearance"
settings.
2011-07-27 17:43:34 +00:00
: **Config_barCommands**=Run, explore doc;Monitor_toggleBar();Main_reload();Reload;ExitApp
The commands seperated by semicolon, which are listed in the command GUI
of the bar (#!) and therewith can be selected rather then typed; bug.n
functions (as used in the hotkey configuration), the "Run" and "Send"
2012-10-20 14:53:46 +00:00
command of AutoHotkey can be used here.
2011-07-27 17:43:34 +00:00
: **Config_readinBat**=0
If true (=1), the system battery status is read in and displayed in the
status bar. This only makes sense, if you have a system battery
2011-07-27 17:43:34 +00:00
(notebook).
: **Config_readinCpu**=0
If true (=1), the current CPU load is read in and displayed in the
status bar.
2011-07-27 17:43:34 +00:00
: **Config_readinDate**=1
If true (=1), the current date is read in (format: "WW, DD. MMM. YYYY")
and displayed in the status bar.
2011-07-27 17:43:34 +00:00
2012-10-20 14:53:46 +00:00
: **Config_readinDiskLoad**=0
If true (=1), the current disk load (read and write) is read in and
2012-10-20 14:53:46 +00:00
displayed in the status bar.
: **Config_readinMemoryUsage**=0
If true (=1), the system memory usage is read in and displayed in the
2012-10-20 14:53:46 +00:00
status bar.
: **Config_readinNetworkLoad**=0
If true (=1), the current network load (up and down) is read in and
2012-10-20 14:53:46 +00:00
displayed in the status bar.
2011-07-27 17:43:34 +00:00
: **Config_readinTime**=1
If true (=1), the current time is read in (format: "HH:MM") and
displayed in the status bar.
: **Config_readinInterval**=30000
Time in milliseconds after which the above status values are refreshed.
=== Windows UI ===
: **Config_bbCompatibility**=0
If true (=1), bug.n looks for BlackBox components (bbLeanBar, bbSlit
and SystemBarEx) when calculating the work area. It is assumed that the
virtual desktop functionality of BlackBox and NOT bug.n is used
(=> Hiding and showing windows is detected and acted upon).
2011-07-27 17:43:34 +00:00
: **Config_borderWidth**=0
If > 0, the window border width is set to the integer value
Config_borderWidth.
: **Config_borderPadding**=-1
If >= 0, the window border padding is set to the integer value
Config_borderPadding (only for Windows >= Vista).
2011-07-27 17:43:34 +00:00
: **Config_showTaskBar**=0
If false (=0), the task bar is hidden. It can be made visible or hidden
by hotkey (see below).
2011-07-27 17:43:34 +00:00
: **Config_showBorder**=1
If false (=0), the window borders are hidden; therefor windows cannot
be resized manually by dragging the border, even if using the according
hotkey.
2011-07-27 17:43:34 +00:00
: **Config_selBorderColor**=
Border colour of the active window; format: 0x00BBGGRR (e. g.
"0x006A240A", if = "", the system's window border colour is not
2011-07-27 17:43:34 +00:00
changed).
Config_borderWidth, Config_borderPadding and Config_selBorderColor are
especially usefull, if you are not allowed to set the design in the system
settings.
2011-07-27 17:43:34 +00:00
=== View / Layout ===
: **Config_viewNames**=1;2;3;4;5;6;7;8;9
The names of the views separated by a semicolon. This variable sets the
names of the views shown in the status bar and determines the nummber of
views (Config_viewCount); the total number of names given, i. e. views,
2012-10-20 14:53:46 +00:00
should not be exceeded by the configured hotkeys.
2011-07-27 17:43:34 +00:00
: **Config_layout_#1**=[]=;tile
The layout symbol and arrange function (the first entry is set as the
default layout, no layout function means floating behavior)
: **Config_layout_#2**=[M];monocle
: **Config_layout_#3**=><>;
: **Config_layoutCount**=3
Total number of layouts defined above.
: **Config_layoutAxis_#1**=1
2011-07-27 17:43:34 +00:00
The layout axis: 1 = x, 2 = y; negative values mirror the layout,
setting the master area to the right / bottom instead of left / top.
: **Config_layoutAxis_#2**=2
2011-07-27 17:43:34 +00:00
The master axis: 1 = x (from left to right), 2 = y (from top to
bottom), 3 = z (monocle).
: **Config_layoutAxis_#3**=2
2011-07-27 17:43:34 +00:00
The stack axis: 1 = x (from left to right), 2 = y (from top to
bottom), 3 = z (monocle).
2012-10-20 14:53:46 +00:00
: **Config_layoutGapWidth=0
The default gap width in px (only even numbers) of the "tile" layout,
2012-10-20 14:53:46 +00:00
i. e. the space between windows and around the layout.
2011-07-27 17:43:34 +00:00
: **Config_layoutMFactor**=0.6
The factor for the size of the master area, which is multiplied by the
monitor size.
2012-10-20 14:53:46 +00:00
: **Config_viewMargins**=0;0;0;0
The margin of a view (around the layout, "monocle" and "tile") as a
semicolon separated list of values in px (top;right;bottom;left), which
by default can be activated per view with the hotkey Win+Shift+N
2012-10-20 14:53:46 +00:00
(View_toggleMargins).
With view margins you may create an empty area on the monitor, which is
2012-10-20 14:53:46 +00:00
not occupied by the layout, therewith making a desktop widget visible.
2011-07-27 17:43:34 +00:00
=== Runtime ===
2012-10-20 14:53:46 +00:00
: **Config_ghostWndSubString**= (Not Responding)
The text string, which identifies a hung window in its title bar; the
2012-10-20 14:53:46 +00:00
german Windows version uses " (Keine Rückmeldung)".
2011-07-27 17:43:34 +00:00
: **Config_mouseFollowsFocus**=1
If true (=1), the mouse pointer is set over the focused window, if a
window is activated by bug.n.
2012-10-20 14:53:46 +00:00
: **Config_newWndPosition=top
The position of a new window in a view; "top": at the beginning of the
window list and the master area (default), "masterBottom": at the end
of the master area, "stackTop": on top of the stack area, "bottom": at
2012-10-20 14:53:46 +00:00
the end of the window list and the stack area.
: **Config_onActiveHiddenWnds**=view
The action, which will be taken, if a window e. g. should be
activated, but is not visible; "view": show the view accordng to the
first tag of the window in question, "tag": add the window in question
to the current visible view, "hide": hide the window again ignoring the
activation.
2011-07-27 17:43:34 +00:00
: **Config_shellMsgDelay**=350
The time bug.n waits after a shell message (a window is opened, closed
or the focus has been changed); if there are any problems recognizing,
when windows are opened or closed, try to increase this number.
: **Config_syncMonitorViews**=0
The number of monitors (2 or more), for which views should be
activated, when using the accordant hotkey. If set to 1, the views are
2012-10-20 14:53:46 +00:00
activated for all monitors. If set to 0, views are activated
independently (only on the active monitor).
2011-07-27 17:43:34 +00:00
: **Config_viewFollowsTagged**=0
If true (=1) and a window is tagged with a single tag, the view is
correspondingly set to the tag.
2011-07-27 17:43:34 +00:00
=== Rules ===
2012-10-20 14:53:46 +00:00
: **Config_rule_#1**=.*;.*;;1;0;0;0;0;0;
If you want to replace a default rule, you will have to use the
correct variable name, e. g. you may set a rule (.*;.*;) for a default
monitor, view and / or showing window title bars by setting the first
rule "Config_rule_#1=..." and therewith replacing the value.
If you want to add a rule you do not have to use a numbered variable,
but "Config_rule=..." (the numbering will be done automatically in the
order given in the configuration file). General format:
2012-10-20 14:53:46 +00:00
Config_rule_#<i>=<class (regular expression string)>;<title (regular
expression string)>;<window style (hexadecimal number or blank)>;
<is managed (1 = True or 0 = False)>;<monitor (0 <= integer <= total
number of monitors, 0 means the currently active monitor)>;<tags
(binary mask as integer >= 0, e. g. 17 for 1 and 5, 0 means the
currently active tag)>;<is floating (1 = True or 0 = False)>;
<is decorated (1 = True or 0 = False)>;<hide title (1 = True or
2012-10-20 14:53:46 +00:00
0 = False)>;<action on single windows (Close or Maximize)>
(all in one line, ";" is not allowed as a character)
2012-10-20 14:53:46 +00:00
: **Config_rule_#2**=.*;.*;0x80000000;0;0;0;1;1;1;
2011-07-27 17:43:34 +00:00
Pop-up windows (style WS_POPUP=0x80000000) will not be managed, are
floating and the titles are hidden.
2012-10-20 14:53:46 +00:00
: **Config_rule_#3**=SWT_Window0;.*;;1;0;0;0;0;0;
2011-07-27 17:43:34 +00:00
Windows created by Java (SWT) e. g. Eclipse have the style WS_POPUP,
2012-10-20 14:53:46 +00:00
but should be excluded from the second rule.
: **Config_rule_#4**=QWidget;.*;;1;0;0;0;0;0;
Also windows created by QT (QWidget) should be excluded from the second
2012-10-20 14:53:46 +00:00
rule for the same reason as above.
: **Config_rule_#5**=Xming;.*;;1;0;0;0;0;0;
Also Xming windows should be excluded from the second rule for the same
2012-10-20 14:53:46 +00:00
reason as above.
: **Config_rule_#6**=MsiDialog(No)?CloseClass;.*;;1;0;0;1;1;0;
: **Config_rule_#7**=AdobeFlashPlayerInstaller;.*;;1;0;0;1;0;1;
: **Config_rule_#8**=CalcFrame;.*;;1;0;0;1;1;0;
: **Config_rule_#9**=MozillaDialogClass;.*;;1;0;0;1;1;0;
: **Config_rule_#10**=_sp;_sp;;1;0;0;1;0;1;
: **Config_rule_#11**=MozillaWindowClass;.* - Mozilla Firefox;;1;0;0;0;1;0;Maximize
: **Config_rule_#12**=Chrome_WidgetWin_1;.*;;1;0;0;0;1;0;Maximize
2011-07-27 17:43:34 +00:00
=== Session management ===
: **Config_autoSaveSession**=0
Automatically save the current state of monitors, views, layouts (active
view, layout, axes, mfact and msplit) to the configuration file when
quitting bug.n.
2011-07-27 17:43:34 +00:00
=== Hotkeys ===
: **Config_hotkey**=<key name>::<command or function name>
2011-07-27 17:43:34 +00:00
You may overwrite default or add new hotkeys by using the above
format. "<key name>::<command or function name>" is the original
2011-07-27 17:43:34 +00:00
syntax from AutoHotkey as described in
http://www.autohotkey.com/docs/Hotkeys.htm.
- To deacivate a default hotkey as listed in %%LINK_hotkeys, add a new
line in the format "Config_hotkey=<key name>::" (without a
2011-07-27 17:43:34 +00:00
function name).
- To assign an internal function of bug.n to a new hotkey, add a line
as documented in %%LINK_hotkeys, but with the new key name.
- To assign an external program to a new hotkey, add a line in the
general format using the "Run" command of AutoHotkey as described in
http://www.autohotkey.com/docs/commands/Run.htm ("Run, Target [,
WorkingDir, Max|Min|Hide]").
- You may also use the "Send" command of AutoHotkey as described in
http://www.autohotkey.com/docs/commands/Send.htm
''<BR>''
%%html: ''' <DIV CLASS="footer">
2011-07-27 17:43:34 +00:00
------------------------------------------------------------------------
%%txt: (c) 2010-2012 Joshua Fuhs, joten. Last modified %%date(%d.%m.%Y).
%%html: | (c) 2010-2012 Joshua Fuhs, joten. Last modified %%date(%d.%m.%Y). | [jn.png]
%%html: ''' </DIV>
%%html: ''' </DIV>