diff options
| author | Simeon Simeonov | 2014-07-19 13:58:54 +0200 |
|---|---|---|
| committer | Simeon Simeonov | 2014-07-19 13:58:54 +0200 |
| commit | fa1aacfde8679551cebda346a2c45d04204441eb (patch) | |
| tree | 6dc0b0c754f8bdeec35db4e4d6aacc07a0897bd1 | |
| parent | a57a2a77dc5101ca3c62700e7bca4eaf4e25fd5c (diff) | |
README almost done
| -rw-r--r-- | README | 23 |
1 files changed, 23 insertions, 0 deletions
| @@ -27,7 +27,30 @@ beinc_generic_client.py - a simple client used to push notification messages | |||
| 27 | Why should I use BEINC and what has it done for me lately? | 27 | Why should I use BEINC and what has it done for me lately? |
| 28 | ---------------------------------------------------------- | 28 | ---------------------------------------------------------- |
| 29 | 29 | ||
| 30 | BEINC is designed to assist you two common scenarios. | ||
| 31 | As an example we will consider the case of an IRC cliet, although BEINC can be | ||
| 32 | used by any client that conforms with BEINC's "messaging protocol". | ||
| 30 | 33 | ||
| 34 | We have the common situation where a user is accessing an IRC client located on | ||
| 35 | a different computer (typically: weechat, irssi, etc. running on a remote server) | ||
| 36 | The IRC client receives a private message (or any event that requires the user's | ||
| 37 | attention) and the user has to be notified. | ||
| 38 | |||
| 39 | Scenario one: | ||
| 40 | The user's computer can be reached from the server running the IRC client. | ||
| 41 | If the server (running the IRC client) is able to connect to | ||
| 42 | a specified TCP port on the user's computer, this is sufficient for BEINC to | ||
| 43 | directly notify the user. Solution: | ||
| 44 | - set up the beinc_server.py on the desktop workstation (the computer where the | ||
| 45 | notification-message should be displayed). Define an unprivileged port for | ||
| 46 | beinc_server.py to listen on and enable its OSD capabilities | ||
| 47 | (through pynotify and/or pyosd) | ||
| 48 | - set up a BEINC client similar to beinc_generic_client.py on the server | ||
| 49 | If you are running weechat >=0.4.0, this version of BEINC comes with | ||
| 50 | a complete weechat BEINC-client: beinc_weechat.py | ||
| 51 | Configure the client to send notifications to the beinc_server.py | ||
| 52 | |||
| 53 | Scenario two: | ||
| 31 | 54 | ||
| 32 | 55 | ||
| 33 | 56 | ||
