HELPLIB.HLB  —  PRINT  Qualifiers

1    /AFTER

       /AFTER=time
       /NOAFTER

    Holds the job until the specified time. The time can be specified
    as absolute time or a combination of absolute and delta times.
    If the specified time has passed, the job is queued for printing
    immediately.

    For complete information on specifying time values, see the
    OpenVMS User's Manual or the online help topic Date.

2    /BACKUP

       /BACKUP
       /NOBACKUP

    Modifies the time value specified with the /BEFORE or the
    /SINCE qualifier. The /BACKUP qualifier selects files according
    to the dates of their most recent backups. This qualifier
    is incompatible with the /CREATED, /EXPIRED, and /MODIFIED
    qualifiers, which also allow you to select files according
    to time attributes. If you specify none of these four time
    qualifiers, the default is the /CREATED qualifier.

3    /BEFORE

       /BEFORE[=time]
       /NOBEFORE

    Selects only those files dated prior to the specified time. You
    can specify time as absolute time, as a combination of absolute
    and delta times, or as one of the following keywords: BOOT,
    LOGIN, TODAY (default), TOMORROW, or YESTERDAY. Specify one of
    the following qualifiers with the /BEFORE qualifier to indicate
    the time attribute to be used as the basis for selection:
    /BACKUP, /CREATED (default), /EXPIRED, or /MODIFIED.

    For complete information on specifying time values, see the
    OpenVMS User's Manual or the online help topic Date.

4    /BURST

       /BURST[=keyword]
       /NOBURST

    Positional qualifier.

    Controls whether two file flag pages with a burst bar between
    them are printed preceding a file. If the /BURST qualifier is
    specified between the PRINT command and the file specifications,
    it can take either of the following keywords:

    ALL     Prints the flag pages and a burst bar before each file in
            the job.

    ONE     Prints the flag pages and a burst bar before the first
            file in the job.

    If you want the /BURST qualifier to apply to individual files
    in a multifile job, place the qualifier directly after each file
    that you want to have the flag pages and a burst bar.

    Use the /[NO]BURST qualifier to override the /DEFAULT options
    that have been set for the output queue you are using. The
    /[NO]BURST qualifier does not override the /SEPARATE options
    set for the queue.

    When you specify the /BURST qualifier for a file, the /[NO]FLAG
    qualifier does not add or subtract a flag page from the two flag
    pages that are printed preceding a file.

5    /BY_OWNER

       /BY_OWNER[=uic]
       /NOBY_OWNER

    Selects only those files whose owner user identification code
    (UIC) matches the specified owner UIC. The default UIC is that of
    the current process.

    Specify the UIC by using standard UIC format as described in the
    VSI OpenVMS Guide to System Security.

6    /CHARACTERISTICS

       /CHARACTERISTICS=(characteristic[,...])

    Specifies the name or number of one or more characteristics to be
    associated with the job. Characteristics can refer to such things
    as color of ink. If you specify only one characteristic, you can
    omit the parentheses.

    A characteristic's number must range from 0 to 127. To see which
    characteristics have been defined for your system, use the SHOW
    QUEUE/CHARACTERISTICS command. To see which characteristics
    are associated with a particular queue, use the SHOW QUEUE/FULL
    command.

    A print job can be processed on an execution queue if the job's
    characteristics are a subset of the queue's characteristics.
    However, if any of the characteristics associated with the job
    are not associated with the queue, the job remains pending until
    one or more of the following occurs:

    o  The characteristics specified with the queue are changed
       to make the job's characteristics a subset of the
       queue's characteristics (using, for example, the SET
       QUEUE/CHARACTERISTICS command).

    o  The characteristics specified with the job are changed
       to make the job's characteristics a subset of the
       queue's characteristics (using, for example, the SET
       ENTRY/CHARACTERISTICS command).

    o  The job is moved to a queue on which all the job's
       characteristics have been specified (using, for example, the
       SET ENTRY/REQUEUE command).

    o  The job is deleted (using, for example, the DELETE/ENTRY
       command).

