[an error occurred while processing this directive]

HP OpenVMS Systems Documentation

Content starts here

OpenVMS User's Manual


Previous Contents Index

2.4 Entering Parameters

File specifications are the most common type of parameter. DCL commands can accept input file specifications (files that are acted upon by a command) and output file specifications (files that are created by a command).

The following rules apply when specifying parameters in a command line:

  • Square brackets ([]) in command descriptions indicate optional items. For example, you do not have to enter a file specification in the following command:

    DIRECTORY [file-spec]

  • In a command description, anything not enclosed in square brackets is required. For example, you must enter a device name in the following command:

    SHOW PRINTER device-name

  • In general, precede an output file parameter with an input file parameter.
  • A parameter can be one item or a series of items. If you enter a series of items, separate the items with commas (,) or plus signs (+). Any number of spaces or tab characters can precede or follow a comma or a plus sign. Note that some commands regard the plus sign as a concatenator, not as a separator.

Examples

The following example shows how to copy the input file LISTS.TXT to the output file FORMAT.TXT:


$ COPY LISTS.TXT FORMAT.TXT

The following example line shows how you can enter a list of file specifications as the parameter:


DELETE file-spec[,...]

The following example shows how to specify a list of parameters. Here, three files are copied to a fourth file. The three file specifications, PLUTO.TXT, SATURN.TXT, and EARTH.TXT, constitute the first parameter. PLANETS.TXT is the second parameter. Note that there are no spaces (although they could have been inserted) between the PLUTO.TXT, SATURN.TXT, and EARTH.TXT file specifications.


$ COPY PLUTO.TXT,SATURN.TXT,EARTH.TXT PLANETS.TXT

2.5 Entering Qualifiers

There are three types of qualifiers:

  • Command
  • Positional
  • Parameter

You can abbreviate any qualifier name as long as the abbreviated name remains unique among all qualifier names for the same command. However, to ensure that your command procedures are upwardly compatible, do not abbreviate commands and qualifiers in command procedures.

Commands have default qualifiers; you do not have to specify a qualifier unless it is different from the command default. The following sections describe types of qualifiers and qualifier defaults. The OpenVMS DCL Dictionary contains default information for specific commands.

2.5.1 Command Qualifiers

A command qualifier modifies a command and can appear anywhere in the command line. However, it is a good practice to place the qualifier after the command name. If you are specifying multiple qualifiers, you should place a command qualifier with other command qualifiers that follow the command name.

In the following example, /QUEUE is a command qualifier. The files SATURN.TXT and EARTH.TXT are queued to the print queue LN03_PRINT:


$ PRINT/QUEUE=LN03_PRINT SATURN.TXT,EARTH.TXT

2.5.2 Positional Qualifiers

A positional qualifier can modify commands or parameters and has different meanings depending on where you place it in the command string. If you place a positional qualifier after the command but before the first parameter, it affects the entire command string. If you place a positional qualifier after a parameter, it affects only that parameter.

In the following example, the first PRINT command requests two copies of the files SPRING.SUM and FALL.SUM. The second PRINT command requests two copies of the file SPRING.SUM but only one copy of FALL.SUM.


$ PRINT/COPIES=2 SPRING.SUM,FALL.SUM
$ PRINT SPRING.SUM/COPIES=2,FALL.SUM

2.5.3 Parameter Qualifiers

A parameter qualifier can be used only with certain types of parameters, such as input files and output files. For example, the BACKUP command accepts several parameter qualifiers that apply only to input and output file specifications.

In the following example, the /CREATED and /BEFORE qualifiers, which can be specified only with input files, select specific input files for the backup operation. The asterisk (*) is a wildcard character that replaces the file name. BACKUP selects all files with the .TXT file type that were created before December 11, 2002.


$ BACKUP *.TXT/CREATED/BEFORE=11-DEC-2002 NEWFILE.TXT

2.5.4 Conflicting Qualifiers

