summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README51
1 files changed, 51 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..31e1edc
--- /dev/null
+++ b/README
@@ -0,0 +1,51 @@
+README Kommando v0.3.0:
+
+What is Kommando?
+
+Basically Kommando can be considered a menu providing fast access to favorit commands.
+The user can arrange links to the applications or shellscripts (though only shellscripts independent from the position they are run from, yet) in a circle shaped menu.
+This menu can be easiliy accessed by a keyboard shortcut. This enhances workflow significantly, as you can find the app you need in no time.
+
+What are Kommandos features?
+
+Besides the features mentioned above, Kommando supports the organization of commands in submenus containing other commands or submenus. (Well nesting submenus really shouldn't be overdone, although it is possible ;-) )
+Another fancy feature is the ability to define context sensitive menus. You just have to open the configuration menu, click the "new" button on the top right and
+select an open window of the application kommando shell react on. Try the included config file. It interfaces with our favourite music player amarok via dcop ;-)
+
+How does it work?
+
+Kommando draws a borderless widget with buttons representing commands. It can be invoked by pressing ALT+CONTROL+H by default or any other shortcut you specify and appears under the mouse cursor's position.
+By clicking one of the buttons, you can either issue the command bound to the button or enter/leave a submenu.
+Another way of invoking Kommando is using DCOP calls. This is especially usefull when you are trying to make Kommando work with Mousegestures or through other programs which can only execute a console command. Refere to the Tricks section for more pieces of information.
+If you managed to make Kommando showing up, then there are several ways to use it. First of all, you can simply click on a button to execute it. Another way is to scroll through the buttons using the mousewheel or the keyboards arrow keys (god bless modulo arithmetics) or to directly jump to a button by pressing its corresponding number (1-9) on the keyboard. You will notice that the navigation button in the middle changes. This means that you can execute the selected button by simply clicking the navigation button or by pressing enter.
+
+How to configure it?
+Kommando is yet easy to configure through the dialog which appears if you click on the tray icon. But if you are a purist (well, why are you using kommando then ;-) ) you can simply edit the config file, which is in self explaining XML format. You can find it here: $HOME/.kommandorc
+
+Are there any tricks?
+
+If you don't think that using a keyboard shortcut is fun, I agree!
+But if you have a mouse with a spare button I recommend imwheel to you.
+This programm can be used to catch X11 events and emit keystrokes. Just map the Kommando shortcut to the mousebutton and let the fun begin!
+
+Here is an excerpt from my imwheelrc:
+
+ ...
+ #map CONTROL+ALT+H to thumbbutton
+ ,Right,Control_L|Alt_L|H
+ ...
+
+Another possibility are DCOP calls. If you want Kommando to show up, just type:
+ dcop kommando Menu show
+to hide it use "hide" instead of show and if you are lazy you can just use "toggle" to toggle between the visibility states.
+DCOP Calls are most useful, if you try to invoke Kommando through an external application, that is only able to start execute console commands.
+
+KNOWN ISSUES/ PLANNED FEATURES:
+ - Kommando does not respect the screen border and kicker, so if you invoke it close to one of both, some buttons will be obscured (on my KDE 3.5 box this problem does not exist anymore, but there are some graphics artifacts in the background image)
+
+A final statement?
+
+Yes, if you have any suggestions/enhancements/criticism or found a nasty bug please let me know!
+the_docter@gmx.net
+
+Thanks for using Kommando ;-) \ No newline at end of file