!=============================================================================!
!  DIVISION   I	:				     HELP MODULE DECLARATION  !
!=============================================================================!
!									      !
!      -----------------------------------------------------------------      !
!      SECTION 01 :					 INITIAL VERSION      !
!      -----------------------------------------------------------------      !
!									      !
!      File Specification: ACC_HELP:EBS.HLP  			              !
!      Author		 : Allen J. Miller				      !
!      Initial version	 : 01.00.00 04-SEP-1985	VMS 4.2			      !
!									      !
!=============================================================================!
!  DIVISION  II	:				  HELP MODULE SPECIFICATIONS  !
!=============================================================================!
!									      !
!      Key 1 (Command name)............	EBS				      !
!	 Key 2 ........................	Operation			      !
!	 Key 2 ........................	Examples			      !
!	 Key 2 ........................	Qualifiers			      !
!	 /qualifier ...................	/ALL				      !
!	 /qualifier ................... /BELL				      !
!	 /qualifier ................... /ENHANCED_VIDEO			      !
!	 /qualifier ................... /LOG				      !
!	 /qualifier ................... /SELF				      !
!	 /qualifier ................... /TERMINAL			      !
!	 /qualifier ................... /USERNAME			      !
!	 /qualifier ................... /WAIT				      !
!									      !
!=============================================================================!
!
!==============================================================================!
! Key 1									   EBS !
!==============================================================================!
!
1 EBS
Sends a message to specified terminals and/or users regardless of the 
state of the terminal or the broadcast settings.

Format:

      $ EBS "message-text"
!
!==============================================================================!
! Key 2								     Operation !
!==============================================================================!
!
2  Operation
The EBS command allows access to the Emergency Broadcast System, which
is a system which will send a message to any user  regardless  of  the
PASSALL  or  PASTHRU  state of the target terminal. Broadcast settings
are also ignored by EBS. This is useful in situations such  as  BACKUP
warnings and when the system must be shut down during normal operating
hours.

While  EBS  was designed for operational use in the Academic Computing
Center, it can be useful for other users also.  You may include an EBS
command  in  a  job command file so that you will be notified when the
job completes.

Before sending a message to  a  user,  EBS  performs  several  checks.
One is that  the  user  must  have  privilege to get information about
the target user.  The required privileges are:

        OPER, WORLD, or SETPRV  : May send a message to any user.

                         GROUP  : May send a message to anyone in  the
                                  same UIC group.

             none of the above  : May  send  messages  to  users  with
                                  identical UICs.
!
!==============================================================================!
! Key 2								     Operation !
!==============================================================================!
!
2 Exclusions
EBS  checks  against  the permanent exclusion list to determine if the
target user or device has been excluded from recieving  EBS  messages.
The   permanent   exclusion  list  is  defined  by  the  logical  name
EBS_EXCLUSIONS.  The logical name can be defined in the system, group,
job,  and  process  name  tables.   If the name is defined in multiple
tables, the exclusion lists are concatenated.

There  are two ways in which EBS_EXCLUSIONS can be defined.  The first
is to define the logical name as a  list  of  device  and  user  names
separated  by  commas.  Device names must be terminated by a colon (:)
and may optionally be prefixed by an underscore (_).  Example:

        $ DEFINE EBS_EXCLUSIONS "SYS_USER,TT*:"

The second method is to define EBS_EXCLUSIONS  as  "@file-spec"  where
"file-spec"  contains  the  exclusion  list.   The  file  can  contain
multiple records and the exclaimation mark (!) is the comment  symbol.
Example:

        $ DEFINE EBS_EXCLUSIONS "@SYS_OPERATOR:EBS_EXCLUDE.LIS"

        where SYS_OPERATOR:EBS_EXCLUDE.LIS contains:

          !
          !           Emergency Broadcast System exclusion list.
          !
          !
          ! Device exclusions:
          !
          TT*:,TXD4:
          !
          ! Username exclusions:
          !
          SYS_OPR,FIELD

The  logical  name  EBS_EXCLUSIONS is only checked when the message is
sent.  Individual users cannot define EBS_EXCLUSIONS  to  prevent  EBS
messages from being delivered.
!
!==============================================================================!
! Key 2								      Examples !
!==============================================================================!
!
2 Examples
To send a message to all users on the system (except those excluded by
the EBS_EXCLUSIONS logical name), use the command:
                                               
        $ EBS/ALL "The system will be going down in 5 minutes."

A  message  can be sent to all users whose username begins with "OPR_"
by using a wildcard pattern:

        $ EBS/USERNAME=OPR_* "All operators attend the meeting at 3:00"

