bug.n/doc/Overview.md

Documentation overview

This page links the resources available for information on installing and running, customizing and using bug.n, a list of changes made with the current version and the Wiki pages available for additional information.

README

A description of what bug.n can do.

CHANGES

A list of changes to the user interface (i.a. configuration variables and hotkeys) for each version of bug.n.

Installing and running bug.n

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 Microsoft Windows higher than Vista.

Stable version

The current stable version of bug.n as a package (.zip file); it includes the source, a compiled version as one executable and the corresponding documentation for that version.

Development version

The development version of bug.n as a package (.zip file); it includes the source, a compiled version as one executable and the corresponding documentation for the current development status.

Usage

Using bug.n

A short introduction on how to use bug.n and on concepts, like layouts and tagging, bug.n uses.

Default hotkeys

A list of all hotkeys with their default mapping to functions and a short description.

Customization

Customizing bug.n

A description on how to customize bug.n by setting configuration variables and hotkeys. Also described is a method to re-use the hotkey WinL, which is blocked by the Windows function to lock the screen.

Default setting of configuration variables

A list of all configuration variables with their default values and a short description.

Configuring rules

A description of 'rules', bug.n uses for handling windows, and how they can be set in Config.ini.

Default hotkeys

A list of all hotkeys with their default mapping to functions and a short description.

Used hotkeys

An overview of those hotkeys, already in use by bug.n with the default configuration. With this overview you may find unused keys, which can be used for non-bug.n hotkeys or to reassign bug.n functions.

User proposed hotkeys

Some individual hotkeys, proposed by bug.n users.

LICENSE

bug.n is licensed under the GNU General Public License version 3.

CREDITS

A list of people and projects, which contributed to bug.n.

Wiki

Configuration examples

Some configuration examples given as a Config.ini and shown by a screenshot.

Default hotkeys cheat sheet

A cheat sheet giving an overview of the default hotkeys on one page (PDF).

Documentation

The documentation in the doc directory of the repository, which is also linked above.

Q&A

Some questions and answers regarding bug.n and window management in general.

Tutorials

Some tutorials explaining bug.n and its functionality in more detail.