7    /CONFIRM

       /CONFIRM
       /NOCONFIRM (default)

    Controls whether a request is issued before each file is queued
    for printing to confirm that the operation should be performed on
    that file. The following responses are valid:

    YES      NO       QUIT
    TRUE     FALSE    Ctrl/Z
    1        0        ALL
             <Return>

    You can use any combination of uppercase and lowercase letters
    for word responses. Word responses can be abbreviated to one or
    more letters (for example, T, TR, or TRU for TRUE), but these
    abbreviations must be unique. Affirmative answers are YES, TRUE,
    and 1. Negative answers include: NO, FALSE, 0, and pressing
    Return. Entering QUIT or pressing Ctrl/Z indicates that you want
    to stop processing the command at that point. When you respond by
    entering ALL, the command continues to process, but no further
    prompts are given. If you type a response other than one of
    those in the list, DCL issues an error message and redisplays
    the prompt.

8    /COPIES

       /COPIES=n

    Positional qualifier.

    Specifies the number of copies to print. The value of the
    parameter n can be from 1 to 255 and defaults to 1. If you place
    the /COPIES qualifier after the PRINT command name, each file in
    the parameter list is printed the specified number of times. If
    you specify the /COPIES qualifier following a file specification,
    only that file is printed the specified number of times.

9    /CREATED

       /CREATED (default)
       /NOCREATED

    Modifies the time value specified with the /BEFORE or the /SINCE
    qualifier. The /CREATED qualifier selects files based on their
    dates of creation. This qualifier is incompatible with the
    /BACKUP, /EXPIRED, and /MODIFIED qualifiers, which also allow
    you to select files according to time attributes. If you specify
    none of these four time qualifiers, the default is the /CREATED
    qualifier.

10    /DELETE

       /DELETE
       /NODELETE (default)

    Positional qualifier.

    Controls whether files are deleted after printing. If you place
    the /DELETE qualifier after the PRINT command name, all specified
    files are deleted. If you specify the /DELETE qualifier after
    a file specification, only that file is deleted after it is
    printed.

    The protection applied to the file must allow delete (D) access
    for the life of the job. You need to have delete access when you
    submit the job and delete access when the system deletes your
    file at the end of the job.

11    /DEVICE

       /DEVICE=queue-name[:]

    Places the print job in the specified queue (rather than the
    default queue SYS$PRINT). This qualifier is synonymous with the
    /QUEUE qualifier, except that the /DEVICE qualifier is reserved
    for special use by VSI. Its usage, therefore, is not recommended.

12    /EXCLUDE

       /EXCLUDE=(filespec[,...])
       /NOEXCLUDE

    Excludes the specified files from the print operation. You can
    include a directory but not a device in the file specification.
    The asterisk (*)  and the percent sign (%) wildcard characters
    are allowed in the file specification; however, you cannot use
    relative version numbers to exclude a specific version. If you
    specify only one file, you can omit the parentheses.

13    /EXPIRED

       /EXPIRED
       /NOEXPIRED

    Modifies the time value specified with the /BEFORE or the /SINCE
    qualifier. The /EXPIRED qualifier selects files according to
    their expiration dates. (The expiration date is set with the
    SET FILE/EXPIRATION_DATE command.) The /EXPIRED qualifier
    is incompatible with the /BACKUP, /CREATED, and /MODIFIED
    qualifiers, which also allow you to select files according
    to time attributes. If you specify none of these four time
    qualifiers, the default is the /CREATED qualifier.

14    /FEED

       /FEED
       /NOFEED

    Positional qualifier.

    Controls whether form feeds are inserted into the print job when
    the printer reaches the bottom margin of the form in use. You can
    suppress this automatic form feed (without affecting any of the
    other carriage control functions that are in place) by using the
    /NOFEED qualifier. The /[NO]FEED qualifier does not affect user-
    formatted files and can be used to override the installation-
    defined defaults that have been set for the output queue you are
    using.

