updated documentation for release 8.3.0

This commit is contained in:
joten 2012-12-01 20:16:58 +01:00
parent 747766274e
commit 98d06a02ce
5 changed files with 129 additions and 61 deletions

68
src/doc/README.t2t Normal file
View File

@ -0,0 +1,68 @@
Tags software / Microsoft Windows / tiling window management / AutoHotkey
Title bug.n
Author Joshua Fuhs, joten
Version 8.3.0
Date 01.12.2012
Please see doc/help.txt for more information on installing and running,
customizing and using bug.n and doc/changes.txt for a list of changes made
with this version, in particular the changes in configuration variables and
hotkeys.
Credits
bug.n is written by Joshua Fuhs and joten, but some source was copied from
the AutoHotkey forum (http://www.autohotkey.com/forum). These are
explicitly marked in the source code at the end of the appropriate section.
Additionally the following listing summarizes these sources (of ideas or
code):
Patch ideas
* pitkali:
+ Sync window arrays on fussy events and unknown window ids
+ Dialog detection upon manage
+ Regular expression support in rules
+ Window information handling patches
- memory leaks
- flickering windows
http://pitkali.info/bugn (patches/code outdated)
Ideas or concepts
* suckless.org: dwm
http://dwm.suckless.org
* jgpaiva: GridMove
http://jgpaiva.donationcoders.com/gridmove.html
* Lexikos: WindowPad - multi-monitor window-moving tool
http://www.autohotkey.com/forum/topic21703.html
Code snippets
* fures: System + Network monitor - with net history graph
http://www.autohotkey.com/community/viewtopic.php?p=260329
* maestrith: Script Writer
http://www.autohotkey.net/~maestrith/Script Writer/
* PhiLho: AC/Battery status
http://www.autohotkey.com/forum/topic7633.html
* Sean:
+ CPU LoadTimes
http://www.autohotkey.com/forum/topic18913.html
+ Network Download/Upload Meter
http://www.autohotkey.com/community/viewtopic.php?t=18033
* SKAN:
+ Crazy Scripting : Quick Launcher for Portable Apps
http://www.autohotkey.com/forum/topic22398.html
+ HDD Activity Monitoring LED
http://www.autohotkey.com/community/viewtopic.php?p=113890&sid=64d9824fdf252697ff4d5026faba91f8#p113890
+ How to Hook on to Shell to receive its messages?
http://www.autohotkey.com/forum/viewtopic.php?p=123323#123323
* Unambiguous: Re-use WIN+L as a hotkey in bug.n
http://www.autohotkey.com/community/viewtopic.php?p=500903&sid=eb3c7a119259b4015ff045ef80b94a81#p500903
License
bug.n is licensed under the GPL version 3; please see doc/license.txt for
the explicit license text.
Copyright (c) 2010-2012 Joshua Fuhs, joten

View File

@ -13,45 +13,45 @@
=8.3.0=
(~) Improved view arranging runtime.
(~) Fixed bug #18641: Freezing problem. In most cases, bug.n will no
(~) Fixed bug #18641: Freezing problem. In most cases, bug.n will no
longer hang when one of its managed windows hangs.
(~) Fixed bug: Sometimes cycling through the windows in a view would
(~) Fixed bug: Sometimes cycling through the windows in a view would
get stuck on a particular window.
(~) Fixed bug: Activating a window on a non-active view on
(~) Fixed bug: Activating a window on a non-active view on
a non-active monitor could cause both monitors to change views.
(~) Gap widths are now treated identically on both "tile" and "monocle"
layouts.
(~) Fixed bug #18650: Unexpected monitor focus changes
(~) Fixed bug in 'Manager_setWindowMonitor(d)' and
(~) Fixed bug in 'Manager_setWindowMonitor(d)' and
'Manager_setViewMonitor(d)'
(~) Fixed bug, which prevented bug.n from Main_reload, if the number of
(~) Fixed bug, which prevented bug.n from Main_reload, if the number of
monitors changed.
(~) Fixed bug: Closing Bar_cmdGui and activating the next to last window.
(~) Fixed bug: Vertical position of Bar_cmdGui, if
Config_verticalBarPos=tray and the task bar is at the top of the
(~) Fixed bug: Vertical position of Bar_cmdGui, if
Config_verticalBarPos=tray and the task bar is at the top of the
monitor.
(~) Fixed bug: On Main_reload() and Config_verticalBarPos=tray.
(~) Changed the command line argument from specifying 'the path to the
config.ini' to 'the path to the general data directory containing
(~) Changed the command line argument from specifying 'the path to the
config.ini' to 'the path to the general data directory containing
the config.ini and log.txt'.
(+) Multi-dimensional tiling of the master area. The user may now specify
X and Y dimensions independently up to 9 x 9.
(+) Initially assign windows to the monitor on which they appear if
(+) Initially assign windows to the monitor on which they appear if
nothing is specified in the configuration.
(+) Created bug.n log to record major and debugging events and window
(+) Created bug.n log to record major and debugging events and window
information.
(+) 'View margins' allowing a layout to occupy a limited space of the
(+) 'View margins' allowing a layout to occupy a limited space of the
monitor.
(+) 'Single window action', which allows to close or maximize windows
(+) 'Single window action', which allows to close or maximize windows
based on rules.
(+) 'Reload' hotkey, which reloads the whole script.
(+) Re-Setting the 'Reload' and 'ExitApp' hotkey in 'config.ini'-
(+) Added the configuration variable "Config_viewNames", with which views
can be named and the number of views can be set. The configuration
(+) Added the configuration variable "Config_viewNames", with which views
can be named and the number of views can be set. The configuration
variable "Config_viewCount" therewith becomes obsolete.
(-) Removed the configuration variable "Config_viewCount".
(-) Removed the explicit listing of commands in the Bar_cmdGui.
(-) Removed the default rules for Gimp, since from version 2.8 onwards
(-) Removed the default rules for Gimp, since from version 2.8 onwards
Gimp can use a single application window instead of three and more.
@ -178,4 +178,4 @@
------------------------------------------------------------------------
%%txt: (c) 2010-2011 joten, last modified %%date(%d.%m.%Y)
%%txt: (c) 2010-2012 Joshua Fuhs, joten. Last modified %%date(%d.%m.%Y).

View File

@ -16,7 +16,7 @@
%!postproc(html): '\(c\)' '©'
%!options(txt): -o configuration.txt
%!preproc(txt): '%%txt: ' ''
%!postproc(txt): '%%LINK_hotkeys' 'docs/hotkeys.txt'
%!postproc(txt): '%%LINK_hotkeys' 'doc/hotkeys.txt'
%!postproc(txt): '<DIV ID="frame">' ''
%!postproc(txt): '<BR>' ''
@ -97,10 +97,10 @@
The default values are retrieved from the "Window Color and Appearance"
settings.
: **Config_barCommands**=Run, explore docs;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"
: **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
@ -117,15 +117,15 @@
and displayed in the status bar.
: **Config_readinDiskLoad**=0
If true (=1), the current disk load (read and write) is read in and
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
If true (=1), the system memory usage is read in and displayed in the
status bar.
: **Config_readinNetworkLoad**=0
If true (=1), the current network load (up and down) is read in and
If true (=1), the current network load (up and down) is read in and
displayed in the status bar.
: **Config_readinTime**=1
@ -175,9 +175,9 @@ settings.
=== 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,
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
@ -203,7 +203,7 @@ settings.
bottom), 3 = z (monocle).
: **Config_layoutGapWidth=0
The default gap width in px (only even numbers) of the "tile" layout,
The default gap width in px (only even numbers) of the "tile" layout,
i. e. the space between windows and around the layout.
: **Config_layoutMFactor**=0.6
@ -211,18 +211,18 @@ settings.
monitor size.
: **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
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
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.
=== Runtime ===
: **Config_ghostWndSubString**= (Not Responding)
The text string, which identifies a hung window in its title bar; the
The text string, which identifies a hung window in its title bar; the
german Windows version uses " (Keine Rückmeldung)".
: **Config_mouseFollowsFocus**=1
@ -230,9 +230,9 @@ settings.
window is activated by bug.n.
: **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 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
@ -287,11 +287,11 @@ settings.
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
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
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;
@ -334,7 +334,7 @@ settings.
''<BR>''
%%html: ''' <DIV CLASS="footer">
------------------------------------------------------------------------
%%txt: (c) 2010-2011 joten, last modified %%date(%d.%m.%Y)
%%html: | (c) 2010-2011 joten, last modified %%date(%d.%m.%Y) | [jn.png]
%%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>

View File

@ -20,8 +20,8 @@
%!preproc(txt): '%%txt: ' ''
%!postproc(txt): '<DIV ID="frame">' ''
%!postproc(txt): '<BR>' ''
%!postproc(txt): '%%LINK_configuration' 'docs/configuration.txt'
%!postproc(txt): '%%LINK_hotkeys' 'docs/hotkeys.txt'
%!postproc(txt): '%%LINK_configuration' 'doc/configuration.txt'
%!postproc(txt): '%%LINK_hotkeys' 'doc/hotkeys.txt'
''' <DIV ID="frame">
%%html: ''' <DIV CLASS="header">
@ -183,7 +183,7 @@ The following functions can also be controlled with the mouse:
''<BR>''
%%html: ''' <DIV CLASS="footer">
------------------------------------------------------------------------
%%txt: (c) 2010-2011 joten, last modified %%date(%d.%m.%Y)
%%html: | (c) 2010-2011 joten, last modified %%date(%d.%m.%Y) | [jn.png]
%%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>

