Cynosphere/bug.n
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fixed typos and abbreviations from issue #138

Browse source 
...but without the "key shortcuts"
This commit is contained in:
joten 2018-01-14 22:53:01 +01:00
parent a8e7c8926e
commit e358ef5415
10 changed files with 57 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/CHANGES.md
View file

@ -15,7 +15,7 @@
4. `~` Revised the following functions to allow setting absolute and relative values: `Debug_setLogLevel`, 4. `~` Revised the following functions to allow setting absolute and relative values: `Debug_setLogLevel`,
`Manager_activateMonitor`, `Manager_setViewMonitor`, `Manager_setWindowMonitor`, `Monitor_activateView`, `Monitor_setWindowTag`, `Manager_activateMonitor`, `Manager_setViewMonitor`, `Manager_setWindowMonitor`, `Monitor_activateView`, `Monitor_setWindowTag`,
`View_setGapWidth`, `View_setLayout`, `View_setMFactor`, `View_shuffleWindow`. `View_setGapWidth`, `View_setLayout`, `View_setMFactor`, `View_shuffleWindow`.
5. `~` Revised the interface, i. e. the parameters, of the following functions for setting absolute and relative values -- but did 5. `~` Revised the interface, i.e. the parameters, of the following functions for setting absolute and relative values -- but did
not implement the functionality: `Monitor_toggleWindowTag`, `View_activateWindow`. not implement the functionality: `Monitor_toggleWindowTag`, `View_activateWindow`.
6. `~` Revised the bar color scheme. 6. `~` Revised the bar color scheme.
7. `~` Revised the rule layout. The third parameter is not compared to the window style anymore, but is a function name, which is 7. `~` Revised the rule layout. The third parameter is not compared to the window style anymore, but is a function name, which is

8
doc/Configuring_rules.md
View file

@ -3,7 +3,7 @@
### General description ### General description
Not all windows should be managed by bug.n the same way, or even may not be Not all windows should be managed by bug.n the same way, or even may not be
managable at all. To handle windows differently, you can add rules to the manageable at all. To handle windows differently, you can add rules to the
configuration. configuration.
The general format of a rule added to `Config.ini` is as follows (all in one The general format of a rule added to `Config.ini` is as follows (all in one
@ -27,7 +27,7 @@ following information:
1. class (as a regular expression) 1. class (as a regular expression)
2. title (as a regular expression) 2. title (as a regular expression)
3. arbitrary criterion (as a function name, e. g. "Window_isPopup", or blank) 3. arbitrary criterion (as a function name, e.g. "Window_isPopup", or blank)
With the second part you can give bug.n the following information on how to With the second part you can give bug.n the following information on how to
handle the identified windows: handle the identified windows:
@ -37,14 +37,14 @@ handle the identified windows:
0 means the currently active monitor)? 0 means the currently active monitor)?
3. On which views should the window be set (given as a binary mask converted to 3. On which views should the window be set (given as a binary mask converted to
an integer >= 0, 0 means the currently active view)? an integer >= 0, 0 means the currently active view)?
4. Is the window floating, i. e. should not be tiled (0 = no, 1 = yes)? 4. Is the window floating, i.e. should not be tiled (0 = no, 1 = yes)?
5. Is the window decorated (0 = no, 1 = yes)? If not, the window title bar is 5. Is the window decorated (0 = no, 1 = yes)? If not, the window title bar is
removed. removed.
6. Should the title text be hidden in the bug.n bar (0 = no, 1 = yes)? 6. Should the title text be hidden in the bug.n bar (0 = no, 1 = yes)?
7. A special single window action (`close` or `maximize` or blank). 7. A special single window action (`close` or `maximize` or blank).
If you want to replace a rule, which is already set in `Config.ahk`, you will If you want to replace a rule, which is already set in `Config.ahk`, you will
have to use the correct variable name; e. g. you may set a default rule have to use the correct variable name; e.g. you may set a default rule
(identifying part: `.*;.*;`), overwriting the first rule set in `Config.ahk`, (identifying part: `.*;.*;`), overwriting the first rule set in `Config.ahk`,
by using the variable name `Config_rule_#1`. If you want to _add_ a rule, by using the variable name `Config_rule_#1`. If you want to _add_ a rule,
simply use `Config_rule` as the variable name; the numbering will be done simply use `Config_rule` as the variable name; the numbering will be done

