! XShow.Hlp
!                                                       Pat Rankin, 7/88
!   Online help for XSHOW.
!
1 XSHOW
  Extended show command.  Display information generally not available
  through the standard VMS SHOW command.

  format:
    XSHOW option [/option_qualifiers]
2 CLI
  Displays current or default Command Language Interpreter.

  format:
    XSHOW CLI
3 Qualifiers

/USERNAME
 /USERNAME[=user]

  Controls which CLI to display.  By default, the CLI of the current
  process is displayed.  If /USERNAME if specified without a value then
  the user's default CLI is retreived from the System User Authorization
  File.  If a username value is included then that user's default CLI
  is retreived (privilege is required).

/OUTPUT
 /OUTPUT[=file-spec]

  Controls where the output is sent.  By default, it goes to SYS$OUTPUT.
!
2 COMMAND
  Formats the definition of one or more DCL commands.

  format:
    XSHOW COMMAND cmd[,cmd...]
3 parameter

 cmd[,cmd...]

  The name of one or more DCL commands.  Wildcards are supported.
3 qualifiers
!(pr) /all is not of much use when the command parameter is required.
!/ALL
!
!  Display all commands.

/PROCESS

  Requests commands defined for the current process be displayed.
  This is the default operation.

  /PROCESS is incompatable with /TABLE.

/TABLE
 /TABLE[=tablefile]

  Requests commands in the specified table image file be displayed.
  The default value is SYS$SHARE:DCLTABLES.EXE.

/IMAGE
 /IMAGE=imagefile

  Requests a compiled command definition be extracted from a shareable
  image.  /SYMBOL is required.

/SYMBOL
 /SYMBOL=globalsymbol

  Specifies the name of a global symbol within a shareable image.  Only
  allowed when /IMAGE is used.  The symbol must be the module name of
  a compiled command definition.

/OUTPUT
 /OUTPUT=file

  Controls where the output is sent.  By default, it goes to SYS$OUTPUT.
  The default output file type is .CLD.

/WIDTH
 /WIDTH=page_width

  Affects output formatting.

/LIST

  Causes the names of commands to be listed, but not their definitions.
2 CONTROL
  Displays the current status of CTRL/Y and CTRL/T settings.

  format:
    XSHOW CONTROL
2 CPU
  Displays the percentage of CPU utilization since the system booted.

  format:
    XSHOW CPU
2 DAY
  Displays the current system day type for user authorization.

  format:
    XSHOW DAY
2 DEFAULT
  Displays current or login-default disk and directory default values
  used by RMS.

  format:
    XSHOW DEFAULT

  Note:  the standard VMS SHOW DEFAULT command is quicker and utilizes
  less system resources.
3 Qualifiers

/USERNAME
 /USERNAME[=user]

  Controls which DEFAULT to display.  Normally, the current default
  is displayed.  If /USERNAME if specified without a value then the
  user's default is retreived from the System User Authorization File
  (the value that is stored in SYS$LOGIN at login time).  If a username
  value is included then that user's default is retreived (privilege
  is required).

/OUTPUT
 /OUTPUT[=file-spec]

  Controls where the output is sent.  By default, it goes to SYS$OUTPUT.
!
2 ENTRY
  Displays information about a batch or print queue entry.
2 HOST
  Displays the name of the current host processor.

  format:
    XSHOW HOST

  XSHOW NODE is equivalent.
2 LOAD_AVERAGE
  Displays an approximation of the current system load, estimated over
  the last minute, last five minutes, and last fifteen minutes.

  format:
    XSHOW LOAD_AVERAGE

  Note:  Kashtan's load average driver (LAVDRIVER) must be installed on
  the system in order for this command to work.
3 Qualifiers
/BRIEF
 /BRIEF

  Requests a single line display (the default).

/FULL
 /[NO]FULL

  Determines whether average blocking priority and maximum disk i/o
  queue length values are also displayed if they are available.

