Oracle Repository Command Line Tool


Go to previous Go to next

Preface

About the Command Line Tool

The Command Line Tool provides a powerful and flexible means of accessing repository data and for performing day-to-day development tasks such as checkin and checkout. It also enables a build manager to perform bulk operations in the repository, such as creating releases or individual workareas for entire teams.

The Command Line Tool can be run from Windows. It can be used in interactive mode, in which you can execute a series of commands, in one-shot mode, which executes a single command, or to execute a command script containing a series of commands.

The Command Line Tool is installed with Oracle Repository and runs under Windows operating systems, as a DOS session.

Generally, you cannot create repository objects using the Command Line Tool. However, you can create files and folders using the upload or synchronization commands and you can create folders using the mkfolder command.

Operating system commands can be executed within the interactive shell using the exec (host) command.

About the Command Line Tool documentation

This documentation is for users of the Oracle Repository Command Line Tool, a command shell that enables users to connect to a repository and perform repository management tasks using commands.

Documentation provided for the Command Line Tool is:

Prerequisites for using the Command Line Tool documentation

To derive most benefit from this documentation, you should be familiar with Oracle Repository concepts such as workareas, access rights and privileges, and the containership model. For information about these topics, see the Oracle Repository Online Help and in the Oracle Repository API Help.

How to use the Command Line Tool documentation

To find out how to start and stop the Command Line Tool and how to run commands, read Using the Oracle Repository Command Line Tool. To find detailed information about a particular command, use the Contents list or the Index.

When you are using the Command Line Tool, you can get help about all the available commands or details of a specific command using the Command Line Tool help command.

Conventions used in the Command Line Tool documentation

The following conventions are used in this documentation for representing command formats.

Characters that you need to enter as shown in the syntax are in bold.

Examples:

In the following, the words setpolicy, on and off are words that you may need to enter:

setpolicy  <policy-nameon|off

In the following, you need to enter the { and } round the <version-label>:

<object-name>{<version-label>}

Placeholders for names or strings are in angle brackets (< >).

Example:

lockcheckout <name>

Alternatives are separated by a single vertical bar ( | ) to denote or. You need to supply only one of the alternatives.

Examples:

setpolicy  <policy-nameon|off
remove
  <name(spec)>|<pattern>  [-s]  [-ty<nls-type>]  [-nosync]  [-p

Optional items are enclosed in brackets ([ ]). There may be a single item or a choice of alternatives.

Example:

exec  [<os-command>]
lsbranch  [<pattern>]  [-nt]   [-nh]
changefolder
  <foldername>  [-rp|-lo]

Example commands are shown in equal-spaced type.

Example:

    mkconfig internal -fsd:\config_specs\internal.txt

Other features available from the command line

In addition to the features available with the Command Line Tool, the following are Oracle Repository features that can be executed from an operating system command line:

For information about both these features, see the Oracle Repository Online Help.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle Corporation is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace.

 


Go to previous
Prev

Go to next
Next

Oracle logo 
Copyright © 2000, 2004, Oracle Corporation. 
All Rights Reserved.