12
doc/Customization.md
View file

@ -4,17 +4,17 @@ bug.n can be customized by setting configuration variables and hotkeys (the key
bindings for the bug.n functions). bindings for the bug.n functions).
To change either of them, first create a configuration file (`Config.ini`) by To change either of them, first create a configuration file (`Config.ini`) by
using the hotkey `#^s`, i. e. <kbd>Win</kbd><kbd>Ctrl</kbd><kbd>S</kbd>. The using the hotkey `#^s`, i.e. <kbd>Win</kbd><kbd>Ctrl</kbd><kbd>S</kbd>. The
file is either saved in the directory you specified with the parameter to the file is either saved in the directory you specified with the parameter to the
executable or script when running bug.n, or in the Windows user directory executable or script when running bug.n, or in the Windows user directory
(e. g. `C:\Users\joten\AppData\Roaming\bug.n`). (e.g. `C:\Users\joten\AppData\Roaming\bug.n`).
You may then edit the file with a text editor, i. a. using the hotkey `#^e` You may then edit the file with a text editor, i.a. using the hotkey `#^e`
(<kbd>Win</kbd><kbd>Ctrl</kbd><kbd>E</kbd>), and add a new line for each (<kbd>Win</kbd><kbd>Ctrl</kbd><kbd>E</kbd>), and add a new line for each
configuration variable with its value; the general format is configuration variable with its value; the general format is
`<variable>=<value>` not using quotation marks surrounding the values. `<variable>=<value>` not using quotation marks surrounding the values.
If you want to set a boolean value, use `1` for "True" and `0` for "False"; If you want to set a boolean value, use `1` for "True" and `0` for "False";
e. g. `Config_showBar=0`. You will have to reload bug.n for the changes to take e.g. `Config_showBar=0`. You will have to reload bug.n for the changes to take
effect. effect.
To set a hotkey, use the variable name `Config_hotkey` and [the hotkey notation To set a hotkey, use the variable name `Config_hotkey` and [the hotkey notation
@ -42,9 +42,9 @@ You may find a sample and template configuration file in the
The hotkey `#l` (<kbd>Win</kbd><kbd>L</kbd>) is set by Microsoft Windows to The hotkey `#l` (<kbd>Win</kbd><kbd>L</kbd>) is set by Microsoft Windows to
lock the workstation. If you want to use it as a hotkey in bug.n, you can bind lock the workstation. If you want to use it as a hotkey in bug.n, you can bind
another hotkey, e. g. `#^+l` another hotkey, e.g. `#^+l`
(<kbd>Win</kbd><kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>L</kbd>), to the lock (<kbd>Win</kbd><kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>L</kbd>), to the lock
function by using the bug.n-function `Manager_lockWorkStation()`, which i. a. function by using the bug.n-function `Manager_lockWorkStation()`, which i.a.
sets the registry key sets the registry key
`Software\Microsoft\Windows\CurrentVersion\Policies\System\DisableLockWorkstation` `Software\Microsoft\Windows\CurrentVersion\Policies\System\DisableLockWorkstation`
and locks the workstation. This than allows to set `#l` as a hotkey in and locks the workstation. This than allows to set `#l` as a hotkey in

34
doc/Default_configuration.md
View file

@ -56,7 +56,7 @@ Appearance" settings for the "Active Title Bar".
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_largeFontSize=24` `Config_largeFontSize=24`
Font size in pixel, i. a. for the numbering of areas in the area trace. Font size in pixel, i.a. for the numbering of areas in the area trace.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_backColor_#1=<COLOR_GRADIENTINACTIVECAPTION>;<COLOR_ACTIVECAPTION>;<COLOR_MENU>;<COLOR_ACTIVECAPTION>;<COLOR_MENU>;<COLOR_ACTIVECAPTION>;<COLOR_GRADIENTINACTIVECAPTION>;<COLOR_GRADIENTACTIVECAPTION>;<COLOR_GRADIENTACTIVECAPTION>` `Config_backColor_#1=<COLOR_GRADIENTINACTIVECAPTION>;<COLOR_ACTIVECAPTION>;<COLOR_MENU>;<COLOR_ACTIVECAPTION>;<COLOR_MENU>;<COLOR_ACTIVECAPTION>;<COLOR_GRADIENTINACTIVECAPTION>;<COLOR_GRADIENTACTIVECAPTION>;<COLOR_GRADIENTACTIVECAPTION>`
@ -84,14 +84,14 @@ elaborate example have a look at [joten_01.ini](../usr/joten_01.ini).
`Config_backColor_#2=<COLOR_GRADIENTACTIVECAPTION>;;;;;;;<COLOR_MENU>;<COLOR_MENU>` `Config_backColor_#2=<COLOR_GRADIENTACTIVECAPTION>;;;;;;;<COLOR_MENU>;<COLOR_MENU>`
The background color of bar elements, which are highlighted depending on the The background color of bar elements, which are highlighted depending on the
status, i. a. the active view, a discharging battery and the sound volume, if status, i.a. the active view, a discharging battery and the sound volume, if
it is not muted. it is not muted.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_backColor_#3=;;;;;;;ff8040;` `Config_backColor_#3=;;;;;;;ff8040;`
The background color of bar elements, which are highlighted depending on the The background color of bar elements, which are highlighted depending on the
status, i. a. a discharging battery with a battery level lower than 10%. status, i.a. a discharging battery with a battery level lower than 10%.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_foreColor_#1=<COLOR_INACTIVECAPTION>;<COLOR_ACTIVECAPTION>;<COLOR_MENU>;<COLOR_ACTIVECAPTION>;<COLOR_MENU>;<COLOR_ACTIVECAPTION>;<COLOR_INACTIVECAPTION>;<COLOR_ACTIVECAPTION>;<COLOR_GRADIENTINACTIVECAPTION>` `Config_foreColor_#1=<COLOR_INACTIVECAPTION>;<COLOR_ACTIVECAPTION>;<COLOR_MENU>;<COLOR_ACTIVECAPTION>;<COLOR_MENU>;<COLOR_ACTIVECAPTION>;<COLOR_INACTIVECAPTION>;<COLOR_ACTIVECAPTION>;<COLOR_GRADIENTINACTIVECAPTION>`
@ -104,14 +104,14 @@ foreground depends on the value of the progress bar.
`Config_foreColor_#2=<COLOR_ACTIVECAPTION>;;;;;;;<COLOR_HIGHLIGHT>;<COLOR_HIGHLIGHT>` `Config_foreColor_#2=<COLOR_ACTIVECAPTION>;;;;;;;<COLOR_HIGHLIGHT>;<COLOR_HIGHLIGHT>`
The foreground color of bar elements, which are highlighted depending on the The foreground color of bar elements, which are highlighted depending on the
status, i. a. the active view, a discharging battery and the sound volume, if status, i.a. the active view, a discharging battery and the sound volume, if
it is not muted. it is not muted.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_foreColor_#3=;;;;;;;<COLOR_INACTIVECAPTION>;` `Config_foreColor_#3=;;;;;;;<COLOR_INACTIVECAPTION>;`
The foreground color of bar elements, which are highlighted depending on the The foreground color of bar elements, which are highlighted depending on the
status, i. a. a discharging battery with a battery level lower than 10%. status, i.a. a discharging battery with a battery level lower than 10%.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_fontColor_#1=<COLOR_INACTIVECAPTIONTEXT>;<COLOR_CAPTIONTEXT>;<COLOR_MENUTEXT>;<COLOR_CAPTIONTEXT>;<COLOR_MENUTEXT>;<COLOR_CAPTIONTEXT>;<COLOR_INACTIVECAPTIONTEXT>;<COLOR_CAPTIONTEXT>;<COLOR_INACTIVECAPTIONTEXT>` `Config_fontColor_#1=<COLOR_INACTIVECAPTIONTEXT>;<COLOR_CAPTIONTEXT>;<COLOR_MENUTEXT>;<COLOR_CAPTIONTEXT>;<COLOR_MENUTEXT>;<COLOR_CAPTIONTEXT>;<COLOR_INACTIVECAPTIONTEXT>;<COLOR_CAPTIONTEXT>;<COLOR_INACTIVECAPTIONTEXT>`
@ -122,14 +122,14 @@ The default font color for the text of bar elements.
`Config_fontColor_#2=<COLOR_CAPTIONTEXT>;;;;;;;<COLOR_MENUTEXT>;<COLOR_MENUTEXT>` `Config_fontColor_#2=<COLOR_CAPTIONTEXT>;;;;;;;<COLOR_MENUTEXT>;<COLOR_MENUTEXT>`
The font color of bar elements, which are highlighted depending on the The font color of bar elements, which are highlighted depending on the
status, i. a. the active view, a discharging battery and the sound volume, if status, i.a. the active view, a discharging battery and the sound volume, if
it is not muted. it is not muted.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_fontColor_#3=;;;;;;;<COLOR_INACTIVECAPTIONTEXT>;` `Config_fontColor_#3=;;;;;;;<COLOR_INACTIVECAPTIONTEXT>;`
The fontground color of bar elements, which are highlighted depending on the The fontground color of bar elements, which are highlighted depending on the
status, i. a. a discharging battery with a battery level lower than 10%. status, i.a. a discharging battery with a battery level lower than 10%.
> The default color values are retrieved from the "Window Color and Appearance" > The default color values are retrieved from the "Window Color and Appearance"
settings. settings.
@ -145,7 +145,7 @@ visible at all, if `Config_barTransparency` is not set to `off`.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_barCommands=Run, explore doc;Monitor_toggleBar();Reload;ExitApp` `Config_barCommands=Run, explore doc;Monitor_toggleBar();Reload;ExitApp`
The commands seperated by semicolon, which are listed in the command GUI of The commands separated by semicolon, which are listed in the command GUI of
the bar (#!) and therewith can be selected rather then typed; bug.n functions 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 (as used in the hotkey configuration), the `Run` and `Send` command of
AutoHotkey can be used here. AutoHotkey can be used here.
@ -257,7 +257,7 @@ resized manually by dragging the border, even if using the according hotkey
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_selBorderColor=` `Config_selBorderColor=`
Border colour of the active window, format: 0x00BBGGRR; e. g. `0x006A240A`, Border colour of the active window, format: 0x00BBGGRR; e.g. `0x006A240A`,
if `=0`, the system's window border colour is not changed (supported Windows if `=0`, the system's window border colour is not changed (supported Windows
versions: _not_ 10). versions: _not_ 10).
@ -267,7 +267,7 @@ versions: _not_ 10).
The names of the views separated by a semicolon. This variable sets the names 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 number of views of the views shown in the status bar and determines the number of views
(`Config_viewCount`); the total number of names given, i. e. views, should not (`Config_viewCount`); the total number of names given, i.e. views, should not
be exceeded by the configured hotkeys. be exceeded by the configured hotkeys.
Config_layout_#1=[]=;tile Config_layout_#1=[]=;tile
@ -303,7 +303,7 @@ The stack axis: 1 = x (from left to right), 2 = y (from top to bottom),
`Config_layoutGapWidth=0` `Config_layoutGapWidth=0`
The default gap width in px (only even numbers) used in the "tile" and The default gap width in px (only even numbers) used in the "tile" and
"monocle" layout, i. e. the space between windows and around the layout. "monocle" layout, i.e. the space between windows and around the layout.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_layoutMFactor=0.6` `Config_layoutMFactor=0.6`
@ -327,7 +327,7 @@ If true (`=1`), the area trace is continuously shown over the desktop.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_dynamicTiling=1` `Config_dynamicTiling=1`
If true (`=1`), windows are dynamically tiled i. e. the layout is reset and 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 therewith all windows resized and positioned automatically, if new windows are
created or existing destroyed or moved. created or existing destroyed or moved.
If false (`=0`) you may use manual tiling. If false (`=0`) you may use manual tiling.
@ -363,8 +363,8 @@ list and the stack area.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_onActiveHiddenWnds=view` `Config_onActiveHiddenWnds=view`
The action, which will be taken, if a window e. g. should be activated, but 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 is not visible; `view`: show the view according to the first tag of the window
in question, `tag`: add the window in question to the current visible view, in question, `tag`: add the window in question to the current visible view,
`hide`: hide the window again ignoring the activation. `hide`: hide the window again ignoring the activation.
@ -408,7 +408,7 @@ the [specific documentation](./Configuring_rules.md).
`Config_rule_#1=.*;.*;;1;0;0;0;0;0;` `Config_rule_#1=.*;.*;;1;0;0;0;0;0;`
By default all windows are managed, not allocated on a specific monitor or By default all windows are managed, not allocated on a specific monitor or
view, not floating (i. e. tiled), the window title bar is not visible, the view, not floating (i.e. tiled), the window title bar is not visible, the
title is not hidden on the bug.n status bar and no window action is taken, when title is not hidden on the bug.n status bar and no window action is taken, when
the window first is created. the window first is created.
@ -433,7 +433,7 @@ excluded from the preceding rule.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_rule_#5=SWT_Window0;.*;;1;0;0;0;0;0;` `Config_rule_#5=SWT_Window0;.*;;1;0;0;0;0;0;`
Also windows created by Java (SWT) e. g. Eclipse should be excluded from the Also windows created by Java (SWT) e.g. Eclipse should be excluded from the
second rule for the same reason as above. second rule for the same reason as above.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -518,5 +518,5 @@ unintentionally quits.
`Config_monitorDisplayChangeMessages=1` `Config_monitorDisplayChangeMessages=1`
If true (`=1`) bug.n reacts on `WM_DISPLAYCHANGE` system messages asking to If true (`=1`) bug.n reacts on `WM_DISPLAYCHANGE` system messages asking to
reset the monitor configuration, e. g. if a monitor is dis-/connected or the reset the monitor configuration, e.g. if a monitor is dis-/connected or the
monitor resolution is changed. monitor resolution is changed.

