added configuration_variables.md
with some formatting tests
This commit is contained in:
joten
parent
8306f75b8f
commit
dd5da73b45
1 changed files with 298 additions and 0 deletions
|
|
@ -0,0 +1,298 @@
|
|||
## Configuration variables
|
||||
|
||||
### Status bar
|
||||
|
||||
`Config_showBar=1`
|
||||
> If false (=0), the bar is hidden. It can be made visible or hidden by hotkey
|
||||
(see below).
|
||||
|
||||
`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.
|
||||
|
||||
`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=`
|
||||
> Font size in pixel. The default value is retrieved from the "Window Color and
|
||||
Appearance" settings for the "Active Title Bar".
|
||||
|
||||
`Config_largeFontSize=24`
|
||||
> Font size in pixel, i, a, for the numbering of areas in the area trace.
|
||||
|
||||
`Config_normBgColor=`
|
||||
> 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=`
|
||||
> 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=`
|
||||
> 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=`
|
||||
> 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.
|
||||
|
||||
`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" command of
|
||||
AutoHotkey can be used here.
|
||||
|
||||
`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 (notebook).
|
||||
|
||||
`Config_readinCpu=0`
|
||||
> If true (=1), the current CPU load is read in and displayed in the status bar.
|
||||
|
||||
`Config_readinDate=1`
|
||||
> If true (=1), the current date is read in (format: "WW, DD. MMM. YYYY") and
|
||||
displayed in the status bar.
|
||||
|
||||
`Config_readinDiskLoad=0`
|
||||
> If true (=1), the current disk load (read and write) is read in and displayed
|
||||
in the status bar.
|
||||
|
||||
`Config_readinMemoryUsage=0`
|
||||
> If true (=1), the system memory usage is read in and displayed in the status
|
||||
bar.
|
||||
|
||||
`Config_readinNetworkLoad=0`
|
||||
> If not false (=0) and given an identifying string for the network interface,
|
||||
which should be monitored, the current network load (up and down) is read in
|
||||
and displayed in the status bar.
|
||||
|
||||
`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 elements
|
||||
|
||||
`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).
|
||||
|
||||
`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).
|
||||
|
||||
`Config_showTaskBar=0`
|
||||
> If false (=0), the task bar is hidden. It can be made visible or hidden by
|
||||
hotkey (see below).
|
||||
|
||||
`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.
|
||||
|
||||
`Config_selBorderColor=`
|
||||
>> Border colour of the active window; format: 0x00BBGGRR (e. g. "0x006A240A",
|
||||
if = "", all without the quotation marks, the system's window border colour is
|
||||
not changed).
|
||||
|
||||
|
||||
### Window arrangement
|
||||
|
||||
`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, should not be
|
||||
exceeded by the configured hotkeys.
|
||||
|
||||
`Config_layout_#1=[]=;tile`
|
||||
`Config_layout_#2=[M];monocle`
|
||||
`Config_layout_#3=><>;`
|
||||
> The layout symbol and arrange function (the first entry is set as the default
|
||||
layout, no layout function means floating behavior)
|
||||
|
||||
`Config_layoutCount=3`
|
||||
> Total number of layouts defined above.
|
||||
|
||||
`Config_layoutAxis_#1=1`
|
||||
> 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`
|
||||
> The master axis: 1 = x (from left to right), 2 = y (from top to bottom),
|
||||
3 = z (monocle).
|
||||
|
||||
`Config_layoutAxis_#3=2`
|
||||
> The stack axis: 1 = x (from left to right), 2 = y (from top to bottom),
|
||||
3 = z (monocle).
|
||||
|
||||
`Config_layoutGapWidth=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 (notebook).
|
||||
|
||||
`Config_layoutMFactor=0.6`
|
||||
> The factor for the size of the master area, which is multiplied by the
|
||||
monitor size.
|
||||
|
||||
`Config_areaTraceTimeout=1000`
|
||||
> The time in milliseconds, for which the area trace is shown.
|
||||
The area trace indicates the areas in the "tile" layout, which can be used to
|
||||
manually resize and position windows by hotkey. See also `View_moveWindow(<n>)`
|
||||
and `View_traceAreas()` in the listing of hotkeys.
|
||||
|
||||
`Config_continuouslyTraceAreas=0`
|
||||
> If true (=1), the area trace is continuously shown over the desktop.
|
||||
|
||||
`Config_dynamicTiling=1`
|
||||
> If true (=1), windows are dynamically tiled i. e. the layout is reset and
|
||||
therewith all windows resized and positioned automatically, if new windows are
|
||||
created or existing destroyed or moved.
|
||||
If false (=0) you may use manual tiling.
|
||||
|
||||
`Config_ghostWndSubString= (Not Responding)`
|
||||
> The text string, which identifies a hung window in its title bar; the german
|
||||
Windows version uses " (Keine Rückmeldung)".
|
||||
|
||||
`Config_mouseFollowsFocus=1`
|
||||
> If true (=1), the mouse pointer is set over the focused window, if a window
|
||||
is activated by bug.n.
|
||||
|
||||
`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 (View_toggleMargins).
|
||||
With view margins you may create an empty area on the monitor, which is not
|
||||
occupied by the layout, therewith making a desktop widget visible.
|
||||
|
||||
`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 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.
|
||||
|
||||
`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 activated for all
|
||||
monitors. If set to 0, views are activated independently (only on the active
|
||||
monitor).
|
||||
|
||||
`Config_viewFollowsTagged=0`
|
||||
> If true (=1) and a window is tagged with a single tag, the view is
|
||||
correspondingly set to the tag.
|
||||
|
||||
|
||||
### Rules
|
||||
`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:
|
||||
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
|
||||
0 = False)>;<action on single windows (Close or Maximize)>
|
||||
(all in one line, ";" is not allowed as a character)
|
||||
|
||||
`Config_rule_#2=.*;.*;0x80000000;0;0;0;1;1;1;`
|
||||
> Pop-up windows (style WS_POPUP=0x80000000) will not be managed, are floating
|
||||
and the titles are hidden.
|
||||
|
||||
`Config_rule_#3=SWT_Window0;.*;;1;0;0;0;0;0;`
|
||||
> Windows created by Java (SWT) e. g. Eclipse have the style WS_POPUP, 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 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
|
||||
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`
|
||||
|
||||
`Config_ruleCount=12`
|
||||
> This variable will be automatically set to the total number of active rules
|
||||
above.
|
||||
|
||||
|
||||
### Configuration management
|
||||
|
||||
**`Config_autoSaveSession=auto`**
|
||||
Automatically save the current state of monitors, views, layouts (active
|
||||
view, layout, axes, mfact and msplit) and windows to the configuration files in
|
||||
the data directory of bug.n. Possible values are `off`, `auto` and `ask`.
|
||||
|
||||
**`Config_maintenanceInterval=5000`**
|
||||
The interval in milliseconds, in which the session will be automatically
|
||||
saved to especially support the recovery of window states after bug.n
|
||||
unintentionally quits.
|
||||
Loading…
Reference in a new issue