Preface

The VOS Commands Reference Manual (R098) documents the VOS operating system commands and command functions for VOS Release 15.0.0.

This manual is intended for users who have access to the VOS operating system, applications and systems programmers, and system administrators.

Manual Version

This manual is a revision. Change bars, which appear in the margin, note the specific changes to text since the previous publication of this manual.

This revision incorporates the following changes.

  • It includes information about the new ftServer V-Series hardware platform.
  • It describes the new (software_purchased) command function.
  • It describes the following new commands: check_posix, cvt_fixed_to_stream, handle_sig_dfl, kill, locate_large_files, set, set_line_wrap_width, vcc, and verify_posix_access.
  • It includes changes in the functionality or the descriptions of the following commands or command functions.

    • (module_info)
    (process_dir)
    (process_info)
    (string)
    (terminal_info)
    add_library_path
    add_profile
    attach_port
    batch
    bind
    break_process
    c
    c_preprocess
    cc
    cobol
    compare_files
    copy_dir
    copy_file
    create_data_object
    create_deleted_record_index
    create_file
    create_index
    create_tape_volumes
    debug
    display
    display_device_info
    display_file
    display_file_status
    display_object_module_info
    display_program_module
    display_system_usage
    display_tape_params
    dump_file
    edit_form
    fortran
    get_external_variable
    harvest_pc_samples
    help
    list_port_attachments
    list_save_tape
    list_terminal_types
    list_users
    login
    logout
    mount_tape
    move_dir
    move_file
    nls_edit_form
    pascal
    pl1
    preprocess_file
    profile
    read_tape
    restore_object
    save_object
    set_external_variable
    set_file_allocation
    set_owner_access
    set_tape_mount_params
    set_terminal_parameters
    set_time_zone
    start_logging
    start_process
    stop_logging
    stop_process
    update_batch_requests
    update_process_cmd_limits
    verify_save
    walk_dir
    who_locked

Manual Organization

This manual has two chapters and three appendixes.

Chapter 1 describes the VOS command functions.

Chapter 2 describes the VOS commands.

Appendix A describes tape parameter values.

Appendix B describes the general software limits for VOS.

Appendix C describes a way to reduce program module size when using shared virtual memory databases.

Related Manuals

Refer to the following Stratus manuals for related documentation.

  • VOS Reference Manual 
  • VOS Commands User's Guide 

Refer also to the VOS System Administration manuals.

  • VOS System Administration: Administering and Customizing a System 
  • VOS System Administration: Starting Up and Shutting Down a Module or System 
  • VOS System Administration: Registration and Security 
  • VOS System Administration: Disk and Tape Administration 
  • VOS System Administration: Backing Up and Restoring Data 
  • VOS System Administration: Configuring a System 

Notation Conventions

This manual uses the following notation conventions.

  • Italics introduces or defines new terms. For example:

The master disk is the name of the member disk from which the module was booted.

  • Boldface emphasizes words in text. For example:

Every module must have a copy of the module_start_up.cm file.

  • Monospace represents text that would appear on your terminal's screen (such as commands, subroutines, code fragments, and names of files and directories). For example:
change_current_dir (master_disk)>system>doc
  • Monospace italic represents terms that are to be replaced by literal values. In the following example, the user must replace the monospace-italic term with a literal value.
list_users -module module_name
  • Monospace bold represents user input in examples and figures that contain both user input and system output (which appears in monospace). For example:
display_access_list system_default

%dev#m1>system>acl>system_default

w  *.*

Key Mappings for VOS Functions

VOS provides several command-line and display-form functions. Each function is mapped to a particular key or combination of keys on the terminal keyboard. To perform a function, you press the appropriate key(s) from the command-line or display form. For an explanation of the command-line and display-form functions, see the manual Introduction to VOS 

The keys that perform specific VOS functions vary depending on the terminal. For example, on a V105 ANSI terminal, you press the and keys simultaneously to perform the INTERRUPT function; on a V105/V109 EPC terminal, you press the key on the numeric keypad to perform the INTERRUPT function.

Note: Certain applications may define these keys differently. Refer to the documentation for the application for the specific key mappings.

The following table lists some VOS functions and the keys to which they are mapped on commonly used Stratus terminals. For information about the key mappings for a terminal that is not listed in this table, refer to the documentation for that terminal.

VOS Function
V105 PC/+ 106
V105 ANSI
V105/V109 EPC
CANCEL
† or *†
† or *†
CYCLE
 †
 †
CYCLE BACK
 †
-
 †
DISPLAY FORM
 † or - †
or -
 † or - †
HELP
-
-
INSERT DEFAULT
-
-
INSERT SAVED
INTERRUPT
 †
-
 †
NO PAUSE
 †
-
 †
†Numeric-keypad key

Format for Commands and Requests

