Browse files

README updates

  • Loading branch information...
1 parent ff659a2 commit f0000bfbe9933bd25944bb250e54aaba19da86e2 @jwiegley committed Aug 26, 2011
Showing with 10 additions and 10 deletions.
  1. +10 −10 README.org
View
20 README.org
@@ -8,7 +8,7 @@ by the user.
Just use =alert= instead of =message= as follows:
-#+begin_src emacs-lisp
+#+begin_src lisp
(require 'alert)
;; This is the most basic form usage
@@ -35,32 +35,32 @@ For the user, there are several variables to control when and how alerts
are presented. By default, they appear in the minibuffer much the same
as a normal Emacs message. But there are many more possibilities:
- - alert-fade-time ::
+ - =alert-fade-time= ::
Normally alerts disappear after this many seconds, if the style
supports it. The default is 5 seconds.
- - alert-default-style ::
+ - =alert-default-style= ::
Pick the style to use if no other config rule matches. The
default is =message=, but =growl= works well too.
- - alert-reveal-idle-time ::
+ - =alert-reveal-idle-time= ::
If a config rule choose to match on =idle=, this is how many
seconds idle the user has to be. Defaults to 5 so that users
don't miss any alerts, but 120 is also good.
- - alert-persist-idle-time ::
+ - =alert-persist-idle-time= ::
After this many idle seconds, alerts will become sticky, and not
fade away more. The default is 15 minutes.
- - alert-log-messages ::
+ - =alert-log-messages= ::
By default, all alerts are logged to *Alerts* (and to *Messages*,
if the =message= style is being used). Set to nil to disable.
- - alert-hide-all-notifications ::
+ - =alert-hide-all-notifications= ::
Want alerts off entirely? They still get logged, however, unless
you've turned that off too.
- - alert-user-configuration ::
+ - =alert-user-configuration= ::
This variable lets you control exactly how and when a particular
alert, a class of alerts, or all alerts, get reported -- or if at
all. Use this to make some alerts use Growl, while others are
@@ -73,7 +73,7 @@ customizing =alert-user-configuration=. Here is one that the author
currently uses with ERC, so that the fringe gets colored whenever people
chat on BitlBee:
-#+begin_src emacs-lisp
+#+begin_src lisp
(alert-add-rule :status '(buried visible idle)
:severity '(moderate high urgent)
:mode 'erc-mode
@@ -111,7 +111,7 @@ a function that receives the details of the alert. These details are
given in a plist which uses various keyword to identify the parts of the
alert. Here is a prototypical style definition:
-#+begin_src emacs-lisp
+#+begin_src lisp
(alert-define-style 'style-name :title "My Style's title"
:notifier
(lambda (info)

0 comments on commit f0000bf

Please sign in to comment.