From 0e27e1759787f390bfedae49ce83c083daf70a6d Mon Sep 17 00:00:00 2001 From: Josh Holtrop Date: Tue, 19 Jul 2011 11:20:11 -0400 Subject: [PATCH] add documentation for 'mouse' configuration item --- README | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README b/README index f367eea..23b4033 100755 --- a/README +++ b/README @@ -38,6 +38,23 @@ Available configuration parameters: This value will be updated by the program when it closes. 'mailbox': String giving the name of the mailbox directory to search for the unread message count (if unspecified, uses "Inbox"). +'mouse': A hash which configures the actions for the program to take + in response to a mouse click. The keys of this hash can be + 'left', 'middle', or 'right'. The values of the hash can take + the following forms: + 'exit' - the program will terminate + 'reconnect' - the program will reconnect to the IMAP server + 'cmd:COMMAND' - the command COMMAND will be executed + The cmd:COMMAND form can be used to execute arbitrary processes + in response to a mouse click. This can be used to raise a mail + client window, for example: + mouse = { + 'middle': 'reconnect', + 'right': 'exit', + 'left': 'cmd:"C:\\Program Files\\Microsoft Office\\' + 'Office12\\OUTLOOK.EXE" /recycle ' + '/select "outlook:Sent Items"' + } 'password': String containing the password to use to connect to the server 'port': String containing the port number of the IMAP SSL port on the mail server.