15    /FLAG

       /FLAG[=keyword]
       /NOFLAG

    Positional qualifier.

    Controls whether a file flag page is printed preceding a file.
    The flag page contains the name of the user submitting the job,
    the job entry number, and other information about the file being
    printed. If the /FLAG qualifier is positioned between the PRINT
    command and the file specifications, it can take either of the
    following keywords:

    ALL     Prints a file flag page before each file in the job.
    ONE     Prints a file flag page before the first file in the job.

    If you want the /FLAG qualifier to apply to individual files in a
    multifile job, place the qualifier directly after each file that
    you want to have a flag page.

    Use the /[NO]FLAG qualifier to override the /DEFAULT=[NO]FLAG
    option that has been set for the output queue you are using.
    The /[NO]FLAG qualifier does not override the /SEPARATE=[NO]FLAG
    option set for the queue.

    When you specify the /BURST qualifier for a file, the /[NO]FLAG
    qualifier does not add or subtract a flag page from the two flag
    pages that are printed preceding the file.

16    /FORM

       /FORM=form

    Specifies the name or number of the form to be associated with
    the print job. If you omit the /FORM qualifier, the default form
    for the execution queue is associated with the job.

    Forms have attributes such as print image width and length or
    paper stock, which the print symbiont associates with a job when
    the job is processed. To see which forms have been defined for
    your system, use the SHOW QUEUE/FORM command. To find out which
    form is mounted currently on a particular queue and which form is
    specified as that queue's default form, use the SHOW QUEUE/FULL
    command.

    The stock of the form associated with the job must match the
    stock of the form mounted on the execution queue on which you
    want the job to be processed. If the stocks do not match, the job
    remains pending until one or more of the following occurs:

    o  A form with the same stock as the job's form is mounted on
       the queue (using, for example, the SET QUEUE/FORM_MOUNTED
       command).

    o  A form with the same stock as the queue's mounted form is
       specified with the job (using, for example, the SET ENTRY/FORM
       command).

    o  The job is moved to a queue on which the stock of the mounted
       form matches the stock of the job's form (using, for example,
       the SET ENTRY/REQUEUE command).

    o  The job is deleted (using, for example, the DELETE/ENTRY
       command).

17    /HEADER

       /HEADER
       /NOHEADER (default)

    Positional qualifier.

    Controls whether a heading line is printed at the top of each
    page.

18    /HOLD

       /HOLD
       /NOHOLD (default)

    Controls whether a job is available for printing immediately.
    The /HOLD qualifier holds the job until released by a SET
    ENTRY/RELEASE or SET ENTRY/NOHOLD command.

19    /IDENTIFY

       /IDENTIFY (default)
       /NOIDENTIFY

    Displays the job name, queue name, entry number, and status of
    the job when it is queued.

20    /JOB_COUNT

       /JOB_COUNT=n

    Prints the job n times. The value of the parameter n can be from
    1 to 255 and defaults to 1.

21    /LOWERCASE

       /LOWERCASE
       /NOLOWERCASE (default)

    Indicates whether the print job must be printed on a printer that
    can print both lowercase and uppercase letters. The /NOLOWERCASE
    qualifier means that files can be printed on printers supporting
    only uppercase letters. If all available printers can print both
    uppercase and lowercase letters, you do not need to specify the
    /LOWERCASE qualifier.

22    /MODIFIED

       /MODIFIED
       /NOMODIFIED

    Modifies the time value specified with the /BEFORE or the /SINCE
    qualifier. The /MODIFIED qualifier selects files according to
    the dates on which they were last modified. This qualifier
    is incompatible with the /BACKUP, /CREATED, and /EXPIRED
    qualifiers, which also allow you to select files according
    to time attributes. If you specify none of these four time
    modifiers, the default is the /CREATED qualifier.

23    /NAME

       /NAME=job-name

    Names the job. The name consists of 1 to 39 alphanumeric
    characters. If characters other than alphanumerics, underscores
    (_),  or dollar signs ($) are used in the name, enclose the name
    in quotation marks (" ").  The default is the name of the first
    (or only) file in the job. The job name appears in the SHOW ENTRY
    and SHOW QUEUE command display and is printed on the flag page
    for the job.

24    /NOTE

       /NOTE=string

    Specifies a message string of up to 255 characters to appear on
    the flag page of the job.

25    /NOTIFY

       /NOTIFY
       /NONOTIFY (default)

    Controls whether a message is broadcast to your terminal session
    when the job is printed or aborted.

