#==============================================================
#
#  Name: README
#
#  Rem:  This directory contains EPICS Magnet Application
#        scripts that generate ChannelWatcher config and 
#        restore files.
#
#        I) To create ChannelWatcher config files: 
#
#        Note: The configuration files generated should 
#        be CVS'ed in $TOOLS/ChannelWatcher/config and the
#        filename added to $TOOLS/ChannelWatcher/config/LCLS.Master 
#         
#        1. For each sector, create a list of devices and place in  
#           the directory for that sector (eg. li21).
#           The file naming convention for the device list is:
#
#                 mgnt_<sector>_all.dev
#                 mgnt_<sector>_<type>.dev
#
#        2. Define a list of attributes to associate with each 
#           device and place this file in the directory "attr".
#           The file naming convention for the attributes list is:
#
#                mgnt_all.cwConfig 
#                mgnt_<type>.cwConfig
# 
#        3) Create the script that will provide the input and output 
#           files used by the perl script cw.pl. The file naming
#           convention used for this script is:
#
#                mgnt_<sector>_cwConfig.csh
#            ex) mgnt_li21_cwConfig.csh
#           
#           Output files:
#           -------------
#           The ChannelWatcher configuration file that is
#           generated from the perl script is written to:
#
#               /config/<nodename>.cwConfig
#               ex) IOC-IN20-MG01.cwConfig
#
#           Usage: To envoke this script do the following:
#                  1) add the generated script filename to 
#                     $TOOLS/ChannelWatcher/config/LCLS.Master.cwConfig
#                  ex) IOC_IN20-MP01 epics/ioc/data/IM20/restore/ioc-in20-mp01.sav
#
#       II) To create ChannelWatcher restore files:
#
#          1) See item 1 above.
#
#          2) Define a list of attribute, value pairs to associate 
#             with each device type and place this file in the 
#             the directory "attr". The file naming convention used
#             for the attributes list is:
#
#               mgnt_all.cw
#               mgnt_<type>.cw
#
#         3) Create the script that will provide the input and output 
#            files used by the perl script cw.pl. The file naming 
#            convention for this script is:
#
#                  mgnt_<sector>.cw.csh
#              ex) mgnt_li21_cw.csh 
#           
#           Output files:
#           -------------
#           The ChannelWatcher retstore file that is
#           generated from the perl script is written to:
#
#              $IOC_DATA/<micro alias>/config/mgnt_<sector>.cw
#              ex) $IOC_DATA/LM21/config/mgnt_li21.cw
#
#          Usage: To envoke this ChannelWatcher script that 
#                 has been generated issue the following 
#                 command from the Unix shell:
#
#                   CWput <filename>
#                   ex) CWput mgnt_li21.cw
#
#  Loc:  /afs/slac/g/lcls/epics/ioc/mgntApp/mgntApp/script/li21
#
#  Auth: 20-Feb-2007, Koosh           (KOOSH)
#  Rev:  dd-mmm-yyyy, Reviewer's Name (USERNAME)
#--------------------------------------------------------------
#  Mod:
#        dd-mmm-yyyy, First Lastname  (USERNAME):
#          comments
#
#==============================================================
#
Files and Directory         Description
--------------------        -----------------
README                      This file
device                      Directory for device list files
mgnt_li21_caput.csh         Script to generate injector caput file
mgnt_li21_cwConfig.csh      Script to generate injector ChannelWatcher config files
mgnt_li21_cw.csh            Script to generate injector ChannelWatcher restore files
