diff --git a/doc/Cheat_sheet/Default_hotkeys.md b/doc/Cheat_sheet/Default_hotkeys.md new file mode 100644 index 0000000..c4bf6d3 --- /dev/null +++ b/doc/Cheat_sheet/Default_hotkeys.md @@ -0,0 +1,221 @@ +## bug.n default hotkeys + +### Abbreviations + +* `!` Alt +* `^` Ctrl, Control +* `#` Win / LWin, the left Windows key +* `+` Shift + +### Window management + +#### #Down +Activate the next window in the active view. + +#### #Up +Activate the previous window in the active view. + +#### #+Down +Move the active window to the next position in the window list of the view. + +#### #+Up +Move the active window to the previous position in the window list of the view. + +#### #+Enter +Move the active window to the first position in the window list of the view. + +#### #c +Close the active window. + +#### #+d +Show / Hide the title bar of the active window. + +#### #+f +Toggle the floating status of the active window. + +#### #^m +Minimize the active window. + +#### #+m +Move the active window by key (only floating windows). + +#### #+s +Resize the active window by key (only floating windows). + +#### #+x +Move and resize the active window to the size of the work area (only floating +windows). + +#### #i +Get information for the active window. + +#### #+i +Get a window list for the active view. + +#### !Down +Manually move the active window to the next area in the layout. + +#### !Up +Manually move the active window to the previous area in the layout. + +#### !+Enter +Move and resize the active window to the size of the work area (only floating +windows). + +#### ! +Manually move the active window to the nth area in +the layout (n = 1..9). + +#### !0 +Manually move the active window to the nth area in +the layout. + +#### !BackSpace +Toggle the stack area of the layout. + +### Window debugging + +#### #^i +Dump window information on the windows of the active view to the log. + +#### #+^i +Dump window information on the contents of the managed window list to the log. + +#### #^h +Print a description of the formatting (column headings) used in the previous +two log messages to the log. + +#### #^d +Decrement the debug log level. + +#### #^+d +Increment the debug log level. + +### Layout management + +#### #Tab +Set the previously set layout. + +#### #f +Set the floating layout. + +#### #m +Set the monocle layout. + +#### #t +Set the tile layout. + +#### #Left +Reduce the size of the master area in the active view (only for the "tile" +layout). + +#### #Right +Enlarge the size of the master area in the active view (only for the "tile" +layout). + +#### #^t +Rotate the layout axis (only for the "tile" layout). + +#### #^Enter +Mirror the layout axis (only for the "tile" layout). + +#### #^Tab +Rotate the master axis (only for the "tile" layout). + +#### #^+Tab +Rotate the stack axis (only for the "tile" layout). + +#### #^Up +Increase the master Y dimension by 1 (only for the "tile" layout). + +#### #^Down +Decrease the master Y dimension by 1 (only for the "tile" layout). + +#### #^Right +Increase the master X dimension by 1 (only for the "tile" layout). + +#### #^Left +Decrease the master X dimension by 1 (only for the "tile" layout). + +#### #+Left +Decrease the gap between windows in "monocle" and "tile" layout. + +#### #+Right +Increase the gap between windows in "monocle" and "tile" layout. + +### View / Tag management + +#### #+n +Toggle the view margins. + +#### #BackSpace +Activate the previously activated view. + +#### #+0 +Tag the active window with all tags (n = 1..`Config_viewCount`). + +#### # +Activate the nth view (n = 1..`Config_viewCount`). + +#### #+ +Tag the active window with the nth tag (n = +1..`Config_viewCount`). + +#### #^ +Add / Remove the nth tag (n = 1..`Config_viewCount`) +for the active window, if it is not / is already set. + +### Monitor management + +#### #. +Activate the next monitor in a multi-monitor environment. + +#### #, +Activate the previous monitor in a multi-monitor environment. + +#### #+. +Set the active window's view to the active view on the next monitor in a +multi-monitor environment. + +#### #+, +Set the active window's view to the active view on the previous monitor in a +multi-monitor environment. + +#### #^+. +Set all windows of the active view on the active view of the next monitor in +a multi-monitor environment. + +#### #^+, +Set all windows of the active view on the active view of the previous monitor +in a multi-monitor environment. + +### GUI management + +#### #+Space +Hide / Show the bar (bug.n status bar) on the active monitor. + +#### #Space +Hide / Show the task bar. + +#### #y +Open the command GUI for executing programmes or bug.n functions. + +#### #+y +Toggle the overflow window of the 'notify icons'. + +#### !+y +Indicate the areas of the "tile" layout. + +### Administration + +#### #^e +Open the configuration file in the standard text editor. + +#### #^s +Save the current state of monitors, views, layouts to the configuration file. + +#### #^r +Reload bug.n (i. e. the whole script). + +#### #^q +Quit bug.n, restore the default Windows UI and show all windows. diff --git a/doc/Cheat_sheet/README.md b/doc/Cheat_sheet/README.md new file mode 100644 index 0000000..7ec5cd1 --- /dev/null +++ b/doc/Cheat_sheet/README.md @@ -0,0 +1,15 @@ +## README + +The cheat sheet was created from `bug.n/doc/Default_hotkeys.md` as a source by + +* copying the file to `bug.n/doc/Cheat_sheet/` +* changing the title from "Default hotkeys" to "bug.n default hotkeys" +* changing the heading "General description" to "Abbreviations" +* finding and replacing "\r\n\r\n[^#*`>].-\r\n\r\n" with "\r\n\r\n" (lpeg pattern) +* finding and replacing "`Config_hotkey=" with "#### " (lpeg pattern) +* finding and replacing "::.-\n> " with "\n" (lpeg pattern) +* converting the markdown to HTML with the following command: +`pandoc -o cheat_sheet.html -S --section-divs -c reset.css -c cheat_sheet.css Default_hotkeys.md` + +-- No, neither the resulting markdown, nor the HTML source is pretty. But with +the accompanying CSS it looks good. \ No newline at end of file diff --git a/doc/Cheat_sheet/cheat_sheet.css b/doc/Cheat_sheet/cheat_sheet.css new file mode 100644 index 0000000..664f1ef --- /dev/null +++ b/doc/Cheat_sheet/cheat_sheet.css @@ -0,0 +1,77 @@ +/*body { background-color: red; }*/ +.level2 { + background-color: white; + font-family: Ubuntu; + font-size: 12px; +/* position: absolute; top: 10mm; left: 10mm;*/ + position: absolute; top: 0; left: 0; + height: 190mm; + width: 277mm; +} +h2 { +/* background-color: #008AB8;*/ + border-radius: 4px; + border-top: 2px solid #008AB8; + border-bottom: 2px solid #008AB8; + color: #008AB8; +/* color: white;*/ + font-size: 24px; + font-weight: bold; + padding: 8px; + text-align: center; + width: 75.8mm; +} + +.level3 { + border-bottom: 2px solid; + border-color: #008AB8; + border-radius: 2px; + width: 90mm; +} +h3 { + background-color: #008AB8; + border-top-left-radius: 2px; + border-top-right-radius: 2px; + color: white; + font-size: 16px; + font-weight: bold; + padding: 4px; +} + +.level4 { margin: 4px 0; } +.level4:last-child { margin: 0px 0; } +.level4:nth-child(2n+1) { background-color: lightgrey; } +h4 { + float: left; + font-family: Ubuntu Mono; + padding: 0 1mm; + width: 16mm; +} +p { + margin-left: 18mm; + padding: 0 1mm; +} + +#abbreviations { position: absolute; top: 0.0mm; left: 0; } +#layout-management { position: absolute; top: 41.3mm; left: 0; } +#administration { position: absolute; bottom: 0; left: 0; } + +#window-management { position: absolute; top: 0; left: 93.5mm; } +#window-debugging { position: absolute; bottom: 10.6mm; left: 93.5mm; } + +#view-tag-management { position: absolute; top: 0.0mm; right: 0; } +#monitor-management { position: absolute; top: 58.3mm; right: 0; } +h2 { position: absolute; top: 132.0mm; right: 0; } +#gui-management { position: absolute; bottom: 0; right: 0; } + +code { font-family: Ubuntu Mono; } +kbd { + background-color: lightgrey; + border: 1px solid grey; + border-bottom-width: 2px; + border-radius: 2px; + font-family: Ubuntu Mono; + font-size: 10px; + padding: 1px 4px; +} +li { padding: 4px; } \ No newline at end of file diff --git a/doc/Cheat_sheet/cheat_sheet.html b/doc/Cheat_sheet/cheat_sheet.html new file mode 100644 index 0000000..90fbeb0 --- /dev/null +++ b/doc/Cheat_sheet/cheat_sheet.html @@ -0,0 +1,295 @@ + + + + + + + + + + + + +
+