26    /OPERATOR

       /OPERATOR=string

    Specifies a message of up to 255 characters to be sent to the
    operator when the job begins to print.

27    /PAGES

       /PAGES=([lowlim,]uplim)

    Positional qualifier.

    Specifies the number of pages to print for the specified job. You
    can use the /PAGES qualifier to print portions of long files. By
    default, all pages of the file are printed.

    The lowlim specifier refers to the first page in the group of
    pages that you want printed for that file. If you omit the lowlim
    specifier, the printing starts on the first page of the file.

    The uplim specifier refers to the last page of the file that you
    want printed. If you want to print to the end of the file, but
    do not know how many pages the file contains, use quotation marks
    (" ")  as the uplim specifier. You can omit the parentheses if
    you are including only a specific value for the uplim specifier.
    For example, /PAGES=10 prints the first ten pages of the file;
    /PAGES=(5,10) prints pages 5 through 10; /PAGES=(5,"") starts
    printing at page 5 in the file and continues until the end of the
    file is reached.

28    /PARAMETERS

       /PARAMETERS=(parameter[(=value[,...])] [,...])

    Specifies from 1 to 8 optional parameters that are unique to a
    particular print symbiont. Each parameter and its values are
    passed as a single text string directly to the print symbiont:
    logical names and DCL symbols are not translated by the PRINT
    command.

    Each parameter can take from 1 to 8 values for a total of 255
    characters. If you specify only one parameter or parameter value,
    you can omit the parentheses. Enclose parameter values containing
    lowercase letters or nonalphanumeric characters (such as spaces,
    parentheses, or commas) in quotation marks.

    You can specify the /PARAMETERS qualifier only once in each PRINT
    command. For example, in the command PRINT /PARAMETERS=(JJJ,KK)
    /PARAMETERS=(LL,MMM), the JJJ and KK are ignored because the
    second occurrence of the /PARAMETERS qualifier supersedes the
    first occurrence.

    For information on parameters available for printing to
    PostScript printers using DECprint Supervisor software (DCPS),
    see the DCL Help topic PRINT_Parameter.

29    /PASSALL

       /PASSALL
       /NOPASSALL (default)

    Positional qualifier.

    Specifies whether the symbiont bypasses all formatting and
    sends the output QIO to the driver with format suppressed. All
    qualifiers affecting formatting, as well as the /HEADER, /PAGES,
    and /SETUP qualifiers, are ignored.

    If the /PASSALL qualifier is placed between the PRINT command and
    any file specifications, all files are printed in PASSALL mode.
    To specify the /PASSALL qualifier for only some files in the
    job, place the qualifier after each file that you want printed in
    PASSALL mode.

30    /PRIORITY

       /PRIORITY=n

    Requires OPER (operator) or ALTPRI (alter priority) privilege
    to raise the priority above the queue's maximum scheduling
    priority.

    Specifies the job-scheduling priority of the print job. The value
    of the parameter n can be from 0 through 255, where 0 is the
    lowest priority and 255 is the highest. The default value of n
    is the value of the system parameter DEFQUEPRI. No privilege
    is needed to set the priority lower than the queue's maximum
    scheduling priority.

31    /QUEUE

       /QUEUE=queue-name[:]

    Queues the job to the specified output queue. The default queue
    is SYS$PRINT. This qualifier is synonymous with the /DEVICE
    qualifier.

32    /REMOTE

    Queues the job to SYS$PRINT on the remote node specified in the
    file specification; the file must exist on the remote node. When
    you use the /REMOTE qualifier, you must include the node name in
    the file specification.

    You can specify only the following qualifiers with the /REMOTE
    qualifier:

       /BACKUP
       /BEFORE
       /BY_OWNER
       /CONFIRM
       /CREATED
       /EXCLUDE
       /EXPIRED
       /MODIFIED
       /SINCE

    Note that, unlike the printing on the local node, multiple files
    queued by a single PRINT/REMOTE command are considered separate
    jobs.

33    /RESTART

       /RESTART (default)
       /NORESTART

    Indicates whether a job restarts after a system failure or after
    a STOP/QUEUE/REQUEUE command.