You can send a message to the users SYSTEM and SYS_OPERATOR by using a
list with the /USERNAME qualifier:

        $ EBS/USERNAME=(SYSTEM,SYS_OPERATOR) "Someone please help me!"

The target can be a terminal or range of terminals also:

        $ EBS/TERMINAL=TXB7: "Is your terminal working OK?"

        $ EBS/TERMINAL=(TXB7:,TXA*:) "Please save your work."

To  exclude a user or device from the target list, use the /NOUSERNAME
or /NOTERMINAL qualifier:

        $ EBS/ALL/NOUSER=SYS_USER/NOTERMINAL=TXD4: "This is a test."
!
!==============================================================================!
! Key 2	    							    Parameters !
!==============================================================================!
!
2 Parameters

message-text

  The message-text parameter specifies  the  text  to  be  sent  as  a
  messge.   The  message  the  target  user  receives  is formatted as
  follows:

      Message from SENDING_USERNAME dd-mmm-yyyy hh:mm:ss.cc
      message-text

  If  the  target  user  is  logged  on  a  terminal with the ANSI-CRT
  attribute, the message is highlighted and blinks.

  This parameter is required.
!
!==============================================================================!
! Key 2								    Qualifiers !
!==============================================================================!
!
2 Qualifiers
/ALL

  Send  a  message  to all terminals which are currently logged on the
  system.

/BELL

  /BELL   (D)
  /NOBELL

  Send a bell character with the message.

/ENHANCED_VIDEO

  /ENHANCED_VIDEO   (D)
  /NOENHANCED_VIDEO

  If the  target  user is  logged  on a  terminal  with the  ANSI  CRT
  attribute  set this causes the message to be displayed with the BOLD
  and BLINK video attributes.  The default is ENHANCED_VIDEO.

/LOG

  /LOG
  /NOLOG (D)

  Causes a message to be displayed on the sender's terminal indicating
  the identity of the terminals which were sent messages.  The default
  is NOLOG.

/SELF

  /SELF   (Default in batch mode)
  /NOSELF (Default in interactive mode)

  Sends a message to all sessions logged on under the same name as the
  calling  process.   This  qualifier  may be useful in batch jobs for
  sending status messages to an interactive session.

/TERMINAL

  /TERMINAL=(terminal-name[,...])
  /NOTERMINAL=(terminal-name[,...])

  Sends the message to the terminals specified by /TERMINAL, excluding
  those specified by /NOTERMINAL.  The  /NOTERMINAL  qualifier  always
  takes  precedence over /TERMINAL.  The terminal-name can contain the
  wildcard characters *,?, and #; * matches zero or more characters, ?
  matches  exactly  one alphanumeric characters, and # matches exactly
  one numeric character.

/USERNAME

  /USERNAME=(username[,...])
  /NOUSERNAME=(username[,...])

  Sends the message to the usernames specified by /USERNAME, excluding
  those specified by /NOUSERNAME.  The  /NOUSERNAME  qualifier  always
  takes  precedence  over  /USERNAME.   The  username  can contain the
  wildcard  characters  *,?,  and  #;  the  *  matches  zero  or  more
  characters,  ?  matches  exactly  one alphanumeric characters, and #
  matches exactly one numeric character.

/WAIT

  /WAIT[=time]
  /NOWAIT      (D)

  Specifies  how EBS should handle non-responding terminals.  When EBS
  sends a message to a terminal,  it  waits  for  the  message  to  be
  delivered.  If a user has done a CTRL-S on the terminal, the message
  cannot be delivered until  the  user  hits  CTRL-Q.   EBS  does  not
  terminate  until  messages  have  been  delivered  or until the time
  specified by the /WAIT qualifier has  elapsed.   Before  terminating
  EBS  cancels  any  outstanding messages.  The /WAIT qualifier allows
  the user to control how this situation is handled.

        /WAIT          : Causes   EBS   to   wait   indefinitely   for
                         all messages to be delivered.

        /WAIT=time     : If one or more messages cannot be  delivered,
                         EBS  will wait until the specified time.  If,
                         after the  specified  time  has  elapsed  and
                         messages  are still waiting for delivery, the
                         messages are cancelled.  If all messages  can
                         be  delivered,  EBS  completes  and  does not
                         wait.  The time parameter can be an  absolute
                         or delta time.

        /NOWAIT        : EBS   will   not   wait  for  slow-responding
                         terminals.  EBS  sends  the  message  to  all
                         selected  terminals.  If any message delivery
                         has not completed by the time  EBS  has  sent
                         all  messages,  the  undelivered messages are
                         cancelled, and EBS terminates.
!
!=============================================================================!
!							   END OF HELP MODULE !
!=============================================================================!
!
