[an error occurred while processing this directive]

HP OpenVMS Systems Documentation

Content starts here HP OpenVMS DCL Dictionary

HP OpenVMS DCL Dictionary


Previous Contents Index

Processing Options for Text Output

The Text output converter supports the following options:

  • ASCII_FALLBACK [ON,OFF]
    Causes the Text output converter to output text in 7-bit ASCII. The fallback representation of the characters is described in the ASCII standard. If this option is not specified, the default is OFF; if this option is specified without a value, the default is ON.
  • CONTENT_MESSAGES [ON,OFF]
    Causes the Text output converter to put a message in the output file each time a nontext element is encountered in the intermediate representation of the input file. If this option is not specified, the default is OFF; if this option is specified without a value, the default is ON.
  • HEIGHT value
    Specifies the maximum number of lines per page in your text output file. If you specify zero, the number of lines per page will correspond to the height specified in your document. If you also specify OVERRIDE_FORMAT, or if the document has no inherent page size, the document is formatted to the height value specified by this option. The default height is 66 lines.
  • OVERRIDE_FORMAT [ON,OFF]
    Causes the Text output converter to ignore the document formatting information included in your document, so that the text is formatted in a single large galley per page that corresponds to the size of the page as specified by the HEIGHT and WIDTH processing options. If this option is not specified, the default is OFF; if this option is specified without a value, the default is ON.
  • SOFT_DIRECTIVES [ON,OFF]
    Causes the Text output converter to obey the soft directives contained in the document when creating your text output file. If this option is not specified, the default is OFF; if this option is specified without a value, the default is ON.
  • WIDTH value
    Specifies the maximum number of columns of characters per page in your text output file. If you specify zero, the number of columns per page will correspond to the width specified in your document. If you also specify OVERRIDE_FORMAT, or if the document has no inherent page size, the document is formatted to the value specified by this processing option. If any lines of text exceed this width value, the additional columns are truncated. The default width is 80 characters.

PostScript Output Converter

The PostScript output converter supports the following options:

  • PAPER_SIZE size
    Specifies the size of the paper to be used when formatting the resulting PostScript output file. Valid values for the size argument are as follows:
    Keyword Size
    A0 841 x 1189 millimeters (33.13 x 46.85 inches)
    A1 594 x 841 millimeters (23.40 x 33.13 inches)
    A2 420 x 594 millimeters (16.55 x 23.40 inches)
    A3 297 x 420 millimeters (11.70 x 16.55 inches)
    A4 210 x 297 millimeters (8.27 x 11.70 inches)
    A 8.5 x 11 inches (216 x 279 millimeters)
    B 11 x 17 inches (279 x 432 millimeters)
    C 17 x 22 inches (432 x 559 millimeters)
    D 22 x 34 inches (559 x 864 millimeters)
    E 34 x 44 inches (864 x 1118 millimeters)
    LEDGER 11 x 17 inches (279 x 432 millimeters)
    LEGAL 8.5 x 14 inches (216 x 356 millimeters)
    LETTER 8.5 x 11 inches (216 x 279 millimeters)
    LP 13.7 x 11 inches (348 x 279 millimeters)
    VT 8 x 5 inches (203 x 127 millimeters)

    The A paper size (8.5 x 11 inches) is the default.
  • PAPER_HEIGHT height
    Specifies a paper size other than one of the predefined values provided. The default paper height is 11 inches.
  • PAPER_WIDTH width
    Specifies a paper size other than one of the predefined sizes provided. The default paper width is 8.5 inches.
  • PAPER_TOP_MARGIN top-margin
    Specifies the width of the margin provided at the top of the page. The default value is 0.25 inch.
  • PAPER_BOTTOM_MARGIN bottom-margin
    Specifies the width of the margin provided at the bottom of the page. The default value is 0.25 inch.
  • PAPER_LEFT_MARGIN left-margin
    Specifies the width of the margin provided on the left-hand side of the page. The default value is 0.25 inch.
  • PAPER_RIGHT_MARGIN right-margin
    Specifies the width of the margin provided on the right-hand side of the page. The default value is 0.25 inch.
  • PAPER_ORIENTATION orientation
    Specifies the paper orientation to be used in the output PostScript file. The valid values for the orientation argument are as follows:
    Keyword Meaning
    PORTRAIT The page is oriented so that the larger dimension is parallel to the vertical axis.
    LANDSCAPE The page is oriented so that the larger dimension is parallel to the horizontal axis.

    The default is PORTRAIT.
  • EIGHT_BIT_OUTPUT [ON,OFF]
    Specifies whether the PostScript output converter should use 8-bit output. The default value is ON.
  • LAYOUT [ON,OFF]
    Specifies whether the PostScript output converter processes the layout specified in the DDIF document. The default value is ON.
  • OUTPUT_BUFFER_SIZE output-buffer-size
    Specifies the size of the output buffer. The value you specify must be within the range 64 to 256. The default value is 132.
  • PAGE_WRAP [ON,OFF]
    Specifies whether the PostScript output converter performs page wrapping of any text that would exceed the bottom margin. The default value is ON.
  • SOFT_DIRECTIVES [ON,OFF]
    Specifies whether the PostScript output converter processes soft directives in the DDIF file in order to format output. (Soft directives specify such formatting commands as new line, new page, and tab.) If the PostScript output converter processes soft directives, the output file will look more like you intended. The default value is ON.
  • WORD_WRAP [ON,OFF]
    Specifies whether the PostScript output converter performs word wrapping of any text that would exceed the right margin. The default value is ON. If you specify OFF, the PostScript output converter allows text to exceed the right margin.

