Warning, /pim/kalarm/INSTALL is written in an unsupported language. File is not indexed.

0001 Requirements
0002 ============
0003 
0004 The following KDE packages must be installed in order to run KAlarm
0005 successfully:
0006    - Various KDE frameworks libraries
0007    - Various KDE PIM libraries
0008 
0009 KAlarm can use Akonadi if available, to provide email alarms, access to
0010 birthdays, and KOrganizer alarms and todos. Akonadi functions are accessed
0011 via KAlarm's Akonadi plugin, which is optionally built and installed when
0012 KAlarm is built. The following KDE packages must be installed in order to
0013 use KAlarm's Akonadi plugin:
0014    - Various KDE PIM Akonadi libraries
0015    - kdepim-runtime
0016 
0017 The following optional packages enhance KAlarm if they are installed:
0018    - Qt TextToSpeech: if installed and configured (together with compatible
0019            speech synthesiser packages), it allows KAlarm to speak alarm
0020            messages when alarms are displayed.
0021 
0022 Setting up KAlarm on non-KDE desktops
0023 =====================================
0024 
0025 Although KAlarm is a KDE application and requires the above KDE packages to be
0026 installed on your system, you can still use it while running other desktops or
0027 window managers.
0028 
0029 In order to have alarms monitored and displayed automatically from one login
0030 session to the next, KAlarm must be run automatically when you graphically log
0031 in or otherwise start X. If you are running the KDE desktop, the KAlarm
0032 installation process sets this up for you.
0033 
0034 - GNOME 2
0035   =======
0036   Run Desktop Preferences -> Advanced -> Sessions. In the Sessions dialog,
0037   select the Startup Programs tab and click Add. Enter
0038   'kalarmautostart kalarm --tray' as the Startup Command. This will run KAlarm
0039   in the system tray every time you start up.
0040 
0041 - Other Window Managers
0042   =====================
0043   If you want to use KAlarm with a non-KDE window manager:
0044 
0045   1) If your desktop environment/window manager performs session restoration,
0046      ensure that the kalarm is included in the session restoration, and that
0047      after login or restarting X kalarm is running with a '-session' command
0048      line option, e.g.
0049 
0050          kalarm -session 117f000002000100176495700000008340018
0051 
0052      You can use the 'ps' command to check this.
0053 
0054      Using session restoration will ensure that alarm message windows which
0055      were displayed at the time of logout will be redisplayed when you log in
0056      again.
0057 
0058   2) To ensure that KAlarm is always started when you log in, even if it was
0059      not running at logout (so that it wouldn't be included in session
0060      restoration), you should configure one of the following commands to be run
0061      whenever you graphically log in or start X:
0062 
0063      a) If you cannot use session restoration to start KAlarm, run:
0064 
0065             kalarm --tray
0066 
0067      b) If you use session restoration, you MUST NOT use the above command, but
0068         instead run:
0069 
0070             kalarmautostart kalarm --tray
0071 
0072         The reason for using this command instead is that if 'kalarm --tray' is
0073         executed while session restoration is already underway, KAlarm will
0074         fail to start. This is an unavoidable consequence of how a KDE
0075         application interacts with session restoration.
0076 
0077      If your desktop environment or window manager has a facility to configure
0078      programs to be run at login, you can use that facility. Otherwise, you need
0079      to add the command to an appropriate script which is run after X is started.
0080 
0081   If you can send me details on how to set up KAlarm for any particular window
0082   manager, I will include these in the next version of KAlarm.