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

Reset the text in Default_hotkeys

Browse source 
This is the second test regarding a cheat sheet.
This commit is contained in:
joten 2015-07-09 22:53:17 +02:00
parent 685a523c0b
commit 180cc11864
1 changed files with 92 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

184
doc/Default_hotkeys.md
View file

@ -20,135 +20,135 @@ left 'Windows key' and the 'Control key' and the 'Q key'
### Window management ### Window management
`Config_hotkey=#Down::View_activateWindow(0, +1)` `Config_hotkey=#Down::View_activateWindow(0, +1)`
> Activate the next window in the active view. : Activate the next window in the active view.
`Config_hotkey=#Up::View_activateWindow(0, -1)` `Config_hotkey=#Up::View_activateWindow(0, -1)`
> Activate the previous window in the active view. : Activate the previous window in the active view.
`Config_hotkey=#+Down::View_shuffleWindow(0, +1)` `Config_hotkey=#+Down::View_shuffleWindow(0, +1)`
> Move the active window to the next position in the window list of the view. : Move the active window to the next position in the window list of the view.
`Config_hotkey=#+Up::View_shuffleWindow(0, -1)` `Config_hotkey=#+Up::View_shuffleWindow(0, -1)`
> Move the active window to the previous position in the window list of the view. : Move the active window to the previous position in the window list of the view.
`Config_hotkey=#+Enter::View_shuffleWindow(1)` `Config_hotkey=#+Enter::View_shuffleWindow(1)`
> Move the active window to the first position in the window list of the view. : Move the active window to the first position in the window list of the view.
You may also move the active window to any other absolute position in the > You may also move the active window to any other absolute position in the
window list by using the first parameter. window list by using the first parameter.
`Config_hotkey=#c::Manager_closeWindow()` `Config_hotkey=#c::Manager_closeWindow()`
> Close the active window. : Close the active window.
`Config_hotkey=#+d::Window_toggleDecor()` `Config_hotkey=#+d::Window_toggleDecor()`
> Show / Hide the title bar of the active window. : Show / Hide the title bar of the active window.
`Config_hotkey=#+f::View_toggleFloatingWindow()` `Config_hotkey=#+f::View_toggleFloatingWindow()`
> 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).
`Config_hotkey=#^m::Manager_minimizeWindow()` `Config_hotkey=#^m::Manager_minimizeWindow()`
> Minimize the active window. : Minimize the active window.
This implicitly makes the window floating. > This implicitly makes the window floating.
`Config_hotkey=#+m::Manager_moveWindow()` `Config_hotkey=#+m::Manager_moveWindow()`
> Move the active window by key (only floating windows). : Move the active window by key (only floating windows).
`Config_hotkey=#+s::Manager_sizeWindow()` `Config_hotkey=#+s::Manager_sizeWindow()`
> Resize the active window by key (only floating windows). : Resize the active window by key (only floating windows).
`Config_hotkey=#+x::Manager_maximizeWindow()` `Config_hotkey=#+x::Manager_maximizeWindow()`
> Move and resize the active window to the size of the work area (only floating : Move and resize the active window to the size of the work area (only floating
windows). windows).
`Config_hotkey=#i::Manager_getWindowInfo()` `Config_hotkey=#i::Manager_getWindowInfo()`
> Get information for the active window. : Get information for the active window.
The information being id, title, class, process name, style, geometry, tags and > The information being id, title, class, process name, style, geometry, tags and
floating state. floating state.
`Config_hotkey=#+i::Manager_getWindowList()` `Config_hotkey=#+i::Manager_getWindowList()`
> Get a window list for the active view. : Get a window list for the active view.
The list contains information about the window id, title and class. > The list contains information about the window id, title and class.
`Config_hotkey=!Down::View_moveWindow(0, +1)` `Config_hotkey=!Down::View_moveWindow(0, +1)`
> Manually move the active window to the next area in the layout. : Manually move the active window to the next area in the layout.
`Config_hotkey=!Up::View_moveWindow(0, -1)` `Config_hotkey=!Up::View_moveWindow(0, -1)`
> Manually move the active window to the previous area in the layout. : Manually move the active window to the previous area in the layout.
`Config_hotkey=!+Enter::Manager_maximizeWindow()` `Config_hotkey=!+Enter::Manager_maximizeWindow()`
> Move and resize the active window to the size of the work area (only floating : Move and resize the active window to the size of the work area (only floating
windows). windows).
`Config_hotkey=!<n>::View_moveWindow(<n>)` `Config_hotkey=!<n>::View_moveWindow(<n>)`
> Manually move the active window to the n<sup><small>th</small></sup> area in : Manually move the active window to the n<sup><small>th</small></sup> area in
the layout (n = 1..9). the layout (n = 1..9).
`Config_hotkey=!0::View_moveWindow(10)` `Config_hotkey=!0::View_moveWindow(10)`
> Manually move the active window to the n<sup><small>th</small></sup> area in : Manually move the active window to the n<sup><small>th</small></sup> area in
the layout. the layout.
`Config_hotkey=!BackSpace::View_toggleStackArea()` `Config_hotkey=!BackSpace::View_toggleStackArea()`
> Toggle the stack area of the layout. : Toggle the stack area of the layout.
If the stack area is disabled, the master area takes up the whole view. > If the stack area is disabled, the master area takes up the whole view.
### Window debugging ### Window debugging
`Config_hotkey=#^i::Debug_logViewWindowList()` `Config_hotkey=#^i::Debug_logViewWindowList()`
> Dump window information on the windows of the active view to the log. : Dump window information on the windows of the active view to the log.
`Config_hotkey=#+^i::Debug_logManagedWindowList()` `Config_hotkey=#+^i::Debug_logManagedWindowList()`
> Dump window information on the contents of the managed window list to the log. : Dump window information on the contents of the managed window list to the log.
The list contains the floating and tiled windows of all views. > The list contains the floating and tiled windows of all views.
`Config_hotkey=#^h::Debug_logHelp()` `Config_hotkey=#^h::Debug_logHelp()`
> Print a description of the formatting (column headings) used in the previous : Print a description of the formatting (column headings) used in the previous
two log messages to the log. two log messages to the log.
The previous two hotkeys being `Manager_logViewWindowList` and > The previous two hotkeys being `Manager_logViewWindowList` and
`Manager_logManagedWindowList`. `Manager_logManagedWindowList`.
`Config_hotkey=#^d::Debug_setLogLevel(0, -1)` `Config_hotkey=#^d::Debug_setLogLevel(0, -1)`
> Decrement the debug log level. : Decrement the debug log level.
This results in showing fewer debug messages. You may also set the debug log > This results in showing fewer debug messages. You may also set the debug log
level to an absolute value by using the first parameter. level to an absolute value by using the first parameter.
`Config_hotkey=#^+d::Debug_setLogLevel(0, +1)` `Config_hotkey=#^+d::Debug_setLogLevel(0, +1)`
> Increment the debug log level. : Increment the debug log level.
This results in showing more debug messages. You may also set the debug log > This results in showing more debug messages. You may also set the debug log
level to an absolute value by using the first parameter. level to an absolute value by using the first parameter.
### Layout management ### Layout management
`Config_hotkey=#Tab::View_setLayout(-1)` `Config_hotkey=#Tab::View_setLayout(-1)`
> Set the previously set layout. : Set the previously set layout.
You may also use `View_setLayout(0, +1)` for setting the next or > You may also use `View_setLayout(0, +1)` for setting the next or
`View_setLayout(0, -1)` for setting the previous layout in the layout array. `View_setLayout(0, -1)` for setting the previous layout in the layout array.
`Config_hotkey=#f::View_setLayout(3)` `Config_hotkey=#f::View_setLayout(3)`
> Set the floating layout. : Set the floating layout.
`Config_hotkey=#m::View_setLayout(2)` `Config_hotkey=#m::View_setLayout(2)`
> Set the monocle layout. : Set the monocle layout.
`Config_hotkey=#t::View_setLayout(1)` `Config_hotkey=#t::View_setLayout(1)`
> Set the tile layout. : Set the tile layout.
`Config_hotkey=#Left::View_setLayoutProperty(MFactor, 0, -0.05)` `Config_hotkey=#Left::View_setLayoutProperty(MFactor, 0, -0.05)`
> Reduce the size of the master area in the active view (only for the "tile" : Reduce the size of the master area in the active view (only for the "tile"
layout). layout).
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%.
@ -156,10 +156,10 @@ 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.
`Config_hotkey=#Right::View_setLayoutProperty(MFactor, 0, +0.05)` `Config_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"
layout). layout).
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%.
@ -168,162 +168,162 @@ With the second parameter you may set an absolute value, e. g.
and the stacking area one third the size of the view. and the stacking area one third the size of the view.
`Config_hotkey=#^t::View_setLayoutProperty(Axis, 0, +1, 1)` `Config_hotkey=#^t::View_setLayoutProperty(Axis, 0, +1, 1)`
> Rotate the layout axis (only for the "tile" layout). : Rotate the layout axis (only for the "tile" layout).
I. e. 2 -> 1 = vertical layout, 1 -> 2 = horizontal layout. > I. e. 2 -> 1 = vertical layout, 1 -> 2 = horizontal layout.
`Config_hotkey=#^Enter::View_setLayoutProperty(Axis, 0, +2, 1)` `Config_hotkey=#^Enter::View_setLayoutProperty(Axis, 0, +2, 1)`
> Mirror the layout axis (only for the "tile" layout). : Mirror the layout axis (only for the "tile" layout).
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.
`Config_hotkey=#^Tab::View_setLayoutProperty(Axis, 0, +1, 2)` `Config_hotkey=#^Tab::View_setLayoutProperty(Axis, 0, +1, 2)`
> Rotate the master axis (only for the "tile" layout). : Rotate the master axis (only for the "tile" layout).
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.
`Config_hotkey=#^+Tab::View_setLayoutProperty(Axis, 0, +1, 3)` `Config_hotkey=#^+Tab::View_setLayoutProperty(Axis, 0, +1, 3)`
> Rotate the stack axis (only for the "tile" layout). : Rotate the stack axis (only for the "tile" layout).
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.
`Config_hotkey=#^Up::View_setLayoutProperty(MY, 0, +1)` `Config_hotkey=#^Up::View_setLayoutProperty(MY, 0, +1)`
> Increase the master Y dimension by 1 (only for the "tile" layout). : Increase the master Y dimension by 1 (only for the "tile" layout).
This results in an increased number of windows in the master area by X. > This results in an increased number of windows in the master area by X.
Maximum of 9. Maximum of 9.
`Config_hotkey=#^Down::View_setLayoutProperty(MY, 0, -1)` `Config_hotkey=#^Down::View_setLayoutProperty(MY, 0, -1)`
> Decrease the master Y dimension by 1 (only for the "tile" layout). : Decrease the master Y dimension by 1 (only for the "tile" layout).
This results in a decreased number of windows in the master area by X. > This results in a decreased number of windows in the master area by X.
Minimum of 1. Minimum of 1.
`Config_hotkey=#^Right::View_setLayoutProperty(MX, 0, +1)` `Config_hotkey=#^Right::View_setLayoutProperty(MX, 0, +1)`
> Increase the master X dimension by 1 (only for the "tile" layout). : Increase the master X dimension by 1 (only for the "tile" layout).
This results in an increased number of windows in the master area by Y. > This results in an increased number of windows in the master area by Y.
Maximum of 9. Maximum of 9.
`Config_hotkey=#^Left::View_setLayoutProperty(MX, 0, +1)` `Config_hotkey=#^Left::View_setLayoutProperty(MX, 0, +1)`
> Decrease the master X dimension by 1 (only for the "tile" layout). : Decrease the master X dimension by 1 (only for the "tile" layout).
This results in a decreased number of windows in the master area by Y. > This results in a decreased number of windows in the master area by Y.
Minimum of 1. Minimum of 1.
`Config_hotkey=#+Left::View_setLayoutProperty(GapWidth, 0, -2)` `Config_hotkey=#+Left::View_setLayoutProperty(GapWidth, 0, -2)`
> 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.
`Config_hotkey=#+Right::View_setLayoutProperty(GapWidth, 0, +2)` `Config_hotkey=#+Right::View_setLayoutProperty(GapWidth, 0, +2)`
> Increase the gap between windows in "monocle" and "tile" layout. : Increase the gap between windows in "monocle" and "tile" layout.
### View / Tag management ### View / Tag management
`Config_hotkey=#+n::View_toggleMargins()` `Config_hotkey=#+n::View_toggleMargins()`
> Toggle the view margins. : Toggle the view margins.
These are set by the configuration variable `Config_viewMargins`. > These are set by the configuration variable `Config_viewMargins`.
`Config_hotkey=#BackSpace::Monitor_activateView(-1)` `Config_hotkey=#BackSpace::Monitor_activateView(-1)`
> Activate the previously activated view. : Activate the previously activated view.
You may also use `Monitor_activateView(0, -1)` or `Monitor_activateView(0, +1)` > You may also use `Monitor_activateView(0, -1)` or `Monitor_activateView(0, +1)`
for activating the previous or next adjacent view. for activating the previous or next adjacent view.
`Config_hotkey=#+0::Monitor_setWindowTag(10)` `Config_hotkey=#+0::Monitor_setWindowTag(10)`
> Tag the active window with all tags (n = 1..`Config_viewCount`). : Tag the active window with all tags (n = 1..`Config_viewCount`).
You may also use `Monitor_setWindowTag(0, -1)` or `Monitor_setWindowTag(0, +1)` > You may also use `Monitor_setWindowTag(0, -1)` or `Monitor_setWindowTag(0, +1)`
for setting the tag of the previous or next adjacent to the current view. for setting the tag of the previous or next adjacent to the current view.
`Config_hotkey=#<n>::Monitor_activateView(<n>)` `Config_hotkey=#<n>::Monitor_activateView(<n>)`
> Activate the n<sup><small>th</small></sup> view (n = 1..`Config_viewCount`). : Activate the n<sup><small>th</small></sup> view (n = 1..`Config_viewCount`).
`Config_hotkey=#+<n>::Monitor_setWindowTag(<n>)` `Config_hotkey=#+<n>::Monitor_setWindowTag(<n>)`
> Tag the active window with the n<sup><small>th</small></sup> tag (n = : Tag the active window with the n<sup><small>th</small></sup> tag (n =
1..`Config_viewCount`). 1..`Config_viewCount`).
`Config_hotkey=#^<n>::Monitor_toggleWindowTag(<n>)` `Config_hotkey=#^<n>::Monitor_toggleWindowTag(<n>)`
> Add / Remove the n<sup><small>th</small></sup> tag (n = 1..`Config_viewCount`) : Add / Remove the n<sup><small>th</small></sup> tag (n = 1..`Config_viewCount`)
for the active window, if it is not / is already set. for the active window, if it is not / is already set.
### Monitor management ### Monitor management
`Config_hotkey=#.::Manager_activateMonitor(0, +1)` `Config_hotkey=#.::Manager_activateMonitor(0, +1)`
> 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.
`Config_hotkey=#,::Manager_activateMonitor(0, -1)` `Config_hotkey=#,::Manager_activateMonitor(0, -1)`
> Activate the previous monitor in a multi-monitor environment. : Activate the previous monitor in a multi-monitor environment.
`Config_hotkey=#+.::Manager_setWindowMonitor(0, +1)` `Config_hotkey=#+.::Manager_setWindowMonitor(0, +1)`
> Set the active window's view to the active view on the next monitor in a : 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.
`Config_hotkey=#+,::Manager_setWindowMonitor(0, -1)` `Config_hotkey=#+,::Manager_setWindowMonitor(0, -1)`
> Set the active window's view to the active view on the previous monitor in a : Set the active window's view to the active view on the previous monitor in a
multi-monitor environment. multi-monitor environment.
`Config_hotkey=#^+.::Manager_setViewMonitor(0, +1)` `Config_hotkey=#^+.::Manager_setViewMonitor(0, +1)`
> Set all windows of the active view on the active view of the next monitor in : Set all windows of the active view on the active view of the next monitor in
a multi-monitor environment. a multi-monitor environment.
You may also set all windows of the active view on a specific monitor by using > 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 windows of the first parameter, e. g. `Manager_setViewMonitor(1)` will set all windows of
the active view on the first monitor. the active view on the first monitor.
`Config_hotkey=#^+,::Manager_setViewMonitor(0, -1)` `Config_hotkey=#^+,::Manager_setViewMonitor(0, -1)`
> Set all windows of the active view on the active view of the previous monitor : Set all windows of the active view on the active view of the previous monitor
in a multi-monitor environment. in a multi-monitor environment.
### GUI management ### GUI management
`Config_hotkey=#+Space::Monitor_toggleBar()` `Config_hotkey=#+Space::Monitor_toggleBar()`
> Hide / Show the bar (bug.n status bar) on the active monitor. : Hide / Show the bar (bug.n status bar) on the active monitor.
`Config_hotkey=#Space::Monitor_toggleTaskBar()` `Config_hotkey=#Space::Monitor_toggleTaskBar()`
> Hide / Show the task bar. : Hide / Show the task bar.
`Config_hotkey=#y::Bar_toggleCommandGui()` `Config_hotkey=#y::Bar_toggleCommandGui()`
> Open the command GUI for executing programmes or bug.n functions. : Open the command GUI for executing programmes or bug.n functions.
`Config_hotkey=#+y::Monitor_toggleNotifyIconOverflowWindow()` `Config_hotkey=#+y::Monitor_toggleNotifyIconOverflowWindow()`
> Toggle the overflow window of the 'notify icons'. : Toggle the overflow window of the 'notify icons'.
`Config_hotkey=!+y::View_traceAreas()` `Config_hotkey=!+y::View_traceAreas()`
> Indicate the areas of the "tile" layout. : Indicate the areas of the "tile" layout.
### Administration ### Administration
`Config_hotkey=#^e::Run, edit <Config_filePath>` `Config_hotkey=#^e::Run, edit <Config_filePath>`
> Open the configuration file in the standard text editor. : Open the configuration file in the standard text editor.
If you want to set this hotkey in `Config.ini`, you have to replace > If you want to set this hotkey in `Config.ini`, you have to replace
`<Config_filePath>` with an explicit file path. `<Config_filePath>` with an explicit file path.
`Config_hotkey=#^s::Config_UI_saveSession()` `Config_hotkey=#^s::Config_UI_saveSession()`
> Save the current state of monitors, views, layouts to the configuration file. : 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, including > This resets i. a. the configuration and internal variables of bug.n, including
the window lists. It is like Quitting and restarting bug.n. 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.
`Config_hotkey=#^q::ExitApp` `Config_hotkey=#^q::ExitApp`
> Quit bug.n, restore the default Windows UI and show all windows. : Quit bug.n, restore the default Windows UI and show all windows.