34    /RETAIN

       /RETAIN=option

    Specifies the circumstances under which you want your jobs to be
    retained in a queue. When a job is retained in the queue, you can
    issue the SHOW QUEUE command after the job completes to see the
    status of the job. Without job retention, no record of a job is
    left in a queue after a job completes.

    Use the following options to specify job retention:

    o  ALWAYS--Holds the job in the queue regardless of the job's
       completion status.

    o  DEFAULT--Holds the job in the queue as specified by the
       queue's retention policy.

    o  ERROR--Holds the job in the queue only if the job completes
       unsuccessfully.

    o  UNTIL=time-value--Holds the job in the queue for the specified
       length of time, regardless of the job's completion status.

                                   NOTE

       You cannot specify a /NORETAIN qualifier with the PRINT
       command (as system managers can with the commands
       INITIALIZE/QUEUE, START/QUEUE, and SET QUEUE); however,
       you can specify /RETAIN=DEFAULT with the PRINT command. The
       default option holds the job in the queue as specified by
       the queue's retention policy. If the system manager has not
       specified retention for the queue, the job is not retained.

    How Job Retention Is Determined

    Although you can specify job retention options for your own jobs,
    the job retention option you specify may be overridden by the job
    retention option of the queue on which your job executed. If you
    submit or print a job to a generic queue, the generic queue's job
    retention setting may also override the job retention option you
    specify. This section describes how job retention is determined.

    An execution queue's job retention setting takes precedence
    over a generic queue's job retention setting; however, if the
    job's completion status does not match the job retention setting
    (if any) on the execution queue, then the generic queue's job
    retention setting attempts to control job retention. If the job's
    completion status does not match the job retention setting (if
    any) on the generic queue, then the user-specified job retention
    setting is used. Jobs submitted directly to execution queues are
    not affected by job retention settings on generic queues.

    If the execution queue's retention setting applies, the job is
    retained on the execution queue. Likewise, if the generic queue's
    retention setting applies, the job is retained on the generic
    queue. If the user-specified setting applies, the job is retained
    in the queue to which it was submitted.

    The following example illustrates how the queue manager
    determines job retention:

    Suppose you submit a job to a generic queue and specify
    /RETAIN=ALWAYS, and the job completes successfully.

    First, the queue manager compares the job's completion status
    to the execution queue's retention setting. Suppose the queue
    is set with /RETAIN=ERROR (retains only jobs that complete
    unsuccessfully). The job is not retained in the execution queue
    because the error condition was not met.

    The queue manager then compares the job's completion status to
    the generic queue's retention setting. Suppose the generic queue
    has no retention setting. The queue manager's comparison again
    fails to retain the job.

    Finally, the queue manager compares the job's completion
    status to the retention setting you specified for the job. This
    comparison reveals that the job should be retained. Because the
    user-specified setting leads the queue manager to retain the job,
    the job is held in the queue to which the job was submitted-in
    this case, the generic queue.

    For more information on types of queues, see the INITIALIZE/QUEUE
    command. For more information on setting retention options for
    queues, see the INITIALIZE/QUEUE, START/QUEUE, or SET QUEUE
    command.

    Timed Retention

    Timed retention, which you specify using the UNTIL=time-value
    option, allows you to retain a job in the queue only as long as
    you need it. This eliminates the need to delete the job from the
    queue later.

    For example, the following command retains the print job MYFILE
    in the queue until 7:31 on December 14, when the job will
    automatically be deleted from the queue.

    $ PRINT/RETAIN=UNTIL=14-DEC-2001:07:31:0.0 MYFILE.DAT

    However, depending on the queue's job retention policy, the
    job might be retained indefinitely. The job retention policy
    set on the queue takes precedence over the user-specified job
    retention setting. Because system managers cannot specify timed
    job retention for a queue, any jobs retained as a result of a
    queue's setting are retained indefinitely.

    If you specify the /RETAIN=UNTIL=time-value option, you must
    supply a time value. The time value is first interpreted
    as a delta time, then as a combination time, and finally
    as absolute time. If you specify a delta time, the delta
    begins when the job completes. For example, if you specify
    PRINT/RETAIN=UNTIL="+3:00", the job will be retained for three
    hours after the job completes. For information on specifying time
    values, see the OpenVMS User's Manual.