bug.n default hotkeys

+
+

Abbreviations

+
    +
  • ! Alt
    • +
  • ^ Ctrl, Control
    • +
  • # Win / LWin, the left Windows key
    • +
  • + Shift
    • +
+
+
+

Window management

+
+

#Down

+

Activate the next window in the active view.

+
+
+

#Up

+

Activate the previous window in the active view.

+
+
+

#+Down

+

Move the active window to the next position in the window list of the view.

+
+
+

#+Up

+

Move the active window to the previous position in the window list of the view.

+
+
+

#+Enter

+

Move the active window to the first position in the window list of the view.

+
+
+

#c

+

Close the active window.

+
+
+

#+d

+

Show / Hide the title bar of the active window.

+
+
+

#+f

+

Toggle the floating status of the active window.

+
+
+

#^m

+

Minimize the active window.

+
+
+

#+m

+

Move the active window by key (only floating windows).

+
+
+

#+s

+

Resize the active window by key (only floating windows).

+
+
+

#+x

+

Move and resize the active window to the size of the work area (only floating windows).

+
+
+

#i

+

Get information for the active window.

+
+
+

#+i

+

Get a window list for the active view.

+
+
+

!Down

+

Manually move the active window to the next area in the layout.

+
+
+

!Up

+

Manually move the active window to the previous area in the layout.