View File

@ -135,27 +135,27 @@ pressing the left Windows key and the shift key and the q key
the "tile" layout).
: #^Left::**View_setMX(-1)**
Decrease the master X dimension by 1, i. e. decrease the number of
windows in the master area by Y. Minimum of 1 (only for the "tile"
Decrease the master X dimension by 1, i. e. decrease the number of
windows in the master area by Y. Minimum of 1 (only for the "tile"
layout).
: #^Right::**View_setMX(+1)
Increase the master X dimension by 1, i. e. increase the number of
windows in the master area by Y. Maximum of 9 (only for the "tile"
Increase the master X dimension by 1, i. e. increase the number of
windows in the master area by Y. Maximum of 9 (only for the "tile"
layout).
: #^Down::**View_setMY(-1)**
Decrease the master Y dimension by 1, i.e. decrease the number of
windows in the master area by X. Minimum of 1 (only for the "tile"
Decrease the master Y dimension by 1, i.e. decrease the number of
windows in the master area by X. Minimum of 1 (only for the "tile"
layout).
: #^Up::**View_setMY(+1)**
Increase the master Y dimension by 1, i.e. increase the number of
windows in the master area by X. Maximum of 9 (only for the "tile"
windows in the master area by X. Maximum of 9 (only for the "tile"
layout).
: #+n::**View_toggleMargins()**
Toggle the view margins, which are set by the configuration variable
Toggle the view margins, which are set by the configuration variable
"Config_viewMargins".
@ -219,12 +219,12 @@ pressing the left Windows key and the shift key and the q key
Dump window information on the windows of the active view to the log.
: #+^i::**Debug_logManagedWindowList()**
Dump window information on the contents of the managed window list
Dump window information on the contents of the managed window list
(floating and tiled windows of all views) to the log.
: #^h::**Debug_logHelp()**
Print a description of the formatting (column headings) used in the
previous two log messages (Manager_logViewWindowList and
Print a description of the formatting (column headings) used in the
previous two log messages (Manager_logViewWindowList and
Manager_logManagedWindowList) to the log.
: #^d::**Debug_setLogLevel(-1)**
@ -253,14 +253,14 @@ pressing the left Windows key and the shift key and the q key
menu, hotkeys (unless defined in Config.ini), individual window
settings like Config_showBorder (since windows might be hidden) or
hiding the title bar, the monitor count or views.
! It does not reload the monitor configuration and therefor does not
! It does not reload the monitor configuration and therefor does not
recognize any changes in the number of monitors.
! It does not reload functions.
! Changed rules are only applied to new windows.
: #^+r::**Reload**
Reload bug.n (i. e. the whole script), which resets the configuration,
the bar, the monitor configuration and window lists of bug.n. It is
Reload bug.n (i. e. the whole script), which resets the configuration,
the bar, the monitor configuration and window lists of bug.n. It is
like Quitting and restarting bug.n.
: #^q::**ExitApp
@ -270,7 +270,7 @@ pressing the left Windows key and the shift key and the q key
''<BR>''
%%html: ''' <DIV CLASS="footer">
------------------------------------------------------------------------
%%txt: (c) 2010-2011 joten, last modified %%date(%d.%m.%Y)
%%html: | (c) 2010-2011 joten, last modified %%date(%d.%m.%Y) | [jn.png]
%%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>