% VAX-11 Librarian V04-00\m7S܇=S12 5EXCLUDEEXIT HELP ,OVERRIDEQUIT RESETSAVErSET'fSHOW(SHUTDOWN)WATCHN 1 EXCLUDEF The EXCLUDE command defines WATCHER exclusion records, which identify? users that should be excluded from being watched for idleness. Format: EXCLUDE userF The "user" may contain wildcard characters. Any user that matchesF the specified pattern as well as any other specified criteria is( excluded from being watched by WATCHER. 2 Qualifiers /ACCPORNAM /ACCPORNAM=patternF The /ACCPORNAM qualifier indicates that the user should be eligibleF for exclusion only when using a terminal whose port name matches1 "pattern". If omitted, /ACCPORNAM=* is assumed./DELETE /DELETEF The /DELETE qualifier is used to delete an exclusion record from theF WATCHER database. All of the user-matching criteria (username, portF name, terminal, UIC, privilege mask, time-of-day matrix, UIC, andF identifier list) must match in order for the record to be found and removed./DURING /DURING=(day-time[,...])F  The /DURING qualifier indicates that the user is only eligible forF exclusion during the specified times on the specified days. The+ "day-time" specifications are of the form: day:hour-range day:(hour-range[,...])F where "day" may be the name of a day of the week or one of theF keywords PRIMARY or SECONDARY, and "hour-range" may be a single hourF number (0 through 23) or a pair of hour numbers separated by aF hyphen, indicating an inclusive range. If the /DURING qualifier isF omitted, time-of-day is not used as a criterion in deciding exclusion./HOLDING /HOLDING=ident-patternF The /HOLDING qualifier indicates that the user should be eligible forF exclusion only when holding an identifier that matches the specifiedF ident- pattern. If omitted, holding an identifier is not used as an exclusion criterion./IMAGE /IMAGE=filespec-patternF The /IMAGE qualifier indicates that the user should be eligible forF exclusion only when running an executable image that matches the> specified wildcard pattern. If omitted, /IMAGE=* is assumed. /PRIVILEGES /PRIVILEGES=(priv[,...])F The /PRIVILEGES qualifier indicates that the user should be eligibleF for exclusion only when holding the specified privileges. If@ omitted, privilege is not considered as an exclusion criterion. /TERMINAL /TERMINAL=dev-patternF The /TERMINAL qualifier indicates that the user should be eligibleF for excl usion only when using a terminal whose device name matches4 "dev-pattern". If omitted, /TERMINAL=* is assumed./UIC /UIC=uicF The /UIC qualifier indicates that the user should be eligible forF exclusion only if the user's process UIC matches the specified "uic".F "Uic" may be in alphanumeric or octal format and may use an asteriskF for the member part to indicate any user in a group. If omitted, /UIC=[*,*] is assumed.wwէ1 EXITF The EXIT command ex its WCP and optionally saves the configuration. created by the WCP session to a file on exit. Format: EXITF If you have changed the configuration and not already saved the newF configuration to a file, EXIT will save the new configurationF automatically on exit. If the configuration has not already been6 assigned a filename, EXIT will prompt for a filename.wwէ1 HELP> The HELP command displays help information about WCP comands. F ormat: HELP [topic]wwէ 1 OVERRIDEF The OVERRIDE command defines WATCHER override records, which identifyF users whose terminals should be treated differently from the settings in the matching WATCH record. Format: OVERRIDE userF The "user" may contain wildcard characters. Any user that matchesF the specified pattern as well as any other specified user-matchingF criteria (port name, UIC, identifiers, terminal, time-of-day,F p rivileges) will qualify for override of the WATCH settingsF (measurement criteria, warning and logout/disconnect settings); the6 values from the override record will be used instead. 2 Qualifiers /ACCPORNAM /ACCPORNAM=patternF The /ACCPORNAM qualifier indicates that the user should be eligibleF for exclusion only when using a terminal whose port name matches1 "pattern". If omitted, /ACCPORNAM=* is assumed./DELETE /DELETEF The /DELETE qualifier is used to de lete an override record from theF WATCHER database. All of the user-matching criteria (username, portF name, terminal, UIC, privilege mask, time-of-day matrix, UIC, andF identifier list) must match in order for the record to be found and removed. /DISCONNECT /DISCONNECT[=delta-time] /NODISCONNECTF This qualifier specifies that the terminal should be disconnectedF rather than logged out when the logout inactivity interval hasF elapsed. In addition, you may specify what the inactivity intervalF should be. If omitted, the setting is copied from the WATCH_DEFAULTD information. You cannot mix /DISCONNECT, /LOGOUT, and /FORCE_EXIT./DURING /DURING=(day-time[,...])F The /DURING qualifier indicates that the user is only eligible forF override during the specified times on the specified days. The+ "day-time" specifications are of the form: day:hour-range day:(hour-range[,...])F where "day" may be the name of a day of t he week or one of theF keywords PRIMARY or SECONDARY, and "hour-range" may be a single hourF number (0 through 23) or a pair of hour numbers separated by aF hyphen, indicating an inclusive range. If the /DURING qualifier is: omitted, time-of-day is not used as a matching criterion. /FORCE_EXIT /FORCE_EXIT[=delta-time] /NOFORCE_EXITF This qualifier specifies that a forced image exit should be performedF on any user-mode image running on the terminal, rather than ha vingF the terminal disconnected or the process logged out, when the logoutF inactivity interval has elapsed. In addition, you may specify whatF the inactivity interval should be. If omitted, the setting is copiedF from the WATCH_DEFAULT information. You cannot mix /DISCONNECT, /LOGOUT, and /FORCE_EXIT./HOLDING /HOLDING=ident-patternF The /HOLDING qualifier indicates that the user should be eligible forF overrides only when holding an identifier that matches the specifiedF ident- pattern. If omitted, holding an identifier is not used as an matching criterion./IMAGE /IMAGE=filespec-patternF The /IMAGE qualifier indicates that the user should be eligible forF exclusion only when running an executable image that matches the> specified wildcard pattern. If omitted, /IMAGE=* is assumed./LOGOUT /LOGOUT=[delta-time] /NOLOGOUTF This qualifier specifies that the terminal should be logged outF rather than disconnected or an image  exit forced when the logoutF inactivity interval has elapsed. In addition, you may specify whatF the inactivity interval should be. If omitted, the setting is copiedF from the WATCH_DEFAULT information. You cannot mix /DISCONNECT, /LOGOUT, and /FORCE_EXIT./MEASURE /MEASURE=(measurement[,...])F This qualifier indicates what measurement criteria (one or more ofF CPU, TERMINAL_IO, PROCESS_IO) should be used when determining whetherF or not the process using the terminal is  idle. When omitted, theF setting is copied from the WATCH_DEFAULT information. If more thanF one measurement is specified, a change in any one of the metrics, specified indicates the terminal is active.' Measurements are specified as follows: CPU[:threshold]! PROCESS_IO[:threshold]" TERMINAL_IO[:threshold]F Any combination of the three measurements is permitted. If aF measurement is specified without a threshold value, a default threshold of zero is used. /PRIVILEGES /PRIVILEGES=(priv[,...])F The /PRIVILEGES qualifier indicates that the user should be eligibleF for overrides only when holding the specified privileges. IfA omitted, privilege is not considered as an user-match criterion. /TERMINAL /TERMINAL=dev-patternF The /TERMINAL qualifier indicates that the user should be eligibleF for override only when using a terminal whose device name matches4 "dev-pattern". If omitted, /TERMINAL=* is assumed./UIC /UIC=uicF The /UIC qualifier indicates that the user should be eligible forF override only if the user's process UIC matches the specified "uic".F "Uic" may be in alphanumeric or octal format and may use an asteriskF for the member part to indicate any user in a group. If omitted, /UIC=[*,*] is assumed./WARN /WARN[=delta-time] /NOWARNF This qualifier is used to specify that the terminal should be warnedF of inactivity after the warning inactivity interval. In addition,F you can specify what the interval should be. /NOWARN disablesF warnings. If omitted, settings are copied from the SET WATCH_DEFAULT information.wwէ1 QUITE The QUIT command quits WCP without saving configuration information. Format: QUITF If you have changed the configuration and not already saved the newF configuration to a file, QUIT will ask if you really want to quit before leaving WCP.ww:\1 RESET@ The RESET command sends a RESET command to the WATCHER process. Format: RESETF If there is a WATCHER process currently running, it flushes allF configuration and process information it is storing, closes its logF and trace files (if any), and reloads the configuration from theF WATCHERCONFIG file. To have configuration changes take effect, be9 sure to SAVE the changes before using the RESET command.ww:\1 SAVE0 The SAVE command saves a WATCHER configuration. Format: SAVE [file-spec]ww:\1 SETF The SET command is used to define default values for certain WATCHF and EXCLUDE command parameters, and define "global" WATCHER parameters.2 ACTIONF The SET ACTION command defines whether logout, disconnect, warning,* and OPCOM actions are actually performed. Format: SET [NO]ACTIONF The default is SET ACTION. When NOACTION is set, logouts,F disconnects, and warnings are logged in debug/trace and event logF files, but are not actually performed. Also disabled are eventsB logged to OPCOM operators (but not to an event log file, if any).2 BELLF The SET BELL command defines whether the bell is rung on terminals6 when WATCHER displays warning and/or logout messages. Format: SET [NO]BELL The default is SET NOBELL.2 DAYSF The SET DAYS command defines the PRIMARY and SECONDARY keywords for the EXCLUDE/DURING qualifier. Format: SET DAYSF The default PRIMARY days are Monday-Friday. The default SECONDARYF days are Saturday and Sunday. Note that these are simply shorthandF ways of specifying days of the week; PRIMARY and SECONDARY areF converted into the appropriate days of the week by the EXCLUDE command. 3 Qualifiers/PRIMARY /PRIMARY=(day[,...])7 Makes the specified days part of the PRIMARY grouping. /SECONDARY /SECONDARY=(day[,...])9 Makes the specified days part of the SECONDARY grouping.2 DEBUGF The SET DEBUG command is used to turn on and off debug trace information. Format: SET [NO]DEBUG[=mask]F The default is SET NODEBUG. When DEBUG is set, the WATCHER processF will log debugging/trace information to the file WATCHERTRACE (byF default located in SYS$COMMON:[WATCHER] with a file type of .LOG).F This debugging information can be us ed to track down configurationF problems or bugs in the WATCHER program itself. The information thatF is logged depends on the value of "mask", which is a decimal numberF representing a bit mask value in which bit 0 enables main-lineF debugging, bit 1 enables exclusion-check debugging, and bit 2 enablesE override-check debugging. If not specified, the default value is 7.F WARNING: The debug/trace output can become voluminous. Use this option only when necessary! 2 DECWINDOWSF The SET DECWINDOWS command is used to enable the collection of+ information related to DECwindows support. Format: SET [NO]DECWINDOWSF Setting DECWINDOWS on causes WATCHER to perform the extra processingF needed to support watching DECwindows sessions. The default is NODECWINDOWS. 2 EVENT_LOGE SET EVENT_LOG specifies how WATCHER should record its logout events. Format: SET [NO]EVENT_LOGF SET NOEVENT_LOG disables all event logging. SET EVENT_LOG with theF /OPERATOR qualifier directs log messages to OPCOM operator class(es).F The /FILE qualifier directs log messages to the specified file.F Events that are logged include: WATCHER startup, shutdown, and reset; terminal logouts. 3 Qualifiers /OPERATOR /OPERATOR=(oper-class[,...]) /NOOPERATORF Directs WATCHER log messages to the specified OPCOM operator classes./FILE /FILE=file-spec /NOFILEF Directs WATCHER log messages to the specified file. The WATCHERF process must be able to write to the specified file using the file-spec you specify.2 INSWAPF The SET INSWAP command controls the use of the $GETJPI NOINSWAP control flag by WATCHER. Format: SET [NO]INSWAPF The default is SET INSWAP. When NOINSWAP is set, on VAX/VMS V5.2 andF later (and all versions of OpenVMS AXP), WATCHER will use theF NOINSWAP control flag on the $GETJPI calls it issues. This will; prevent WATCHER from causing unnecessary swapper activity.F Note also, however, that NOINSWAP prevents WATCHER from collectingF the information it needs about swapped-out processes, which mayF result in idle processes not getting logged out (or in some cases,+ processes getting logged out prematurely). 2 INTERVALB SET INTERVAL defines the wakeup interval for the WATCHER process. Format:" SET INTERVAL=delta-timeF The default interval is 5 minutes. WATCHER hiberna!tes for thisF length of time between searches through the system process list.F Note that for best operation, the logout and warning times in WATCHF records should be multiples of the wakeup interval. How large anF interval you choose depends on how accurate you want our logouts toF be vs. how much CPU time you can spare. Usually a five-minuteF interval provides reasonable accuracy for half-hour idle-time logoutsF while not consuming an inordinate amount of CPU time" on a systemF averaging 10-15 simultaneous interactive users. Your actual mileageF may vary, and you may need to tweak the interval in order to achieve* the accuracy and low overhead you desire. 2 MULTIWARNF The SET MULTIWARN command is used to enable multiple logout warnings. Format: SET [NO]MULTIWARNF Enabling MULTIWARN causes WATCHER to warn users of imminent logout orF disconnection multiple times, if possible, between the /WARNING andF /LOGOUT, /DISCONNECT, or /F#ORCE_EXIT time. By default, only one% warning is given (at /WARNING time). 3 Qualifiers /INTERVAL /INTERVAL=delta-timeF Specifies that the interval between warnings should be the specifiedF amount of time. The specified interval should be larger than the1 wakeup interval setting (set with SET INTERVAL).2 VERIFYF The SET VERIFY command is used to turn on and off the display of/ commands that are read from WCP command files. Format: SET [NO]VERIFY$F The default is NOVERIFY. Use SET VERIFY to turn on command verification.2 WATCH_DEFAULTF The SET WATCH_DEFAULT command is used to specify default values to be% used with subsequent WATCH commands. Format: SET WATCH_DEFAULT 3 Qualifiers /DISCONNECT /[NO]DISCONNECT[=delta-time]F The /DISCONNECT qualifier is used to enable terminal disconnects asF the default on subsequent WATCH commands. Additionally, a defaultF disconnection inactivity interv%al may also be specified. Only one of7 /DISCONNECT, /FORCE_EXIT, or /LOGOUT may be specified. /FORCE_EXIT /FORCE_EXIT[=delta-time] /NOFORCE_EXITF This qualifier enables forced image exits as the default onF subsequent WATCH commands. Additionally a default inactivityF interval may also be specified. You cannot mix /DISCONNECT, /LOGOUT, and /FORCE_EXIT./LOGOUT /[NO]LOGOUT[=delta-time]F The /LOGOUT qualifier is used to enable logouts as the default& onF subsequent WATCH commands. Additionally, a default logout inactivityF interval may also be specified. You cannot mix /DISCONNECT, /LOGOUT, and /FORCE_EXIT./MEASURE /MEASURE=(measurement[,...])F The /MEASURE qualifier is used to specify the default measurementF criteria to be used for subsequent WATCH commands. Any combinationD of CPU, TERMINALIO, and PROCESSIO may be specified as measurements.' Measurements are specified as follows: CPU[:threshold]! ' PROCESS_IO[:threshold]" TERMINAL_IO[:threshold]F Any combination of the three measurements is permitted. If aF measurement is specified without a threshold value, a default threshold of zero is used./WARN /[NO]WARN[=delta-time]F The /WARN qualifier is used to enable pre-logout warnings as theF default on subsequent WATCH commands. Additionally, a defaultF warning intactivity interval (which should be shorter than the logoutF inactiv(ity interval) may also be specified. Use /NOWARN to have no warnings be the default.wwzi1 SHOWF The SHOW commands displays watch records, exclusion records, and< default settings for warn, logout, event_log, and interval. Format: SHOW keyword[,...]F where "keyword" can be ALL, BELL, DAYS, DEBUG, DECWINDOWS, DEFAULTSF (for displaying SET WATCH_DEFAULT information), EVENT_LOG, EXCLUDE,8 FILE, GLOBALS, INTERVAL, MULTIWARN, OVERRIDE, or WATCH. )2 Qualifiers/COMMAND /[NO]COMMANDF The /COMMAND qualifier causes the information to be displayed in theF form of the WCP commands that would be used to re-create thatF information. The default is /NOCOMMAND, which causes the information& to be displayed in a prettier format./OUTPUT /OUTPUT=file-specF The /OUTPUT qualifier redirects the output of the SHOW command to a: file. If omitted, the output is displayed on SYS$OUTPUT.wwzi 1 SHUTDOWNF T*he SHUTDOWN command sends a shutdown request to the WATCHER process. Format: SHUTDOWNF If WATCHER is currently running, the shutdown request will cause it4 to close its log and trace files (if any) and exit.wwzi1 WATCHF The WATCH command creates a watch record that identifies a terminal' (or group of terminals) to be watched. Format: WATCH deviceF The device specification may contain wildcard characters (forF matching b +y STR$MATCH_WILD). WATCHER always uses physical deviceF names (never VTAn names), prepended with the system's SCS node name,- if there is one, in the form "node$device:".F When using wildcards in watch records, bear in mind that WATCHERF searches watch records sequentially, in the same order as they areF entered. The first watch record that matches the device WATCHER isF examining is the watch record used for that device. Thus you shouldE probably enter specific WATCH comma,nds before entering general ones. 2 Qualifiers /ACCPORNAM /ACCPORNAM=patternF This qualifier is used to match the port name of the terminal device.F This is mainly used with terminals connected to terminal servers.% The "pattern" may contain wildcards. /DISCONNECT /DISCONNECT[=delta-time] /NODISCONNECTF This qualifier specifies that the terminal should be disconnectedF rather than logged out when the logout inactivity interval hasF elapsed. In addition, yo -u may specify what the inactivity intervalF should be. If omitted, the setting is copied from the WATCH_DEFAULTD information. You cannot mix /DISCONNECT, /FORCE_EXIT, and /LOGOUT. /FORCE_EXIT /FORCE_EXIT[=delta-time] /NOFORCE_EXITF This qualifier specifies that a forced image exit should be performedF on any user-mode image running on the terminal, rather than havingF the terminal disconnected or the process logged out, when the logoutF inactivity interval has elapsed. I .n addition, you may specify whatF the inactivity interval should be. If omitted, the setting is copiedF from the WATCH_DEFAULT information. You cannot mix /DISCONNECT, /LOGOUT, and /FORCE_EXIT./GROUP /GROUP=groupnameF This qualifier is used to assign the WATCH record to a device group.F Device groups are used to link terminal devices together for WATCHERF purposes, so that activitiy on any matching terminal in a group isF counted as activity on all the terminals in the gr/oup. This is mostF useful when you run WATCHER on workstations running the VMS Workstation Software./LOGOUT /LOGOUT=[delta-time] /NOLOGOUTF This qualifier specifies that the terminal should be logged outF rather than disconnected when the logout inactivity interval hasF elapsed. In addition, you may specify what the inactivity intervalF should be. If omitted, the setting is copied from the WATCH_DEFAULTD information. You cannot mix /DISCONNECT, /LOGOUT 0, and /FORCE_EXIT./MEASURE /MEASURE=(measurement[,...])F This qualifier indicates what measurement criteria (one or more ofF CPU, TERMINAL_IO, PROCESS_IO) should be used when determining whetherF or not the process using the terminal is idle. When omitted, theF setting is copied from the WATCH_DEFAULT information. If more thanF one measurement is specified, a change in any one of the metrics, specified indicates the terminal is active.' Measurements are specified as f1ollows: CPU[:threshold]! PROCESS_IO[:threshold]" TERMINAL_IO[:threshold]F Any combination of the three measurements is permitted. If aF measurement is specified without a threshold value, a default threshold of zero is used./WARN /WARN[=delta-time] /NOWARNF This qualifier is used to specify that the terminal should be warnedF of inactivity after the warning inactivity interval. In addition,F you can specify what the interval should be. /NOWARN disablesF warnings. If omitted, settings are copied from the SET WATCH_DEFAULT information.ww