+
+
+

!+Enter

+

Move and resize the active window to the size of the work area (only floating windows).

+
+
+

!

+

Manually move the active window to the nth area in the layout (n = 1..9).

+
+
+

!0

+

Manually move the active window to the nth area in the layout.

+
+
+

!BackSpace

+

Toggle the stack area of the layout.

+
+
+
+

Window debugging

+
+

#^i

+

Dump window information on the windows of the active view to the log.

+
+
+

#+^i

+

Dump window information on the contents of the managed window list to the log.

+
+
+

#^h

+

Print a description of the formatting (column headings) used in the previous two log messages to the log.

+
+
+

#^d

+

Decrement the debug log level.

+
+
+

#^+d

+

Increment the debug log level.

+
+
+
+

Layout management

+
+

#Tab

+

Set the previously set layout.

+
+
+

#f

+

Set the floating layout.

+
+
+

#m

+

Set the monocle layout.

+
+
+

#t

+

Set the tile layout.

+
+
+

#Left

+

Reduce the size of the master area in the active view (only for the “tile” layout).

+
+ +
+

#^t

+

Rotate the layout axis (only for the “tile” layout).

+
+
+

#^Enter

+

Mirror the layout axis (only for the “tile” layout).

+
+
+

#^Tab

+

Rotate the master axis (only for the “tile” layout).

+
+
+

#^+Tab

+

Rotate the stack axis (only for the “tile” layout).

+
+
+

#^Up

+

Increase the master Y dimension by 1 (only for the “tile” layout).

+
+
+

#^Down

+

Decrease the master Y dimension by 1 (only for the “tile” layout).