If you use two or more contradictory qualifiers on a command line, the right-most qualifier overrides the others.

Some commands contain conflicting qualifiers that cannot be specified in the same command line. If you use incompatible qualifiers, the command interpreter displays an error message.

Following is an example of conflicting qualifiers. Note that the PRINT command accepts only the /COPIES=2 and the /NOBURST qualifiers because they are the right-most qualifiers in the command line:


$ PRINT MYFILE/COPIES=3/BURST/COPIES=2/NOBURST EARTH.TXT

2.5.5 Values Accepted by Qualifiers

Qualifiers can accept keywords, file specifications, character strings, and numeric values. When you enter a value for a qualifier, separate the qualifier and the value with either an equal sign (=) or a colon (:).

Some qualifier keywords require additional information. In these cases, separate the keyword from its value with a colon or an equal sign.

To specify multiple keywords that require values, enclose the list in parentheses and separate the keyword and value with either an equal sign (=) or a colon (:).

Examples

Either command in this example is valid:


$ PRINT/COPIES=3 MYFILE.DAT


$ PRINT/COPIES:3 MYFILE.DAT

This is an example of a qualifier that requires additional information; the keyword "PROTECTION" is separated from its value by a colon or an equal sign (=):


$ SET SECURITY/PROTECTION:GROUP:RW MYFILE.DAT


$ SET SECURITY/PROTECTION=GROUP=RW MYFILE.DAT

This is an example of a qualifier that requires multiple keywords, each of which require multiple values:


$ SET SECURITY/PROTECTION=(OWNER=RWD,GROUP=RW) myfile.dat


$ SET SECURITY/PROTECTION=(OWNER:RWD,GROUP:RW) myfile.dat

2.6 Entering Dates and Times as Values

Certain commands and qualifiers (such as the PRINT/AFTER command) accept date and time values. You can specify these values in one of the following formats:

  • Absolute time
  • Delta time
  • Combination time (combines absolute and delta time formats)

2.6.1 Absolute Time Format

Absolute time is a specific date or time of day. The format for absolute time is as follows:


[dd-mmm-yyyy][:hh:mm:ss.cc]

The fields are as follows:

dd Day of the month: an integer in the range 1 to 31
mmm Month: JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, or DEC
yyyy Year: an integer
hh Hour: an integer in the range 0 to 23
mm Minute: an integer in the range 0 to 59
ss Second: an integer in the range 0 to 59
cc Hundredths of a second: an integer in the range 0 to 99

The following rules apply when specifying absolute time:

  • You can truncate the date or the time on the right.
  • If you specify both a date and a time, include a colon between them.
  • The date must contain at least one hyphen.
  • You can omit any of the fields within the date and time as long as you include the punctuation marks that separate the fields.
  • A truncated or omitted date field defaults to the corresponding fields for the current date.
  • A truncated or omitted time field defaults to zero.
  • If you specify a past time in a command that expects the current or a future time, the current time is used.

You can also specify an absolute time as one of the following keywords:

TODAY The current day, month, and year at 00:00:00.0 o'clock
TOMORROW 00:00:00.00 o'clock tomorrow
YESTERDAY 00:00:00.00 o'clock yesterday

The following table shows examples of absolute time specifications:

Time Specification Result
11-DEC-2002:13 1 P.M. on December 11, 2002
11-DEC Midnight at the beginning of December 11 this year
15:30 3:30 P.M. today
19-- Midnight on the 19th day of the current year and month
19--:30 12:30 A.M. on the 19th of this month

2.6.2 Delta Time Format

Delta time is an offset (a time interval) from the current date and time to a time in the future. The general format of a delta time is as follows:


"+[dddd-][hh:mm:ss.cc]"

The fields are as follows:

dddd Number of days; an integer in the range 0 to 9999
hh Number of hours; an integer in the range 0 to 23
mm Number of minutes; an integer in the range 0 to 59
ss Number of seconds; an integer in the range 0 to 59
cc Number of hundredths of seconds; an integer in the range 0 to 99

