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

Corrected some errors in doc

Browse source
This commit is contained in:
joten 2015-03-15 17:56:14 +01:00
parent 377c524c62
commit 0480e1924d
4 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/CHANGES.md
View file

@ -189,7 +189,7 @@ desktop and therewith changing the active window.
* `-` `Config_showTitleBars` * `-` `Config_showTitleBars`
* `~` `Config_rules` have two more parameters (window style and if the window * `~` `Config_rules` have two more parameters (window style and if the window
is decorated; this replaces `Config_showTitleBars`). is decorated; this replaces `Config_showTitleBars`).
* `+` <kbd>Win</kbd><kbd>Shift</kbd><kbd>X</kbd>` maximizes a window to the * `+` <kbd>Win</kbd><kbd>Shift</kbd><kbd>X</kbd> maximizes a window to the
bug.n workspace. bug.n workspace.
* `+` You may now use `Monitor_activateView(">")` for cycling through the views * `+` You may now use `Monitor_activateView(">")` for cycling through the views
and `View_setLayout(">")` for cycling through the layouts. and `View_setLayout(">")` for cycling through the layouts.

6
doc/Customization.md
View file

@ -42,7 +42,7 @@ settings.
You may find a sample configuration file at You may find a sample configuration file at
https://github.com/joten/bug.n.config. https://github.com/joten/bug.n.config.
### Re-using <kbd>Win</kbd><kbd>L</kbd> ### Re-using Win+L
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
@ -51,8 +51,8 @@ another hotkey, e. g. `#^+l`
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 <kbd>Win</kbd><kbd>L</kbd> as and locks the workstation. This than allows to set `#l` as a hotkey in
a hotkey in `Config.ini`. `Config.ini`.
If <kbd>Win</kbd><kbd>L</kbd> still locks the workstation, use the new If <kbd>Win</kbd><kbd>L</kbd> still locks the workstation, use the new
keybinding for locking the workstation at least once and therewith set the keybinding for locking the workstation at least once and therewith set the

2
doc/Default_configuration.md
View file

@ -2,7 +2,7 @@
The configuration variables, as you can set them in `Config.ini`, are noted in The configuration variables, as you can set them in `Config.ini`, are noted in
the format `Conifg_<identifier>=<value>`; you may copy the string from ` ` and the format `Conifg_<identifier>=<value>`; you may copy the string from ` ` and
use it as a templete for a new line in `Config.ini`. use it as a template for a new line in `Config.ini`.
### Status bar ### Status bar

14
doc/Default_hotkeys.md
View file

@ -4,13 +4,13 @@
The hotkeys, as you can set them in `Config.ini`, are noted in the format The hotkeys, as you can set them in `Config.ini`, are noted in the format
`Conifg_hotkey=<modifier><key>::<function>(<argument>)`; you may copy the `Conifg_hotkey=<modifier><key>::<function>(<argument>)`; you may copy the
string from ` ` and use it as a templete for a new line in `Config.ini`. string from ` ` and use it as a template for a new line in `Config.ini`.
Possible modifiers are the following: Possible modifiers are the following:
* `!` (<kbd>Alt</kbd>) * `!` <kbd>Alt</kbd>
* `^` (<kbd>Ctrl</kbd>, Control) * `^` <kbd>Ctrl</kbd>, Control
* `#` (<kbd>Win</kbd> / LWin, left Windows) * `#` <kbd>Win</kbd> / LWin, the left Windows key
* `+` (<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
@ -137,7 +137,7 @@ one. E. g. with
step, by which the master area is reduced, is -0.0016% and will be doubled with step, by which the master area is reduced, is -0.0016% and will be doubled with
consecutive calls until it reaches -0.05%. 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.
`Conifg_hotkey=#Right::View_setLayoutProperty(MFactor, 0, +0.05)` `Conifg_hotkey=#Right::View_setLayoutProperty(MFactor, 0, +0.05)`
> Enlarge the size of the master area in the active view (only for the "tile" > Enlarge the size of the master area in the active view (only for the "tile"
@ -147,7 +147,7 @@ one. E. g. with
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.
`Conifg_hotkey=#^t::View_setLayoutProperty(Axis, 0, +1, 1)` `Conifg_hotkey=#^t::View_setLayoutProperty(Axis, 0, +1, 1)`