Stratus manuals use the following format conventions for documenting commands and requests. (A request is typically a command used within a subsystem, such as analyze_system.) Note that the command and request descriptions do not necessarily include each of the following sections.

name
The name of the command or request is at the top of the first page of the description.

Privileged
This notation appears after the name of a command or request that can be issued only from a privileged process.

Purpose
Explains briefly what the command or request does.

Display Form
Shows the form that is displayed when you type the command or request name followed by -form or when you press the key that performs the DISPLAY FORM function. Each field in the form represents a command or request argument. If an argument has a default value, that value is displayed in the form.

The following table explains the notation used in display forms.

The Notation Used in Display Forms

Notation
Meaning

Required field with no default value.

The cursor, which indicates the current position on the screen. For example, the cursor may be positioned on the first character of a value, as in ll.
current_user
current_module
current_system
current_disk
The default value is the current user, module, system, or disk. The actual name is displayed in the display form of the command or request.

Command-Line Form
Shows the syntax of the command or request with its arguments. You can display an online version of the command-line form of a command or request by typing the command or request name followed by -usage.

The following table explains the notation used in command-line forms. In the table, the term multiple values refers to explicitly stated separate values, such as two or more object names. Specifying multiple values is not the same as specifying a star name. When you specify multiple values, you must separate each value with a space.

The Notation Used in Command-Line Forms

Notation
Meaning
argument_1
Required argument.
argument_1...
Required argument for which you can specify multiple values.
 
Î Ï
 
Set of arguments that are mutually exclusive; you must specify one of these arguments.
[argument_1]
Optional argument.
[argument_1]...
Optional argument for which you can specify multiple values.
 
 
Set of optional arguments that are mutually exclusive; you can specify only one of these arguments.
Note: Dots, brackets, and braces are not literal characters; you should not type them. Any list or set of arguments can contain more than two elements. Brackets and braces are sometimes nested.

Arguments
Describes the command or request arguments. The following table explains the notation used in argument descriptions.

The Notation Used in Argument Descriptions

Notation
Meaning
There are predefined values for this argument. In the display form, you display these values in sequence by pressing the key that performs the CYCLE function.
Required
You cannot issue the command or request without specifying a value for this argument.
 
If an argument is required but has a default value, it is not labeled Required since you do not need to specify it in the command-line form. However, in the display form, a required field must have a value—either the displayed default value or a value that you specify.
(Privileged)
Only a privileged process can specify a value for this argument.

Explanation
Explains how to use the command or request and provides supplementary information.

Error Messages
Lists common error messages with a short explanation.

Examples
Illustrates uses of the command or request.

Related Information
Refers you to related information (in this manual or other manuals), including descriptions of commands, subroutines, and requests that you can use with or in place of this command or request.

Online Documentation

The VOS StrataDOC Web site is an online-documentation service provided by Stratus. It enables Stratus customers to view, search, download, print, and comment on VOS technical manuals via a common Web browser. It also provides the latest updates and corrections available for the VOS document set.

You can access the VOS StrataDOC Web site at http://stratadoc.stratus.com. A copy of the VOS StrataDOC CD-ROM is included with this release. You can also order additional copies from Stratus.

This manual is available on the VOS StrataDOC Web site.

For information about ordering the VOS StrataDOC CD-ROM, see the next section, "Ordering Manuals."

Ordering Manuals

You can order manuals in the following ways.

  • If your system is connected to the Remote Service Network (RSN™), issue the maint_request command at the system prompt. Complete the on-screen form with all of the information necessary to process your manual order.
  • Customers in North America can call the Stratus Customer Assistance Center (CAC) at (800) 221-6588 or (800) 828-8513, 24 hours a day, 7 days a week. All other customers can contact their nearest Stratus sales office, CAC office, or distributor; see http://www.stratus.com/support/cac/index.htm for CAC phone numbers outside the U.S.

Manual orders will be forwarded to Order Administration.

Commenting on This Manual

You can comment on this manual by using the command comment_on_manual. To use the comment_on_manual command, your system must be connected to the RSN. Alternatively, you can email comments on this manual to comments@stratus.com.

The comment_on_manual command is documented in the manual VOS System Administration: Administering and Customizing a System  and the VOS Commands Reference Manual (R098). There are two ways you can use this command to send your comments.

  • If your comments are brief, type comment_on_manual, press or , and complete the data-entry form that appears on your screen. When you have completed the form, press .
  • If your comments are lengthy, save them in a file before you issue the command. Type comment_on_manual followed by -form, then press or . Enter this manual's part number, R098, then enter the name of your comments file in the -comments_path field. Press the key that performs the CYCLE function to change the value of -use_form to no and then press .

Note: If comment_on_manual does not accept the part number of this manual (which may occur if the manual is not yet registered in the manual_info.table file), you can use the mail request of the maint_request command to send your comments.

Your comments (along with your name) are sent to Stratus over the RSN.

Stratus welcomes any corrections and suggestions for improving this manual.