[gromit] Incorporate the configfile stuff from the README into the manpage.
- From: Simon Budig <simon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gromit] Incorporate the configfile stuff from the README into the manpage.
- Date: Wed, 17 Mar 2010 01:49:24 +0000 (UTC)
commit 336d0e61f96d9fc3c17b6e91513a28c812bb464d
Author: Simon Budig <simon budig de>
Date: Wed Mar 17 00:57:12 2010 +0100
Incorporate the configfile stuff from the README into the manpage.
gromit.1 | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 62 insertions(+), 0 deletions(-)
---
diff --git a/gromit.1 b/gromit.1
index 0cacfce..032b165 100644
--- a/gromit.1
+++ b/gromit.1
@@ -85,6 +85,68 @@ will toggle the visibility of the window.
.TP
.B \-c, \-\-clear
will clear the screen.
+.SH Configuration:
+
+Gromit is configurable via the file ".gromitrc" in your Homedirectory.
+Here you can specify which Device/Button/Modifier combination invokes
+which tool. See the file "gromitconf" distributed with this program for
+an example. An overview on the syntax:
+
+ # Comments can be either # Shell-Style or
+ /* C-Style. */
+
+This entry defines the tool "red Pen", a pen with size 7 and color red.
+You can specify the color in X-Style: e.g. "#FF0033" or
+colors from rgb.txt.
+
+ "red Pen" = PEN (size=7 color="red");
+
+The following Entries copy an existing configuration (in this case
+"red Pen") and modify the color.
+
+ "blue Pen" = "red Pen" (color="blue");
+ "yellow Pen" = "red Pen" (color="yellow");
+
+You can also draw lines that end in an arrow head. For this you
+have to specify "arrowsize". This is a factor relative to the width
+of the line. For reasonable arrowheads start with 1.
+
+ "blue Arrow" = "blue Pen" (arrowsize=2);
+
+An "ERASER" is a tool that erases the drawings on screen.
+The color parameter is not important.
+
+ "Eraser" = ERASER (size = 75);
+
+A "RECOLOR"-Tool changes the color of the drawing without changing
+the shape. Try it out to see the effect.
+
+ "green Marker" = RECOLOR (color = "Limegreen");
+
+
+If you define a tool with the same name as an input-device
+(see the output of "xsetpointer -l", if there is a "SWITCH"-Tool
+it is uninteresting...) this input-device uses this tool.
+Additionally you can limit the Scope to specific combinations of
+Mousebuttons (1,2,3,4,5 or Button1,...,Button5)
+and Modifiers (SHIFT, CONTROL, ALT, META, while ALT==META).
+
+ "Core Pointer" = "red Pen";
+ "Core Pointer"[SHIFT] = "blue Pen";
+ "Core Pointer"[CONTROL] = "yellow Pen";
+ "Core Pointer"[2] = "green Marker";
+ "Core Pointer"[Button3] = "Eraser";
+
+The descision, which tool to use follows a simple policy:
+ a) Buttons are more important than Modifiers
+ b) Low number Buttons are more important than higher ones
+ c) Modifiers: SHIFT > CONTROL > ALT/META.
+ d) Gromit tries partial matches:
+ If you define "Core Pointer"[] and "Core Pointer"[SHIFT, CONTROL]
+ and only SHIFT actually is pressed, Gromit will use the second
+ definition if there is no "Core Pointer"[SHIFT] definition.
+ Same logic goes for the buttons.
+
.SH BUGS
Gromit may drastically slow down your X-Server, especially when you draw
very thin lines. It makes heavily use of the shape extension, which is
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]