Changeset 2150 for trunk/rms

Show
Ignore:
Timestamp:
07/16/00 08:40:13 (8 years ago)
Author:
graham
Message:

Proper readme

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • trunk/rms/README

    r1865 r2150  
    1 Licq ICQ Forwarder Plugin 
     1Licq ICQ Remote Management Service Plugin 
    22___________________________ 
    33 
     
    1212make install 
    1313 
    14 And then move licq_email.conf to ~/.licq/licq_email.conf and edit this 
     14And then move licq_rms.conf to ~/.licq/licq_rms.conf and edit this 
    1515file appropriately. 
    1616 
     
    1818DESCRIPTION 
    1919 
    20 This program is an ICQ forwarder.  It is a plugin for the Licq 
    21 daemon and can run either on it's own on along with an interface plugin 
    22 (such as the Qt-gui or console plugins). 
    23 This program is distributed under the GPL, see the accompanying COPYING 
    24 file for more information. 
    25 Any events (messages, urls...) received while the plugin is enabled will 
    26 be forwarded either via standard SMTP to a given email account or via ICQ 
    27 to a given UIN.  The resulting message will appear as follows if sent via 
    28 email: 
    29  
    30 ----------------------------------------------------------- 
    31 Date: Sat Nov 13 14:07:08 1999 
    32 From: HackICQ <8562000@pager.mirabilis.com> 
    33 Reply-To: Foo Bar <hackers@uwaterloo.ca> 
    34 To: Apotheosis <graham@localhost.localdomain> 
    35 Subject: Message [This is a regular message sent from...] 
    36  
    37 This is a regular message sent from HackICQ 
    38 to Apotheosis. 
    39  
    40 ----------------------------------------------------------- 
    41  
    42 The From field will contain the Alias of the user who sent the message, 
    43 along with their ICQ pager email address (any email sent to that address 
    44 will be forwarded to their icq account).  The Reply-To field contains 
    45 the full name and real email address of the sender. 
    46 The subject field will contain the type of event (message, url, 
    47 chat request...) and the first 20 characters of the message. 
     20This program is a remote management server for Licq. 
    4821 
    4922 
    5023RUNNING 
    5124 
    52 Loading and running the plugin is simply a matter of adding a "-p forwarder" 
     25Loading and running the plugin is simply a matter of adding a "-p rms" 
    5326to your Licq command line arguments.  Remember that if any plugins are 
    5427loaded from the command line then all plugins must be specified.  In other 
    5528words if you are using the qt-gui plugin and also wish to start the forwarder  
    5629plugin, run: 
    57 licq [options] -p qt-gui -p forwarder -- [ qt-gui options ] -- [ forwarder options ] 
    58  
    59 The forwarder plugin starts in an inactive state, and must be turned on from 
    60 the plugin interface to start forwarding messages.  In this manner it can be 
    61 turned on and off without having to exit Licq. 
    62 Optionally, or if the only plugin desired is the forwarder, it can 
    63 be started enabled by using the "-e" parameter on the command line.  Remember 
    64 that all plugin options must come after a "--" on the command line. 
    65 The "-l <status>" option will tell the plugin to automatically log on in the 
    66 given status at startup.  This is equivalent (and uses the same status strings as) 
    67 the fifo command "status" (see the FAQ under FIFO). 
    68  
    69 For example, to start Licq using only the forwarder and have it start in 
    70 enabled mode and logon, run: 
    71 licq -f -p email -- -e -l online 
    72  
    73 The "-f" option to Licq tells it to fork into the background, thus running Licq 
    74 in true daemon mode.  This is optional in any case. 
    75 Another useful option in this case is "-o <filename>" which will redirect the Licq 
    76 log messages to a file (or device, such as /dev/tty9). 
     30licq [options] -p qt-gui -p forwarder -- [ qt-gui options ] -- [ rms options ] 
    7731 
    7832 
    7933CONFIGURING 
    8034 
    81 The plugin uses a small configuration file (~/.licq/licq_forwarder.conf) which must 
     35The plugin uses a small configuration file (~/.licq/licq_rms.conf) which must 
    8236be set up by hand.  A sample is included with the source, and includes help on 
    8337the various settings.