Alphabetical command list
This section lists the Rational® Synergy
CLI commands, in alphabetical order.
Note: The function to print a PDF of the topics contained
in this CLI Alphabetical command list section does not work at this
time. For your convenience, use the Rational Synergy
CLI Alphabetical command list PDF document, which contains
the information under the Alphabetical command list section of this
information center.
For a list of the administrative
commands, see the following sections in the Administering section:
- alias command
An alias represents a macro that you can use to create another name for an existing command or another alias. When Rational Synergy recognizes a command as an alias name, it expands the alias and replaces the alias name with its defined items. This expansion is repeated until the command is no longer an alias, or a circular reference is found. - attribute command
You can manipulate the attributes associated with objects in various ways. - baseline command
A baseline is a set of projects and tasks used to represent your data at a specific point in time. A baseline has many uses. - candidates command
The candidates command lists all versions of an object that are eligible for selection when you perform a use or update operation in a directory entry. An object is a candidate for use if the name, type, and object instance attribute values of the object match the same attribute values of the directory entry. - cat command
You can display the contents of an object that is not currently a member of the directory. If you specify the file in the context project, and the corresponding work area is visible, the work area file is shown. If not, a temporary copy from the database is shown. - checkin command
Use the checkin command to check in one or more objects and, if necessary, set the next state. You can check in source (non-product objects), product and project objects, and assign task numbers to objects. Additionally, you can add, modify, or replace a comment for the object you to check in. - checkout command
When you check out an object in a non-shared project, its default state is working. When you check out a file or directory in a shared project, its default state is visible if it is a non-product. The default state is shared if it is a product. - checkpoint command
The checkpoint command saves a personal version of an object for your use only. Checkpointing an object preserves it in a state that is not modifiable, but that you can delete later when you no longer need it. You must own the object to perform a checkpoint. To checkpoint an object, it must be in the working state. - cmdhistory command
You can obtain a record of commands run during a session. - conflicts command
You can display the conflicts for a project with update properties that use tasks and a baseline. A conflict represents an inconsistency between the set of changes associated with a project update properties and the set of changes included in project membership. - copy_project command
When you copy a project from a static (non-modifiable) project and do not copy subprojects, and the subprojects have relative work areas, new copies of those subprojects work areas are created in the appropriate locations within the work area of the project being copied. Developers can reuse static subprojects that have relative work areas. - copy_to_file_system command
A project copied to your work area is always copy-based, never link-based, and the files are read-only. You can copy a project to the file system even if the project does not have a work area. File modification time is set to the time the copy is created. - create command
You can create an object and add it to the current project. You can create a project or a project member (directory or file), both of which are created as part of a project, or a floating object. A floating object is a new project that is not created as a part of a project. - dcm command
The ccm dcm command generates a transfer package, sends a transfer package to a destination database, receives a transfer package, and adds objects to a transfer set. - delete command
You can delete an object version if it is not a member of a project. You can also delete an object version if it is only a member of the current project and has no successors. - delimiter command
The delimiter command shows the value of the delimiter character. The default is the dash character. Set the delimiter to any nonrestricted character. When you set the delimiter, you set it for a database. - diff command
The diff command shows the differences between files, directories, or projects. Use this command to do two types of comparisons: a source compare (the default) and a version compare. - dir command
You can display two categories of files: objects under Rational Synergy control and files that exist in the file system only. By default, the command shows only controlled objects. Use the -m option to display uncontrolled objects as well as controlled objects. - edit command
When you edit a file in a project, the editor is started in the work area if the work area is visible to the client. If the specified file is not in a project or if the work area for the project is not visible, the editor is started with a temporary read-only copy of the file from the database. - export command
The ccm export command exports specified objects to a package that might be later imported into the same or another Rational Synergy database at the same release and patch level. The format of the packages that is produced by the ccm export command is implementation private and only intended for use with the ccm import command. - finduse command
The finduse command searches the database for uses of a specified object and returns a list of where the specified object is used. - folder command
Use folders to define the update properties of projects and project groupings. Most commonly, folders are created from folder templates, which are defined in process rules. - folder_template command
Folder templates provide a pattern used to create folders. Folders created from a folder template are controlled by that folder template. Therefore, when you change the folder template, the folders controlled by it are updated. - groups command
You can implement and define security for objects. A database can contain many different collections of objects. Group security restricts check out and modifies permissions to a specified group of users for files, directories, projects, tasks, and folders. In addition, you can specify read security, which limits visibility of the source contents of objects to designated groups. - history command
You can show the version history of a project, directory, file, or release. - import command
The ccm import command imports objects contained in an import package compressed file. The main use of this command is to import the data from an import package created by the ccm migrate command. - ln command
You can create a symbolically linked object in the database. You must execute the command within the context of a project with a maintained UNIX work area on a UNIX client. Alternatively, you can create a controlled symbolic link from file_spec to path_name. The link can point to any path, and does not have to be a controlled object or a path within a maintained project work area. - ls command
You can list the contents of a directory object version in a work area. By default, the output consists of a list of objects and their associated projections in the file system. The ls command displays two categories of files: objects under Rational Synergy control and files that exist in the file system only. - merge command
When you merge source files or directories, the merge tool compares the versions you selected. The tool then compares the differences of each version to the closest common ancestor. A new, merged, controlled version is created automatically when you exit your merge tool. - migrate command
The term migration describes the process of taking data located outside of a Rational Synergy database and creating that data in a Rational Synergy database in a way that represents the external data. - move command
You can rename a file or project, and move files, directories, projects, subprojects, and the contents with the move command. - process command
A process groups process rules into a named set that are designed to work together. - process_rule command
A process rule specifies how a baseline is chosen for the update properties for a project grouping and project. Use this command to display and set process rules. - product_info command
You can show release and patch level information for the Rational Synergy client, server, database schema, or database server. - project command
The project command determines the project associated with a specified file_spec or the current working directory. The file_spec is typically a folder specification within a maintained work area. - project_grouping command
Use project groupings to organize projects by release and purpose for the update operation. The task and baseline properties for a project grouping are used at project update so that member selection is consistent across all projects. A project can be a member of only one project grouping. A project grouping is created automatically when you create a project. - project_purpose command
The project_purpose command creates or shows (depending on your user role) the project purposes for a database. - properties command
Use the properties command to find information about one or more objects. You can display the attribute values of a group of model-defined attributes for the specified objects to standard output. - query command
Use the query command to search for objects in the database. Rational Synergy evaluates a query expression during a search operation. The query expression can consist of any query clause from query-related options combined with any query_string argument. The results of the query display in the selection set. - reconcile command
You can compare the files in your work area with your database files. Discrepancies between the work area contents and the database are called work area conflicts. The reconcile command identifies these work area conflicts and resolves them to make your work area consistent with the database. - relate command
Use this command to add a relationship (relation_name) between file_spec1 and file_spec2, or to show the relationship with the specified data. - release command
Use this command to create, modify, delete, show, and rename release information. - save_offline_and_delete command
The Save Offline and Delete (SOAD) command deletes objects from a database by using a scope. - select command
The ccm select command provides the ability to manipulate the query selection set in various ways. The command supports a stack of selection sets that might be used to save and restore selection sets. - set command
You can set behaviors in Rational Synergy. An option represents a control over the behavior of specific Rational Synergy operations. Some options apply to the current CLI session only and are not saved from session to session. Some options are persistent user preferences stored in the database. Some options are predefined and read-only and cannot be modified. - soad_scope command
The soad_scope command edits, creates, modifies, and deletes scopes used to save objects offline and to delete objects. - show_servers command
Use this command to view the databases and associated Rational Synergy servers known to the router. - start command
The start command begins a Rational Synergy CLI session. - status command
Use this command shows information about user CLI or GUI sessions matching specified criteria. - stop command
The stop command ends a session. - sync command
Your work area is created automatically when you create a project and when you check out a project using the check-out commands. As you add new members to your project, your work area is updated automatically. A sync operation writes out the database files to the work area. - task command
You can use the task command to create, modify, and delete tasks, and to perform the following operations. - typedef command
Rational Synergy supports type-dependent behaviors. For example, you can allow parallel versions for one type of object but not another. Or you can use a selected editor tool for objects of a specific type. When you use an appropriate type for your files, you can define the appropriate behaviors for that type. This method helps describe the purpose of objects of that type. - unalias command
You can remove an alias for the current session only. - undo_update command
You can reverse an update operation for a specified directory or project object. You can also reverse the last undo update operation. In other words, if two or more undo updates are performed, only the last one is reversed. - unrelate command
The unrelate command deletes a relationship, rel_name, between file_spec1 and file_spec2. - unuse command
You can remove an existing file, directory, root directory, or project from the current project or directory. The directory must be modifiable to remove members from it. If you try to remove an object from a non-modifiable directory, the directory is automatically checked out (unless you specify the -r option). You must check in the directory to make the files in the directory available to other users. - update command
You can update a specified directory, project object, or project grouping. Update uses the baseline and tasks of project groupings to find candidates and selection rules to select appropriate versions of the members. You can also specify a project grouping to be updated. - use command
You can replace an existing file, directory, or project with another version. Additionally, you can add a file, directory, or project that is in the database, but not in the current directory. When you add an object to a non-modifiable directory, a new directory version is checked out automatically. - view command
You can show a specified file. The default viewer is used to view the file. - work_area command
You can show and modify work area options.
Feedback