32
doc/Default_hotkeys.md
View file

@ -13,7 +13,7 @@ Possible modifiers are the following:
* `+` <kbd>Shift</kbd> * `+` <kbd>Shift</kbd>
You will have to press all keys of a hotkey at the same time beginning with the You will have to press all keys of a hotkey at the same time beginning with the
modifier for calling the associated function, e. g. `#^q` means pressing the modifier for calling the associated function, e.g. `#^q` means pressing the
left 'Windows key' and the 'Control key' and the 'Q key' left 'Windows key' and the 'Control key' and the 'Q key'
(<kbd>Win</kbd><kbd>Ctrl</kbd><kbd>Q</kbd>) for quitting bug.n. (<kbd>Win</kbd><kbd>Ctrl</kbd><kbd>Q</kbd>) for quitting bug.n.
@ -63,7 +63,7 @@ _Show / Hide the title bar_ of the active window.
_Toggle_ the _floating status_ of the active window. _Toggle_ the _floating status_ of the active window.
> The floating status effects the tiling of the active window (i. e. dis- / > The floating status effects the tiling of the active window (i.e. dis- /
regard it). regard it).
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -219,11 +219,11 @@ _Reduce_ the size of _the master area_ in the active view.
> This has only an effect, if the tile layout is active. > This has only an effect, if the tile layout is active.
> You may also set an additional parameter for accelerating the third one. E. g. > You may also set an additional parameter for accelerating the third one. E.g.
with `Config_hotkey=#Left::View_setLayoutProperty(MFactor, 0, -0.05, 2)` the with `Config_hotkey=#Left::View_setLayoutProperty(MFactor, 0, -0.05, 2)` the
first step, by which the master area is reduced, is -0.0016% and will be first step, by which the master area is reduced, is -0.0016% and will be
doubled with consecutive calls until it reaches -0.05%. doubled with consecutive calls until it reaches -0.05%.
With the second parameter you may set an absolute value, e. g. With the second parameter you may set an absolute value, e.g.
`View_setLayoutProperty(MFactor, 0.5, 0)` splits the view in half. `View_setLayoutProperty(MFactor, 0.5, 0)` splits the view in half.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -233,11 +233,11 @@ _Enlarge_ the size of _the master area_ in the active view.
> This has only an effect, if the tile layout is active. > This has only an effect, if the tile layout is active.
> You may also set a additional parameter for accelerating the third one. E. g. > You may also set a additional parameter for accelerating the third one. E.g.
with `Config_hotkey=#Right::View_setLayoutProperty(MFactor, 0, +0.05, 0.5)` the with `Config_hotkey=#Right::View_setLayoutProperty(MFactor, 0, +0.05, 0.5)` the
first step, by which the master area is reduced, is 0.05%, but with consecutive first step, by which the master area is reduced, is 0.05%, but with consecutive
calls it will be halved until it reaches 0.0016%. calls it will be halved until it reaches 0.0016%.
With the second parameter you may set an absolute value, e. g. With the second parameter you may set an absolute value, e.g.
`View_setLayoutProperty(MFactor, 0.67, 0)` makes the master area two thirds `View_setLayoutProperty(MFactor, 0.67, 0)` makes the master area two thirds
and the stacking area one third the size of the view. and the stacking area one third the size of the view.
@ -246,7 +246,7 @@ and the stacking area one third the size of the view.
Rotate the layout axis. Rotate the layout axis.
> I. e. 2 -> 1 = vertical layout, 1 -> 2 = horizontal layout. > I.e. 2 -> 1 = vertical layout, 1 -> 2 = horizontal layout.
> This has only an effect, if the tile layout is active. > This has only an effect, if the tile layout is active.
@ -255,7 +255,7 @@ Rotate the layout axis.
Mirror the layout axis. Mirror the layout axis.
> I. e. -1 -> 1 / 1 -> -1 = master on the left / right side, > I.e. -1 -> 1 / 1 -> -1 = master on the left / right side,
-2 -> 2 / 2 -> -2 = master at top / bottom. -2 -> 2 / 2 -> -2 = master at top / bottom.
> This has only an effect, if the tile layout is active. > This has only an effect, if the tile layout is active.
@ -265,7 +265,7 @@ Mirror the layout axis.
Rotate the master axis. Rotate the master axis.
> I. e. 3 -> 1 = x-axis = horizontal stack, 1 -> 2 = y-axis = vertical stack, > I.e. 3 -> 1 = x-axis = horizontal stack, 1 -> 2 = y-axis = vertical stack,
2 -> 3 = z-axis = monocle. 2 -> 3 = z-axis = monocle.
> This has only an effect, if the tile layout is active. > This has only an effect, if the tile layout is active.
@ -275,7 +275,7 @@ Rotate the master axis.
Rotate the stack axis. Rotate the stack axis.
> I. e. 3 -> 1 = x-axis = horizontal stack, 1 -> 2 = y-axis = vertical stack, > I.e. 3 -> 1 = x-axis = horizontal stack, 1 -> 2 = y-axis = vertical stack,
2 -> 3 = z-axis = monocle. 2 -> 3 = z-axis = monocle.
> This has only an effect, if the tile layout is active. > This has only an effect, if the tile layout is active.
@ -326,7 +326,7 @@ Minimum of 1.
_Decrease the gap between windows_ in "monocle" and "tile" layout. _Decrease the gap between windows_ in "monocle" and "tile" layout.
> You may also set an absolute value for the gap width by using the first > You may also set an absolute value for the gap width by using the first
parameter, e. g. `View_setLayoutProperty(GapWidth, 0, 0)` will eliminate the parameter, e.g. `View_setLayoutProperty(GapWidth, 0, 0)` will eliminate the
gap and `View_setLayoutProperty(GapWidth, 20, 0)` will set it to 20px. gap and `View_setLayoutProperty(GapWidth, 20, 0)` will set it to 20px.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -386,7 +386,7 @@ is not / is already set.
Activate the _next monitor_ in a multi-monitor environment. Activate the _next monitor_ in a multi-monitor environment.
> You may also activate a specific monitor by using the first parameter, e. g. > You may also activate a specific monitor by using the first parameter, e.g.
`Manager_activateMonitor(1)` will activate the first monitor. `Manager_activateMonitor(1)` will activate the first monitor.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -401,7 +401,7 @@ _Set_ the active window's view _to_ the active view on _the next monitor_ in a
multi-monitor environment. multi-monitor environment.
> You may also set the active window on a specific monitor by using the first > You may also set the active window on a specific monitor by using the first
parameter, e. g. `Manager_setWindowMonitor(1)` will set the active window on parameter, e.g. `Manager_setWindowMonitor(1)` will set the active window on
the first monitor. the first monitor.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -417,7 +417,7 @@ _Set all windows_ of the active view _on_ the active view of _the next monitor_
in a multi-monitor environment. in a multi-monitor environment.
> You may also set all windows of the active view on a specific monitor by > You may also set all windows of the active view on a specific monitor by
using the first parameter, e. g. `Manager_setViewMonitor(1)` will set all using the first parameter, e.g. `Manager_setViewMonitor(1)` will set all
windows of the active view on the first monitor. windows of the active view on the first monitor.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -469,9 +469,9 @@ _Save the current state_ of monitors, views, layouts to the configuration file.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
`Config_hotkey=#^r::Reload` `Config_hotkey=#^r::Reload`
_Reload_ bug.n (i. e. the whole script). _Reload_ bug.n (i.e. the whole script).
> This resets i. a. the configuration and internal variables of bug.n, > This resets i.a. the configuration and internal variables of bug.n,
including the window lists. It is like Quitting and restarting bug.n. including the window lists. It is like Quitting and restarting bug.n.
If `Config_autoSaveSession` is not set to `off`, the window lists can be If `Config_autoSaveSession` is not set to `off`, the window lists can be
restored and windows are put to their associated monitor and views. restored and windows are put to their associated monitor and views.