+
+
+

#^Right

+

Increase the master X dimension by 1 (only for the “tile” layout).

+
+
+

#^Left

+

Decrease the master X dimension by 1 (only for the “tile” layout).

+
+
+

#+Left

+

Decrease the gap between windows in “monocle” and “tile” layout.

+
+
+

#+Right

+

Increase the gap between windows in “monocle” and “tile” layout.

+
+
+
+

View / Tag management

+
+

#+n

+

Toggle the view margins.

+
+
+

#BackSpace

+

Activate the previously activated view.

+
+
+

#+0

+

Tag the active window with all tags (n = 1..Config_viewCount).

+
+
+

#

+

Activate the nth view (n = 1..Config_viewCount).

+
+
+

#+

+

Tag the active window with the nth tag (n = 1..Config_viewCount).

+
+
+

#^

+

Add / Remove the nth tag (n = 1..Config_viewCount) for the active window, if it is not / is already set.

+
+
+
+

Monitor management

+
+

#.

+

Activate the next monitor in a multi-monitor environment.

+
+
+

#,

+

Activate the previous monitor in a multi-monitor environment.

+
+
+

#+.

+

Set the active window’s view to the active view on the next monitor in a multi-monitor environment.

+
+
+

#+,

+

Set the active window’s view to the active view on the previous monitor in a multi-monitor environment.

+
+
+

#^+.

+

Set all windows of the active view on the active view of the next monitor in a multi-monitor environment.

+
+
+

#^+,

+

Set all windows of the active view on the active view of the previous monitor in a multi-monitor environment.

+
+
+
+

GUI management

+
+

#+Space

+

Hide / Show the bar (bug.n status bar) on the active monitor.

+
+
+

#Space

+

Hide / Show the task bar.

+
+
+

#y

+

Open the command GUI for executing programmes or bug.n functions.

+
+
+

#+y

+

Toggle the overflow window of the ‘notify icons’.

+
+
+

!+y

+

Indicate the areas of the “tile” layout.

+
+
+
+

Administration

+
+

#^e

+

Open the configuration file in the standard text editor.

+
+
+

#^s

+

Save the current state of monitors, views, layouts to the configuration file.

+
+
+

#^r

+

Reload bug.n (i. e. the whole script).

+
+
+

#^q

+

Quit bug.n, restore the default Windows UI and show all windows.

+
+
+
+ + diff --git a/doc/Cheat_sheet/reset.css b/doc/Cheat_sheet/reset.css new file mode 100644 index 0000000..9ce89e8 --- /dev/null +++ b/doc/Cheat_sheet/reset.css @@ -0,0 +1,48 @@ +/* http://meyerweb.com/eric/tools/css/reset/ + v2.0 | 20110126 + License: none (public domain) +*/ + +html, body, div, span, applet, object, iframe, +h1, h2, h3, h4, h5, h6, p, blockquote, pre, +a, abbr, acronym, address, big, cite, code, +del, dfn, em, img, ins, kbd, q, s, samp, +small, strike, strong, sub, sup, tt, var, +b, u, i, center, +dl, dt, dd, ol, ul, li, +fieldset, form, label, legend, +table, caption, tbody, tfoot, thead, tr, th, td, +article, aside, canvas, details, embed, +figure, figcaption, footer, header, hgroup, +menu, nav, output, ruby, section, summary, +time, mark, audio, video { + margin: 0; + padding: 0; + border: 0; + font-size: 100%; + font: inherit; + vertical-align: baseline; +} +/* HTML5 display-role reset for older browsers */ +article, aside, details, figcaption, figure, +footer, header, hgroup, menu, nav, section { + display: block; +} +body { + line-height: 1; +} +ol, ul { + list-style: none; +} +blockquote, q { + quotes: none; +} +blockquote:before, blockquote:after, +q:before, q:after { + content: ''; + content: none; +} +table { + border-collapse: collapse; + border-spacing: 0; +} \ No newline at end of file