35    /SETUP

       /SETUP=module[,...]

    Extracts the specified modules from the device control library
    (containing escape sequence modules for programmable printers)
    and copies the modules to the printer before a file is printed.
    By default, no device control modules are copied.

    Note that the module names are not checked for validity until the
    time that the file is actually printed; therefore, PRINT/SETUP
    is susceptible to typing errors and other mistakes. It is
    recommended only for experimental setups.

    For production setups, see DEFINE/FORM/SETUP.

36    /SINCE

       /SINCE[=time]
       /NOSINCE

    Selects only those files dated on or after the specified time.
    You can specify time as absolute time, as a combination of
    absolute and delta times, or as one of the following keywords:
    BOOT, JOB_LOGIN, LOGIN, TODAY (default), TOMORROW, or YESTERDAY.
    Specify one of the following qualifiers with the /SINCE qualifier
    to indicate the time attribute to be used as the basis for
    selection: /BACKUP, /CREATED (default), /EXPIRED, or /MODIFIED.

    For complete information on specifying time values, see the
    OpenVMS User's Manual or the online help topic Date.

37    /SPACE

       /SPACE
       /NOSPACE (default)

    Positional qualifier.

    Controls whether print job output is double-spaced. The default
    is single-spaced output.

38    /STYLE

       /STYLE=keyword

    Specifies the file name format for display purposes.

    The valid keywords for this qualifier are CONDENSED and EXPANDED.
    Descriptions are as follows:

    Keyword     Explanation

    CONDENSED   Displays the file name representation of what is
    (default)   generated to fit into a 255-length character string.
                This file name may contain a DID or FID abbreviation
                in the file specification.
    EXPANDED    Displays the file name representation of what is
                stored on disk. This file name does not contain any
                DID or FID abbreviations.

    The keywords CONDENSED and EXPANDED are mutually exclusive. This
    qualifier specifies which file name format is displayed in the
    output message, along with the confirmation if requested.

    File errors are displayed with the CONDENSED file specification
    unless the EXPANDED keyword is specified.

    See the OpenVMS User's Manual for more information.

39    /SYMLINK

       /SYMLINK=keyword

    The valid keywords for this qualifier are [NO]WILDCARD and
    [NO]ELLIPSIS. Descriptions are as follows:

    Keyword     Explanation

    WILDCARD    Indicates that symlinks are enabled during wildcard
                searches.
    NOWILDCARD  Indicates that symlinks are disabled during directory
                wildcard searches.
    ELLIPSIS    Equivalent to WILDCARD (included for command
                symmetry).
    NOELLIPSIS  Indicates that symlinks are matched for all wildcard
                fields except for ellipsis.

    If the file named in the PRINT command is a symlink, the command
    operates on the symlink target.

40    /TRAILER

       /TRAILER[=keyword]
       /NOTRAILER

    Positional qualifier.

    Controls whether a file trailer page is printed at the end of
    a file. The trailer page displays the job entry number as well
    as information about the user submitting the job and the files
    being printed. If the /TRAILER qualifier is positioned between
    the PRINT command and the file specifications, it can take either
    of the following keywords:

    ALL     Prints a file trailer page after each file in the job.
    ONE     Prints a file trailer page after the last file in the
            job.

    If you want the /TRAILER qualifier to apply to individual files
    in a multifile job, place the qualifier directly after each file
    that you want to have a trailer page.

    Use the /[NO]TRAILER qualifier to override the
    /DEFAULT=[NO]TRAILER option that has been set for the output
    queue you are using. The /[NO]TRAILER qualifier does not override
    the /SEPARATE=[NO]TRAILER option set for the queue.

41    /USER

       /USER=username

    Requires CMKRNL (change mode to kernel) privilege and read (R)
    and write (W)  access to the user authorization file (UAF).

    Allows you to print a job on behalf of another user. The print
    job runs exactly as if that user had submitted it. The print
    job runs under that user's user name and user identification
    code (UIC), and accounting information is logged to that user's
    account. By default, the user identification comes from the
    requesting process. The user name qualifier value can be any
    user name that is valid on your system. The name must be 1 to 12
    alphanumeric characters.
Close Help