If a qualifier is described as a value that can be expressed as an absolute time, a delta time, or a combination of the two, you must specify a delta time as if it were part of a combination time. For example, to specify a delta time value of five minutes from the current time, use "+:5" (not "0-0:5").

The following rules apply when specifying delta time:

  • You can truncate a delta time on the right.
  • If you specify the number of days, include a hyphen.
  • You can omit fields within the time as long as you include the punctuation that separates the fields.
  • If you omit the time field, the default is zero.

The following table shows some examples of delta time specifications:

Time Specification Result
"+3-" 3 days from now (72 hours)
"+3" 3 hours from now
"+:30" 30 minutes from now
"+3-:30" 3 days and 30 minutes from now
"+15:30" 15 hours and 30 minutes from now

2.6.3 Combination Time Format

To combine absolute and delta times, specify an absolute time plus or minus a delta time. Use one of the following formats:


    "[absolute time][+delta time]"

     [absolute time][-delta time]

The variable fields and default fields for absolute and delta time values are the same as those described in the preceding sections.

The following rules apply when specifying combination time:

  • Precede the delta time value by a plus or minus sign. (Note that the minus sign is the same keyboard key as the hyphen.)
  • Enclose the entire time specification in quotation marks if a plus or minus sign precedes the delta time value.
  • Omit the absolute time value if you want to offset the delta time from the current date and time.
  • Specify date and time information as completely as possible.

The following table shows some examples of combination time specifications:

Time Specification Result
"+5" 5 hours from now.
"-1" Current time minus 1 hour. The minus sign (-) indicates a negative offset. (The 1 is interpreted as an hour, not a day, because it is not followed by a hyphen.)
"+:5" 5 minutes from now.
"-:5" Current time minus 5 minutes.
"-1-00" Current time minus 1 day. The minus sign (-) indicates a negative offset. The hyphen (-) separates the day from the time field.
"31-DEC:+:5" 12:05 A.M. on December 31 of the current year. The absolute time specification (before the colon) defaults to midnight on December 31 of the current year. The plus sign (+) indicates a positive offset.
31-DEC:-00:10 11:50 P.M. on December 30 of the current year. The absolute time specification (before the colon) defaults to midnight on December 31 of the current year. The minus sign (-) after DEC: indicates a negative offset.

2.7 Recalling Commands

At the DCL prompt, you can recall previously typed command lines to avoid retyping long command lines. Once a command is displayed, you can reexecute or edit it.

On OpenVMS VAX systems, the recall buffer holds up to 20 previously entered commands.

On OpenVMS Alpha systems, the recall buffer holds up to 254 previously entered commands.

You can display your previously entered commands by using one of the following methods:

  • Pressing Ctrl/B
  • Using up arrow and down arrow keys
  • Using the RECALL command

2.7.1 Pressing Ctrl/B

Pressing Ctrl/B once recalls the previous command line. Pressing Ctrl/B again recalls the line before the previous line and so on to the last saved command line.

2.7.2 Using Arrow Keys

Using the up arrow and down arrow keys recalls the previous and successive command, respectively. Press the arrow keys repeatedly to move through the commands.

2.7.3 Using the RECALL Command

To examine previously typed command lines, type RECALL/ALL. After reviewing the available commands, you can recall a particular command line by typing RECALL and the number of the desired command.

You can also follow RECALL with the first characters of the command line you want to display. RECALL scans the previous command lines (beginning with the most recent one) and Enters the first command line that begins with the characters you typed.

Examples

This is a sample display generated by typing RECALL/ALL:


$ RECALL/ALL


 1 SET DEFAULT DISK2:[MARSHALL]
 2 EDIT ACCOUNTS.COM
 3 PURGE ACCOUNTS.COM
 4 DIRECTORY/FULL ACCOUNTS.COM
 5 COPY ACCOUNTS.COM [.ACCOUNTS]*
 6 SET DEFAULT [.ACCOUNTS]

