aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README83
1 files changed, 54 insertions, 29 deletions
diff --git a/README b/README
index de14378..0c1c5b4 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
==================================
- dzen, (c) 2007 by Robert Manea
+ dzen, (c) 2007 by Robert Manea
==================================
A general purpose messaging, notification and menu program
@@ -9,7 +9,7 @@ The "gadgets" subdirectory contains some tools that you can
use in combination with dzen.
Script archive with a collection of interesting ideas:
- http://gotmor.googlepages.com/dzenscriptarchive
+^fg(lightblue) http://gotmor.googlepages.com/dzenscriptarchive
@@ -26,6 +26,8 @@ Features
* menu functionality
+ * in-text formating language
+
* flexible event/action mechanism
* hideable, collapsable
@@ -77,10 +79,10 @@ dzen accepts a couple of options:
-tw title window width
-sa alignment of slave window, see "-ta"
-l lines, see (1)
- -e events and actions, see (2)
- -m menu mode, see (3)
+ -e events and actions, ^fg(green)see (2)
+ -m menu mode, ^fg(green)see (3)
-u update contents of title and
- slave window simultaneously, see (4)
+ slave window simultaneously, ^fg(green)see (4)
-p persist EOF (optional timeout in seconds)
-x x position
-y y position
@@ -88,12 +90,12 @@ dzen accepts a couple of options:
-xs number of Xinerama screen
-v version information
- For dynamic color support see (5).
+ see (5) for the in-text formating language.
Window layout
-------------
+-------------
Dzen's window layout is as follows:
@@ -146,8 +148,8 @@ A4: Sure, see "(4) Simultaneous updates".
Q5: Can i chnage color of my input at runtime?
-A5: Yes, you can change both background and foreground colors.
- See "(5) Dynamic color support"
+A5: Yes, you can change both background and foreground colors and
+ much more See "(5) In-Text formating language"
Q6: Can I use dzen as a menu?
@@ -156,11 +158,6 @@ A6: Yes, both vertical and horizontal menus are supported.
See "(3) Menu" for further details.
-Q7; What is the expected format to the '-fn' option?
-
-A7: Run 'xfontsel' or 'xlsfonts'. These should come with your X
- distribution by default.
-
Termination:
@@ -204,7 +201,7 @@ and down if the content exceeds the window height (default action).
(2) Option '-e': Events and actions
-----------------------------------
+-----------------------------------
dzen allows the user to associate actions to events.
@@ -222,7 +219,7 @@ An example:
button1=exec:xterm:firefox;
on Button1 event (Button1 press on the mouse) execute xterm and
firefox.
- (Note: xterm and firefox are options to the exec action)
+ Note: xterm and firefox are options to the exec action
entertitle=uncollapse,unhide;
on entertitle (mouse pointer enters the title window) uncollapse
@@ -374,32 +371,60 @@ of lines to the slave window as defined by the parameter to '-l'.
-(5) Dynamic color support:
---------------------------
+(5) In-text formating language:
+-------------------------------
-This feature allows to dynamically (at runtime) set foreground and
-background colors for dzen's input (colored text) working in all
-modes (title only, slave window and menu mode).
+This feature allows to dynamically (at runtime) format the text dzen
+displays.
-Syntax:
+Currently the following commands are supported:
-Foreground color: ^fg(color)
-Background color: ^bg(color)
+ ^fg(color) set foreground color
+ ^bg(color) set background color
+ ^i(path) draw icon specified by path
+ ^r(WIDTHxHEIGHT) draw a rectangle with the dimensions
+ WIDTH and HEIGHT
These commands can appear anywhere and in any combination in dzen's
-input. The color can be specified either as symbolic name (e.g. red,
+input.
+
+The color can be specified either as symbolic name (e.g. red,
darkgreen, etc.) or as #rrggbb hex-value (e.g. #ffffaa).
-Doubling the '^' character removes the special meaning from it.
+Icons must be in the XBM format, see the "bitmaps" directory for some
+sample icons. With the standard "bitmap" application you can easily draw
+your own icons, though there are lots floating around on your harddisk
+or on the web.
+
+Rectangles will be truncated to the maximum possible size if you specify
+a size bigger than dzen's window.
+
+Doubling the '^^' character removes the special meaning from it.
+
Some examples:
- ^fg(red)I'm red text ^fg(blue)I am blue
+ Input:
+ ^fg(red)I'm red text ^fg(blue)I am blue
+
+
+ Input:
+ ^bg(#ffaaaa)The ^fg(yellow)text to ^bg(blue)^fg(orange)colorize
+
+
+ Input:
+ ^fg(grey70)Some text containing ^^ characters
+
+
+ Input for icons:
+ ^i(bitmaps/envelope.xbm) I am an envelope ^fg(yellow)and ^i(bitmaps/battery.xbm) I'm a baterry.
+
+
+ Input for rectangles:
+ 6x4 rectangle ^r(6x4) ^fg(red)12x8 ^r(12x8) ^fg(yellow)and finally 100x15 ^r(100x15)
- ^bg(#ffaaaa)The ^fg(yellow)text to ^bg(blue)^fg(orange)colorize
- ^fg(grey70)Some text containing ^^ characters