/OUTPUT
 /OUTPUT[=file-spec]

  Controls where the output is sent.  By default, it goes to SYS$OUTPUT.
!
2 LOGINS
  Displays the current interactive login limit.

  format:
    XSHOW LOGINS
2 MESSAGE
  Displays the current message component settings.

  format:
    XSHOW MESSAGE
2 NODE
  Displays the name of the current host processor.

  format:
    XSHOW NODE

  XSHOW HOST is equivalent.
!2 ON
!  Displays the current settings of DCL ON-ERROR and ON-CONTROL_Y
!  commands.
!
!  format:
!    XSHOW ON
!
!  Note:  only applicable from within a command procedure.
2 OUTPUT_RATE
  Displays the current batch job's log-file flush interval.

  format:
    XSHOW OUTPUT_RATE

  Note:  only applicable from within a batch job.
2 PASSWORD_INFO
  Displays expiration and other miscellaneous information about the
  user's password.  The actual password value is never revealed.

  format:
    XSHOW PASSWORD_INFO
3 Qualifiers

/USERNAME
 /USERNAME[=user]

  Controls which password is to be checked.  Privilege is required to
  obtain information about another user.

/OUTPUT
 /OUTPUT[=file-spec]

  Controls where the output is sent.  By default, it goes to SYS$OUTPUT.
!
2 PROMPT
  Displays the current prompt.

  format:
    XSHOW PROMPT
2 QUEUE
  Displays information about the system's batch and/or print queues and
  the jobs they contain.

  format:
    XSHOW QUEUE  [queue-name[,queue-name...]]

  Note:  provides much greater flexibility than the standard VMS
  SHOW QUEUE utility.
3 Parameters

  queue-name[,queue-name...]

  Optional comma separated list of queue specifications; full wildcard
  support is provided.  Default value is "*".
3 Qualifiers

/all_jobs
 /[no]all_jobs

  Requests that jobs owned by any user (/ALL) or only jobs owned by the
  current user (/NOALL, the default) be displayed.  Same as SHOW QUEUE.

/batch
 /[no]batch

  Requests that batch queues be displayed (/BATCH) or suppressed
  (/NOBATCH).  The default is /BATCH unless one or more of /DEVICE,
  /FORMS, or /CHARACTERISTICS is specified.  Same as SHOW QUEUE.

/brief
 /[no]brief

  Requests a brief queue and job display.  Same as SHOW QUEUE.

/BY_JOB_STATUS
 /BY_JOB_STATUS=([[NO]ALL,][NO]EXECUTING,[NO]PENDING,[NO]WAITING,-
		 [NO]HOLDING,[NO]RETAINED,[NO]OTHER)

  Specifies what category(s) of jobs to display.  By default, jobs in
  any category will be displayed.

  The keyword PRINTING may be used as a synonym for EXECUTING and
  AFTER may be used as a synonym for WAITING.

  Note:  the /ALL_JOBS qualifier still controls whether any jobs owned
  by other users may be displayed.  Category OTHER is a catch-all that
  should never include any jobs.

/characteristics

  Requests that queue characteristics be displayed.  Same as SHOW QUEUE
  except that it may be used in combination with /FORMS, /DEVICE, and
  /BATCH.

  Note:  the queue-name parameter is treated as a list of characteristic
  names.

/COMPRESS
 /[NO]COMPRESS

  Determines whether to suppress blank lines and some column-header
  lines in order to fit more information on the screen or page.

/device
 /[no]DEVICE[=([[NO]ALL,][NO]PRINTER,[NO]TERMINAL,[NO]SERVER,NONE)]

  Requests that print queues be displayed (/DEVICE) or suppressed
  (/NODEVICE).  The default is /DEVICE unless one or more of /BATCH,
  /FORMS, or /CHARACTERISTICS is specified.  Same as SHOW QUEUE.

  /DEVICE without a value is the same as /DEVICE=ALL, and /DEVICE=NONE
  is the same as /NODEVICE.

  Note:  under version 4 of VMS, any device queue that is neither a
  terminal queue nor a server queue is treated as a printer queue.