Domain Converter

You might create an options file containing processing options that apply to any CDA supported tabular file format for which there is an input converter. Data tables and spreadsheets are examples of tabular file formats.

To convert tabular input files to document output files, use the DTIF_TO_DDIF format name, followed by the processing options described in this section. Specify the DTIF_TO_DDIF processing options in addition to the processing options for a particular tabular input file format and a particular document output file format.

You might want to convert tabular input files to document output files so that you can include textual representations of tables in reports and other documents. You should be aware, however, that you lose cell borders, headers, grid lines, all formulas, and font types when converting a tabular input file to a document output file.

The domain converter supports the following options:

  • COLUMN_TITLE
    Displays the column titles as contained in the column attributes centered at the top of the column.
  • CURRENT_DATE
    Displays the current date and time in the bottom left corner of the page. The value is formatted according to the document's specification for a default date and time.
  • DOCUMENT_DATE
    Displays the document date and time as contained in the document header in the top left corner of the page. The value is formatted according to the document's specification for a default date and time.
  • DOCUMENT_TITLE
    Displays the document title or titles as contained in the document header centered at the top of the page, one string per line.
  • PAGE_NUMBER
    Displays the current page number in the top right corner of the page.
  • PAPER_SIZE size
    Specifies the size of the paper to be used when formatting the resulting PostScript output file. Valid values for the size argument are as follows:
    Keyword Size
    A0 841 x 1189 millimeters (33.13 x 46.85 inches)
    A1 594 x 841 millimeters (23.40 x 33.13 inches)
    A2 420 x 594 millimeters (16.55 x 23.40 inches)
    A3 297 x 420 millimeters (11.70 x 16.55 inches)
    A4 210 x 297 millimeters (8.27 x 11.70 inches)
    A5 148 x 210 millimeters (5.83 x 8.27 inches)
    A 8.5 x 11 inches (216 x 279 millimeters)
    B 11 x 17 inches (279 x 432 millimeters)
    B4 250 x 353 millimeters (9.84 x 13.90 inches)
    B5 176 x 250 millimeters (6.93 x 9.84 inches)
    C 17 x 22 inches (432 x 559 millimeters)
    C4 229 x 324 millimeters (9.01 x 12.76 inches)
    C5 162 x 229 millimeters (6.38 x 9.02 inches)
    D 22 x 34 inches (559 x 864 millimeters)
    DL 110 x 220 millimeters (4.33 x 8.66 inches)
    E 34 x 44 inches (864 x 1118 millimeters)
    10x13_ENVELOPE 13 x 254 millimeters (15600 x 10 inches)
    9x12_ENVELOPE 12 x 229 millimeters (14400 x 9 inches)
    BUSINESS_ENVELOPE 9.5 x 105 millimeters (11400 x 4.13 inches)
    EXECUTIVE 10 x 191 millimeters (12000 x 7.5 inches)
    LEDGER 11 x 17 inches (279 x 432 millimeters)
    LEGAL 8.5 x 14 inches (216 x 356 millimeters)
    LETTER 8.5 x 11 inches (216 x 279 millimeters)
    LP 13.7 x 11 inches (348 x 279 millimeters)
    VT 8 x 5 inches (203 x 127 millimeters)

    The A paper size (8.5 x 11 inches) is the default.
  • PAPER_HEIGHT height
    Specifies a paper size other than one of the predefined values provided. The default paper height is 11 inches.
  • PAPER_WIDTH width
    Specifies a paper size other than one of the predefined sizes provided. The default paper width is 8.5 inches.
  • PAPER_TOP_MARGIN top-margin
    Specifies the width of the margin provided at the top of the page. The default value is 0.25 inch.
  • PAPER_BOTTOM_MARGIN bottom-margin
    Specifies the width of the margin provided at the bottom of the page. The default value is 0.25 inch.
  • PAPER_LEFT_MARGIN left-margin
    Specifies the width of the margin provided on the left side of the page. The default value is 0.25 inch.
  • PAPER_RIGHT_MARGIN right-margin
    Specifies the width of the margin provided on the right side of the page. The default value is 0.25 inch.
  • PAPER_ORIENTATION orientation
    Specifies the paper orientation to be used in the output file. The valid values for the orientation argument are as follows:
    Keyword Meaning
    PORTRAIT The page is oriented so that the larger dimension is parallel to the vertical axis.
    LANDSCAPE The page is oriented so that the larger dimension is parallel to the horizontal axis.

    The default is PORTRAIT.