14
doc/Installing_and_running.md
View file

@ -18,17 +18,17 @@ There is no installation process for bug.n. Unpack the `zip` file, and you
should be able to run either the executable as it is or the main script should be able to run either the executable as it is or the main script
(`src\Main.ahk`) with [AutoHotkey](http://ahkscript.org/download/). (`src\Main.ahk`) with [AutoHotkey](http://ahkscript.org/download/).
You may copy bug.n anywhere you like -- at least if you have write acces You may copy bug.n anywhere you like -- at least if you have write access
there -- e. g. `C:\Program Files\bugn` or link it to the 'Windows Start Menu' there -- e.g. `C:\Program Files\bugn` or link it to the 'Windows Start Menu'
or the 'Windows Taskbar', for example. or the 'Windows Taskbar', for example.
By default bug.n stores the session data (configuration, layout, window states By default bug.n stores the session data (configuration, layout, window states
and log) to the user's APPDATA directory, e. g. and log) to the user's APPDATA directory, e.g.
`C:\Users\joten\AppData\Roaming\bug.n`. `C:\Users\joten\AppData\Roaming\bug.n`.
You may redirect the bug.n data directory by setting the first argument either You may redirect the bug.n data directory by setting the first argument either
to the executable or to the main script (`Main.ahk`), when running bug.n, to the executable or to the main script (`Main.ahk`), when running bug.n,
e. g. `C:\Program Files\bugn\bugn.exe D:\bugn`; but you will need to have write e.g. `C:\Program Files\bugn\bugn.exe D:\bugn`; but you will need to have write
access to this directory. access to this directory.
You can run bug.n manually, either by using the executable and starting it like You can run bug.n manually, either by using the executable and starting it like
@ -42,13 +42,13 @@ possibility, to do so, is to install AutoHotkey, open the directory, where
### Microsoft Windows User Access Control ### Microsoft Windows User Access Control
If you are using bug.n on Microsoft Windows Vista or higher you may use If you are using bug.n on Microsoft Windows Vista or higher you may use
applications, which run with administrator privileges, e. g. 'administrative applications, which run with administrator privileges, e.g. 'administrative
tools'. In the case that you are running bug.n in the standard user session, tools'. In the case that you are running bug.n in the standard user session,
i. e. _without_ administrator privileges, bug.n will not be able to manage the i.e. _without_ administrator privileges, bug.n will not be able to manage the
associated windows. If you want those application windows to be managed, you associated windows. If you want those application windows to be managed, you
need to run bug.n with administrator privileges, too. need to run bug.n with administrator privileges, too.
You can set the option `Run this program as an administrator` on the You can set the option `Run this program as an administrator` on the
'Compatiblity' tab, section 'Privilege level' of the bug.n executable file 'Compatibility' tab, section 'Privilege level' of the bug.n executable file
properties. But if you also want to run bug.n when Windows starts, you will properties. But if you also want to run bug.n when Windows starts, you will
have to create a task in 'Task Scheduler'. have to create a task in 'Task Scheduler'.

4
doc/Overview.md
View file

@ -8,13 +8,13 @@ version and the Wiki pages available for additional information.
> A description of what bug.n can do. > A description of what bug.n can do.
#### [CHANGES](./CHANGES.md) #### [CHANGES](./CHANGES.md)
> A list of changes to the user interface (i. a. configuration variables and > A list of changes to the user interface (i.a. configuration variables and
hotkeys) for each version of bug.n. hotkeys) for each version of bug.n.
#### [Installing and running bug.n](./Installing_and_running.md) #### [Installing and running bug.n](./Installing_and_running.md)
> A description of how to install and run bug.n. Also described is a method to > A description of how to install and run bug.n. Also described is a method to
run bug.n as Administrator to solve problems with the User Access Control of run bug.n as Administrator to solve problems with the User Access Control of
Microsft Windows higher than Vista. Microsoft Windows higher than Vista.
##### [Stable version](../../../releases/latest) ##### [Stable version](../../../releases/latest)
> The current stable version of bug.n as a package (`.zip` file); it includes > The current stable version of bug.n as a package (`.zip` file); it includes

4
doc/Usage.md
View file

@ -43,7 +43,7 @@ following lines in an AutoHotkey script:
;; 3rd example: ;; 3rd example:
ControlSetText, Edit2, % "Monitor_activateView(4)`nRun, explorer.exe", bug.n_BAR_0 ControlSetText, Edit2, % "Monitor_activateView(4)`nRun, explorer.exe", bug.n_BAR_0
It might be necessary to put a `Sleep, <delay in milliseconds>`, e. g. It might be necessary to put a `Sleep, <delay in milliseconds>`, e.g.
`Sleep, 200`, between to consecutive `ControlSetText` to give bug.n time to `Sleep, 200`, between to consecutive `ControlSetText` to give bug.n time to
recognize the next command. recognize the next command.
@ -85,6 +85,6 @@ you will have to run them manually. The configuration variables may include
those listed in the document those listed in the document
"[Default configuration](./Default_configuration.md)", hotkeys as "[Default configuration](./Default_configuration.md)", hotkeys as
listed in the document "[Default hotkeys](./Default_hotkeys.md)" and internal listed in the document "[Default hotkeys](./Default_hotkeys.md)" and internal
variables for the current state of bug.n, e. g. the active view (saved for each variables for the current state of bug.n, e.g. the active view (saved for each
monitor), the layout and its configuration (saved for each view) and window monitor), the layout and its configuration (saved for each view) and window
states as they could be set by a rule. states as they could be set by a rule.

2
doc/Used_hotkeys.md
View file

@ -1,6 +1,6 @@
## Used hotkeys ## Used hotkeys
The following tables list the base keys, i. e. a key without any modifier, and The following tables list the base keys, i.e. a key without any modifier, and
their combination with the modifier keys (Alt: `!`, Ctrl: `^`, LWin: `#` and their combination with the modifier keys (Alt: `!`, Ctrl: `^`, LWin: `#` and
Shift: `+`), which are used in bug.n. With this overview you may find unused Shift: `+`), which are used in bug.n. With this overview you may find unused
keys, which can be used for non-bug.n hotkeys or to reassign bug.n functions. keys, which can be used for non-bug.n hotkeys or to reassign bug.n functions.

2
doc/User-hotkeys.md
View file

@ -72,7 +72,7 @@ Here follows an example for configuring hotkeys, which are similar to those of
### AZERTY compatible hotkeys # ### AZERTY compatible hotkeys #
This configuration was created in order to make view/tagging hotkeys functionnal with AZERTY keyboards. In fact, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9` and `0` triggers respectively `&`, `é`, `"`, `'`, `(`, `-`, `è`, `_`, `ç` and `à` in such a layout. This configuration was created in order to make view/tagging hotkeys functional with AZERTY keyboards. In fact, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9` and `0` triggers respectively `&`, `é`, `"`, `'`, `(`, `-`, `è`, `_`, `ç` and `à` in such a layout.
``` ```
Config_hotkey=#&::Monitor_activateView(1) Config_hotkey=#&::Monitor_activateView(1)