/ENTRY
 /ENTRY=([-,]entry-num[:entry-num][,entry-num[:entry-num]...])

  Specifies a list of job entry numbers to determine which jobs to
  display.  Each element of the list may be a range specified by low
  and high values separated by a colon (':') or dash ('-').  If the
  first element of the list is a dash ('-'), then the list represents
  jobs to be excluded from the display.

  Note:  the /ALL_JOBS qualifier still controls whether any jobs owned
  by other users may be displayed.

/EXCLUDE
 /EXCLUDE=(queue-name[,queue-name...])

  Specifies queues (selected via wildcard) to be omitted.

  Note:  if the first element of the list is a dash ('-'), the dash is
  ignored.

/files
 /[no]files

  Requests that submitted files for job(s) be displayed.  Intermediate
  between /BRIEF and /FULL.  Same as SHOW QUEUE except that /NOFILES
  is allowed with /FULL to provide an alternate intermediate display.

/forms

  Requests that queue forms be displayed.  Same as SHOW QUEUE except
  that it may be used in combination with /CHARACTERISTICS and /DEVICE.

  Note:  the queue-name parameter is treated as a list of form names.

/full
 /[no]FULL[= ALL | QUEUES | JOBS | NONE ]

  Determines level of detail to display.  /FULL=NONE is the same as
  /NOFULL; it is the default and is equivalent to /BRIEF.  /FULL without
  a value means /FULL=ALL and is the same as for SHOW QUEUE.

  /FULL=QUEUES shows full queue information but /brief (or /files) data
  for jobs.  Conversely, /FULL=JOBS shows full job (and file) information
  but /brief for queues.

/GENERIC
 /[NO]GENERIC

  Requests that only generic queues be displayed (/GENERIC) or that all
  generic queues be suppressed (/NOGENERIC).  By default, both generic
  and execution queues are displayed.

  This qualifier is ignored when /IF_QUEUE_STATUS is present.

/IF_QUEUE_STATUS
 /IF_Q=([[NO]SOMETHING,][NO]ACTIVE,[NO]INACTIVE,[NO]EMPTY,[NO]NONEMPTY,-
	[NO]NORMAL,[NO]ABNORMAL,[NO]EXECUTION,[NO]GENERIC,[NO]ANYTHING)

  Specifies selection criteria for which queues to display.  By default,
  all queues matching the queue-name parameter (possibly modified by
  the /exclude and/or /on_node qualifiers) are displayed.

  /IF_QUEUE_STATUS without a value defaults to /IF_QUEUE=SOMETHING which
  limits the display to queues that have one or more jobs displayed
  (determined by /all_jobs, /by_job_status, /entry, /jobname, and
  /username qualifiers).  /IF_QUEUE=ANYTHING is the same as omitting
  the /IF_QUEUE_STATUS qualifier altogether.

  SOMETHING
    A queue is considered "SOMETHING" (ie, of interest) if at least one
    job in it is being displayed.
  ACTIVE,INACTIVE
    A queue is considered active if it has one or more jobs executing,
    inactive otherwise.
  EMPTY,NONEMPTY
    To determine whether a queue is empty, all jobs (regardless of
    username) are examined.
  NORMAL,ABNORMAL
    Stalled, paused, stop pending, stopped are all classed as abnormal.
  EXECUTION,GENERIC
    Every queue that is not generic is considered an execution queue.
  ANYTHING
    Catch-all for completeness.