Example


$ CONVERT/DOCUMENT/OPTIONS=MY_OPTIONS.CDA$OPTIONS -
_$MY_INPUT.DTIF/FORMAT=DTIF MY_OUTPUT.DDIF/FORMAT=DDIF
      

This command converts an input file named MY_INPUT.DTIF, which has the DTIF format, to an output file named MY_OUTPUT.DDIF, which has the DDIF format. The specified options file is named MY_OPTIONS.CDA$OPTIONS.


CONVERT/RECLAIM

Invokes the Convert/Reclaim utility, which makes empty buckets in Prolog 3 indexed files available so that new records can be written in them. The /RECLAIM qualifier is required.

For more information about the Convert/Reclaim utility, refer to the OpenVMS Record Management Utilities Reference Manual or online help.


Format

CONVERT/RECLAIM filespec


COPY

Creates a new file from one or more existing files. The COPY command can do the following:
  • Copy an input file to an output file.
  • Concatenate two or more input files into a single output file.
  • Copy a group of input files to a group of output files.

Format

COPY input-filespec[,...] output-filespec


Parameters

input-filespec[,...]

Specifies the name of an existing file to be copied. The asterisk (*) and the percent sign (%) wildcard characters are allowed. If you do not specify the device or directory, the COPY command uses your current default device and directory. If you specify more than one file, separate the file specifications with either commas (,) or plus signs (+).

output-filespec

Specifies the name of the output file into which the input is copied.

You must specify at least one field in the output file specification. If you do not specify the device or directory, the COPY command uses your current default device and directory. The COPY command replaces any other missing fields (file name, file type, version number) with the corresponding field of the input file specification. If you specify more than one input file, the COPY command generally uses the fields from the first input file to determine any missing fields in the output file.

You can use the asterisk (*) wildcard character in place of any two of the following: the file name, the file type, or the version number. The COPY command uses the corresponding field in the related input file to name the output file.


Description

The COPY command creates a new file from one or more existing files. If you do not specify the device or directory, the COPY command uses your current default device and directory. The COPY command can do the following:
  • Copy an input file to an output file.
  • Concatenate two or more input files into a single output file.
  • Copy a group of input files to a group of output files.

The COPY command, by default, creates a single output file. When you specify more than one input file, the first input file is copied to the output file, and each subsequent input file is appended to the end of the output file. If a field of the output file specification is missing or contains an asterisk (*) wildcard character, the COPY command uses the corresponding field from the first, or only, input file to name the output file.

If you specify multiple input files with maximum record lengths, the COPY command gives the output file the maximum record length of the first input file. If the COPY command encounters a record in a subsequent input file that is longer than the maximum record length of the output file, it issues a message noting the incompatible file attributes and begins copying the next file.

To create multiple output files, specify multiple input files and use at least one of the following:

  • An asterisk (*) wildcard character in the output directory specification, file name, file type, or version number field
  • Only a node name, a device name, or a directory specification as the output file specification
  • The /NOCONCATENATE qualifier

When the COPY command creates multiple output files, it uses the corresponding field from each input file in the output file name. You also can use the asterisk (*) wildcard character in the output file specification to have COPY create more than one output file. For example:


$ COPY A.A;1, B.B;1 *.C

This COPY command creates the files A.C;1 and B.C;1 in the current default directory. When you specify multiple input and output files you can use the /LOG qualifier to verify that the files were copied as you intended.

Note that there are special considerations for using the COPY command with DECwindows compound documents. For more information, refer to the Guide to OpenVMS File Applications.

Version Numbers