The following example shows how to recall the fourth command line:


$ RECALL 4

After you press Enter, the system displays the fourth command in the list at the DCL prompt. (The RECALL command itself is not placed in the buffer.)

The following example shows how to recall a previously entered command, EDIT ACCOUNTS.COM:


$ RECALL E

After you press Enter, the system displays the following command line:


$ EDIT ACCOUNTS.COM

Note

If you are running a utility or an application program that uses OpenVMS screen management software, you can use Ctrl/B and the up arrow and down arrow keys to perform command recall; however, line editing must be enabled. Some utilities that have this feature are Mail, OpenVMS Debugger, Show Cluster, the System Dump Analyzer (SDA), and the EVE editor.

To erase the contents of the recall buffer, enter the RECALL command with the ERASE qualifier. For example:


$ RECALL/ERASE

For security reasons, it is good practice to erase the contents of the recall buffer after you have entered commands that include passwords.

2.8 Editing the DCL Command Line

At the DCL command level, you can use many individual keys and key sequences to change what you type. Although different types of terminals have different operating characteristics, most have standard function keys and keys that can be used with line editors.

To see whether line editing is enabled, enter the SHOW TERMINAL command.

In the following example, line editing is enabled:


$ SHOW TERMINAL

Terminal: _VTA2138:   Device_Type: VT200_Series  Owner: ROHBA
Physical terminal: _TNA2114:
Remote Port Info: Host: 16.32.216.68 Port: 1409

   Input:    9600     LFfill:  0      Width:  80      Parity: None
   Output:   9600     CRfill:  0      Page:   24

Terminal Characteristics:
   Interactive        Echo               Type_ahead         No Escape
   Hostsync           TTsync             Lowercase          Tab
   Wrap               Scope              No Remote          Eightbit
   Broadcast          No Readsync        No Form            Fulldup
   No Modem           No Local_echo      No Autobaud        Hangup
   No Brdcstmbx       No DMA             No Altypeahd       Set_speed
   No Commsync        Line Editing       Overstrike editing No Fallback
   No Dialup          No Secure server   Disconnect         No Pasthru
   No Syspassword     No SIXEL Graphics  No Soft Characters Printer port
   Numeric Keypad     ANSI_CRT           No Regis           No Block_mode
   Advanced_video     Edit_mode          DEC_CRT            DEC_CRT2
   No DEC_CRT3        No DEC_CRT4        No DEC_CRT5        No Ansi_Color
   VMS Style Input

2.8.1 SET TERMINAL Command

You can use the SET TERMINAL command to alter the way in which your terminal edits a DCL command line. By default, changes made with the SET TERMINAL command apply only to the current session. To set the terminal each time you log in, you can include SET TERMINAL commands in your LOGIN.COM file.

To enable line editing, enter the SET TERMINAL/LINE_EDIT command:


$  SET TERMINAL/LINE_EDIT

Insert and Overstrike Modes

You can edit a command line in either insert or overstrike mode. In insert mode, the character you type is inserted to the left of the cursor. In overstrike mode, the character you type overwrites the character indicated by the cursor.

To change editing modes for a single command line, press Ctrl/A (Ctrl/A acts as a toggle). To change edit modes for your session, enter either the SET TERMINAL/INSERT or SET TERMINAL/OVERSTRIKE command.

Text Wrapping

If you use the SET TERMINAL/WRAP command, when you enter more characters than will fit on one line of the screen, the text wraps to the next line. If you use the SET TERMINAL/NOWRAP command, when you enter more characters than will fit on one line of the terminal screen, the last character on the line is typed over.

You can edit only the line where your cursor appears. When text wraps, you cannot use the up arrow key to move the cursor up to edit the previous line. To move the cursor up to the previous line, use the Delete key and delete all the characters in the current line.


Previous Next Contents Index