cde/examples/dtscreen/README

   1 /* $XConsortium: README /main/3 1996/07/15 14:01:10 drk $ */
   2
   3 This directory contains demonstrations of the Dt Screen Saver API
   4
   5 screensaver -   Example of a simple screen saver that uses the DT Screen
   6                 Saver API and techniques to make that screen saver
   7                 available to all desktop users or your own session.
   8
   9                 The desktop provides a set of screen savers for use
  10                 in desktop sessions. This set of screen savers can
  11                 be previewed and selected from the Style Manager Screen
  12                 dialog.
  13
  14                 Each screen saver is known to the desktop by the screen
  15                 saver's action definition. The screen saver's action
  16                 definition provides the desktop with a short localizable
  17                 title for the screen saver, as well as the command line
  18                 and options required to start the screen saver. When the
  19                 desktop starts a screen saver, it is started by invoking a
  20                 screen saver action.
  21
  22                 The set of screen saver actions available to a user's
  23                 desktop session is defined by the DTSCREENSAVERLIST
  24                 environment variable. The default DTSCREENSAVERLIST
  25                 set is defined when you start a desktop session. A
  26                 system administrator can change this set by creating
  27                 a script in directory /etc/dt/config/$LANG/Xsession.d
  28                 that modifies DTSCREENSAVERLIST. A user can do the
  29                 same in their $HOME/.dtprofile.
  30
  31                 A desktop screen saver is a simple application that
  32                 uses the DtSaverGetWindows() API to obtain a list of
  33                 windows, and draws on those windows. The desktop handles
  34                 the starting and stopping of the screen saver application.
  35
  36                 The 'screensaver' application is an example that shows
  37                 how the DtSaverGetWindows() API may be used, how the
  38                 screen saver action may be defined for 'screensaver' and
  39                 how the screen saver can be integrated into the desktop for
  40                 all desktop users or an individual desktop user. The screen
  41                 saver action is named SampleScreenSaver and is defined in
  42                 /usr/dt/examples/dtscreen/dt/appconfig/types/C/screensaver.dt.
  43
  44                 Making the screen saver available to all users
  45                 ----------------------------------------------
  46                 You must be root to make the screen saver available
  47                 to all users. This example assumes you are building
  48                 'screensaver' directly in /usr/dt/examples/dtscreen.
  49
  50                 1) Build the 'screensaver' application
  51
  52                    make -f Makefile.<platform>
  53
  54                 2) Register the screen saver action with the desktop
  55
  56                    dtappintegrate -s /usr/dt/examples/dtscreen
  57
  58                 3) Add the screen saver action to the list of available savers
  59
  60                    #create file /etc/dt/config/Xsession.d/myvars containing:
  61                    DTSCREENSAVERLIST="SampleScreenSaver $DTSCREENSAVERLIST"
  62
  63                 4) Make the /etc/dt/config/Xsession.d/myvars file executable:
  64
  65                    chmod 755 /etc/dt/config/Xsession.d/myvars
  66
  67                 The next time a user starts the desktop, the example screen
  68                 saver will be available for use.
  69
  70                 Making the screen saver to your own desktop session
  71                 ---------------------------------------------------
  72                 1) Copy the screen saver example to $HOME/dtscreen
  73
  74                    cp -r /usr/dt/examples/dtscreen $HOME/dtscreen
  75                    cd $HOME/dtscreen
  76
  77                 2) Build the 'screensaver' application
  78
  79                    make -f Makefile.<platform>
  80
  81                 3) Register the screen saver action with the desktop
  82
  83                    cp $HOME/dtscreen/dt/appconfig/types/C/screensaver.dt \
  84                      $HOME/.dt/types
  85
  86                 4) Change the action EXEC_STRING path
  87
  88                    vi $HOME/.dt/types/screensaver.dt
  89                    #change the EXEC_STRING to '<home>/dtscreen/screensaver',
  90                    #replacing <home> with the value of $HOME
  91
  92                 5) Add the screen saver action to the list of available savers
  93
  94                    #edit $HOME/.dtprofile and add:
  95                    DTSCREENSAVERLIST="SampleScreenSaver $DTSCREENSAVERLIST"
  96
  97                 The next time a user starts the desktop, the example screen
  98                 saver will be available for use.