If you do not specify version numbers for input and output files, the COPY command (by default) assigns a version number to the output files that is either of the following:

  • The version number of the input file
  • A version number one greater than the highest version number of an existing file with the same file name and file type

When you specify the output file version number by an asterisk (*) wildcard character, the COPY command uses the version numbers of the associated input files as the version numbers of the output files.

If you specify the output file version number by an explicit version number, the COPY command uses that number for the output file specification. If a higher version of the output file exists, the COPY command issues a warning message and copies the file. If an equal version of the output file exists, the COPY command issues a message and does not copy the input file.

File Protection and Creation/Revision Dates

The COPY command considers an output file to be new when you specify any portion of the output file name explicitly. The COPY command sets the creation date for a new file to the current time and date.

If you specify the output file by one or more asterisk (*) and percent sign (%) wildcard characters, the COPY command uses the creation date of the input file.

The COPY command always sets the revision date of the output file to the current time and date; it sets the backup date to zero. The file system assigns the output file a new expiration date. (The file system sets expiration dates if retention is enabled; otherwise, it sets expiration dates to zero.)

The protection and access control list (ACL) of the output file is determined by the following parameters, in the following order:

  • Protection of previously existing versions of the output file
  • Default Protection and ACL of the output directory
  • Process default file protection

(Note that the BACKUP command takes the creation and revision dates as well as the file protection from the input file.)

Use the /PROTECTION qualifier to change the output file protection.

Normally, the owner of the output file will be the same as the creator of the output file; however, if a user with extended privileges creates the output file, the owner will be the owner of the parent directory or of a previous version of the output file if one exists.

Extended privileges include any of the following:

  • SYSPRV (system privilege) or BYPASS
  • System user identification code (UIC)
  • GRPPRV (group privilege) if the owner of the parent directory (or previous version of the output file) is in the same group as the creator of the new output file
  • An identifier (with the resource attribute) representing the owner of the parent directory (or the previous version of the output file)

Copying Directory Files

If you copy a file that is a directory, the COPY command creates a new empty directory of the named directory. The COPY command does not copy any files from the named directory to the new directory. See the examples section for examples of copying directory files.


Qualifiers

/ALLOCATION=number-of-blocks

Forces the initial allocation of the output file to the specified number of 512-byte blocks. If you do not specify the /ALLOCATION qualifier, or if you specify it without the number-of-blocks parameter, the initial allocation of the output file is determined by the size of the input file being copied.

/BACKUP

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.

/BEFORE[=time]

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, refer to the OpenVMS User's Manual or the online help topic DCL_Tips (subtopic Date_Time).

/BY_OWNER[=uic]

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 HP OpenVMS Guide to System Security.

/CONCATENATE (default)

/NOCONCATENATE

Creates one output file from multiple input files when you do not use the asterisk (*) or percent sign (%) wildcard characters in the output file specification. The /NOCONCATENATE qualifier generates multiple output files. A wildcard character in an input file specification results in a single output file consisting of the concatenation of all input files matching the file specification.

Files from Files-11 On-Disk Structure Level 2 and 5 disks are concatenated in alphanumeric order. If you specify an asterisk (*) or percent sign (%) wildcard character in the file version field, files are copied in descending order by version number. Files from Files-11 On-Disk Structure Level 1 disks are concatenated in random order.

/CONFIRM

/NOCONFIRM (default)

Controls whether a request is issued before each copy operation 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. You can abbreviate word responses 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.

/CONTIGUOUS

/NOCONTIGUOUS

Specifies that the output file must occupy contiguous physical disk blocks. By default, the COPY command creates an output file in the same format as the corresponding input file. Also, by default, if not enough space exists for a contiguous allocation, the COPY command does not report an error. If you copy multiple input files of different formats, the output file may or may not be contiguous. You can use the /CONTIGUOUS qualifier to ensure that files are copied contiguously.

The /CONTIGUOUS qualifier has no effect when you copy files to or from tapes because the size of the file on tape cannot be determined until after it is copied to the disk. If you copy a file from a tape and want the file to be contiguous, use the COPY command twice: once to copy the file from the tape, and a second time to create a contiguous file.

/CREATED (default)

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.

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

Excludes the specified files from the copy 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.

/EXPIRED

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.

/EXTENSION=n

Specifies the number of blocks to be added to the output file each time the file is extended. If you do not specify the /EXTENSION qualifier, the extension attribute of the corresponding input file determines the default extension attribute of the output file.

/LOG

/NOLOG (default)

Controls whether the COPY command displays the file specifications of each file copied.


Previous Next Contents Index