/JOBNAME
 /JOBNAME[=([-,]job-name[,job-name...])

  List of one or more batch and/or print job-names of interest; wildcards
  are supported.  Only jobs which match the name(s) will be displayed.
  If the first element of the list is a dash ('-'), then only jobs that
  do NOT match names will be displayed.

  Note:  the /ALL_JOBS qualifier still controls whether any jobs owned
  by other users may be displayed.

/ON_NODE
 /ON_NODE[=([-,]node-name[,node-name...])

  List of one or more VAXcluster nodes of interest; wildcards are
  supported.  Only queues that execute on the node(s) will be displayed.
  If the first element of the list is a dash ('-'), then only queues
  NOT on the node(s) will be displayed.

  By default, all queues regardless of node are displayed.  /ON_NODE
  without a value will limit the display to queues on the user's node,
  and /ON_NODE=(-) will limit the display to execution queues on other
  than the user's node.

  Note:  appropriate for VAXcluster systems only; also, incompatable
  with /GENERIC and /IF_QUEUE_STATUS=(GENERIC,NOEXECUTION).

/output
 /output[=file-spec]

  Controls where the output is sent.  By default, it goes to SYS$OUTPUT.
  Same as SHOW QUEUE except that missing filename components default to
  XSHOQUE.LIS.

/summary
 /summary

  Displays a one-line job summary for each selected queue.  /ALL is
  implied.

/USERNAME
 /USERNAME[=([-,]user-name[,user-name...])

  List of one or more VMS usernames of interest; wildcards are supported.
  Only jobs owned by the user(s) will be displayed.  If the first
  element of the list is a dash ('-'), then only jobs NOT owned by the
  user(s) will be displayed.  The default value is the current user.

  Note:  the /ALL_JOBS qualifier still controls whether any jobs owned
  by other users may be displayed.

/WIDTH
 /WIDTH=value

  Specifies line width used when formatting /FULL data.  For output to
  a terminal, the default value is the terminal's width; for output to a
  file, the default value is 80 columns.  Note that the base display
  does not attempt to stay within this limit.
!
2 RESTART_VALUE
  Displays the current batch job's restart value.

  format:
    XSHOW RESTART_VALUE

  Note:  only applicable from within a batch job.
2 UIC
  Displays current or default User Identification Code.

  format:
    XSHOW UIC [identifier]
3 Parameter

  A uic or general identifier may be specified, in which case both its
  numeric and alphabetic values will be displayed.  An identifier is
  mutually exclusive with the /USERNAME and /IDENTIFICATION qualifiers.
3 Qualifiers

/IDENTIFICATION
 /IDENTIFICATION=pid

  Requests display of the specified process's UIC.  GROUP or WORLD
  privilege may be required depending on the process.

  This qualifier and /USERNAME are mutually exclusive.

/USERNAME
 /USERNAME[=user]

  Controls which UIC to display.  By default, the UIC of the current
  process is displayed.  If /USERNAME if specified without a value then
  the user's default UIC is retreived from the System User Authorization
  File.  If a username value is included then that user's default UIC
  is retreived (privilege is required).

  This qualifier and /IDENTIFICATION are mutually exclusive.

/OUTPUT
 /OUTPUT[=file-spec]

  Controls where the output is sent.  By default, it goes to SYS$OUTPUT.
!
2 VERIFY
  Displays the process's current verification settings.

  format:
    XSHOW VERIFY
!2 WATCH
!  Displays the current flags from SET WATCH (undocumented command).
!
!  format:
!    XSHOW WATCH FILE
!
!3 Parameter
!
!  The FILE keyword is required.
!3 Qualifiers
!/CLASS
! /CLASS
!  Has not effect; complimentary to SET WATCH FILE/CLASS.
!
!/OUTPUT
! /OUTPUT[=file-spec]
!
!  Controls where the output is sent.  By default, it goes to SYS$OUTPUT.
!
2 Qualifier
/OUTPUT
 /OUTPUT[=file-spec]

  Controls where the output is sent.  By default, it goes to SYS$OUTPUT.

  Note:  available with most but not all options.
!
