|
DataMuseum.dkPresents historical artifacts from the history of: Rational R1000/400 Tapes |
This is an automatic "excavation" of a thematic subset of
See our Wiki for more about Rational R1000/400 Tapes Excavated with: AutoArchaeologist - Free & Open Source Software. |
top - metrics - downloadIndex: H T
Length: 427379 (0x68573)
Types: TextFile
Names: »Help_Data«
└─⟦6ac9a67ca⟧ Bits:30000548 8mm tape, Rational 1000, access 1_0_1
└─⟦78f173837⟧ »DATA«
└─⟦687a7d38f⟧
└─⟦d10a02448⟧ Bits:30000409 8mm tape, Rational 1000, ENVIRONMENT, D_12_7_3
└─⟦fc9b38f02⟧ »DATA«
└─⟦687a7d38f⟧
└─⟦76eb391d8⟧
└─⟦56d8da70c⟧
└─⟦this⟧ »Rational_Access/Help_Data«
#Help Data Version
Release 1_0_0
November 16, 1992 at 5:12:53 PM by JAF
#File Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>New...
------
Provides commands for creating various objects.
>>Browse...
---------
Allows you to visit any object.
>>Open
----
Opens an object for editing. If the object is not
editable (for example, a library), a dialog box
appears, depending on the kind of object.
>>Close
-----
Abandons editing of the current image. If the image
has unsaved changes, a confirmation dialog appears,
giving you the option to save the changes. The
image does not remain listed in the Image Palette
after it is closed.
>>Save
----
Makes permanent any changes made to the image in
the current window. The image remains open for
further editing.
>>Revert
------
Restores the image in the current window to the
current committed (permanent) value of the version
and discards any changes that may have been made to
the image.
>>Print...
--------
Prints any image or object to a selected printer.
>>Properties...
-------------
Provides editable information about the current
object.
>>Copy File...
------------
Copies the contents of one or more existing source
objects to or into the specified destination
object(s).
>>Move File...
------------
Copies the contents of one or more source objects
to or into the specified destination object(s) and
then deletes the source object(s).
>>Delete File...
--------------
Destroys all versions of the specified object. If
the specified object has children, such as a
library, Delete File also destroys those child
objects. See the Rational Access User's Guide for
more information.
>>Insert File...
--------------
Inserts the named text file into the current Ada
image at the current cursor position.
>>Run...
------
Executes the specified command or Ada program. You
can run the executable under the debugger, if so
desired.
>>Exit...
-------
Logs you out of the Environment and the current
session. If you have unsaved changes, a dialog box
appears giving you the option to save the changes
and commit the open images.
#File New Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).`
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Text File...
------------
Creates a new empty text file. A window is created
containing the image of the text file, and the
image is open for editing.
>>Ada
---
Creates an insertion point in a library where an
Ada compilation unit can be inserted.
>>World...
-------
Creates a world with the specified name on the
specified volume.
>>Directory...
------------
Creates a directory with the specified name.
The new directory is built on the same volume as
the nearest enclosing world. Furthermore, the new
directory gets its library switch-file association
from its parent library.
>>Subsystem...
------------
Subsystems partition a project or application into
high-level components by grouping Ada units or
other objects.
The new subsystem contains an empty working view
that has the specified imports.
>>Working View...
---------------
Creates a copy of the specified views, starting a
new development path or subpath.
A path is a logically connected series of views
within a subsystem or a system. For each view
specified, the File:New:Working View command
creates a new working view that serves as the start
of such a series of views.
A subsystem or a system can contain multiple paths.
For example, if an application has multiple
targets, a path can be made for each target.
Similarly, if a new major release of an application
must be developed while the existing release is
maintained, a separate path can be made for the new
major release.
>>Spec View...
------------
Creates one or more new spec views by copying the
specified view or views. A spec view defines the
set of implemented units that are potentially
available, or visible, to units in views of other
subsystems. Spec views thus define a subsystem's
exports; as such, spec views can be imported by
client views in other subsystems. In a sense, a
spec view is analogous to an Ada package
specification, which defines the resources that are
available to client units.
>>Release View...
---------------
Creates a release view or a configuration release.
A release view is a complete frozen copy of a
working view. As such, a release view contains
program source code, and, if the release view has
been compiled, the units in the release view can be
executed. You should make a release view from a
compiled working view whenever you want to both
preserve a configuration in a working view and be
able to execute its units. (Note that the original
working view itself is not frozen, so it is always
available for further development.)
A configuration release preserves the state of a
working view, without creating a release view. As
such, a configuration release is a summary of
configuration information from which a release view
subsequently can be constructed, if desired. You
should make a configuration release when you want
to keep a record of a particular configuration, but
you do not need to execute the units immediately.
Making a configuration release is faster and uses
less storage than making a release view.
>>Code View...
------------
Creates a code view. Code views are copies of views
that contain only the executable code from the
view. Code views are especially useful when
security requirements restrict visibility to
portions of source code.
>>Switch File...
--------------
Creates a library or session switch file of the
specified name and type. If the specified switch
file already exists, a new version, containing the
system-defined default values, is created. This new
version overwrites the existing version.
>>Activity...
-----------
Creates a new activity, which is an execution table
that must be set up to specify which of the
alternative load views is to be used from each
subsystem. The activity contains one entry for each
subsystem that is required for execution.
>>Mailbox...
----------
Creates a mailbox with a specified name for the
specified user.
The mailbox is created in the specified user's home
library in a directory called Mailbox. If the
directory does not exist, it is created.
>>Venture...
----------
Creates a new venture. A venture is a management
tool that contains information about groups of work
order lists and controls their use. Each work order
must have a venture that is its "parent."
>>Work Order
----------
Creates a work order on the specified venture and
adds it to a work-order list. Work orders are
designed to communicate details about specific
tasks to be accomplished.
>>Work Order List...
------------------
Creates a new work-order list on the specified
venture. A work-order list contains groups of
related work orders.
>>System...
---------
Creates a new system. A system pulls an
application's components together by logically
grouping particular releases from the component
subsystems. Operations for systems are in package
Cmvc_Hierarchy.
The new subsystem or system contains an empty
working view that has the specified imports. This
command also can be used to create an empty view in
an existing subsystem or system.
By default, the model for the system is !Model.R1000.
#New Text File
File:New:Text File creates a new empty text file. A
window is created containing the image of the text
file, and the image is open for editing.
>>OPTIONS
-------
>>Name
----
Enter the name of the file to be created. The name
must be a legal filename. The default is
Current_Library.New_File, where Current_Library is
the library from which you executed the command.
Typing directly on the New_File prompt replaces
that prompt.
If you specify a single name component, the new
world is created under that name in the current
library. Alternatively, you can specify a qualified
name to create the world in a location other than
the current library (however, the specified
location must exist). Wildcards, context prefixes,
and attributes can be used except in the rightmost
component of the name (the object's simple name).
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Text.Create
#New World
File:New:World creates a world with the specified
name. The file is created on the volume with the
most available disk space.
>>OPTIONS
------
>>Name
----
Enter the name of the world to be created. You must
specify a single object that does not already
exist. The default is Current_Library.New_World,
where Current_Library is the library from which you
executed the command. Typing directly on the
New_World prompt replaces that prompt.
If you specify a single name component, the new
world is created under that name in the current
library. Alternatively, you can specify a qualified
name to create the world in a location other than
the current library (however, the specified
location must exist). Wildcards, context prefixes,
and attributes can be used except in the rightmost
component of the name (the object's simple name).
>>Model
-----
Enter the model to be used in creating the new
world. The new world gets its links, its target
key, and its library switches from the model. By
default, !Model.R1000 is used, which has links to
most Environment resources. Specifying the null
string ("") creates a world with no links and with
a target key for R1000 compilation. When the null
string is specified, the new world inherits its
library switch-file association from its parent
library.
>>RESTRICTIONS
------------
Worlds can be created only in other worlds and in
directories that are nested in other worlds. Worlds
cannot be created in subsystems or views.
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Library.Create_World
procedure Library.Nil
#New Directory
File:New:Directory creates a directory with the
specified name.
The new directory is built on the same volume as
the nearest enclosing world. Furthermore, the new
directory gets its library switch-file association
from its parent library.
>>OPTIONS
-------
>>Directory Name
--------------
Enter the name of the new directory at the prompt.
This entry box must specify a single object that
does not already exist. The default is
Current_Library.New_Directory, where
Current_Library is the library from which you
executed the command. Typing directly on the
New_Directory prompt replaces that prompt.
If a single name component is specified, the new
directory is created under that name in the current
library. Alternatively, a qualified name can be
specified to create the directory in a location
other than the current library (however, the
specified location must exist). Wildcards, context
prefixes, and attributes can be used, except in the
New_Directory prompt itself.
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Library.Create_Directory
#New Subsystem
File:New:Subsystem creates a new subsystem.
Subsystems partition a project or application into
high-level components by grouping Ada units or
other objects.
The new subsystem contains an empty working view
that has the specified imports.
>>OPTIONS
-------
>> Name
----
Enter the name of the new subsystem at the
New_Subsystem prompt. This entry box must specify a
single object that does not already exist. The
default is Current_Library.New_Subsystem, where
Current_Library is the library from which you
executed the command. Typing directly on the
New_Subsystem prompt replaces that prompt.
If you specify a single name component, the new
world is created under that name in the current
library. Alternatively, you can specify a qualified
name to create the world in a location other than
the current library (however, the specified
location must exist). Wildcards, context prefixes,
and attributes can be used except in the rightmost
component of the name (the object's simple name).
>>Initial View Name
------------------
Enter the full name of the initial working view to
be created as part of the subsystem. The default
name of the initial view of the subsystem or system
is: System_Object.Working_View_Base_Name_Working.
>>Kind
----
From the Kind option menu, choose the kind of view
to create. Spec_Load creates a load view. A load
view contains the implementation of a subsystem.
Using spec and load views minimizes the
recompilation required after changes are made and
eliminates the need for recompilation during
recombinant testing.
Combined creates a combined view. A combined view
both contains the subsystem implementation and
expresses the exports from that implementation.
Using combined views does not reduce the
recompilation requirements; however, you must use
combined view when generics or inlined subprograms
are exported from implementations for non-R1000
targets.
>>Model
-----
Enter the model to be used in creating the new
world. The new world gets its links, its target
key, and its library switches from the model. By
default, !Model.R1000 is used, which has links to
most Environment resources. Specifying the null
string ("") creates a world with no links and with
a target key for R1000 compilation. When the null
string is specified, the new world inherits its
library switch-file association from its parent
library.
>>Comments
--------
Enter any comments.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Initial
#New Working View
File:New:Working View creates a copy of the
specified view, starting a new development path or
subpath.
A path is a logically connected series of views
within a subsystem or a system. The
File:New:Working View command creates a new working
view that serves as the start of such a series of
views.
A subsystem or a system can contain multiple paths.
For example, if an application has multiple
targets, a path can be made for each target.
Similarly, if a new major release of an application
must be developed while the existing release is
maintained, a separate path can be made for the new
major release.
>>OPTIONS
------
>>Name
----
Enter the name of the new working view. The Name
entry box can contain any string that constitutes a
legal Ada identifier and therefore can contain one
or more underscore characters. Note that other CMVC
operations (such as generating reservation tokens
or creating subpaths) conventionally consider a
view's pathname prefix to be the portion of a view
name up to (but not including) the first underscore
in the name.
>>Kind
----
Choose the kind of view to create. Load creates a
load view. A load view contains the implementation
of a subsystem. Using spec and load views minimizes
the recompilation required after changes are made
and eliminates the need for recompilation during
recombinant testing.
Combined creates a combined view. A combined view
both contains the subsystem implementation and
expresses the exports from that implementation.
Using combined views does not reduce the
recompilation requirements; however, you must use
combined view when generics or inlined subprograms
are exported from implementations for non-R1000
targets.
>>Join
----
A new view can, but need not, be joined to the
source view (and hence to the path) from which it
is created. Two paths should be joined (by checking
this box) if the majority of the controlled objects
in them are to be joined. (Joined objects cannot be
checked out and modified independently.) The
controlled objects that need to be modified
independently can be severed subsequently with the
CMVC:Sever command. For example, if an application
has two targets, the target-independent code is
shared and the target-dependent code is not.
Assuming that a path already exists for one of the
targets, a joined path can be created for the
second target and then the target-dependent units
can be severed.
A new view should not be joined to the view from
which it is created if most of the controlled
objects in these two paths are to be modified
independently. For example, if a new major release
of an application is developed while the previous
major release is maintained, the objects in the two
paths typically need to be modified independently,
so the paths are not joined. (Note that changes can
be propagated across unjoined objects with the
Cmvc.Merge_Changes Environment command.) Although
the new path is not joined when created, individual
objects in it subsequently can be joined to the
corresponding objects in other views (see the
CMVC:Join command).
>>Copy Of
-------
Enter the view that is to be copied as the
beginning of new path or subpath. The default is
the view on which the cursor is located. In this
entry box, you can name:
* Combined, load, or spec views
* Either working or released views
All controlled objects in a view named in the Copy
Of entry box must be checked in.
>>Same Imports
------------
Checking this box causes the new working view to
use the same imports as the view from which it was
copied.
>>New Imports
-----------
Checking this box causes the new working view to
use only the imports you enter in the associated
entry box.
Multiple views can be specified by using wildcards,
context characters, special names, set notation, or
an indirect file. Furthermore, this field can name
an activity as an indirect file, which is
equivalent to naming the spec view associated with
each subsystem listed in the activity.
>>Comments
--------
Enter any comments.
>>Model
-----
Enter the model world or view from which to create
the new world view. If the specified name cannot be
resolved in the context !Model, the name is
resolved relative to the current context. By
default, the new working view uses the same model
as the view from which it was copied.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Make_Path
procedure Cmvc.Sever
procedure Cmvc.Merge_Changes
Rational Access Help
CMVC:Join
#New Spec View
File:New:Spec View creates one or more new spec
views by copying the specified view or views. A
spec view defines the set of implemented units that
are potentially available, or visible, to units in
views of other subsystems. Spec views thus define a
subsystem's exports; as such, spec views can be
imported by client views in other subsystems. In a
sense, a spec view is analogous to an Ada package
specification, which defines the resources that are
available to client units.
>>OPTIONS
-------
>>Name
----
Enter the name of the new spec view.
>>Copy Of
-------
Enter the view that is to be copied as the source
of the new spec view. The default is the view on
which the cursor is located. In this entry box, you
can name:
* Combined, load, or spec views
* Either working or released views
All controlled objects in a view named in the Copy
Of entry box must be checked in.
>>Join
----
A new spec view can, but need not, be joined to the
source view (and hence to the path) from which it
is created. Two paths should be joined (by checking
this box) if the majority of the controlled objects
in them are to be joined. (Joined objects cannot be
checked out and modified independently.) The
controlled objects that need to be modified
independently can be severed subsequently with the
CMVC:Sever command. For example, if an application
has two targets, the target-independent code is
shared and the target-dependent code is not.
Assuming that a path already exists for one of the
targets, a joined path can be created for the
second target and then the target-dependent units
can be severed.
A new spec view should not be joined to the view
from which it is created if most of the controlled
objects in these two paths are to be modified
independently. For example, if a new major release
of an application is developed while the previous
major release is maintained, the objects in the two
paths typically need to be modified independently,
so the paths are not joined. (Note that changes can
be propagated across unjoined objects with the
Cmvc.Merge_Changes Environment command.) Although
the new path is not joined when created, individual
objects in it subsequently can be joined to the
corresponding objects in other views (see the
CMVC:Join command).
>>Same Imports
------------
Checking this box causes the new spec view to use
the same imports as the view from which it was
copied.
>>New Imports
-----------
Checking this box causes the new spec view to use
only the imports you enter in the associated entry
box.
Multiple views can be specified by using wildcards,
context characters, special names, set notation, or
an indirect file. Furthermore, this field can name
an activity as an indirect file, which is
equivalent to naming the spec view associated with
each subsystem listed in the activity.
>>Comments
--------
Enter any comments.
>>Model
-----
Enter the model world for the new spec view. If the
specified name cannot be resolved in the context
!Model, the name is resolved relative to the
current context. By default, the new spec view uses
the same model as the view from which it was
copied.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Copy
#New Release View
File:New:Release View creates a release view or a
configuration release, depending on if you check
the Build Full View Copy box (release view) or the
Save Release Generation Information Only box
(configuration release).
A release view is a complete frozen copy of a
working view. As such, a release view contains
program source code, and, if the release view has
been compiled, the units in the release view can be
executed. You should make a release view from a
compiled working view whenever you want to both
preserve a configuration in a working view and be
able to execute its units. (Note that the original
working view itself is not frozen, so it is always
available for further development.)
A configuration release preserves the state of a
working view, without creating a release view. As
such, a configuration release is a summary of
configuration information from which a release view
subsequently can be constructed, if desired. You
should make a configuration release when you want
to keep a record of a particular configuration, but
you do not need to execute the units immediately.
Making a configuration release is faster and uses
less storage than making a release view.
Note that if you are making a configuration
release, the Kind, Join, Imports, and Model fields
will be ignored.
>>OPTIONS
-------
>>Name
----
Enter the name of the new release view. If the
source view is Rev1_Working, the default name is
usually of the form Rev1_1.
>>Kind
----
Choose the kind of view to create. Spec_Load
creates a load view. A load view contains the
implementation of a subsystem. Using spec and load
views minimizes the recompilation required after
changes are made and eliminates the need for
recompilation during recombinant testing.
Combined creates a combined view. A combined view
both contains the subsystem implementation and
expresses the exports from that implementation.
Using combined views does not reduce the
recompilation requirements; however, you must use
combined view when generics or inlined subprograms
are exported from implementations for non-R1000
targets.
>>Join
----
A new release view can, but need not, be joined to
the source view (and hence to the path) from which
it is created. Joined objects are represented in a
single series of generations stored in the CMVC
database. In general, you should join the release
view to its source view.
>>Copy Of
------
Enter the view from which to create the release
view. The default is the view on which the cursor
is located. In this entry box, you can name:
* Combined, load, or spec views
* Either working or released views
All controlled objects in a view named in the Copy
Of entry box must be checked in.
>>Same Imports
-----------
Checking this box causes the new release view to
use the same imports as the view from which it was
copied.
>>New Imports
-----------
Checking this box causes the new release view to
use only the imports you enter in the associated
entry box.
Multiple views can be specified by using wildcards,
context characters, special names, set notation, or
an indirect file. Furthermore, this entry box can
name an activity as an indirect file, which is
equivalent to naming the spec view associated with
each subsystem listed in the activity.
>>Comments
--------
Enter any comments.
>>Model
-----
Enter the model to be used in creating the new
release view. The new view gets its target key and
its library switches from the model. By default,
!Model.R1000 is used. Specifying the null string
("") creates a view with a target key for R1000
compilation. When the null string is specified, the
new view inherits its library switch-file
association from the parent subsystem.
>>Build Full View Copy
--------------------
Check this box to make a release view.
>>Save Release Generation Information Only
----------------------------------------
Check this box to make a configuration release. If
this box if checked, the Kind, Join, Imports, and
Model fields are ignored.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Copy
procedure Cmvc.Release
#New Code View
File:New:Code View creates a code view. Code views
are copies of views that contain only the
executable code from the view. Code views are
especially useful when security requirements
restrict visibility to portions of source code.
>>OPTIONS
------
>>Name
----
Enter the name of the new code view.
>>Copy Of
-------
Enter the name of the view from which the code view
is to be made. The named view must be a load view.
The default is the view on which the cursor is
located. All units in the named view must be coded
and must contain bodies for all specifications that
require them. All controlled units in the named
views must be checked in.
>>Comments
--------
Enter any comments.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Make_Code_View
#New Switch File
File:New:Switch File creates a library switch file
of the specified name. If the specified switch file
already exists, a new version, containing the
system-defined default values, is created.
WARNING: This new version overwrites the existing
version.
When switch files are first created, they are
empty. An empty switch file is one in which all of
the switch values are the system-defined default
values. These values are "hard-wired" and are not
read from any other switch file. These
system-defined values are also used if no switch
file exists. Thus, you need to create a switch file
only if you want to edit a switch so that it uses a
nondefault value.
Library switch files must be associated explicitly
with a directory or world to affect operations or
units in that directory or world. To associate a
library switch file, use the Switches.Associate
Environment command.
Switch files can also be created using the
Switches.Create Environment command.
To create a session switch file for the current
session, execute the Session:Session Switches menu
command.
>>OPTIONS
-------
>>Name
----
Enter the name of the switch file to be created.
Note that the name of a session switch file must
follow the naming convention Session_Name_Switches
for it to affect that session. For example, the
session switch file S_1_Switches affects the way
the system behaves in session S_1.
Note that session switch files must located in your
home library.
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Switches.Associate
procedure Switches.Define
procedure Switches.Create
#New Activity
File:New:Activity creates a new activity file,
which is an execution table that must be set up to
specify which of the alternative load views is to
be used from each subsystem. The activity contains
one entry for each subsystem that is required for
execution.
>>OPTIONS
-------
>>Name
----
Enter the name of the new activity.
>>Copy Of
-------
Enter the name of the activity from which the new
activity is to be created. Entering the null string
("") causes an empty activity to be created. The
default is the default activity for the current
session.
>>Exact Copy Preserving References
--------------------------------
Check this box to indicate that the new activity
should be formed as an exact copy of the source
activity. Thus, if the source entry contains the
name of an actual view, the new entry also will
contain an identical indirect reference.
>>Exact Copy Replacing References with Values
-------------------------------------------
Check this box to indicate that the new activity
should be formed as the dereferenced value of the
corresponding source activity. Indirect
(differential) references will be resolved until an
actual view is found.
>>Differential
------------
Check this box to indicate that the new activity
should be formed as an indirect reference to the
source activity. The created activity will not
contain the name of a view but the name of another
activity that specifies an actual view or another
activity from which to derive the view. With this
mode, changes made to the source activity will be
reflected in the target activity.
>>SEE ALSO
---------
Project Management (PM) book of the Environment
Reference Manual
procedure Activity.Create
#New Mailbox
File:New:Mailbox creates a mailbox with a specified
name for the specified user.
The mailbox is created in the specified user's home
library in a directory called Mailbox. If the
directory does not exist, it is created.
>>OPTIONS
-------
>>Mailbox Simple Name
-------------------
Enter the name for the mailbox. The mailbox named
Main is the mailbox into which mail is received.
>>SEE ALSO
--------
Mail User's Manual
procedure Mail.Create
#New Venture
File:New:Venture creates a new venture. A venture
is a management tool that contains information
about groups of work-order lists and controls their
use. Each work order must have a venture that is
its "parent."
>>OPTIONS
-------
>>Name
----
Enter the name of the venture.
>>Notes
-----
Enter a string to be saved in the notes field of
the venture. Notes typically are used to provide a
brief description of the venture.
>>Make Default
------------
Check this box to make the new venture become the
default venture for the current session.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Work_Order.Create_Venture
#New Work Order
File:New:Work Order creates a work order on the
specified venture and adds it to a work-order list.
Work orders are designed to communicate details
about specific tasks to be accomplished.
>>OPTIONS
-------
>>Name
----
Enter the name of the new work-order.
>>Notes
-----
Enter a string to be saved in the notes field of
the work order. Notes typically are used to provide
a brief description of the work order.
>>Venture
-------
Enter the name of the venture for which the work
order is created. The default is the venture for
the current session.
>>Work Order List
---------------
Enter the name of the work order list to which the
new work order is to be added.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Work_Order.Create
#New Work Order List
File:New:Work Order List creates a new work-order
list on the specified venture. A work-order list
contains groups of related work orders.
>>OPTIONS
-------
>>Name
----
Enter the name of the new work-order list.
>>Ventures
--------
Enter the name of the venture to which the new
work-order list is added. The default is the
venture for the current session.
>>Make Default
------------
Check this box to set the new work-order list as
the default for the current session.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Work_Order.Create_List
#New System
File:New:Subsystem creates a new system. A system
pulls an application's components together by
logically grouping particular releases from the
component subsystems. Operations for systems are in
package Cmvc_Hierarchy.
The new system contains an empty working view that
has the specified imports.
The model for the system is !Model.R1000.
>>OPTIONS
-------
>>Name
----
Enter the name of the system.
>>Initial View Name
-----------------
Enter the name of the initial system view. By
default, the name of the initial view of the system
is: System_Object.Working_View_Base_Name_Working
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Initial
procedure Cmvc.System
#Browse
File:Browse allows you to visit any object.
>>OPTIONS
-------
>>Name
----
Enter the name of the object to visit. The object
can be a library, file, Ada unit, etc. You may
enter a full pathname or a pathname relative to
your current library. By default, the object name
that appears in the Name entry box is the last
object you have visited using the File:Browse
command.
>>SEE ALSO
--------
Editing Specific Types (EST) book of the Environment
Reference Manual
procedure Common.Definition
#Open
File:Open opens an object for editing. If the
object is not editable (for example, a library), a
dialog box appears, depending on the kind of
object.
>>SEE ALSO
--------
Rational Access Help
File Open Check Out
File Open Demote
#Open Check Out
The File:Open Check Out box reserves the right to
modify the specified controlled object or objects
by acquiring the objects' reservation tokens.
Controlled objects can be modified only while they
are checked out. When objects are joined across
multiple views, they share the same reservation
token, so that only one of the joined objects can
be checked out at a time. Checking out a joined
object in one view renders the corresponding
objects in the other views unavailable for update.
>>OPTIONS
-------
>>Name
----
Enter the name of the object to be checked out.
>>Comments
--------
Enter any comments in this box. All characters,
including the [Tab] key, are interpreted as literal
characters.
>>Automatic Demotion if Needed
----------------------------
If the specified object was last checked out in
another view, it must be updated to the latest
generation before it can be checked out. Updating
the object may call for demoting specified or
dependent Ada units.
Choose this box to allow the command to demote Ada
units in order to update the specified objects to
the latest generation. If this box is checked, the
command is permitted to demote Ada units if
necessary. The command does not recompile any units
that were demoted. If this box is not checked, the
command proceeds only if no demotion is required;
otherwise, an error is reported and the command
quits.
Choosing this box has no effect if Automatic Accept
Latest Generation is not chosen.
>>Automatic Accept Latest Generation
----------------------------------
If the specified object was last checked out in
another view, it must be updated to the latest
generation before it can be checked out.
Choose this box to allow the command to update the
specified objects to the latest generation. If this
box is checked, the command is permitted to update
the objects. If it is not checked, the command
proceeds only if the specified objects are already
the latest generation; otherwise, an error is
reported and the command quits.
>>SEE ALSO
---------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Check_Out
#Open Demote
The File:Open Demote box demotes a coded or
installed Ada unit to source and opens it for
editing. This dialog box lists how many units and
how many lines of code will be demoted.
>>SEE ALSO
--------
Editing Specific Types (EST) book of the Environment
Reference Manual
procedure Common.Definition
procedure Common.Edit
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Check_Out
#Print
File:Print prints any image or object to a selected
printer.
>>OPTIONS
-------
>>Name
----
Enter the name of the object or image to be
printed. The default is the contents of the current
window. To print multiple objects or images, enter
the names of the objects using an appropriate
naming expression:
# Matches a single character other than a period
@ Matches zero or more characters not containing
a period.
? Matches zero or more nonworld name components.
?? Matches zero or more name components and all
their contents.
[...] Encloses a set of names.
~name Excludes a name from a set.
>>Selected Printer
----------------
Enter the name of the printer you want the object
or image printed on. You can also click the name of
the printer in the associated list box to make it
appear in the Selected Printer entry box.
This list of your available printer configurations
is set in !Machine.Initialization by your system
manager. The list is empty if your printers are
configured in another way.
>>Print Options
-------------
* Border: Prints a border around the page. If the
Twoup option (see below) is also selected, a
border is printed around both text areas on the
page.
* Date: Prints the date and time of the printout at
the bottom of each page in verbose format, such
as October 23, 1992 at 2:46:14 PM.
* Filename: Prints the full pathname of the file at
the top of each page. If the printout is a mail
message or I/O window, the image does not have an
associated object with a pathname. In this case,
the image is written to a temporary file, whose
name is displayed if you check this box.
* Ada Format: Prints Ada reserved words in bold
when printing source code.
>>Page Layout
-----------
* Twoup: Prints two text areas (in book form)
across the length of a single page. If you are
printing a PostScript file that specifies
orientation, this option will be overridden.
* Portrait: Prints the page vertically. If you are
printing a PostScript file that specifies
orientation, this option will be overridden.
* Landscape: Prints the page horizontally. If you
are printing a PostScript file that specifies
orientation, this option will be overridden.
>>All Pages
---------
Check this box to print all pages in the file.
>>First Page/Last Page
--------------------
Check this box to print a selected range of pages.
If you select this option, enter the desired page
numbers in the associated entry boxes. To print
only one page, enter that page number in both the
First Page and Last Page entry boxes.
>>Other Options
------------
This entry box will take all of the print options
as described in procedure Queue.Print. For more
information, see the System Management Utilities
(SMU) book of the Environment Reference Manual.
>>SEE ALSO
--------
System Management Utilities (SMU) book of the Environ-
ment Reference Manual
package Queue
#File Properties
File:Properties provides editable information about
the current file, Ada unit, or mailbox.
This command displays the requested information in
a dialog box. This information can be modified in
the dialog box and then changed for the object that
is selected. The collection of information
displayed is dependent on the object that is
selected.
>>OPTIONS
-------
When the selected object is a file, an Ada unit or
a mailbox, the resulting dialog box contains the
following fields:
>>Name
----
Displays the name of the file, Ada unit, or mailbox
whose properties are displayed in the dialog box.
This should not be modified.
>>Frozen
---------------
Displays the current state of the object. If this
box is checked, the object is currently frozen.
When objects are frozen, no changes can be made to
them, including changing Ada-unit state. (However,
frozen units can be executed.) Freezing objects can
be used as part of releasing software.
If this check box is unchecked when it was
previously checked, then the Environment unfreezes
the object. By default, this will also unfreeze
subobjects.
If the box is unchecked, the object is NOT frozen.
Objects that are not frozen can be changed. If an
object is frozen, its children are also frozen.
To change whether the specified objects are frozen,
change the value of this box and click OK.
Unfreezing an object permits changes to be made to
it. The command can unfreeze a single object or an
entire library structure of objects.
>>Under CMVC Control
------------------
Displays whether or not the object is under CMVC
control. If this box is checked, the object is
currently controlled.
* If you uncheck this box, the object becomes
uncontrolled, so that change information about it
is no longer collected in the CMVC database.
Existing history for the object remains in the
CMVC database until the database is expunged
using the Cmvc_Maintenance.Expunge_Database
Environment command.
* If you check this box, the object becomes
controlled, and therefore subject to CMVC
facilities such as reservation tokens and
history.
Once controlled, an object must be checked out
before it can be modified and it must be checked
in before various commands can access it.
Because controlled objects cannot be deleted or
withdrawn, making the object uncontrolled prepares
a controlled object for deletion. Similarly, an Ada
unit's kind cannot be changed (for example, from
procedure to function) while the unit is
controlled. Therefore, the unit must be made
uncontrolled and then the database must be expunged
(using Cmvc_Maintenance.Expunge_Database) before
the unit's kind can be changed.
Objects can be made controlled again; if the CMVC
database has not been expunged, the history for the
recontrolled objects continues where it stopped.
>>Checked Out
-----------
Displays the current state of the object; if the
box is checked, the object is currently checked
out.
* If you uncheck this box, the object will be
checked in.
An object that is checked in cannot be modified
until it is checked out again. Only controlled
objects can be checked in or out.
* If you check this box, the object will be checked
out.
Because checked-in objects cannot be modified in
any way, it is recommended that all incremental
additions or changes to Ada units be promoted
before those units are checked in. Errors will
result from attempting to compile the checked-in
units that contain insertion points, because
promoting insertion points would require the
modification of checked-in units.
Note that checking in an object that was made
controlled without saving source simply releases
the right to update that object; no text is
recorded in the CMVC database.
>>Access List
-----------
Displays the username of the creator of the file,
the read/write access that the creator has, the
access-control group with access to the file, and
what the status of that access is.
>>Read-only Information
---------------------
Lists the following properties of the selected
object:
* Creator
* Date Created
* Object subclass type
* Total byte size
* Updater
* Update date
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Access_List.Set
procedure Access_List.Set_Default
procedure Library.Unfreeze
procedure Library.Freeze
#World Properties
The World Properties dialog box is generated by the
File:Properties command when the current object is
a world. This dialog box provides editable
information about the current world, view, or
subsystem.
This command displays the requested information in
a dialog box. This information can be modified in
the dialog box and then changed for the object that
is selected. The collection of information
displayed is dependent on the object that is
selected.
Note that when an object of class Session is
selected, File:Properties does not produce a dialog
box, but simply opens for editing the session
switches for the current session.
>>OPTIONS
-------
When the selected object is a world, view, or
subsystem, the resulting dialog box contains the
following fields:
>>Name
----
Displays the name of the selected world, view, or
subsystem. This should not be modified.
>>Frozen
------
Displays the current state of the object. If this
box is checked, the object is currently frozen.
When objects are frozen, no changes can be made to
them, including changing Ada-unit state. (However,
frozen units can be executed.) Freezing objects can
be used as part of releasing software.
If this check box is unchecked when it was
previously checked, then the Environment unfreezes
the object. By default, this will also unfreeze
subobjects.
If the box is unchecked, the object is NOT frozen.
Objects that are not frozen can be changed. If an
object is frozen, its children are also frozen.
To change whether the specified objects are frozen,
change the value of this box and click OK.
Unfreezing an object permits changes to be made to
it. The command can unfreeze a single object or an
entire library structure of objects.
>>Switch File
-----------
Displays the current switch file associated with
this object.
If this is modified, an association is built
between a library switch file and the world
displayed in the Name entry box. The switches in
the library switch file are used for all applicable
operations within that world. The association is by
reference, which means that changes made to the
library switch file have an immediate effect on
subsequent operations or units in the associated
world.
For more information, see the Switches.Associate
Environment command in the Library Management (LM)
book of the Environment Reference Manual.
>>Access List
-----------
Displays the username of the creator of the file,
the read/write access that the creator has, and the
access-control group with access to the file, and
what the status of that access is.
>>Default ACL
-----------
Displays the default access control list currently
set for the object. Modifying this changes the
default.
Worlds determine the ACLs for new objects created
within them. In particular, a world's ACL is given
to any new worlds created within it. Furthermore,
in addition to its own ACL, every world has a
default ACL associated with it. The default ACL is
given to new files and Ada units created within the
world. In sum:
* New worlds inherit the ACL of the enclosing world.
* New files and Ada units inherit the default ACL
of the enclosing world. (However, a new version
of a file or Ada unit inherits its ACL from the
previous version of that object.)
If you have owner access to the enclosing world,
you can modify the ACLs that were inherited by the
new objects, in addition to any other ACLs in the
world.
You can use the Set_Default command to specify the
entire default ACL for a world; the Add_Default
command is useful for adding one or more entries to
the default ACL. The Default_Display command
displays a world's default ACL in an Environment
output window.
>>Read-only Information
---------------------
Displays the following properties of the selected
object:
* Creator
* Date created
* Object subclass type
* Total byte size
* Updater
* Update date
* Volume
* Target key information (if available)
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Access_List.Set
procedure Access_List.Set_Default
procedure Library.Freeze
procedure Library.Unfreeze
procedure Switches.Associate
#Directory Properties
The Directory Properties dialog box is generated by
the File:Properties command when the current object
is a directory. This dialog box provides editable
information about the current directory.
This command displays the requested information in
a dialog box. This information can be modified in
the dialog box and then changed for the object that
is selected. The collection of information
displayed is dependent on the object that is
selected.
Note that when an object of class Session is
selected, File:Properties does not produce a dialog
box, but simply edits the session switches.
>>OPTIONS
-------
When the selected object is a directory, the
resulting dialog box contains the following fields:
>>Name
----
Displays the name of the selected directory. This
should not be modified.
>>Frozen
------
If this check box is unchecked when it was
previously checked, then the Environment unfreezes
the object. By default, this will also unfreeze
subobjects.
If the box is unchecked, the object is NOT frozen.
Objects that are not frozen can be changed. If an
object is frozen, its children are also frozen.
To change whether the specified objects are frozen,
change the value of this box and click OK.
Unfreezing an object permits changes to be made to
it. The command can unfreeze a single object or an
entire library structure of objects.
>>Switch File
-----------
Displays the current switch file associated with
this object.
If this is modified, an association is built
between a library switch file and the directory
displayed in the Name entry box. The switches in
the library switch file are used for all applicable
operations within that directory. The association
is by reference, which means that changes made to
the library switch file have an immediate effect on
subsequent operations or units in the associated
directory.
For more information, see the Switches.Associate
Environment command in the Library Management (LM)
book of the Environment Reference Manual.
>>Read-only Information
---------------------
Displays the following properties of the selected
object:
* Creator
* Date created
* Object subclass type
* Total byte size
* Updater
* Update date
* Volume
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Library.Freeze
procedure Library.Unfreeze
procedure Switches.Associate
#Copy File
File:Copy File copies the contents of one or more
existing source objects to or into the specified
destination object(s).
This command can be used to copy objects under a
different name in the same library. The command
also can be used to copy objects into a different
command, under either the same or a different
simple name. Multiple objects can be copied under
new names by specifying the Source field with
wildcards and the Destination field with
substitution characters.
>>OPTIONS
-------
>>Source
------
Enter the name of the object(s) to be copied. The
default is the current object. Multiple objects can
be specified using wildcards, context characters,
set notation, indirect files, and attributes.
The source object(s) must already exist. If a
source object contains other objects, the contained
subobjects are copied as well. If more than one
object is copied, each object is copied
independently of any other.
If you are copying a library that is associated
with a library switch file, then the copy operation
handles the association as follows:
* If the library is copied along with its switch
file, the copy of the library is associated with
the copy of the switch file. This situation
frequently arises when you copy a library that
contains its switch file. Note that when copying
directories between views in a subsystem, you may
need to change switch-file associations that
arise this way.
* If the library is copied without its switch file,
the copy is associated with the same switch file
as the copy's parent library.
Note that when worlds are copied, its links are
copied as well. Note also that the semantic
consistency of copied Ada units is not assured by
the Copy File command. Semantic references must be
checked after the object is copied.
Depending on the types of source and destination
objects that are specified, the Copy File command
either copies the source object to the destination
object (overwriting it or merging their contents)
or copies the source object into the destination
object (provided that the destination object can
contain other objects). For example, copying an
object from one library to another with the same
simple name can be accomplished by using the name
of the destination library as the Destination name.
>>Destination
-----------
Enter the name of the destination library.
If a relative pathname is specified, it is
interpreted relative to the current library. The
default is the current image. Substitution
characters can be used to create the destination
name(s) from the source name(s). Each source name
must map to a unique destination name.
The destination object may, but need not, already
exist:
* If the destination object already exists, it must
be of the same class as the source object. The
Copy File command overwrites (and in some cases
merges) the contents of the destination object
with the contents of the source object. For Ada
units and files, a new version of the destination
object is created, which may force old versions
of the object to be expunged.
* If the destination object does not already exist,
it is created. A newly created destination object
has the same class as its source object (that is,
copying a world creates a new world). For all Ada
units, the destination object is created in the
source state.
The table below summarizes the "to" or "into" copy
operations that result from specifying various
types of objects as the Destination and Source
entry boxes. The number in parentheses following
the results indicates a restriction on the move.
These restrictions are listed below the table.
-----------------------------------------------------
|Source |To |To |To |To |To |To No |
| |Non-Ada|Library|Subunit|World |Direc-|Object|
| |Object |Unit | | |tory | |
| | | | | | | |
-----------------------------------------------------
|Non-Ada |To (1) |Error |Error | Into | Into | To |
|Object | | | | | | |
-----------------------------------------------------
|Library |Error |To |To | Into | Into | To |
|Unit (2)| | | | | | |
-----------------------------------------------------
|Subunit |Error |Into |To | Into | Into | To |
|(2) | | | | | | |
-----------------------------------------------------
|World |Error |Error |Error |To (4)|To (4)| To |
|(3) | | | | | | |
-----------------------------------------------------
|Direc- |Error |Error |Error |To (4)|To (4)| To |
|tory (3)| | | | | | |
-----------------------------------------------------
1 The objects must be of the same class.
2 The subunits of the unit are involved. The
relative nesting of subunits is preserved.
3 The subcomponents of the library are involved.
The relative nesting of subcomponents is
preserved.
4 The contents of the Source library are merged
with the contents of the Destination library.
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Library.Copy
#Move File
File:Move File copies the contents of one or more
source objects to or into the specified destination
object(s) and then deletes the source object(s).
This command can be used to move an object from one
library to another, preserving or changing its
simple name in the new location. This command can
also be used to give an object a new simple name
within the same library.
Multiple objects can be moved and given new names
by specifying the Source name with wildcards and
the Destination name with substitution characters.
>>OPTIONS
-------
>>Source
------
Enter the existing object or objects to be moved.
Multiple objects can be specified using wildcards,
context characters, set notation, indirect files,
and attributes. The default is the current
selection, whether or not the cursor is in the
selection.
The source object(s) must already exist. If a
source object contains other objects, the contained
subobjects are moved as well. If more than one
object is moved, each object is moved independently
of any other.
If deleting a source object would result in
demotion or obsolescence of any Ada units, that
source object is copied rather than moved. Objects
that cannot be copied are not deleted.
If you are moving a library that is associated with
a library switch file, then the move operation
handles the association as follows:
* If the library is moved along with its switch
file, the moved library is associated with the
moved switch file. This situation frequently
arises when you move a library that contains its
switch file. Note that when moving directories
between views in a subsystem, you may need to
change switch-file associations that arise this
way.
* If the library is moved without its switch file,
the moved library is associated with the same
switch file as the new parent library.
Note that when worlds are moved, their links are
moved as well. Note also that the semantic
consistency of new Ada units is not assured by this
command. Semantic references must be checked after
the object is moved.
>>Destination
-----------
Enter the name of the destination object. If a
relative pathname is specified, it is interpreted
relative to the current library. The default is the
current image.
Substitution characters can be used to create the
Destination name(s) from the Source name(s);
however, because the move operation deletes source
objects, it is recommended that you use the
Navigate:Resolve Name menu command to test a pair
of Source and Destination names containing
wildcards and substitution characters. Each Source
name must map to a unique Destination name.
If the Destination entry box names an existing
object, that object is overwritten or objects are
moved into it, as specified above. If it does not
name an existing object, the destination object is
created.
The destination object may, but need not, already
exist:
* If the destination object already exists, it must
be of the same class as the source object. The
File:Move command overwrites (and in some cases
merges) the contents of the destination object
with the contents of the source object. For Ada
units and files, a new version of the destination
object is created, which may force old versions
of the object to be expunged.
* If the destination object does not already exist,
it is created. A newly created destination object
has the same class as its source object (that is,
moving a world creates a new world). For all Ada
units, the destination object is created in the
source state.
Depending on the types of source and destination
objects that are specified, the move command either
moves the source object to the destination object
(overwriting it or merging their contents) or it
moves the source object into the destination object
(provided that the destination object can contain
other objects). The following table summarizes the
"to" or "into" move operations that result from
specifying various types of objects in the
Destination and Source fields. The number in
parentheses following the results indicates a
restriction on the move. These restrictions are
listed below the table.
------------------------------------------------------
|Source |To |To |To |To |To |To No |
| |Non-Ada|Library|Subunit|World |Direc-|Object|
| |Object |Unit | | |tory | |
| | | | | | | |
| | | | | | | |
-----------------------------------------------------
|Non-Ada |To (1) |Error |Error | Into | Into | To |
|Object | | | | | | |
-----------------------------------------------------
|Library |Error |To |To | Into | Into | To |
|Unit (2)| | | | | | |
-----------------------------------------------------
|Subunit |Error |Into |To | Into | Into | To |
|(2) | | | | | | |
-----------------------------------------------------
|World |Error |Error |Error |To (4)|To (4)| To |
|(3) | | | | | | |
-----------------------------------------------------
|Direc- |Error |Error |Error |To (4)|To (4)| To |
|tory (3)| | | | | | |
-----------------------------------------------------
1 The objects must be of the same class.
2 The subunits of the unit are involved. The
relative nesting of subunits is preserved.
3 The subcomponents of the library are involved.
The relative nesting of subcomponents is preserved.
4 The contents of the Source library are merged
with the contents of the Destination library.
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Library.Move
procedure Library.Resolve
Rational Access Help
Resolve Filename
#Delete File
File:Delete File destroys all versions of the
specified object.
Destroying an object is equivalent to deleting and
expunging all versions of that object. A destroyed
object cannot be recovered; recoverable deletions
can be made with the Environment command
Common.Delete or Library.Delete.
Destroying an Ada unit also destroys subordinate
units (bodies and subunits). A destroy operation is
abandoned if it would cause the demotion of units
outside the specified limit.
The command provides for a threshold number (2) of
dependent objects that can be destroyed along with
each specified object. If the threshold is
exceeded, the command abandons all destructions.
The threshold serves as a safeguard against
destroying too many objects.
CAUTION: If the specified objects are under CMVC
control, this command checks them in, makes them
uncontrolled, and destroys them. No confirmation
box is generated.
>>OPTIONS
-------
>>Name
----
Enter the name of the object(s) to be destroyed.
The object(s) can be a:
* Text file
* Ada unit
* Mailbox
* Library
* Switch file
The default is the current selection, provided that
it contains the cursor. Multiple objects can be
specified using wildcards, context characters, set
notation, indirect files, and attributes.
If the object is something other than a command in
a command window, a confirmation dialog box appears
that lists what will be deleted, breaking down the
objects by class and displaying a total for each
class (see Access help for "Delete Confirm" for
more information).
>>SEE ALSO
--------
Editing Specific Types (EST) book of the Environment
Reference Manual
procedure Common.Edit
procedure Common.Object.Delete
Library Management (LM) book of the Environment
Reference Manual
procedure Library.Destroy
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Check_In
procedure Cmvc.Destroy_Subsystem
procedure Cmvc.Destroy_Views
procedure Cmvc.Make_Uncontrolled
#Delete File Confirmation
The File:Delete Confirmation dialog box displays
what object(s) will be destroyed. Objects are
broken down by class, and a total for each class is
displayed.
>>OPTIONS
-------
>>OK
--
Destroys the listed objects. If the object is under
CMVC control, it is checked in (if necessary), made
uncontrolled, and destroyed.
>>Cancel
------
Cancels the command; no objects are destroyed,
checked in, or made uncontrolled.
>>SEE ALSO
--------
Rational Access Help
Delete File
#Insert File
File:Insert File inserts the named text file into
the current Ada image at the current cursor
position.
No semantic analysis of the contents of the file or
the resulting object is done.
Specifically, this command has the following
effects:
* Ada images: Copies the contents of the text file
specified in the Name entry box into the current
Ada image at the current cursor position.
* Command images: Copies the contents of the named
text file into the command window at the current
cursor position.
* Text images: Inserts the named text file into the
current text image at the current cursor position.
>>OPTIONS
-------
>>File to Insert
--------------
Enter the name of the file to be inserted.
>>SEE ALSO
--------
Editing Specific Types (EST) book of the Environment
Reference Manual
procedure Common.Insert_File
#Run Program
File:Run executes the specified command. This
command compiles, links, and executes the Ada
statements in the Command field. The Ada statements
can be any series of statements that can be placed
between a begin/end pair. (The begin/end pair is
implicit.) If the default value of the Command
field is used, the program designated by the
selection is executed. The selection must be in an
Ada unit or a library.
The Ada statements must run to completion before
this command completes; they are not run as a
separate job.
If an exception propagates out of the statements
executed by this command, a message indicating the
exception is written into the log file for the
current job. The exception does not propagate to
the caller.
To create a new job and run the specified
statements under that job, use the
Program.Create_Job or program.Run_Job Environment
procedures.
>>OPTIONS
-------
>>Command
-------
Enter the name of the command or Ada unit you want
to run.
>>Debug
-----
Check this box to run the command under the
debugger.
This command also creates a new job under which to
execute the statements.
>>Alternate Machine
-----------------
Enter the name of the remote R1000 on which to run
the command. You cannot run the command under the
debugger on a remote machine.
>>SEE ALSO
--------
Session and Job Management (SJM) book of the Environ-
ment Reference Manual
procedure Job.Connect
procedure Program.Create_Job
procedure Program.Run
procedure Program.Run_Job
procedure Remote.Run
#Commit Buffers
The Commit Buffers dialog box is generated if you
attempt to log out of your Rational session when
there are objects that contain unsaved changes. An
object with unsaved changes is indicated by an
asterisk (*) in its window banner.
From the Commit Buffers dialog box:
* To save all the objects and log out of your
Rational Environment session, click Commit.
* To abandon all the objects without saving changes
and log out of your Rational Environment session,
click OK. The objects are reverted to their last
saved version.
* To return to your Environment session, from which
you can selectively save or abandon individual
objects, click Cancel.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Quit
#Edit Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Cut
---
Deletes the current Environment-selected region and
pushes it onto the hold stack.
>>Copy
----
Pushes the current Environment-selected region onto
the hold stack.
>>Paste
-----
Retrieves the top item in the hold stack, leaving
that item on the hold stack. The retrieved item is
copied into the current cursor location.
>>Capitalize
----------
Capitalizes the first letter in all the words in
the selected region.
>>Uppercase
---------
Converts all words in the selected region to
uppercase.
>>Lowercase
---------
Converts all words in the selected region to
lowercase.
>>Make Into Comment
-----------------
Puts comment characters (-- ) before the leftmost
character of each line in the current
Environment-selected region. If a line is already
commented in that selection, additional comment
characters (-- )are inserted in front of it.
>>Uncomment
---------
Removes comment characters (-- ) from lines in
which they are the leftmost three nonblank
characters. This command does not remove comments
from the end of lines that begin with Ada code.
>>Justify
-------
Adjusts the placement of all words in the current
Environment-selected region to justify the
selection flush left between the left edge of the
image and the defined right margin. The right
margin is set by the Fill Column entry box in
Edit:Typing Modes, or by editing the corresponding
session switch. The default is 72.
>>Fill
----
Adjusts the placement of all words in the current
Environment-selected region to fill completely the
column between the left edge of the image and the
defined right margin. The right margin is set by
the Fill Column entry box in Edit:Typing Modes, or
by editing the corresponding session switch. The
default is 72.
>>Search/Replace...
-----------------
Allows you to search for strings and, if desired,
replace those strings.
See the "Search and Replace" topic for more
information.
>>Typing Modes...
---------------
Allows you to set overwrite or insert mode, to turn
fill mode (right margin justification) on or off,
and to specify a right margin.
>>Spelling=>
----------
Allows you to check the spelling of a particular
word or all words in an image, and to replace a
misspelled word. You can also add words to the
dictionary or specify strings to be skipped by the
speller.
See the "Edit Spelling Menu" topic for more
information.
>>Underlines Off
--------------
Removes all underlines from the current image.
>>Deselect
--------
Clears any Environment selection that the
Environment cursor is in. Deselect also removes any
prompts in the image.
>>Add Entry
---------
Inserts an entry into the designated activity file,
searchlist, set of links, or other object.
>>Edit Entry
----------
Allows you to change the designated activity file,
searchlist, set of links, or other object,
prompting for the new value in a command window.
>>Delete Entry
------------
Deletes the specified entry from the designated
activity file, searchlist, set of links, or other
object. In a switch file, Delete Entry reverts the
value of the entry to the system-default value.
#Search and Replace
Edit:Search/Replace allows you to search an image
for a specified string of text and, if desired,
replace the string with a new specified string.
>>OPTIONS
-------
>>Search For
----------
Enter the string to be searched for. The string can
be literal or it can contain wildcard characters.
>>Change To
---------
To replace text, enter the new string.
>>Search Options
--------------
* Consider Case: Makes the search case-sensitive.
If you do not have a switch file for your current
session, this option is inoperative and appears
grayed out.
* Preserve Case: Keeps the case of the text as it
finds it in the string that is being replaced. If
you do not have a switch file for your current
session, this option is inoperative and appears
grayed out.
* Wildcards: Treats wildcard characters in the
Search For entry box as wildcards. When this
option is not selected, all characters are
treated as literal characters.
* Current Selection: Searches only the text in the
current Environment selection text.
>>Search Direction
----------------
* Forward: Directs the search forward (down) in the
object.
* Backward: Directs the search backward (up) in the
object.
>>Search Button
-------------
Activate this button to search for the string
specified in the Search For entry box. The
Environment cursor will stop at the string; your
view of the image will change accordingly. Activate
the Search button again to go to the next
occurrence of the string.
>>Replace Button
--------------
After the Environment has located an occurrence of
the string specified in the Search For entry box,
activate this button to replace the string with the
new string specified in the Change To entry box.
>>Replace & Search Button
-----------------------
Activate this button to replace the string
specified in the Search For entry box with the new
string specified in the Change To entry box, and
then traverse the Environment cursor to the next
occurrence of the old string. Your view of the
image will change accordingly.
>>Replace All Button
------------------
Activate this button to replace all occurrences of
the string (from the location of the Environment
cursor to the beginning or end of the image,
depending on the search direction) specified in the
Search For entry box with new string specified in
the Change To entry box.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
package Editor.Search
#Typing Modes
Edit:Typing Modes allows you to set overwrite or
insert mode, to turn fill mode (right margin
justification) on or off, and to specify a right
margin.
Note that the options you set in this box only
affect the image of the current object.
>>OPTIONS
-------
>>Overwrite Mode
--------------
Click this radio button to type text over existing
text.
>>Insert Mode
-----------
Click this radio button to insert text at the
location of the Environment cursor without
overwriting existing text.
>>Fill Mode On
------------
Check this box to turn on Fill Mode. Fill Mode
automatically moves the Environment cursor to the
next line when your entry reaches the specified
fill column, whose default is 72 characters from
the left margin.
>>Fill Column
-----------
Enter the number of characters from the left margin
where you want Fill Mode to take effect. The
default fill column is 72. The Fill Mode On box
must be checked for this setting to have any
effect.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Set.Fill_Column
procedure Editor.Set.Fill_Mode
procedure Editor.Set.Insert_Mode
#Edit Spelling Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
The operations on the Edit:Spelling menu allow you
to check the spelling of a particular word or all
words in an image, and to replace a misspelled
word. You can also add words to the dictionary or
specify strings to be skipped by the speller.
>>Check Word
----------
Checks the spelling of the word designated by the
Environment cursor. If the word is not found, it
will be underlined, and a list may appear in the
message window of possible spellings for the word.
>>Check Image
-----------
Checks the entire image for spelling mistakes. A
message will appear in the message window, and all
suspicious spellings will be underlined in the
image. Use Edit:Spelling:Next Spelling Error to
traverse to the next underlined word.
>>Replace Word
------------
Replaces the word designated by the Environment
cursor with the first alternative suggested by the
Environment's dictionary.
>>Add Word To Dictionary
----------------------
Enters the word designated by the Environment
cursor to the Environment dictionary. Further
occurrences of the word will not be underlined as
errors.
>>Learn Replacement
-----------------
Trains the spelling checker to correct certain
spelling errors automatically.
>>Next Spelling Error
-------------------
Moves the Environment cursor to the next underlined
spelling error. Your view moves accordingly.
#Navigate Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Definition
----------
Shows the definition or contents of the object
designated by the Environment cursor.
>>Enclosing
---------
Shows the enclosing (parent) library or object of
the object designated by the Environment cursor.
>>Other Part
----------
Displays the Ada specification if the current
object is a body, and the Ada body if the current
object is a specification.
>>Next Underline
--------------
Moves the Environment cursor to the next underlined
error or reference indicator. Your view moves
accordingly.
>>Previous Underline
------------------
Moves the Environment cursor to the previous
underlined error or reference indicator. Your view
moves accordingly.
>>Next Item
---------
Moves the Environment cursor to the next underline
or prompt. Your view moves accordingly.
>>Previous Item
-------------
Moves the Environment cursor to the previous
underline or prompt. Your view moves accordingly.
>>Top of Region
-------------
Moves the Environment cursor to the beginning of
the current Environment-selected region.
>>Bottom of Region
----------------
Moves the Environment cursor to the end of the
current Environment-selected region.
>>Resolve Name...
---------------
Resolves the specified name by finding the object
or objects it references and then displaying the
fully qualified pathnames of those objects.
>>Home Library
------------
Displays your home library.
#Resolve Name
Navigate:Resolve Name resolves the specified name
by finding the object or objects it references and
then displaying the fully qualified pathnames of
those objects.
This command is especially useful for evaluating
names containing wildcards, context characters, and
substitution characters.
The command attempts to resolve the specified name
by looking through the objects listed in
Environment libraries. Thus, only library units or
subunits can be resolved.
Note that the Resolve Name command displays the
fully qualified pathname of an object only if you
have at least read access to the world enclosing
that object.
The job display is sent to Current_Output (by
default, an Environment output window). Errors are
reported in log messages, which, by default, are
also sent to the output window.
>>OPTIONS
-------
>>Name
----
Enter the name to be resolved. The default is the
name that is currently highlighted. Note that this
can be a highlighted text string or a selected
object.
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Library.Resolve
#Program Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Format
------
Formats the current image appropriately for its
image type.
For Ada units, this command checks the syntax of
the image, performs syntactic completion, and
pretty-prints.
>>Complete
--------
Completes the designated item by inserting new text
and prompts into the image using information about
the syntax and semantics of the image type.
>>Semanticize
-----------
Checks the image in the current window to ensure
that it is correct according to the syntax and
semantic rules for the type of the image and
indicates any errors.
>>Promote
-------
Promotes the designated item to the next higher
state.
>>Promote to Coded...
-------------------
Promotes the designated Ada unit to the coded
state.
>>Promote to Installed...
-----------------------
Promotes the designated Ada unit to the installed
state.
>>Promote to Source...
--------------------
Promotes the designated archived Ada unit to the
source state.
>>Demote
------
Demotes the designated item to the next lower
state.
>>Demote to Installed...
----------------------
Demotes the designated Ada unit to the installed
state.
>>Demote to Source...
-------------------
Demotes the designated Ada unit to the source
state.
>>Demote to Archived...
---------------------
Demotes the designated Ada unit to the archived
state.
>>Incremental=>
-------------
Allows for incremental operations in installed or
coded Ada units. You can incrementally:
* Insert statements, declarations or other elements
* Edit statements, declarations or other elements
* Promote the edited statements, declarations or
other elements back to the installed or coded state
* Delete statements, declarations or other elements
>>Show Usage
----------
Displays a list of the actual usages of the
specified declaration.
>>Show Unused
-----------
Shows the declarations that are not referenced in
the specified Ada unit.
>>Build=>
-------
Provides commands for:
* Creating a loaded main program
* Parsing source files
* Inserting a template for the private part of the
current package visible part.
* Inserting a template for the body of the named
visible part, the selected visible part, or the
visible part in the current window.
* Changing the selected subprogram from an in-line
program unit to a separate subunit.
* Changes the subunit in the image or selected
subunit stub from a subunit to an in-line program
unit.
* Withdraws the stub (library entry for) of the
named Ada unit, the selected Ada unit from its
parent, or the Ada unit in the current window and
demotes the unit to the source state.
>>Compiler Switches
-----------------
Creates a window in which to edit the set of
switches from the library switch file associated
with the current library.
#Promote
Program:Promote raises one or more Ada units to the
indicated unit state.
Compiling a program in the Environment consists of
promoting all of its units from the source state
(or the archived state) through the installed state
to the coded state, at which point the unit can be
executed. You can promote units to either the next
higher unit state or directly to a specific unit
state.
Note that to ensure semantic consistency, the Ada
units that compose a program must be promoted in
the order specified by the Reference Manual for the
Ada Programming Language. In general:
* A unit specification must be promoted before any
units that depend on (with) it.
* A unit specification must be promoted before its
corresponding body.
* A unit body must be promoted before its subunits.
(Note that when promoting to the coded state, a
package subunit, generic package subunit, or task
subunit must be promoted before its parent body.)
The Environment maintains databases of dependencies
between units that allow it to compute the
compilation order. If an attempted state change
would violate compilation-order rules, the
operation is rejected and the state change does not
take place. Furthermore, Access commands determine
the additional units that need to be promoted to
maintain semantic consistency and usually attempt
to promote them accordingly.
>>OPTIONS
-------
>>Name
----
Enter the name of the unit to be promoted.
To promote all the units in a library, specify the
name of that library.
To promote multiple units, specify an appropriate
naming expression using set notation ( [unit1,
unit2] ) or the standard wildcard characters for
specifying pathnames:
# matches any single character
@ matches zero or more characters
? matches zero or more nonworld name components
?? matches zero or more name components, including
worlds
>>Goal State
----------
* Coded: Promotes the unit to the coded state.
* Installed: Promotes the unit to the installed
state.
* Source: Promotes the archived unit to the source
state.
>>Limit Compilation To
--------------------
* This World/View Only: Limits compilation to only
objects in the current world or subsystem view.
* No Limit on Compilation: Allows compilation to
include everything in the closure.
>>Compile
-------
* This Unit Only: Compiles only the named unit
(with no prerequisites).
* This And All Prerequisite Specs: Compiles the
named unit and any prerequisite specs needed for
compilation.
* ...And All Subunits: Compiles the named unit and
its subunits (including all prerequisite specs).
* ...And All Units Needed To Execute: Compiles the
named unit and all subunits and prerequisite bodies
specs needed for execution.
>>Log To
------
* Window: Displays the log of the compilation in an
I/O window.
* File: Routes the log to a file. The Environment
will create a default text file, or you can edit
the filename in the File entry box.
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
package Compilation
#Demote
Program:Demote lowers the specified Ada units to
the indicated unit state.
Demoting units is the counterpart to promoting
them. Whereas promoting a unit raises it to a
higher state, demoting a unit changes the state of
the unit to a lower state. For example, changing a
unit from the coded to the installed state entails
demoting the unit. There are two main reasons for
demoting a unit:
* To edit the unit. Demoting a unit to the
installed state allows you to edit it using
incremental operations. Demoting a unit to the
source state allows you to arbitrarily edit it
using basic text-editing operations.
* To allow the demotion or deletion of another unit
(specifically, a unit "withed" by the specified
unit), thus preserving semantic consistency and
maintaining the compilation order.
To demote all the units in a library, specify the
name of the library to be demoted.
As when promoting units, the Ada units that compose
a program must be demoted in the order specified by
the Reference Manual for the Ada Programming
Language.
>>OPTIONS
-------
>>Name
----
Enter the name of the Ada unit to be demoted. By
default, the current Ada unit is listed.
To demote multiple units, specify an appropriate
naming expression using set notation ( [unit1,
unit2] ) or the standard wildcard characters for
specifying pathnames:
# matches any single character
@ matches zero or more characters
? matches zero or more nonworld name components
?? matches zero or more name components, including
worlds
>>Goal State
----------
* Installed: Demotes the Ada unit to the installed
state.
* Source: Demotes the Ada unit to the source state.
* Archived: Demotes the Ada unit to the archived
state.
>>Demote Only If Demotion Affects
-------------------------------
* This Unit Only: Demotes only the named Ada unit.
* Only Units In The Same World Or View: Demotes
only the named Ada unit and its prerequisite
units in the current world or subsystem view.
* Any Ada Units Anywhere: Demotes the named Ada
unit and all of its prerequisite units anywhere.
>>SEE ALSO
--------
Editing Specific Types (EST) book of the Environment
Reference Manual
procedure Common.Promote
Library Management (LM) book of the Environment
Reference Manual
procedure Compilation.Promote
#Program Incremental Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
The Program:Incrmental submenu provides commands
for making incremental changes to installed and
coded Ada units. For more information see the
Rational Access User's Guide, the Rational
Environment User's Guide, and the Editing Specific
Types (EST) book of the Environment Reference
Manual.
>>Incremental Insert
------------------
Creates an insertion point in installed and coded
units where statements, declarations, other
elements on which incremental compilation
operations are supported, or an entire compilation
unit can be inserted into the current element.
>>Incremental Edit
----------------
Creates a window in which to edit the selected Ada
construct.
If there is no selection or if the current
selection is for an entire compilation unit or
subunit declaration, the command creates a window
in which to edit the unit, if necessary, and
demotes the unit to source if no units depend on
the unit. If there are dependent units, a list of
them is displayed in the menu window that is
brought onto the screen, and the operation fails.
If the operation succeeds, a write lock is acquired
on the unit.
If there is a selection other than the entire unit
and if incremental compilation is allowed on the
element selected (see the rules on incremental
compilation stated above), this command removes the
element from the parent unit, replaces it with an
insertion point, and brings up a new window with
the element in it.
>>Incremental Promote
-------------------
Promotes the designated item to the next higher
state. This command causes the elements in the
window to be inserted in the parent and the window
is deleted.
>>Incremental Delete
------------------
Deletes the selected element. If other elements are
dependent on the element because of semantic
references (from installed or coded units), the
deletion fails and a menu of the dependent units is
displayed in the menu window. See the description
of the editing operations on menus in the Editing
Specific Types (EST) book of the Environment
Reference Manual for more information. Contained
units of the selected element are not deleted. The
cursor must be in the selection for the operation
to succeed.
#Program Build Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
The Program:Build submenu provides commands for
loading coded main programs and for creating Ada
units from related Ada units or text files. For
more information see the Rational Access User's
Guide, the Rational Environment User's Guide, and
the Editing Specific Types (EST) book of the
Environment Reference Manual.
>>Load...
-------
Creates a loaded main program from the specified
coded main program.
>>Parse Source Files...
---------------------
Scans the contents of the named files, searching
for compilation units, and creates those units. The
newly created units are of class Ada and therefore
have the underlying structured (DIANA)
representation characteristic of units in the
Environment. The units are created in the source
state.
>>Build Private Part
------------------
Inserts a template for the private part of the
current package visible part.
This command creates the private region of the
package. It has no effect if the private part
already exists and contains all of the declared
private types. The command applies recursively to
enclosed packages. A prompt is left for the
completion of each private type or deferred
constant.
>>Build Body
----------
Inserts a template for the body of the named
visible part, the selected visible part, or the
visible part in the current window.
This command builds a template for the body of the
currently selected or named visible part or the
visible part in the current window. The template is
brought up in a new window, and prompts are
provided for statements that must be completed. Any
"with" clauses that exist in the visible part are
copied into the body template.
>>Make Separate
-------------
Changes the selected subprogram from an in-line
program unit to a separate subunit.
This command replaces the body with a "separate"
clause and creates a separate library entry
containing the body for the unit.
>>Make Inline
-----------
Changes the subunit in the image or selected
subunit stub from a subunit to an in-line program
unit.
This command removes the "separate" clause and
moves the body for the subunit into the parent
unit. The library entry for the subunit is removed
from the library structure.
>>Withdraw
--------
Withdraws the stub (library entry for) of the named
Ada unit, the selected Ada unit from its parent, or
the Ada unit in the current window and demotes the
unit to the source state.
The stub is replaced with an insertion point.
#Load Main Program
Program:Build:Load creates a loaded main program
from the specified coded main program.
This help describes:
* What a loaded main program is
* Saving, copying, and restoring loaded main
programs
* Consistency between loaded main programs and their
source
* Options in the Program:Build:Loaded Main Program
dialog box
>>What is a Loaded Main Program?
------------------------------
A loaded main program is an executable program that
does not depend on its source code; that is, a
loaded main program does not become obsolete if the
source code from which it was created is modified.
Furthermore, a loaded main program can be moved
between R1000s without having to move and recompile
its source code.
Loaded main programs are created from coded main
programs, which are main subprograms that contain
pragma Main and that have been promoted to the
coded state. The resulting loaded main program is
comprised of a valid Ada specification (that can be
utilized by other programs) and a separate,
self-contained copy of the main program's code
segments, similar to an executable module on other
computer systems. The Program:Build:Load command
automatically inserts the Loaded_Main pragma in
place of the Main pragma in the newly created Ada
specification. Furthermore, this command converts
the object's subclass from Main_Proc or Main_Func
to Load_Proc or Load_Func.
>>Saving, Copying, and Resoring Loaded Main Programs
--------------------------------------------------
Because loaded main programs have a valid Ada
specification, you should use care when saving,
copying, or restoring them. In particular, if the
Ada specification contains "with" clauses that
reference other packages, those packages must be
visible (through links or imports) from any location
to which the loaded main program is copied or
restored.
>>Consistency Between Loaded Main Programs And Source
---------------------------------------------------
Because its code segments are independent of its
source code, a loaded main program is unaffected by
demoting, and even changing, the source code. Thus,
consistency between a loaded main program and its
source code may be lost. Furthermore, loaded main
programs, like code views, can be debugged using the
Rational debugger only if the same version of the
original source code still exists in the same
location on the same R1000 and is still in the coded
state.
See Chapter 4, "Compiling and Executing Main
Programs," in the Library Management (LM) book of
the Environment Reference Manual and Appendix F for
the R1000 Target in the Ada LRM for more
information about pragma Loaded_Main and pragma
Main.
>>OPTIONS
-------
>>Main Program Name
-----------------
Enter the name of the coded main program from which
the loaded main program is to be created. The
specified main program must be in the coded state.
The default is the current context.
>>Load Proc/Func Name
-------------------
Enter the name of the loaded main program to be
created.
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Compilation.Load
#Parse Source Files
Program:Build:Parse Source Files scans the contents
of the named files, searching for compilation
units, and creates those units. The newly created
units are of class Ada and therefore have the
underlying structured (DIANA) representation
characteristic of units in the Environment. The
units are created in the source state.
The specified files can contain any number of
Ada-unit specifications and/or bodies. However, the
image of each file must be Ada source for
compilation as defined by Section 10.1 of the
Reference Manual for the Ada Programming Language.
If no unit name can be determined from the input,
the unit is created with a temporary name. If a
specified file contains any syntactic or semantic
error, no Ada unit is created.
Existing Ada units that have the same name as a
newly created unit are made obsolete and are
deleted from the library. The original text file
remains unchanged.
This command is useful when transporting Ada source
code from another host to the Rational Environment.
In that case, source code is loaded into text files
in a library in the Environment. These files are
then transformed into parsed Ada units using this
command.
>>OPTIONS
-------
>>Source File(s)
--------------
Enter the name of the text file that contains Ada
units to be parsed. Multiple units can be specified
using wildcards, context prefixes, indirect files,
set notation, and attributes. The default is the
selected region.
>>Destination Library
-------------------
Enter the library (directory, world, or view) in
which to create the parsed Ada units. Wildcards,
attributes, and context characters can be used in
this name if the name resolves unambiguously to a
single location. The default is the current
library.
>>SEE ALSO
--------
Library Management (LM) book of the Environment
Reference Manual
procedure Compilation.Parse
#CMVC Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Check Out...
------------
Reserves the right to modify the specified
controlled object or objects by acquiring the
objects' reservation tokens. Controlled objects can
be modified only while they are checked out. When
objects are joined across multiple views, they
share the same reservation token, so that only one
of the joined objects can be checked out at a time.
Checking out a joined object in one view renders
the corresponding objects in the other views
unavailable for update.
>>Check In...
-----------
Releases the reserved right to modify the specified
controlled object or objects by releasing the
objects' reservation tokens. When you have finished
modifying a controlled object, you should check in
the object so that:
* The changes are available to other views.
* The changes you made are recorded in the CMVC
database.
* The object cannot be modified until it is checked
out again.
>>Accept Changes...
-----------------
Updates the specified object(s) to the same
generation(s) of the specified corresponding
object(s). The updated objects are changed to
reflect any modifications that have been made to
the corresponding objects.
Accepting changes is useful is you want to:
* Synchronize the development of controlled objects
that are joined to objects in other views.
* Update out-of-date objects to the latest
generation.
* "Go backward in time" to a previous generation of
a controlled object that is joined to a less
recently updated object in another view.
* Copy new controlled objects between views.
>>Abandon
-------
If the current object is checked out, abandons the
reservation on that object, effectively canceling
the checkout. Any changes made during the canceled
checkout are discarded and the object is reverted
to the last checked-in generation. If necessary,
the demotes Ada units. Any units that are demoted
in the process of reverting units to the last
check-in generation remain demoted; they are not
repromoted.
>>Join...
-------
Joins the specified controlled objects to the
corresponding objects in the designated view.
When objects are joined across views, they form a
join set. Objects in a join set have the same
pathname within their respective views and share a
single reservation token, so that only one object
in the set can be checked out at a time. Thus,
joining allows synchronized changes to an object
when there are instances of the same object in
multiple working views.
>>Sever...
--------
Severs the specified object(s) from their
respective join sets. When an object is severed, it
is given a different reservation token, so that it
can be checked out and modified independent of the
objects to which it had previously been joined.
>>Imports/Model...
----------------
Displays and allows you to change the imports and
model for one or more views. A view's imports
determine the objects in other views that are
visible to objects in the current view. A view's
model determines the view's target key and initial
library-switch file.
>>CMVC Editor
-----------
Displays a configuration image for the designated
view or configuration object or for the view
enclosing the designated object. A configuration
image for a view is a library-like display of CMVC
information pertaining to that view. The initial
display:
* Contains an entry for each controlled object in
the view.
* Indicates the generation number for each object
in the view. A two-part generation indicates that
the specified view does not have the most current
generation (for example, 4/8 indicates generation
4 of 8).
From this display, you can obtain more information
about each object such as date and user who last
modified it, by pressing [Expand] (generally bound
to [Meta][!]). To display the release history for
the view, press [Explain] (generally bound to
[F3]). From this display, you can also perform
common and CMVC operations on the objects listed.
Note that CMVC Editor can be used to display a
configuration image for a configuration object that
has no view associated with it (for example, a
configuration release). In this case, the
configuration image provides access to generation
images and history images even for objects that may
not still exist outside the CMVC database. This is
a useful means for browsing past generations of
objects. Similarly, the CMVC Editor can be used to
display configuration images for code views, which
do not contain source objects.
>>Control/Uncontrol...
--------------------
Determines whether the specified object(s) are
controlled by the CMVC system and therefore subject
to reservation. Any object in a subsystem can be
controlled.
Controlling an object associates a reservation
token with it. The CMVC:Check In and CMVC:Check Out
commands operate by manipulating reservation
tokens, and joined objects share not only the same
name but also a single reservation token.
>>Revert to Generation...
-----------------------
Returns the specified controlled CMVC object or
objects to the specified generation. More
specifically, this command replaces the contents of
each specified object with the contents of the
indicated generation of that object.
The generation to which an object is reverted can
be retained as the latest generation, or the
reverted object can be updated to the latest
generation the next time the object is checked out.
This command will demote Ada units, if necessary in
order to revert the specified objects to the
specified generation. It does not repromote units
that were demoted in the process of reverting the
specified objects.
>>CMVC Report=>
-------------
Provides commands for displaying information about
the controlled objects in the current view.
>>Activity
--------
Opens a window containing the activity file
associated with your current session.
An activity maintains a mapping between subsystems
and pairs of views. The pair consists of a spec
view and a load view from that subsystem. An
activity typically is used to specify an
implementation from each subsystem to be used for
execution.
From the window displayed by this command you can
add, edit, or delete entries using commands from
the Edit menu or from Environment package
!Commands.Common.
Changes to activities are not made permanent until
committed. When an activity is changed, but not yet
committed, the # symbol appears in the window
banner. Committing the activity makes all changes
to the activity permanent, and the = symbol appears
in the window banner.
For more information, see package Activity in the
Project Management (PM) book of the Environment
Reference Manual.
#Check Out
CMVC:Check Out reserves the right to modify the
specified controlled object or objects by acquiring
the objects' reservation tokens.
Controlled objects can be modified only while they
are checked out. However, objects need not be
checked out in order to be compiled.
This help discusses:
* Objects joined across views
* Generations
* Demotion and recompilation
* Finding out about controlled objects
* Options in the CMVC:Check Out dialog box
>>Objects Joined Across Views
---------------------------
When objects are joined across multiple views, they
share the same reservation token, so that only one
of the joined objects can be checked out at a time.
Checking out a joined object in one view renders
the corresponding objects in the other views
unavailable for update. (In contrast, objects that
do not share the same reservation token can be
checked out and modified independently.) If the
command encounters an object that is checked out in
another view, an error is reported that point and
the command quits without looking at any more
objects. Checkouts made before the command quits
are abandoned.
>>Generations
-----------
A new generation of an object is created when it is
checked out. The new generation can be preserved by
the CMVC:Check In command or abandoned by the
CMVC:Abandon command. When one object in a join set
is checked out and then checked in, the other
objects in the set are rendered at least one
generation out of date. You cannot check out
out-of-date objects without bringing them up to the
current generation. You can bring out-of-date
objects up to date during the check out process by
choosing the Automatic Accept Latest Generation
box.
>>Demotion and Recompilation
--------------------------
If Ada units are compiled against a unit that
requires updating, checking out that unit may
require the demotion of the other dependent units.
In this case, the Automatic Demotion If Needed box
controls whether the command actually performs the
demotion and checks out the unit.
>>Finding Out About Controlled Objects
------------------------------------
Commands on the CMVC:CMVC Report submenu can be
used to determine whether objects are out-of-date
(List Out-of-Date Objects) or currently checked out
(List All Checked Out). Other related information,
such as the checkout date, time, and user, can be
displayed using the CMVC:CMVC Report:Object History
Information command.
For more information about reservation tokens and
checking objects out, see the Project Management
(PM) book of the Environment Reference Manual.
>>OPTIONS
-------
>>Name
----
Enter the name(s) of the objects(s) that are to be
checked out. You can specify multiple objects by
using wildcards, context characters, special names,
set notation, or indirect files. If you specify
multiple objects, all the objects must belong to
the same view. If you specify a view name, the
command attempts to check out all the objects in
the view.
Objects must be controlled to be checked out. If
uncontrolled objects are named, they are noted in
the output log generated by the command.
>>Comments
--------
Enter the comments to be stored in the CMVC
database with the notes for the specified
object(s). The specified comments also are logged
to the default work order for the current session.
These comments appear in the display produced by
the CMVC:CMVC Report:Object History Information
command. They can also be displayed using the
Cmvc.Get_Notes command.
>>Automatic Demotion If Needed
----------------------------
If the specified object was last checked out in
another view, it must be updated to the latest
generation before it can be checked out. Updating
the object may call for demoting specified or
dependent Ada units.
Choose this box to allow the command to demote Ada
units in order to update the specified objects to
the latest generation. If this box is checked, the
command is permitted to demote Ada units if
necessary. The command does not recompile any units
that were demoted. If this box is not checked, the
command proceeds only if no demotion is required;
otherwise, an error is reported and the command
quits.
Choosing this box has no effect if Automatic Accept
Latest Generation is not chosen.
>>Automatic Accept Latest Generation
----------------------------------
If the specified object was last checked out in
another view, it must be updated to the latest
generation before it can be checked out.
Choose this box to allow the command to update the
specified objects to the latest generation. If this
box is checked, the command is permitted to update
the objects. If it is not checked, the command
proceeds only if the specified objects are already
the latest generation; otherwise, an error is
reported and the command quits.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Check_Out
#Check In
CMVC:Check In releases the reserved right to modify
the specified controlled object or objects by
releasing the objects' reservation tokens.
When you have finished modifying a controlled
object, you should check in the object so that:
* The changes are available to other views.
* The changes you made are recorded in the CMVC
database.
* The object cannot be modified until it is checked
out again.
Because checked-in objects cannot be modified in
any way, it is recommended that all incremental
additions or changes to Ada units be promoted
before those units are checked in. Errors will
result from attempting to compile the checked-in
units that contain insertion points, because
promoting insertion points would require the
modification of checked-in units.
Note that checking in an object that was made
controlled without saving source simply releases
the right to update that object; no text is
recorded in the CMVC database.
For more information about reservation tokens and
checking in objects, see the Project Management
(PM) book of the Environment Reference Manual.
>>OPTIONS
-------
>>Name
----
Enter the name of the object or objects to be
checked in. Multiple objects can be specified by
using wildcards, context characters, special names,
set notation, or an indirect file.
These objects must be controlled. If uncontrolled
objects are named, they are noted in the output log
generated by the command and ignored. To make
objects controlled, use CMVC:Control/Uncontrol.
>>Comments
--------
Enter the comments to be stored in the CMVC
database with the notes for the specified
object(s). The specified comments also are logged
to the default work order for the current session.
These comments appear in the display produced by
the CMVC:CMVC Report:Object History Information
command. They can also be displayed using the
Cmvc.Get_Notes command.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Check_In
#Accept Changes
CMVC: Accept Changes updates the object(s)
specified in the Units to Update option to the
generation(s) indicated by the Update From option;
that is, the Units to Update are changed to reflect
any modifications that have been made to the
corresponding Update From objects.
Accepting changes is useful is you want to:
* Synchronize the development of controlled objects
that are joined to objects in other views.
When an object in a join set is checked out and
then checked in, a new generation is created,
rendering the other objects in the set at least
one generation out of date. This command can be
used on the out-of-date objects to update them to
the latest generation.
* Update out-of-date objects to the latest
generation.
* "Go backward in time" to a previous generation of
a controlled object that is joined to a less
recently updated object in another view.
* Copy new controlled objects between views.
Note that when changes to individual Ada units are
being accepted, unit specifications should be
updated before their corresponding bodies to ensure
that the units compile correctly.
>>Demotion and Recompilation
--------------------------
If Ada units are compiled against a specified unit,
accepting changes to that unit may require the
demotion of the other dependent units. If
necessary, the Accept Changes command demotes such
units. It does not recompile the units.
>>Finding Out About Controlled Objects
------------------------------------
Commands on the CMVC:CMVC Report submenu can be
used to determine whether objects are out-of-date
(List Out-of-Date Objects) or currently checked out
(List All Checked Out). Other related information,
such as the checkout date, time, and user, can be
displayed using the CMVC:CMVC Report:Object History
Information command.
For more information about accepting changes
between views, see the Project Management (PM) book
of the Environment Reference Manual.
>>OPTIONS
-------
>>View to Update
--------------
Enter the name of the view into which changes are
to be accepted. Only a single view can be
specified.
>>Units to Update
---------------
Choose the set of objects (within the View to
Update) into which changes are to be accepted:
* To update all the controlled objects in the View
to Update, check the All (and add new units)
radio button. For each controlled object in the
view specified in the Update From field that is
not already in the View to Update, the command
also adds a new, corresponding controlled object
in the View to Update.
* To update only a specified set of objects within
the view, enter the names of those objects in the
entry box and check the radio button next to the
box. You can specify multiple objects by using
wildcards, context characters, special names, set
notation, or an indirect file.
The specified objects must be controlled and
checked in. If uncontrolled objects are named, they
are noted in the output log generated by the
command. If a named object is checked out, it is
not updated and a warning message is issued.
If an object to be updated was made controlled
without saving source, the object can be updated
only if the Update From field names an object that
exists in some view. (For example, when updating
such an object, the Update From field may not name
a configuration object that has no view associated
with it.)
>>Update From
-----------
Enter the view from which the corresponding View to
Update and Units to Update are to be updated:
* To accept changes from the latest generation of
each controlled object, check Latest. If the View
to Update already contains the latest generation
of a particular object, that object will not be
updated.
* To accept changes from a particular view or
configuration, check View or Configuration and
select the view or configuration from the list on
the right. If the view or configuration from
which you want to accept changes is not in the
list, you can enter its name directly in the
Selected View or Configuration entry box.
If Update From names a view, and
* Units to Update specifies All (and add new
units), every controlled object in the Update
From view updates the corresponding object in the
View to Update. New controlled objects in the
Update From view are copied into the View to
Update. The copied objects are automatically
controlled and joined to the corresponding
objects in the Update From view.
* Units to Update specifies a particular set of
objects, the command updates the Units to Update
to match the corresponding objects in the Update
From view.
Naming a configuration is the same as naming a
view, except that naming a view always updates the
Units to Update to more recent generations, whereas
naming a configuration can change the Units to
Update to older generations. (The name of a
previously release view cannot be used in place of
a configuration to go back in time.)
Note that changing the Units to Update to an older
generation does not cause that generation to become
the latest one. Checking out such an object updates
it to the latest generation.
If an Update From object is currently checked out,
it's previous generation is used and a warning
message appears in the output log.
>>Restrict to Units
-----------------
If you want to restrict the objects from which to
accept changes, enter those objects in the Restrict
to Units entry box.
Multiple objects can be specified by using
wildcards, context characters, special names, set
notation, or an indirect file. Note that
subdirectories (for example, Units) are not
accepted as object names; instead you must use
naming expressions that resolve to the contents of
such subdirectories (for example, Units.@). If this
entry box is empty, all objects from the specified
view or configuration are assumed.
When a set of objects are specified in the Restrict
to Units entry box, the Units to Update should
specify All (and add new units).
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Accept_Changes
#Join Controlled CMVC Objects
CMVC:Join joins the specified controlled objects to
the corresponding objects in the designated view.
When a team of developers needs to work on objects
in the same subsystem, multiple development views
(paths or subpaths) are usually set up. Such views
usually are created such that the objects in them
are joined automatically. Joining objects in
different views facilitates parallel development
because objects that are joined:
* Share a single reservation token. Consequently, a
joined object can be checked out in only one view
at a time.
* Are represented as a single series of generations
stored in the CMVC database. Consequently,
changes make to one object can be propagated to
the other objects to which it is joined.
If views are set up such that the objects in them
are not automatically joined, you can join two
objects using the Join command provided that:
* The objects have the same pathname within their
respective views.
* The objects to be joined are textually identical.
The Cmvc.Merge_Changes Environment command can be
used to prepare objects for joining.
Note that if the object is currently joined, it
will first be severed. Thus, joining an object A in
view V1 to view V2 is not necessarily the same as
joining the corresponding object A in view V2 to
view V1.
>>OPTIONS
-------
>>Sever the following objects
---------------------------
Enter the name of the object(s) to be joined to the
corresponding object(s) in another view. Multiple
objects can be specified by using wildcards,
context characters, special names, set notation, or
an indirect file.
Note that the named objects must be controlled and
must be textually identical to the corresponding
objects to which they are to be joined.
If you name an object that already belongs to a
join set, the Join command implicitly severs that
object from its original join set before joining
the object to the new join set.
>>Then join to corresponding objects in view
------------------------------------------
Enter the name of the view that contains the
objects to which the specified objects are to be
joined. Objects in the specified view must be
checked in.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Join
#Sever Controlled CMVC Objects
CMVC:Sever severs the specified object(s) from
their respective join sets.
If two users need concurrent access a controlled
object, you can sever the object between views.
Severing provides each copy of the object with its
own reservation token, so that each copy can be
checked out independently. Separate sets of
generations are kept for severed objects.
When an object is severed, it is given a different
reservation token, so that it can be checked out
and modified independent of the objects to which it
had previously been joined.
The name of the new reservation token is
automatically generated by the Environment.
Automatically generated names of reservation tokens
are derived from the view portion of the enclosing
view name (up to the first underscore character).
For example, the severed objects in a view called
Rev1_Working would have "Rev1" as the
automatically-generated name of the reservation
token. However, if "Rev1" is currently in use, then
"Rev1_1" is used.
>>OPTIONS
-------
>>Objects
-------
Enter the name of the object(s) to be severed from
their join sets. Multiple objects can be specified
by using wildcards, context characters, special
names, set notation, or an indirect file. If a view
is specified, all the objects in the view are
severed.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Sever
#Imports/Model
CMVC:Imports/Model displays and allows you to
change the imports and model for one or more views.
A view's imports determine the objects in other
views that are visible to objects in the current
view. A view's model determines the view's target
key and initial library-switch file.
The Imports/Model command can be used to:
* Add new imports
* Change an existing import by importing a
different view from the same subsystem
* Refresh a view's existing imports after new
specifications have been added to the imported
views
* Remove existing imports
* Change a view's model, and thereby:
- Invoke a new switches file for the view.
- Rebuild the view's links.
- Reset the number of levels for automatic name
generation for release and spec views.
- Change the view's target key.
This help describes consistency checking of imports,
import and export restrictions, demotion and
recompilation, and the options in the
CMVC:Imports/Model dialog box.
>>Consistency Checking
--------------------
This command performs consistency checking to
ensure that no view directly or indirectly imports
more than one view from the same subsystem. It
checks the closure of the view named in the View
Name entry box and the closures of all views that
import it. An error results if any new or changed
import would cause an inconsistency.
Furthermore, within spec/load subsystems,
circularity checking is done to ensure that no view
directly or indirectly imports itself. (Circular
importing is permitted among views in combined
subsystems, however.)
An import operation succeeds only if the target key
of the importing (client) view is compatible with
the target key of the imported (supplier) view. For
example, a view with target key R1000 cannot import
a view with target key Mc68020_Bare.
>>Import/Export Restrictions
--------------------------
An import operation will create links to a subset
of the units in a supplier view if export and
import restrictions exist. Users create export and
import restrictions as text files in the supplier
and client views, respectively.
>>Demotion and Recompilation
--------------------------
This command does not recompile any units that were
demoted when imports were added to, changed in, or
removed from the view.
For more information about imports, exports, and
working in subsystems, see the Project Management
(PM) book of the Environment Reference Manual.
>>OPTIONS
-------
>>View Name
---------
Enter the name of the view(s) for which the model
or imports are to be changed. You can specify a
spec, load, or combined view. Multiple views can be
specified using wildcards, context characters,
special names, set notation, or an indirect file.
If both the View Name and Add/Change Imports views
name the same set of combined views, the named
views import each other.
Note that to replace the model, all units in the
view must be in the source state.
>>Current Imports
---------------
Lists all of the views that are imported by the
view specified in the View Name entry box. This
list cannot be changed.
>>Add/Change Imports
------------------
Enter the name(s) of the view(s) to be added to the
imports for the view specified in the View Name
entry box. The Imports/Model command imports only
the views named in Add/Change Imports list. It does
not import views in the closures of those views.
The views named in the Add/Change Imports list must
be spec or combined views. If multiple views are
specified in the View Name entry box, the
Imports/Model command imports each of the views in
the Add/Change Imports list into each of the views
in the View Name entry box.
Existing imports are not affected unless a
Add/Change Imports view is from the same subsystem
as an existing import. In this case, the Add/Change
Import view replaces the corresponding existing
import.
To add or change one or more imported views that
are listed in the Current Imports list:
* Click on the name(s) of the view(s) in the
Current Imports list. The view names appear in
reverse video. Note that you can select more than
one view from the list without unselecting other
views. (To unselect a view, click on it again.)
* Click on the right arrow button to the left of
the Add/Change Imports list. The selected view
names are copied into the Remove Imports list.
Alternatively, you can:
* Place the insertion point in the Add/Change
Imports list by clicking in the list.
* Enter or edit the name of a view using basic text
editing operations. Note that the view names must
be fully qualified; that is, they must begin at
the root world, !. You also can name an activity
as an indirect file, which is equivalent to
naming the spec view associated with each
subsystem in the activity.
To remove a view name from the Add/Change Imports
list, use basic text editing operations.
>>Remove Imports
--------------
Enter the name of the view(s) to be removed from
the imports of the view specified in the View Name
entry box. The Imports/Model command destroys links
to the views specified in this list.
If multiple views are specified in the View Name
entry box, the Imports/Model command removes
imports of any the views in the Remove Imports list
from each of the views in the View Name entry box.
Note that imports cannot be removed from code views.
To remove one or more imported views that are
listed in the Current Imports list:
* Click on the name(s) of the view(s) in the
Current Imports list. The view names appear in
reverse video. Note that you can select more than
one view from the list without unselecting other
views. (To unselect a view, click on it again.)
* Click on the right arrow button to the left of
the Remove Imports list. The selected view names
are copied into the Remove Imports list.
Alternatively, you can:
* Place the insertion point in the Remove Imports
list by clicking in the list.
* Enter or edit the name of a view using basic text
editing operations. Note that the view names must
be fully qualified; that is, they must begin at
the root world, !.
To remove a name from the Remove Imports list, edit
the list directly using text editing operations.
The Imports/Model command does not remove an import
if there are units compiled against any of the
links it created. However, such an import can be
removed if the units are demoted to the source
state.
>>Model
-----
Enter the name of the world to be used as the new
model for the view specified in the View Name entry
box. The context for the resolution of this name is
the world !Model, although a model in another world
can be specified by using a fully qualified
pathname.
You can change a view's model to:
* Invoke a new switches file for the view.
* Rebuild the view's links.
* Reset the number of levels for automatic name
generation for release and spec views. (This
affects only future release views.)
* Change the view's target key. However, the change
must be to a target key that is compatible with
the current target key. For example, a view with
target key R1000 cannot change to a model with
target key Mc68020_Bare.
Changing the view's model does not affect the
behavior of the Add/Change Imports or Remove
Imports list.
>>Refresh Imports
---------------
Check this box to cause the existing imports of the
view specified in the View Name entry box to be
refreshed to include any new unit specifications
that have been added.
Checking this box does not affect the behavior of
the Add/Change Imports list or Remove Imports list.
Views listed in those fields are added, changed, or
removed, independent of the value of the Refresh
Imports list.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Import
function Cmvc.Imported_Views
procedure Cmvc.Remove_Import
procedure Cmvc.Replace_Model
#Control/Uncontrol
CMVC:Control/Uncontrol determines whether the
specified object(s) are controlled by the CMVC
system and therefore subject to reservation. Any
object in a subsystem can be controlled.
Controlling an object associates a reservation
token with it. The CMVC:Check In and CMVC:Check Out
commands operate by manipulating reservation
tokens, and joined objects share not only the same
name but also a single reservation token.
For more information about controlling and
uncontrolling objects, see the Project Management
(PM) book of the Environment Reference Manual.
>>OPTIONS
-------
>>View
----
Enter the name of the view that contains the
object(s) that are to be controlled or
uncontrolled. Multiple views can be specified using
wildcards, context characters, special names, set
notation, or an indirect file. If multiple views
are specified, they must all be in the same
subsystem.
>>Units to Control or Uncontrol
-----------------------------
Choose the object(s) in the view(s) specified in
the View entry box that are to be made controlled
or uncontrolled:
* To affect all the objects in the Units directory
of the specified view(s), check the All radio
button.
* To affect all the Ada compilation units in the
Units directory of the specified view(s), check
the All Ada Units radio button.
* To affect a single object or a specific set of
objects, enter the name(s) of those object(s) in
the entry box and check the radio button next to
the box. This name is resolved with respect to
the view specified in the View entry box and must
include the name of the Units directory name, if
that is where the object(s) are. Multiple views
can be specified using wildcards, context
characters, special names, set notation, or an
indirect file.
Before a subunit can be controlled, its parent must
be controlled.
Objects in the State subdirectory of a view cannot
be controlled; attempting to do so produces an
error message. Similarly, derived objects resulting
from cross-target development cannot be controlled
(the names of such objects are enclosed in angle
brackets in directory displays).
The name of the new reservation token is
automatically generated by the Environment.
Automatically generated names of reservation tokens
are derived from the view portion of the enclosing
view name (up to the first underscore character).
For example, the severed objects in a view called
Rev1_Working would have "Rev1" as the
automatically-generated name of the reservation
token. However, if "Rev1" is currently in use, then
"Rev1_1" is used.
If a named object is already controlled, a note
appears in the output log.
>>Control
-------
Check this radio button to make the specified
object(s) controlled by the CMVC system and
therefore subject to reservation.
Once controlled, an object must be checked out
(using CMVC:Check Out) before it can be modified
and it must be checked in (using CMVC:Check In)
before various commands can access it.
When an object is made controlled with this
command, the textual changes from one generation to
the next are stored in the CMVC database. This
permits the reconstruction of previous generations
through, for example, the CMVC:Revert to Generation
command or by rebuilding a view from a
configuration object. (Note that because changed
lines are determined textually, changing an Ada
unit's pretty-printing causes all lines to be
stored as changed lines.)
The newly controlled objects are not joined to any
objects in any other views.
>>Uncontrol
---------
Check this radio button to make the specified
object(s) uncontrolled, so that change information
about them is no longer collected in the CMVC
database. You may need to uncontrol objects to:
* Prepare a controlled object for deletion
* Change an Ada unit's kind (for example, from
procedure to function). Before changing an Ada
unit's kind, you must expunge the CMVC database
using the Cmvc_Maintenance.Expunge_Database
command.
Existing history for the objects remains in the
CMVC database until the database is expunged using
the Expunge_Database command. Objects can be made
controlled again using this command and setting the
Control radio button; if the CMVC database has not
been expunged, the history for the recontrolled
objects continues where it stopped.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Make_Controlled
procedure Cmvc.Make_Uncontrolled
#Revert to Generation
Each time you check out an object, a new generation
of that object is created in the CMVC database.
Editing changes are collected in the new generation
and saved in the CMVC database when you check in
the object. Thus, generations capture the changes
made from checkout to checkout. Each generation of
an object is numbered, starting with generation 1.
Generation 1 is created when you make an object
controlled; initially generation 1 contains the
text of the object at the time it was made
controlled. Over time the CMVC database builds up a
series of numbered generations for each controlled
object.
CMVC:Revert to Generation returns the specified
controlled CMVC object or objects to the specified
generation. More specifically, this command
replaces the contents of each specified object with
the contents of the indicated generation of that
object.
The generation to which an object is reverted can
be retained as the latest generation if the Create
New Latest Generation entry box is true. Otherwise,
the reverted object is updated to the latest
generation the next time the object is checked out.
This command will demote Ada units, if necessary in
order to revert the specified objects to the
specified generation. It does not repromote units
that were demoted in the process of reverting the
specified objects.
>>OPTIONS
-------
>>Object Name
-----------
Enter the name of the object or objects to be
reverted. Only controlled and sourced objects can
be reverted. (An error is reported if you try to
revert an object that was made controlled without
saving source.) An object that is currently checked
out cannot be reverted, and this is reported in the
output log. By default, the selected object is
reverted.
Multiple objects can be specified by using
wildcards, context characters, special names, set
notation, or an indirect file.
>>Revert Object to Prior Generation Number
----------------------------------------
Enter the number of the generation to which the
specified object is to be reverted. A positive
integer expresses a particular generation number
(each generation is numbered, starting from 0). A
negative integer expresses a previous generation,
counting back from the object's current generation;
for example, the value of -1 indicates the object's
previous generation.
If multiple objects are specified in the Object
Name box and the Revert Object to Prior Generation
Number box has a positive value, the Revert to
Generation command attempts to change all objects
to the same generation. If multiple objects are
specified and Revert Object to Prior Generation
Number has a negative value, the generation of each
object is calculated individually.
>>Create New Latest Generation
----------------------------
Check this box to make a copy of the reverted
generation at the end of the current history,
effectively making a new latest generation that is
a copy of the generation specified in the Revert
Object to Prior Generation Number entry box.
Development proceeds from this new latest
generation.
If this box is not checked, the latest generation
remains the same as it was before this command was
executed. Consequently, a reverted object can be
inspected or compiled against other units; however,
the next time the object is checked out, it is
updated to the latest generation.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Revert
#CMVC Report Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>List Controlled
---------------
Displays a list of the objects in the current view
that are under CMVC control. For each object, the
display includes the object's name, its current and
latest generation numbers, the view in which it is
checked out or from which it was most recently
checked in, whether or not it is currently checked
out, the user who checked it out most recently, and
the expected check-in date.
>>List Uncontrolled
-----------------
Displays a list of the objects in the current view
that are not under CMVC control.
>>List Out-of-Date Objects
------------------------
Displays a list of the objects in the current view
that are not at the most recent generation. For
each object, the display includes the object's
name, its current and latest generation numbers,
the view in which it is checked out or from which
it was most recently checked in, whether or not it
is currently checked out, the user who checked it
out most recently, and the expected check-in date.
>>List Checked-Out Objects
------------------------
Displays a list of the objects in the current view
that are checked out. For each object, the display
includes the object's name, its current and latest
generation numbers, the view in which it is checked
out, the user who checked it out, and the expected
check-in date.
>>List View Imports
-----------------
Displays a list of all the views imported by the
current view.
>>List View Referencers
---------------------
Displays a list of all subsystems that import the
current view.
>>List View Exports
-----------------
Displays a list of all the units exported by the
current view.
>>List View Model
---------------
Displays the name of the model used by the current
view.
>>Object History Information...
-----------------------------
Displays the history for a view or object within a
view. This command can be used to display the
differences between two released views, between a
working view and a previously released view, and
the like. It also can be used to display how a
particular object has changed from one view or
configuration to another.
#Object History Information
CMVC:CMVC Report:Object History Information
displays the history for the specified view or
object within a view.
This command shows what has changed between two
configurations (or two views) on the same path. For
example, the Object History Information command can
be used to display the differences between two
released views, between a working view and a
previously released view, and the like. It also can
be used to display how a particular object has
changed from one view or configuration to another.
The Object History Information command provides the
following information for each specified object (if
a view is specified, this information is shown for
each controlled object in the view):
* The join set name (the name of the reservation
token for the joined objects)
* The object's history for the generations that
were created between the configurations specified
in the Starting Generation and Ending Generation
entry boxes
For each of the requested generations of an object,
the history includes:
* The time and date of the checkout and checkin
that created the generation
* The notes for the object
* The changes that occurred since the previous
generation (if requested by the Show Changed
Regions check box)
>>OPTIONS
-------
>>Object Name
-----------
Enter the name of the object or objects whose
history is to be displayed. You can specify one or
more views or one or more controlled objects within
a view. Multiple objects can be specified by using
wildcards, context characters, special names, set
notation, or an indirect file.
>>Starting Generation
------------------
Enter the name of the view or configuration that
serves as the starting point for the displayed
history. The view or configuration you specify must
contain some generation of each of the objects
designated in the Object Name entry box. This
command displays the history for each object,
starting with changes to the generation contained
in the specified view or configuration.
The null string ("") specifies that history is to
be displayed starting with generation 1.
>>Ending Generation
-----------------
Enter the name of the view or configuration that
serves as the ending point for the displayed
history. The view or configuration you specify must
contain some generation of each of the objects
designated by the Object Name entry box. The
history displayed for each object ends with the
generation contained in the specified view or
configuration.
The null string ("") specifies that history is
displayed up to the latest generation.
>>Show Changed Regions
--------------------
Choose this box to display the differences between
a given generation and the one before it.
If this box is checked, the text of the changes is
displayed. The command displays only the
differences between the generations, omitting lines
that are the same as the previous generation. If
this box is not checked, no changes are displayed.
>>SEE ALSO
--------
Project Management (PM) book of the Environment
Reference Manual
procedure Cmvc.Show_History
#Debug Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Start Debugging of Command
--------------------------
Creates a new job to run the current command under
the debugger.
>>Debugger Commands Palette...
----------------------------
Displays the Debugger Palette, a control palette
that allows you to debug Ada programs.
>>Debugger Window
---------------
Designates the current debugger.
If there is more than one active debugger, this
command designates which one is the current
debugger. All debugging commands are directed to
the current debugger. This command applies to
various targets with active debuggers in the
current session along with the R1000 native
debugger.
For more information regarding each debugger, see
the "Cross-Debugging" chapter of the
Cross-Development Facility User's Manual for the
specific target.
>>Finish Debugging Job and Detach
-------------------------------
Terminates debugging of the current job. The job
continues normal execution.
>>Finishing Debugging Job and Kill
--------------------------------
Terminates debugging of the current job and aborts
the job.
#Debugger Palette
The Debugger Palette allows you to debug Ada
programs using a persistent control palette.
The top left section of the Debugger Palette
contains controls for the execution of the program
running under the debugger. The bottom-left section
of the palette controls variables. The right side
of the palette contains the debugging option menu
that controls sets of buttons for:
* Breakpoint manipulation
* Exception handling
* Task information
* Task control
* Debugger control
* Tracing control
* Target machine operations
* Machine and memory information
* Quitting
To display a set of buttons from the option menu,
click the option menu label to reveal the options.
Then click the option you want to reveal the new
set of buttons.
>>Opening The Debugger Palette
----------------------------
Choose Debug:Debugger Commands Palette or click the
Debug button on the window control panel.
>>Closing The Debugger Palette
----------------------------
Click the Window Remove button in the top, right
corner of the Debugger Palette (it looks like four
arrows pointing into each other).
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
#Debugger Put Variable
The Put button (with ellipsis) on the Debugger
Palette displays the value of the object specified
by the variable.
By default, the Put command displays the value of
the selected object in the current frame of the
last stopped task.
The Put command accesses variables according to the
type of Ada unit in which they were declared.
Variables declared in a procedure or function are
elaborated each time that procedure or function is
called, and Put accesses the individual instance of
such a variable by its stack frame. Variables
declared in library-unit packages are elaborated
once, and Put accesses such variables without
reference to stack frames.
Note: Unless the Variable entry box and Stack Frame
slider specify a specific elaboration of a
variable, the Put command uses the current control
context and stack searching to determine which
instance of that variable to designate for display
modification. See the descriptions of these options
for more details.
>>OPTIONS
-------
>>Variable
--------
Enter the name of the object to be displayed. The
value of Variable can be an absolute pathname, a
relative pathname, or a special name that resolves
to a designated object. The values of Variable and
Stack Frame (see below) together designate the
actual object whose value the Put command displays.
These values define which has precedence in
determining the location:
* If Variable is an absolute pathname, it has
precedence when Put searches for the object.
* If Variable is a relative pathname, Put uses
both Variable and Stack Frame to designate an
object.
* If Variable is a special name, Put searches for
the first occurrence of the specified object in
the designated frame and subsequent frames.
>>Stack Frame
-----------
Set the slider to the number of the stack frame
containing the object to be displayed.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Put
#Debugger Modify Variable
The Modify button on the Debugger Palette modifies
the value of the specified variable.
By default, the Modify command modifies the value
of the selected variable in the current frame of
the last stopped task.
The specified variable must be a scalar. Structures
such as records or arrays can be modified only by
changing the values of individual components.
The Modify command accesses variables according to
the type of Ada unit in which they were declared.
Variables declared in a procedure or function are
elaborated each time that procedure or function is
called, Modify accesses the individual instance of
such a variable by its stack frame. Variables
declared in library-unit packages are elaborated
once, and Modify accesses such variables without
reference to stack frames.
>>OPTIONS
-------
>>Name
----
Enter the name of the variable to be modified. You
may enter an absolute pathname, a relative
pathname, or a special name that resolves to a
designated variable. The value of the Name entry
box designates the actual variable whose value
Modify changes. This value determines the location,
as shown in the following:
* If the name is an absolute pathname or a relative
pathname, the name has precedence when this
command searches for the variable.
* If the name is a special name, this command
searches for the first occurrence of the
specified variable name from the first frame in
the stack.
>>New Value
---------
Enter the new value of the variable. Numeric values
are specified with simple numeric representations.
Expressions are not allowed.
Enumeration values are specified with unqualified
names of enumeration constants. Because the
variable name determines its type, enumerated
values for New_Value do not need to be qualified.
For example, the string "Nul" is sufficient to
specify the character literal Ascii.Nul.
>>Stack Frame
-----------
Move the slider to specify the number of the stack
frame containing the variable to be modified.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Modify
#Debugger Set Breakpoint
The Break button on the Breakpoints button set of
the Debugger Palette option menu creates a
breakpoint at a specific location in the specified
task.
A breakpoint interrupts execution of a task at a
specified location (for example, a statement or
declaration) in the program source. The task stops
before the execution of the specified statement or
declaration and the debugger displays the
breakpoint number and location. The task does not
resume execution until directed; the Run and
Execute commands resume execution of stopped tasks.
A breakpoint must be active to interrupt execution.
Breakpoints are active when created; they can be
deactivated and reactivated at any time.
Breakpoints remain until they are deleted, although
they can be enabled or disabled.
>>OPTIONS
-------
>>Location
--------
Enter the location at which the breakpoint is to be
set. The location may be an Ada program unit (a
package, task, or subprogram), a frame reference, a
statement, or a declaration. By default, the value
of Location is the selected statement or
declaration.
The value of Location can be an absolute pathname,
a relative pathname, or a special name that
resolves to a designated location. The value of the
Location entry box designates the actual location
at which the Break command creates a breakpoint.
>>Lifetime
--------
These radio buttons specify the lifetime of the
breakpoint.
* Permanent: Makes the breakpoint permanently
enabled.
* Temporary: Makes the breakpoint temporarily
enabled.
>>In Task(s)
----------
These radio buttons specify the task in which the
breakpoint is set.
* All: Makes the breakpoint apply to all tasks.
* Root Task: The breakpoint applies to the root
task.
* "Current Task": The breakpoint applies to the
default task based on the control context (see
Access help for Debugger Control Context):
- If the control context is set, the breakpoint
is set for the task in the control context.
- If the control context is not set, the
breakpoint applies to all tasks, including the
new tasks initiated after the breakpoint is
set.
* Task: Enter the pathname of the task in which you
want to set the breakpoint.
>>Trip Count
----------
Enter the number of times the statement in which
the breakpoint is set must be encountered in the
execution of the program before the debugger
interrupts execution of the task. If Count = N,
execution will be halted just before the Nth time
the statement is executed. The default specifies
that the breakpoint interrupts execution the first
time the statement is encountered.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Break
#Debugger Exception Handling
The Catch, Propagate, and Forget buttons on the
Exception Handling button set of the Debugger
Palette option menu have the following
functionality:
* Catch: Requests that the debugger halt task
execution when a particular exception is raised.
Propagate requests and Catch requests combine to
determine the action that the debugger takes when
an exception is raised. The debugger maintains a
list of catch and propagate requests entered by
calls to the Catch and Propagate commands. When
an exception in the user program is raised, the
debugger looks at this list to determine whether
to stop the program and inform the user. If the
most specific request is a Catch request, the
debugger halts execution; otherwise, it does not.
* Propagate: Requests that the debugger continue
task execution when a particular exception is
raised.
* Forget: Removes Catch and Propagate requests. By
default, this command removes Catch and Propagate
requests for the selected exception in all tasks
and locations.
A Forget command removes Catch and Propagate
requests matching the options of the command. The
debugger does not apply Forget requests in order
of specificity as it does Catch and Propagate
requests.
Note: A Forget command that applies to all
exceptions in all tasks and locations does not
clear every Catch and Propagate request active in
the job currently being debugged. To clear Catch
and Propagate requests, choose Exception
Handling:Forget All on the option menu of the
Debugger Palette.
>>OPTIONS
-------
>>Name
----
Enter the name of the exception to be caught or
propagated, or the Catch or Propagate request to be
cleared.
>>Task
----
Enter the name of the task to which the request is
limited. The reserved name "All" selects all tasks.
The default value is null.
If the value is null, the command designates no
specific task and chooses a default based on the
control context (see Access Help for Debugger
Control Context for information on setting the
control context):
* If the control context is set, the request
applies to the task in the control context.
* If the control context is not set, the request
applies to all tasks.
Values for this option can be task synonyms.
>>Location
--------
Specifies the location in which the exception will
be caught. This entry box restricts the request to
exceptions raised within the specified location. If
the pathname is not fully qualified, it is
interpreted relative to the current evaluation
context. The default value is null, which
identifies all locations.
If Location specifies an Ada unit, the request
applies only to exceptions raised inside that unit.
The request does not apply to Ada units nested
inside the selected unit (for example, procedures
nested within a package body, nested blocks, and
accept statements).
>>Catch
-----
Requests that the debugger halt task execution when
a particular exception is raised.
>>Propagate
---------
Requests that the debugger continue task execution
when a particular exception is raised.
>>Forget
------
Removes Catch and Propagate requests.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Catch
procedure Debug.Forget
procedure Debug.Propagate
#Debugger Control Context
The Set Control Context button on the Debugger
Control button set of the Debugger Palette option
menu sets the control context to the specified
pathname.
By default, this command sets the control context
to the selected item.
The debugger maintains two contexts: the control
context and the evaluation context. The debugger
evaluates unqualified pathnames, task names, and
exception names in one of the two contexts. Context
evaluation does not apply to fully qualified
pathnames, task names, or exception names.
To display the current contexts, choose Debugger
Control: Show Contexts on the Debugger Palette
option menu.
If the Set Debugger Control Context To option
specifies a selection, the command searches the
selection for a context in the stack for that
selection. The command substitutes the value of the
Stack_Start flag. The default value of Stack_Start
is the first frame in the stack.
From the first search frame, the command searches a
specific number of frames, specified with the
Stack_Count flag. The default number of search
frames is 10.
>>Control-Context Usage
---------------------
The following table lists the manner in which various
commands use the control context:
-----------------------------------------------
|Command |Control Context Used As: |
-----------------------------------------------
|Break |Default task to which the break is |
| |restricted. The control context also |
| |specifies which task's stack is used |
| |if the pathname in the command refers |
| |to a stack. |
-----------------------------------------------
|Catch |Task for which exception controls are |
| |set. |
-----------------------------------------------
|Clear_ |Default task for which stepping |
|Stepping|operations are canceled. |
-----------------------------------------------
|Display |Task whose stack is used if the |
| |pathname in the Display command refers|
| |to a stack. |
-----------------------------------------------
|Execute |Default task that is started. |
-----------------------------------------------
|Forget |Exception and task for which exception|
| |operations are cleared. |
-----------------------------------------------
|History_|Default task for which history |
|Display |information is displayed. |
-----------------------------------------------
|Hold |Default task that is held. |
-----------------------------------------------
|Propa- |Task for which exception controls are |
|gate |set. |
-----------------------------------------------
|Put |Task whose stack is used if the |
| |pathname in the Put command refers to |
| |a stack. |
-----------------------------------------------
|Release |Default task that is released. |
-----------------------------------------------
|Run |Default task for stepping. |
-----------------------------------------------
|Stack |Default task whose stack is displayed.|
-----------------------------------------------
|Stop |Default task that is stopped. |
-----------------------------------------------
|Take_ |Default task for which history |
|History |information is gathered. |
-----------------------------------------------
|Trace |Default task for which a tracing |
| |operation is enabled or disabled. |
-----------------------------------------------
The value of the control context can be the null
string (""):
* For commands requiring a task designation, a null
value defaults to all tasks.
* For commands requiring a stack designation, a
null value defaults to the stack of the last task
stopped by the debugger. Specifically, the name
of the last stopped task is used for interpreting
pathnames in any command.
* For certain commands (for example, Run and
Stack), it is also the default value for
parameters designating tasks.
>>OPTIONS
-------
>>Set Debugger Control Context To
-------------------------------
Enter the value for the context. The default value
is the context in the selected item.
The null string ("") and the reserved name "All,"
both of which identify all tasks, are legal values
for this entry box.
The control context must be an Ada pathname to a
task, a task number, or a task synonym. The
Debug.Set_Task_Name and Debug_Tools.Set_Task_Name
Environment commands create task synonyms.
If the value of Set Debugger Control Context To is
not a task number, task synonym, or fully qualified
pathname, the Context command interprets it in the
current control context as any other pathname. This
command interprets the pathname before defining the
new value for the context; it uses the current
context to determine the new context.
The context must be valid both at the time it is
specified and at the time it is used.
The value of the Set Debugger Control Context To
option can be an absolute pathname, a relative
pathname, or a special name that resolves to an
appropriate item. The value of this entry box
designates the new context.
See the "Debugger Naming" section of the Key
Concepts and the Path_Name subtype for more
information on designating contexts with pathnames.
>>RESTRICTIONS
------------
The context pathname must be legal both when
defined and when used by another command.
>>SEE ALSO
--------
Debugging book (DEB) of the Environment Reference
Manual
procedure Debug.Context
procedure Debug.Show
Rational Access Help
Set Evaluation Context
#Debugger Evaluation Context
The Set Evaluation Context button on the Debugger
Control option menu of the Debugger Palette option
menu sets the evaluation context to the specified
pathname.
The debugger maintains two contexts: the control
context and the evaluation context. The debugger
evaluates unqualified pathnames, task names, and
exception names in one of the two contexts. Context
evaluation does not apply to fully qualified
pathnames, task names, or exception names.
To display the current contexts choose Debugger
Control:Show Contexts on the Debugger Palette
option menu.
If the Set Debugger Evaluation Context To entry box
specifies a selection, the command searches the
selection for a context in the stack for that
selection. The command substitutes the value of the
Stack_Start flag. The default value of Stack_Start
is the first frame in the stack.
From the first search frame, the command searches a
specific number of frames, specified with the
Stack_Count flag. The default number of search
frames is 10.
>>Evaluation-Context Usage
------------------------
The following table lists the manner in which various
commands use the evaluation context:
----------------------------------------------
|Command|Evaluation Context Used As: |
----------------------------------------------
|Break |A context in which to interpret |
| |unqualified object names. |
----------------------------------------------
|Catch |A context for unqualified location and|
| |exception names. |
----------------------------------------------
|Context|A context for unqualified names for |
| |the control or evaluation context. |
----------------------------------------------
|Display|A context in which to interpret |
| |unqualified object names. |
----------------------------------------------
|Forget |A context for unqualified location and|
| |exception names. |
----------------------------------------------
|Modify |A context in which to interpret |
| |unqualified object names. |
----------------------------------------------
|Propa- |A context for unqualified location and|
|gate |exception names. |
----------------------------------------------
|Put |A context in which to interpret |
| |unqualified object names. |
----------------------------------------------
|Take_ |A context for unqualified location |
|History|names. |
----------------------------------------------
|Trace |A context for unqualified location |
| |names. |
----------------------------------------------
If the pathname is not qualified--that is, if it
does not begin with a period (.), underscore ( _ ),
exclamation mark (!), dollar sign ($), double
dollar sign ($$), caret (^), or percent symbol
(%)--the debugger prefixes it with the evaluation
context, using appropriate connecting
punctuation.
>>OPTIONS
-------
>>Set Debugger Evaluation Context To
----------------------------------
Enter the value for the context. The default value
is the context in the selected item.
The null string ("") and the reserved name "All,"
both of which identify all tasks, are legal values
for this entry box.
The evaluation context must be an Ada pathname to a
task, a task number, or a task synonym. The
Debug.Set_Task_Name and Debug_Tools.Set_Task_Name
Environment commands create task synonyms.
If the value of Set Debugger Evaluation Context To
is not a task number, task synonym, or fully
qualified pathname, the command interprets it in
the current evaluation context as any other
pathname. This command interprets the pathname
before defining the new value for the context; it
uses the current context to determine the new
context.
The context must be valid both at the time it is
specified and at the time it is used. For example,
an evaluation context of _4.X must be valid when
specified (frame 4 must exist and have an object X
in it) and when it is used (the Put ("Y") command
is valid only when _4.X.Y exists).
The value of the Set Debugger Evaluation Context To
entry box can be an absolute pathname, a relative
pathname, or a special name that resolves to an
appropriate item. The value of this entry box
designates the new context.
See the "Debugger Naming" section of the Key
Concepts and the Path_Name subtype for more
information on designating contexts with pathnames.
>>RESTRICTIONS
------------
The context pathname must be legal both when
defined and when used by another command.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Context
procedure Debug.Show
Rational Access Help
Debugger Control Context
#Debugger Variables
The Set button on the Debugger Control button set
of the Debugger Palette option menu sets a numeric
value flag to the specified value.
See the Numeric type for more information on the
numeric value flags.
>>OPTIONS
-------
>>Set (option menu)
-----------------
Choose the numeric variable to change. Your options
are:
* Display Count: Specifies the default value of the
Count parameter in the Display_Environment
command. The standard value is 10.
* Display Level: Specifies the number of levels to
expand complex data structures in the Put
command.
* Element Count: Specifies the maximum number of
elements in any array displayed with the Put
button on the Debugger Palette.
* First Element: Specifies the first element of an
array displayed with the Put command.
* History Count: Specifies the default value for
the Count parameter for the History_Display
Environment command. The standard value is 10.
* History Entries: Specifies the maximum number of
history entries kept by the debugger. The
standard value is 1,000. This flag is not
currently supported.
* History Start: Specifies the oldest history entry
displayed by the History_Display Environment
command.
* Memory Count: Specifies the default value in the
Count entry box in the dialog box displayed by
the Display Memory button. This button is located
on the Machine and Memory option on the Debugger
Palette option menu.
* Pointer Level: Specifies the level of pointer
values to be expanded in the display produced by
the Put button on the Debugger Palette.
* Stack Count: Specifies the default value of the
Count option used in various commands (for
example, Modify and Stack on the Debug Palette).
* Stack Start: Specifies the default starting frame
number in various commands (for example, Modify
and Stack on the Debugger Palette).
>>To
--
Enter the new value for the selected variable.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Disable
procedure Debug.Enable
type Debug.Numeric
type Debug.Option
procedure Debug.Set_Value
#Debugger Control Options
The Enable and Disable buttons on the Debugger
Control button set of the Debugger Palette option
menu enables or disables the selected option,
respectively.
>>OPTIONS
-------
>>Enable
--------------
Choose the Enable radio button to cause the command
to enable the specified option. The Enable and
Disable buttons cannot be chosen simultaneously.
>>Disable
-------
Choose the Diable radio button to cause the command
to diable the specified option. The Enable and
Disable buttons cannot be chosen simultaneously.
>>Addresses
---------
Includes machine information in displays produced by
the Stack command (on the Debugger Palette); All
Tasks and Stopped Tasks (on the Show popup menu of
the Debugger Palette); Exceptions--All Tasks,
Rendezvous Info--All Tasks, and Space
Information--All Tasks (on the Task Information
button set of the Debugger Palette option menu);
Activate All Tracing and Deactivate All Tracing (on
the Tracing button set of the Debugger Palette
option menu); and the standard display message for
stopped tasks.
>>Break at Creation
-----------------
Causes the equivalent of a breakpoint to be placed
at the point where new tasks begin elaboration.
>>Declaration Display
-------------------
Forces listing of all declarations in source-code
listings by the Debug.Display Environment command.
>>Delete Temporary Breaks
-----------------------
Forces deletion of temporary breakpoints after the
debugger encounters them.
>>Display Creation
----------------
Forces a trace display for each task as it is
created.
>>Echo Commands
-------------
Forces all debugger commands to be echoed in the
debugger window.
>>Freeze Tasks
------------
Requests that the debugger attempt to stop all tasks
when any task is stopped by the debugger.
>>Include Packages
----------------
Causes inclusion of elaborated packages in displays
generated by the following commands on the Task
Information button set of the Debugger Palette
option menu: List All Tasks, List Blocked Tasks,
List Held Tasks, List Tasks Not Running, List
Running Tasks, and List Stopped Tasks; and for All
Tasks, Held Tasks and Stopped Tasks on the Show
popup menu on the Debugger Palette.
>>Interpret Control Words
-----------------------
Forces termination of control stack words displayed
by the Display Memory command (on the Machine and
Memory button set of the Debugger Palette option
menu).
>>Kill Old Jobs
-------------
Forces termination of the last job being debugged
when a new program is started.
>>Machine Level
-------------
Allows certain machine-level operations.
>>No History Timestamps
---------------------
Prevents inclusion of timestamps in history entries
displayed by the History_Display Environment
command.
>>Optimize Generic History
------------------------
Precludes history tracing for generic instances. A
history is taken only for the generic itself, which
increases execution speed for that generic.
>>Permanent Breakpoints
---------------------
Specifies whether breakpoints are permanent or
temporary.
>>Put Locals
----------
Causes display of local variables as well as formals
when the Put command (on the Debugger Palette) is
called with locations that are packages or
subprograms.
>>Qualify Stack Names
-------------------
Causes the names displayed by the Stack command to
be fully qualified. When disabled, the names are the
simple names of the subprograms executing in
command.
>>Require Debug Off
-----------------
Prevents the initiation of a new debugger job from
forcing the termination of the current job. If this
option flag is enabled, the current job can
terminate only by normal completion of the job or by
explicitly executing the Debug:Finish Debugging and
Detatch or Debug:Finish Debugging Job and Kill menu
command. If this option is disabled, the current job
will be terminated by the debugger when a new job is
initiated.
>>Save Exceptions
---------------
Causes retention of exception-handling information
from the Catch and Propagate commands until the next
debugging run.
>>Show Locations
--------------
Causes highlighted display of current source
location for any task that stops in the debugger.
The debugger displays source code for only the
control context task, the root task, or (in the case
of the Step commands on the Debugger Palette) all
tasks.
>>Timestamps
----------
Forces display of a timestamp for each command and
stopped task.
#Debugger Tracing Control
The Tracing Control button on the Tracing button set
of the Debugger Palette option menu enables or
disables tracing for a specified task. By default,
this command initiates tracing of all events
occurring in all tasks in the selected location.
The Tracing Control command creates a trace request
with the restrictions defined in the options of the
command. For each event that matches the options of
a trace request, the debugger displays a message in
the debugger window. These events include
statements, declarations, calls, rendezvous, and
exceptions. Trace output can also be directed to a
file using the Trace_To_File Environment command.
>>Order of Trace Messages
-----------------------
The order in which events occur and the debugger
displays messages regarding them differs depending
on the type of event. The following list details the
specific order for each event:
* Statement trace messages are displayed before the
statement is executed.
* Call trace messages are displayed before the
first declaration or statement of the subprogram
is executed.
* Rendezvous trace messages are displayed before
the first statement of the rendezvous is
executed.
* Exception trace messages are displayed
immediately after the exception is raised but
before any stack frames are popped and before the
handler code is executed.
The debugger allows multiple simultaneous trace
requests. This permits tracing of more than one
subprogram.
The Tracing Control command does not maintain a
buffer of history entries as the Take_History
Environment command does. In a history, selected
sets of messages can be displayed, such as messages
only from a specific task or for some range of
messages. See the Take_History and History_Display
Environment commands for more information on
histories.
Note: Tracing reduces execution speed.
>>OPTIONS
-------
>>Trace
-----
* Enable: Enables the trace. By default, the trace
is enabled.
* Disable: Disables the trace.
>>All Events (option menu)
------------------------
Choose the class of execution events to be traced.
Your options are:
* All Events (default)
* Call
* Exception Raised
* Machine Instruction
* Propagate Exception
* Rendezvous
* Statement
>>In Task
-------
Enter the task to be traced. The default value is
the null string ("").
Trace requests apply only to a specific task or to
all tasks. If the value is nonnull, In_Task
designates the specified task. If the value is
null, In_Task designates no specific task and Trace
chooses a default task based on the control
context:
* If the control context is set, the trace request
is limited to the task in the control context.
* If the control context is not set, the trace
request applies to all tasks.
>>Location
--------
Enter the location to which tracing is restricted.
The Location entry box must specify a subprogram,
statement, or all locations. By default, the value
of this entry box is the selected statement or
declaration.
The value of Location can be an absolute pathname,
a relative pathname, or a special name that
resolves to a designated location. This value
designates the actual location to which tracing is
limited.
If the value of the Location entry box is the null
string (""), the entry box designates all
locations. Also, if the value is a special name
that cannot be resolved, the entry box designates
all locations.
See the "Debugger Naming" section of the Key
Concepts and the Path_Name subtype in the Debugging
(DEB) book of the Environment Reference Manual for
more information on designating locations.
>>Stack Frame
-----------
Move the slider to display the number of the frame
for which tracing is initiated.
>>To File
-------
Enter the name of the file to which commands send
tracing output. The default null string ("")
resolves to the debugger window.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.History_Display
procedure Debug.Take_History
procedure Debug.Trace
type Debug.Trace_Event
procedure Debug.Trace_To_File
#Debugger Display Memory
The Display Memory button on the Machine and Memory
button set of the Debugger Palette option menu
displays the contents of absolute memory.
The display format is determined by the value of
the Format option:
* Control words (displayed when the value of Format
is "Control") are interpreted according to the
interpretation tag contained within the word.
* Code segment words (displayed when the value of
Format is "Code") are disassembled into their
symbolic form.
* All other types of memory units are displayed in
hexadecimal.
>>OPTIONS
-------
>>Address
-------
Enter the address from which to display memory. For
the R1000, the address format is "(pound
sign)segment_number, (pound sign)offset. The
segment value specifies the segment number in
hexadecimal notation. The offset specifies the
location of the instruction in the segment.
>>Count
----
Enter the number of items to display. The meaning
of this option is interpreted differently for each
target. For the R1000, Count specifies the number
of memory units displayed (as specified by the
Format option), starting from the memory address
specified by the Address entry box. The default is
one.
>>Format
-----
Enter the format of the memory to be displayed. The
meaning of this entry box is interpreted
differently for each target. The legal values for
the R1000 debugger are:
* Control: Control word offset (memory unit is
control stack words)
* Typ: Type word offset (memory unit is type stack
words).
* Queue: Bit offset (the display always starts on a
full word boundary; the starting offset will be
the nearest full word that contains the bit
specified by the offset section of the Address
parameter).
* Data: Bit offset into the segment (the display
always starts on a full word boundary; the
starting offset will be the nearest full word
that contains the bit specified by the offset
section of the Address parameter).
* Import: Word offset (memory unit is import
words).
* Code: Instruction offset (memory unit is
instructions).
* System: Bit offset (the display always starts on
a full word boundary; the starting offset will be
the nearest full word that contains the bit
specified by the offset section of the Address
parameter).
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Memory_Display
#Debugger Display Registers
The Display Registers button on the Machine and
Memory button set of the Debugger Palette option
menu modifies the value of a register with a given
hexadecimal value. The Display Registers button is
on the Machine Memory button set of the Debugger
Palette option menu.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Register_Modify
See the appropriate Cross-Development Facility (CDF)
manual for information on cross-debugging.
#Debugger Modify Memory
The Modify Memory button on the Machine and Memory
button set of the Debugger Palette option menu
modifies up to a longword of memory.
The Modify Memory button is on the Machine Memory
button set of the Debugger Palette option menu.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Memory_Modify
See the appropriate Cross-Development Facility (CDF)
manual for information on cross-debugging.
#Debugger Address to Location
The Address to Location button on the Machine and
Memory button set of the Debugger Palette option
menu displays the Ada source-code location of the
specified runtime address.
The Address to Location button is on the Machine
Memory button set of the Debugger Palette option
menu.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Address_To_Location
See the appropriate Cross-Development Facility (CDF)
manual for information on cross-debugging.
#Debugger Location to Address
The Location to Address button on the Machine and
Memory button set of the Debugger Palette option
menu displays the runtime address of the generated
code for a selected source-code location.
The Location to Address button is on the Machine
Memory button set of the Debugger Palette option
menu.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Location_To_Address
See the appropriate Cross-Development Facility (CDF)
manual for information on cross-debugging.
#Debugger Modify Register
The Modify Register button on the Machine and
Memory button set of the Debugger Palette option
menu modifies the value of a register with a given
hexadecimal value.
The Modify Register button is on the Machine Memory
button set of the Debugger Palette option menu.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Register_Modify
See the appropriate Cross-Development Facility (CDF)
manual for information on cross-debugging.
#Debugger Object to Address
The Object to Address button on the Machine and
Memory button set of the Debugger Palette option
menu displays the runtime address of the generated
code for a selected source-code object.
The Object to Address button is on the Machine and
Memory button set of the Debugger Palette option
menu.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Location_To_Address
See the appropriate Cross-Development Facility (CDF)
manual for information on cross-debugging
#Debugger Exception to Name
The Exception to Name button on the Machine and
Memory button set of the Debugger Palette option
menu displays the Ada name of the exception
corresponding to the address entered in the
Implementation Name entry box.
The Exception to Name button is located on the
Machine Memory button set of the Debugger Palette
option menu.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Exception_To_Name
See the appropriate Cross-Development Facility (CDF)
manual for information on cross-debugging.
#Debugger Target Request
The Target Request button on the Target button set
of the Debugger Palette option menu controls some
operations of the target-resident debugger
(RatCom).
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Target_Request
See the appropriate Cross-Development Facility (CDF)
manual for information on cross-debugging.
#Debugger Invoke
The Invoke button on the Target button set of the
Debugger Palette option menu starts the debugger on
the selected main unit after determining the target
key.
>>SEE ALSO
--------
Debugging (DEB) book of the Environment Reference
Manual
procedure Debug.Invoke
See the appropriate Cross-Development Facility (CDF)
manual for information on cross-debugging.
#Session Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Profile...
----------
A profile is a set of response characteristics that
tell commands:
* How to respond to errors
* Where to generate the logs that summarize command
behavior
* How to filter and format the messages that are
recorded in these logs
* Where to find the activity to use (when executing
commands that compile and/or load programs
written in subsystems)
* Where to find the remote-passwords file and
remote-sessions file to use when executing
commands on remote systems
This command displays the session response profile
for the current session and allows you to reset any
of the profile's component values. The session
response profile for the current session is
reflected in the values of the session switches
with the processor name "Profile."
>>Searchlist
----------
A searchlist is an ordered list of libraries that
is associated with a user session. When you enter a
command through a command window, the Environment
searches through each of the libraries named in
your searchlist until the command being entered is
found.
This command displays the searchlist for your
current session. If a searchlist does not exist,
one is created (based on the system default
searchlist) and displayed in a window. From the
window, the searchlist can be edited using commands
from the Edit menu that apply to entries or
commands from package !Commands.Search_List. You
cannot use basic text editing operations in
searchlists.
For more information, see the introduction to
package Search_List in the Session and Job
Management (SJM) book of the Environment Reference
Manual or the Environment help for
!Commands.Search_List.
>>Session Switches
----------------
Session switches control workspace characteristics
that are subject to your personal preference. They
control log files, library displays, debugger
operations, window management, and networking
operations. Session switches also determine the
default activity for the session.
This command opens an Environment window containing
the session switches for your current session. If a
set of session switches does not exist, one is
created and displayed in a window. From the window,
you can edit the session switches using commands
from the Edit menu that apply to entries or
commands from package !Commands.Switches. You
cannot use basic text editing operations on session
switches.
For more information about session switches, see
the Session Switches section of the Session and Job
Management (SJM) book of the Environment Reference
Manual.
To display a library switch file, choose Compiler
Switches from the Program menu.
>>Jobs=>
------
A job consists of one or more commands that are
executed together. For example, executing a command
from a menu constitutes a single job; executing
multiple commands in a command window also
constitutes a single job. Jobs can also be
initiated programmatically from other jobs using
commands in package !Commands.Program.
This submenu contains commands for displaying lists
of and controlling jobs.
For further information about job characteristics
and job behavior, see the Key Concepts of the
Session and Job Management (SJM) book of the
Environment Reference Manual or the Environment
help for package !Commands.Job.
>>End-of-Input
------------
When executed from an Environment I/O window,
signals the interacting program that no more input
will be provided. For more information, see
procedure !Commands.Text.End_Of_Input in the
Editing Specific Types (EST) book of the
Environment Reference Manual.
>>Screen=>
--------
Contains commands for customizing and controlling
the Access window and the set of windows in the
Environment area.
#Profile
Session:Profile displays the session response
profile for the current session and allows you to
reset any of the profile's component values. The
session response profile for the current session is
reflected in the values of the session switches
with the processor name "Profile."
This help entry provides a brief introduction to
your session response profile and a description of
the options in the Session:Profile dialog box for
setting your session response profile.
>>WHAT IS A SESSION RESPONSE PROFILE?
-----------------------------------
The session response profile for a session provides
the default response characteristics for all
commands executed under that session. A command's
response characteristics tell it:
* How to respond to errors
* Where to generate the logs that summarize command
behavior
* How to filter and format the messages that are
recorded in these logs
* Where to find the activity to use (when executing
commands that compile and/or load programs written
in subsystems)
* Where to find the remote-passwords file and
remote-sessions file to use when executing commands
on remote systems
The initial values for the session response profile
for your default session (S_1) are inherited from
system-defined default values. The initial values
for subsequent session are inherited from your
default session. Thus, you do not need to set your
session response profile unless you want to change
its values.
You can override the session response profile for
the duration of a particular job or Environment
command by setting different response
characteristics for that job or command. To set
different response characteristics for a job, call
procedures from package !Tools.Profile from within
that job. To set different response characteristics
for most Environment commands, use the Response
parameter of the command. Note that you cannot
override the session response profile when
executing commands from Access menus, key bindings,
and mouse bindings.
For further information about using profiles, see
the Key Concepts and package Profile in the Session
and Job Management (SJM) book of the Environment
Reference Manual. For further information about
using the Response parameter to override the
default response characteristics set in your
session response profile, see Parameter-Value
Conventions in the Reference Summary (RS) book of
the Reference Manual.
>>OPTIONS
-------
>>Prefix
------
From each of the three option menus, choose the
kind of prefix that is to appear, by default, in
that position (first, middle, or third) before each
message in the logs generated by the Environment.
The options for each menu are:
* Nil: Specifies an empty prefix. For example, if
you choose to prefix each log message with only two
prefixes, you should set the third prefix to Nil.
* Time: Specifies the normal A.M./P.M. format for
time, which includes hours, minutes, and seconds,
such as 11:34:32 AM or 8:19:09 PM.
* Hr_Mn_Sc: Specifies a military format for time,
including hours, minutes, and seconds, such as
19:54:04.
* Hr_Mn: Specifies a military format for time,
including hours and minutes, such as 21:08.
* Date: Specifies a verbose format for the date,
including the spelled-out month, the day of the
month, and the year, such as June 30, 1991.
* Mn_Dy_Yr: Specifies a short format for the date,
including the numeric month, the day of the month,
and the year, such as 06/30/91.
* Dy_Mn_Yr: Specifies an abbreviated format for the
date, including the day of the month, an
abbreviation of the month, and the year, such as
30-JUN-91.
* Yr_Mn_Dy: Specifies a short format for the date,
including the year, the numeric month, and the day
of the month, such as 91/06/30.
* Symbols: Specifies the symbols associated with
the kind of message. These symbols denote the kind
of message being added to the log, such as *** for
errors or !!! for warnings. See the Filters in the
dialog box or below for a list of message kinds and
their associated symbols.
>>Reaction
--------
From this option menu, choose what Environment
commands should do, by default, in case of error:
* Quit: Specifies that the command terminate at its
first error. No exception is raised.
* Propagate: Specifies that the command terminate
at its first error. An exception is raised. If no
other exception is defined for the command, the
Profile.Error exception is raised.
* Persevere: Specifies that the command continue
executing as best it can after errors are
discovered. No exception is raised.
* Raise Error: Specifies that the command continue
executing as best it can after errors are
discovered. At some point, an exception is raised.
If no other exception is defined for the command,
the Profile.Error exception is raised.
>>Log File
--------
From this option menu, choose the location to which
log output is be directed by default:
* Use Output: Specifies that log output should be
sent to Current_Output. By default, Current_Output
directs output to Standard_Output (an Environment
I/O window); however, Current_Output can be
redirected to another location such as a text file
using the Log.Set_Output or Io.Set_Output
Environment command.
* Use Error: Specifies that log output should be
sent to Current_Error. By default, Current_Error
directs output to Standard_Error (the Environment
message window); however, Current_Error can be
redirected to another location such as a text file
using the Log.Set_Error or Io.Set_Error Environment
command.
* Use Standard Output: Specifies that log output
should be sent to Standard_Output, which is an
Environment I/O window. Standard_Output cannot be
redirected.
* Use Standard Error: Specifies that log output
should be sent to Standard_Error, which is the
Environment message window. Standard_Error cannot
be redirected.
>>Width
-----
Enter the default maximum number of columns that
lines in the logs can be. If a log message is
longer than the width specified, the message is
continued on the next line. Messages that have
been continued are prefixed with the ellipsis (...)
symbol. The maximum width is 1,023 columns.
>>Activity
--------
Enter the pathname of the activity that is to be
the default for all jobs executed under the current
session. This activity is used by the Environment
when you execute commands that are delivered or
developed in subsystems. It is also used by
commands that compile and/or load programs written
in subsystems.
An activity maintains a mapping between subsystems
and pairs of views. The pair consists of a spec
view and a load view from that subsystem. An
activity typically is used to specify an
implementation from each subsystem to be used for
execution.
>>Remote Passwords File
---------------------
Enter the name of the remote-passwords file that is
to be the default for the current session.
Remote passwords files contain usernames and
passwords required for remote operations.
Remote-passwords files are used by commands that
perform operations across a network, including
commands that are part of the standard Rational
Environment (such as those in !Commands.Ftp) and
commands from other Rational products (such as the
Rational Compilation Integrator). Using
remote-passwords files enables you to perform
remote operations without the necessity of
supplying usernames and passwords directly to the
networking command.
>>Remote Session File
-------------------
Enter the name of the remote passwords file that is
to be the default for the current session.
A remote-sessions file is a text file that
specifies which session (or account) should be used
when logging into a remote machine.
>>Filters
-------
Choose the kinds of messages you want included, by
default, in the logs produced by the Environment.
Each kind of message is associated with a
three-character symbol. These symbols are noted in
parentheses.
* Auxiliaries (:::) specify a general message. This
kind of message is provided by the Environment as
commentary on the execution of commands.
* Diagnostics (???) specify a debugging message.
This kind of message is provided by the Environment
as an aid in debugging commands.
* Notes (---) specify a general message. This kind
of message is provided by the Environment as
commentary on the execution of commands.
* Positives (+++) specify a message indicating
positive progress. This kind of message is provided
by the Environment when operations complete
successfully.
* Negatives (++*) specify a message indicating
negative progress. This kind of message is provided
by the Environment when operations do not complete
successfully. Such conditions cause the error
reaction to be taken by the command.
* Positions (>>>) specify a message indicating the
position in some object where an event, explained
by another message, has occurred. This kind of
message is provided by the Environment as an aid in
locating errors and other events in large objects.
* Warnings (!!!) specify a message that warns of
some minor error. This kind of message indicates
that the operation has found some condition that is
not quite correct but is not serious enough to
prevent the operation from continuing.
* Errors (***) specify a message indicating a
serious error. This kind of message indicates that
the operation has found some condition that
prevents the operation from completing
successfully. This causes the error reaction to be
taken by the command. A message of this kind may be
accompanied by a negative message.
* Exceptions (%%%) specify a message indicating
that an exception was raised during the execution
of the command. This kind of message indicates
that the operation has found some condition that
prevents the operation from continuing. This causes
the error reaction to be taken by the command. A
message of this kind may be accompanied by a
negative message.
* Sharps (###) specify a message that has no
predefined meaning. This kind of message is not
used by the Environment but can be used by users to
insert messages into the log files for user-defined
purposes.
* Dollars ($$$) specify a message that has no
predefined meaning. This kind of message is not
used by the Environment but can be used by users to
insert messages into the log files for user-defined
purposes.
* At Signs (@@@) specify a message that has no
predefined meaning. This kind of message is not
used by the Environment but can be used by users to
insert messages into the log files for user-defined
purposes.
>>SEE ALSO
--------
Session and Job Management (SJM) book of the
Environment Reference Manual
Key Concepts
Session Switches
package Log
package Profile
package Remote_Passwords
type Profile.Error_Reaction
type Profile.Log_Output_File
type Profile.Log_Prefix
type Profile.Msg_Kind
#Session Jobs Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Show Jobs
---------
Displays a list of all the jobs currently active on
the system that are associated with the current
user and session. This command lists:
* The current user's login ID or username
* The port number on which the user is logged in
* The jobs associated with the user
* The state of each job
* The amount of time each job has been active
* The name of each job
This command is useful for obtaining a job number
to be used in the Session:Jobs:Connect to Job,
Enable Job, Disable Job, or Kill Job command.
>>Show All Jobs
-------------
Displays a list of all the jobs currently active on
the system, including those belonging to all users
and the system itself (*SYSTEM). For each user,
this command lists:
* The user's login ID or username
* The port number on which the user is logged in
* The jobs associated with the user
* The state of each job
* The amount of time each job has been active
* The name of each job
This command is useful for obtaining a job number
to be used in the Session:Jobs:Connect to Job,
Enable Job, Disable Job, or Kill Job command.
>>Connect to Job...
-----------------
Connects (attaches) the current session to a
previously disconnected (detached) job. Connecting
the session to a job causes the job to run in the
foreground and displays the "...running" message in
the banner of the message window. As a result,
connecting the session to a job effectively
suspends input from the keyboard until the job
completes.
>>Disconnect Current Job
----------------------
Disconnects (detaches) the current session from the
current job, causing that job to run in the
background and removing the "...running" message
from the banner of the message window. Control of
the keyboard, mouse, and menus is returned to the
user.
Note that you cannot disconnect from a job using
the menus; you must use [Control][G]. This
limitation is because while the "...running"
message is displayed, the Environment queues any
commands you enter and executes them after the
current job has completed.
The position of the cursor is cached at the
beginning of a job. Thus, a job that requires
knowledge of cursor position can be disconnected,
leaving the user free to perform other commands.
The same applies for resolution of any special
names.
>>Disable Job...
--------------
Temporarily stops execution of the specified job.
The job is not terminated but is prevented from
executing by the Environment.
>>Enable Job...
-------------
Restarts execution of the specified (previously
disabled) job.
>>Kill Job...
-----------
Terminates execution of the specified job. All
files declared as Current_Output, Current_Input, or
Current_Error, or files on the current-output,
current-input, or current-error stacks, are closed
(see package Log in the Session and Job Management
book of the Environment Reference Manual for more
information about these stacks). All other files
are abandoned, and temporary files are deleted.
#Connect to Job
Session:Jobs:Connect to Job connects the current
session to the specified job, bringing the job to
the foreground and displaying the "...running"
message in the banner of the message window.
This command connects (attaches) the current
session to a previously disconnected (detached)
job. Connecting the session to a job causes the job
to run in the foreground. As a result, connecting
the session to a job effectively suspends input
from the keyboard until the job completes.
However, connected jobs can read keyboard input
with facilities in package Window_Io (see the Data
and Device Input/Output (DIO) book of the
Environment Reference Manual). Connected jobs also
can bring windows onto the screen.
>>OPTIONS
-------
>>Job Number
----------
Enter the job identification number (also called
job id or job number) of the job to which you want
to connect.
Job numbers are assigned by the Environment when
jobs are created. The Environment assigns job
numbers uniquely for each session in the range 0
through 255. To display a list of jobs currently
running and their associated job numbers, use the
Session:Jobs:Show Jobs or Session:Jobs:Show All
Jobs command.
The job number entered in this entry box must be
associated with the current session. The default,
0, connects you to the most recently interrupted
job for the current session.
This entry box has no effect if the Last Job
Disconnected box is checked.
>>Last Job Disconnected
---------------------
Check this box to connect to the job from which you
most recently disconnected.
>>SEE ALSO
--------
Session and Job Management (SJM) book of the
Environment Reference Manual
procedure Job.Connect
#Job Enable/Disable/Kill
Session:Jobs:Enable restarts execution of the
specified (previously disabled) job.
Session:Jobs:Disable temporarily stops execution of
the specified job. The job is not terminated but is
prevented from executing by the Environment.
Session:Jobs:Kill terminates execution of the
specified job. All files declared as
Current_Output, Current_Input, or Current_Error, or
files on the current-output, current-input, or
current-error stacks, are closed (see package Log
in the Session and Job Management book of the
Environment Reference Manual for more information
about these stacks). All other files are abandoned,
and temporary files are deleted.
A single dialog box is used for all three of these
commands. Note, however, that the operation
performed when you click the OK button depends on
the menu item you chose and which displayed the
dialog box. If you are uncertain which menu item
produced the dialog box, you can click the Cancel
button to remove the dialog box without affecting
any jobs.
Note that you cannot enable, disable, or kill a job
from the Access menus while there is a job running
in the foreground under your current session
(indicated by the "...running" message in the
banner of the message window). First, you must
disconnect from the current job by pressing
[Control][G].
>>OPTIONS
-------
>>Job Number
----------
Enter the job identification number (also called
job id or job number) for the job to be enabled,
disabled, or killed.
Job numbers are assigned by the Environment when
jobs are created. The Environment assigns job
numbers uniquely for each session in the range 0
through 255. To display a list of jobs currently
running and their associated job numbers, use the
Session:Jobs:Show Jobs or Session:Jobs:Show All
Jobs command.
When disabling or enabling a job, a value of 0
indicates all the jobs running under the specified
session, provided that session belongs to you; the
value 0 cannot be used to indicate all jobs for a
session that belongs to another user. When killing
a job, you cannot use the value 0 to indicate all
the jobs running under the specified session, even
if that session is your own.
>>Session
-------
Enter the name of the session with which the job is
associated. Special names, wildcards, and context
characters can be used if they resolve to a single
object. The name in this box is resolved with
respect to the current library. The name must
resolve to a session object--for example,
!Users.Robinson.S_1. The default value, the null
string, specifies the current session.
>>RESTRICTIONS
------------
To disable, enable, or kill jobs that belong to
another user, you must have read access to that
user's home world or be operating in privileged
mode (belong to the access-control group Privileged
and have enabled privileges).
>>SEE ALSO
--------
Session and Job Management (SJM) book of the
Environment Reference Manual
procedure Job.Disable
procedure Job.Enable
procedure Job.Kill
#Session Screen Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Screen Push
-----------
Saves the current "screen" on a stack for retrieval
at a later time. (In Access, the "screen" is the
set of Environment windows currently displayed in
the Environment area of the Access window.) This
command saves the Environment windows currently
displayed, including their size, the cursor
location, and the current viewport into the window.
The 100 most recent screen saves are kept on the
stack. The screen stack feature is useful when you
are performing one task with a specific set of
windows and then need to perform another task using
a different set of windows. You can save and later
retrieve either one or both of the sets of windows.
For more information, see package Editor.Screen in
the Editing Images (EI) book of the Environment
Reference Manual.
>>Screen Pop
----------
Retrieves the most recently-saved "screen" and
displays it in the Environment area of the Access
window. (In Access, the "screen" is a set of
Environment windows that have been displayed in the
Environment area of the Access window.)
If you have changed the contents of any of the
windows since they were saved, the new contents
will be shown when the windows are retrieved from
the stack. More specifically, this means that if
you abandon a window, it will not be displayed when
you retrieve the set of windows that contains it; a
blank window will appear in its space. If you have
altered the contents of the window---for example,
adding text to the window---the new contents of the
window will be displayed.
The message window will be displayed in its current
state, rather than the state it was in when saved.
Also, command windows will be in the state they
were in when last used, rather than the state they
were in when they were saved.
For more information, see package Editor.Screen in
the Editing Images (EI) book of the Environment
Reference Manual.
>>Window Frames...
-------------
Allows you to set the maximum number of frames the
system will maintain in the Environment area of the
Access window.
>>Save Button Panel
-----------------
Saves your current user-defined buttons. The
buttons are stored on your workstation in a file in
your home directory called
.Rational-Access-buttons. The buttons are displayed
in each Access window you create. Thus, buttons are
user-specific; they are not session-specific.
>>Full Reset
----------
Resets the Access window. Resetting the window
includes:
* Completely clearing the Environment area of the
Access window
* Ensuring that Session:Screen:Rational Mode is not
set
* Ensuring that Session:Screen:Inverse Video is not
set
After resetting the Access window, you can either:
* Repaint the Environment area of the Access window
by pressing [Control][L].
* Obtain a telnet prompt by pressing [Control][]].
From the telnet prompt, you can enter "z" to put
the telnet session in the background and display a
UNIX prompt.
If you obtain a telnet or UNIX prompt and are
having problems with keystrokes, check to ensure
that Rational Mode is not set.
>>Rational Mode
-------------
For the most part, Rational Access manages the
value of the Rational Mode check box. If, however,
you find that key and mouse operations are not
being interpreted correctly, you should verify that
Rational Mode is set correctly. For example, if
none of the menu commands activate when clicked,
you should verify the Rational Mode setting:
* Rational Mode should be set whenever you are
logged into and working in an Environment session
through the Access window.
* Rational Mode should not be set if you are
entering commands at a telnet or UNIX prompt in the
Access window.
>>Inverse Video
-------------
Switches the text color in the Environment area of
the Access window with the background color of the
area.
>>Visual Bell
-----------
Controls whether the Access window flashes instead
of beeping when the Environment discovers an error.
For this setting to have an effect, the
Session.Beep_On_Errors switch for the current
session must be True.
#Window Frames
Session:Screen:Window Frames allows you to set the
maximum number of frames the system will maintain
in the Environment area of the Access window.
When you first log into an Environment session, the
Environment creates the number of frames specified
in the Session.Window_Frames_Startup switch for
that session. (The default for Access is 3 frames.)
Once you have logged in, the Environment maintains
the number of frames specified in the
Session.Window_Frames switch for that session. (The
default for Access is 3 frames.) (To display your
session switches, use Session:Session Switches.)
You can use Session:Screen:Window Frames to
override the value of the Session.Window_Frames
switch, causing the Environment to maintain the
number of frames you specify. This setting is
preserved until you log out or reset it.
>>OPTIONS
-------
>>Maximum Number of Window Frames
-------------------------------
Choose the maximum number of window frames the
Environment is to maintain in the Environment area
of the Access window. The default value is 3.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Frames
#Tools Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Mail=>
------
Provides operations for creating, sending, reading,
replying to, forwarding, and remailing electronic
mail messages.
>>Insight=>
---------
Provides operations for using Insight. Insight is a
reverse-engineering and browsing tool that
generates diagrams of software systems developed
using the Rational Environment. Insight uses a
subset of the module-diagram notation defined by
Booch. Insight diagrams contain:
* Icons representing subsystems, libraries, and Ada
compilation units.
* Arcs representing dependencies ("with"ing
relationships among Ada units and importing
relationships among subsystems).
You can use Insight to:
* Browse the Environment to gain a better
understanding of your software.
* Save and print diagrams to include in documents.
* Edit diagrams to improve their layout, to
represent partitionings of your software that are
not realized as libraries or subsystems, to
experiment with alternative software architectures.
>>RDF=>
-----
Provides operations for using the Rational Design
Facility (RDF). RDF is a set of tools and
mechanisms to automate the design and documentation
of software systems. Configurations of these tools
and mechanisms can be constructed to support
various design methodologies. Rational delivers a
specific configuration: Rational Design Facility:
DOD-STD-2167A (RDF: 2167A), with the following
capabilities:
* Support for automated generation of
2167A-compliant documents
* Design capture and consistency checking
* Requirements tracking and traceability
* Enforcement of design and implementation
standards
* Enforcement of transitions among lifecycle phases
>>RPI=>
-----
Provides operations for using the Rational
Publishing Interface: Interleaf(TM) TPS product
(RPI). RPI bridges between the Rational Design
Facility (RDF), which helps to automate the design
and documentation of software systems, and
Interleaf's Technical Publishing Software(TM)
(TPS), which formats text and graphics.
>>RTI=>
-----
Provides operations for using the Rational Teamwork
Interface (RTI). RTI works with two other products:
the Rational Design Facility: DOD-STD-2167A (RDF:
2167A), a tool that automates the design and
documentation of software systems, and Cadre
Teamwork(R), a CASE tool for performing
requirements analysis and design. RTI allows you to
augment your Teamwork models with DOD-STD-2167A
information and import the information to RDF,
which you can use to generate 2167A-compliant
documents and continue project development.
>>Macro=>
-------
Provides commands for creating, executing, and
binding keyboard macros. A macro is a sequence of
Environment keystrokes that can be invoked with a
single keystroke or key combination. Macros can be
bound to a key or referenced as the current macro.
>>Operator=>
----------
Provides commands for performing system-management
operations, such as creating users, managing
access-control groups, making backups of the
system, and shutting down the system. The commands
on this submenu are used primarily by system
managers, operators, and Rational technical
representatives. All users can use the Create/Edit
User command to change their passwords.
>>Files Info=>
------------
Provides commands for obtaining information about
objects, such as their name, their version, and any
locks on them.
>>System Info=>
-------------
Provides commands for obtaining information about
the system, such as the users that are currently
logged in, the disk space available and used, the
configuration of the system, and the system load.
#Tools Mail Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Read Mail
---------
Displays your main mailbox. If your main mailbox is
already displayed, this command refreshes the
mailbox, ensuring that it lists all
recently-received mail messages. For more
information, see the Environment help for
!Commands.Mail.Edit.
>>New Mail Message
----------------
Creates an open template for an electronic mail
message, which you can fill in and send. By
default, the template contains several fields:
* From: By default the username under which you are
logged into the Environment. If you would like the
return path to display another username or e-mail
address, enter that username or address here.
* To: Enter the e-mail address(s) to which the
message is to be sent. Multiple addresses can be
entered by separating them with commas.
* Cc: Enter other e-mail address(s) to which the
message is to be sent. Multiple addresses can be
entered by separating them with commas.
* Subject: Enter a brief description of the
contents or purpose of the message.
* The final prompt indicates the area in which you
can enter the body to the message.
For more information, see the Environment help for
Mail.Send.
>>Check Mail Message
------------------
Checks the mail message in the current window to
ensure that it is syntactically and semantically
correct. In particular, this command checks to
ensure the existence of all local destinations in
the To field. Errors in the mail message are
underlined.
>>Send Mail Message
-----------------
Sends the mail message in the current window. Once
a message has been sent it cannot be retrieved.
>>Reply
-----
Creates a reply template, which you can fill in and
send, for the current mail message or the selected
message in the current mailbox. By default, the
template contains several fields:
* From: By default the username under which you are
logged into the Environment. If you would like the
return path to display another username or e-mail
address, enter that username or address here.
* To: Enter the e-mail address(s) to which the
message is to be sent. Multiple addresses can be
entered by separating them with commas. By default,
this field contains the return path of the sender
of the message to which you are replying.
* Cc: Enter other e-mail address(s) to which the
message is to be sent. Multiple addresses can be
entered by separating them with commas. By default,
this field is empty.
* Subject: Enter a brief description of the
contents or purpose of the message. By default, the
Subject field contains "Re:" followed by the
subject from the message to which you are replying.
* The final prompt indicates the area in which you
can enter the body to the message.
* If the value of the Mail_Include_Text_In_Reply
switch for the current session is True, the
template also contains the full text of the message
to which you are replying.
For more information, see the Environment help for
Mail.Reply.
>>Reply to All
------------
Creates a reply template, which you can fill in and
send, for the current mail message or the selected
message in the current mailbox. The template
contains the same fields as that produced by the
Reply command, except for one:
* Cc: Enter other e-mail address(s) to which the
message is to be sent. Multiple addresses can be
entered by separating them with commas. By default,
this field contains the e-mail addresses that were
in the Cc field of the message to which you are
replying.
>>Forward
-------
Creates a forwarding template, which you can fill
in and send, for the current mail message or the
selected message in the current mailbox. By
default, the template contains several fields:
* From: By default the username under which you are
logged into the Environment. If you would like the
return path to display another username or e-mail
address, enter that username or address here.
* To: Enter the e-mail address(s) to which the
message is to be sent. Multiple addresses can be
entered by separating them with commas.
* Cc: Enter other e-mail address(s) to which the
message is to be sent. Multiple addresses can be
entered by separating them with commas. By default,
this field is empty.
* Subject: Enter a brief description of the
contents or purpose of the message. By default, the
Subject field contains "From:" followed by the name
of the sender and the subject from the message you
are forwarding.
* The final prompt indicates the area in which you
can enter the body to the message.
* If the value of the Mail_Include_Text_In_Reply
switch for the current session is True, the
template also contains the full text of the message
to which you are replying.
For more information, see the Environment help for
Mail.Forward.
>>Remail
------
Creates a forwarding template, which you can fill
in and send, for the current mail message or the
selected message in the current mailbox. The
template contains several fields of interest:
* From: By default the username under which you are
logged into the Environment. If you would like the
return path to display another username or e-mail
address, enter that username or address here.
* To: Enter the e-mail address(s) to which the
message is to be sent. Multiple addresses can be
entered by separating them with commas. By default,
the To field contains the same e-mail addresses as
the message you are remailing.
* Cc: Enter other e-mail address(s) to which the
message is to be sent. Multiple addresses can be
entered by separating them with commas. By default,
this field is empty.
* Subject: Enter a brief description of the
contents or purpose of the message. By default, the
Subject field contains subject from the message you
are remailing.
* The address information is followed by the
complete contents of the message you are remailing.
For more information, see the Environment help for
Mail.Remail.
>>Delete Mail Message
-------------------
Deletes the mail message in the current window or
the selected mail message in the current mailbox.
If the Mail_Retain_Deleted_Messages switch for the
current session is set to True, the "deleted"
message is marked with a "D"; it is not actually
deleted until you expunge the mailbox. Until the
mailbox is expunged, you can use Undelete Message
to undelete such messages. If the
Mail_Retain_Deleted_Messages switch is set to
False, the deleted message cannot be recovered.
>>Undelete Mail Message
---------------------
Undeletes the mail message in the current window or
the selected mail message in the current mailbox.
Mail messages that have been marked for deletion
and can be undeleted are indicated by a "D" next
to them in the mailbox.
>>Expunge Mailbox
---------------
Permanently removes any mail messages that have
been marked for deletion (with a "D" next to their
entry in the mailbox). Messages that have been
expunged cannot be recovered.
>>Sort Mailbox
------------
Rearranges the list of messages in your mailbox.
You can sort mail messages based on who they are
from, the date and time they were received, the
date and time they were sent, whether or not they
have been read, and whether or not they are marked
for deletion.
#Sort Mailbox
Tools:Mail:Sort Mailbox rearranges the list of
messages in your mailbox. You can sort mail
messages based on who they are from, the date and
time they were received, the date and time they
were sent, whether or not they have been read, and
whether or not they are marked for deletion.
The sort order set by this command is maintained
until you log out or resort your mailbox. The next
time you log in, your mailbox will be sorted
according to the sort order set in the
Mailbox_Sort_Order session switch for the current
session.
>>OPTIONS
-------
>>Mail Sort Order
---------------
Check the radio button indicating the criteria by
which to sort your mail messages:
* From: Displays messages in alphabetical order
based on the value of the From field in each
message.
* Date Received: Displays messages in chronological
order based on the date they were received.
* Date Sent: Displays messages in chronological
order based on the date they were sent.
* Read / Unread: Displays messages that have been
read in chronological order, followed by messages
that have not been read, also in chronological
order.
* Deleted: Displays messages that are not marked
for deletion in chronological order, followed by
messages that are marked for deletion, also in
chronological order.
The corresponding "reverse" options sort mail
messages based on the same criteria but list the
messages in reverse order. For example, Date
Received (reverse) lists the most recently received
messages at the top of your mailbox.
>>SEE ALSO
--------
Network Mail User's Guide
Editing Specific Types (EST) book of the Environment
Reference Manual
procedure Common.Sort_Image
#Tools Insight Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Invoke...
---------
Starts Insight for interactive use. Starting
Insight this way brings up the Insight main window
on your X display. You perform all subsequent
Insight operations (including exiting from Insight)
by choosing commands from the menus in Insight
windows, as described in the Insight User's Manual.
>>Create Diagram...
-----------------
Creates and saves an Insight diagram as an
Environment file. The diagram is generated as a
windowless operation -- that is, you do not need to
be logged into an X display in order to generate
the diagram. When you want to see the diagram you
generated, you must invoke Insight for interactive
use and then use interactive commands to open the
diagram file.
>>Delete Diagram...
-----------------
Deletes one or more diagram files from the
Environment. This operation deletes only diagram
files, unlike the more general Environment delete
operations.
>>Print Diagram...
----------------
Queues the specified diagram directly to a printer
*or* generates and saves a printable diagram file
for that diagram. In either case, the operation is
windowless -- that is, you do not need to be logged
into an X display in order to print the diagram.
#Insight Invoke
Tools:Insight:Invoke starts Insight for interactive
use. Starting Insight this way brings up the
Insight main window on your X display. You perform
all subsequent Insight operations (including
exiting from Insight) by choosing commands from the
menus in Insight windows, as described in the
Insight User's Manual.
Invoking Insight involves invoking two software
components:
* The Data Manager on the R1000, which identifies
the objects and dependencies being diagrammed
* The Illustrator on a UNIX workstation, which
generates the diagrams from the object and
dependency information
By default, this menu entry is equivalent to the
Insight.Invoke command, which invokes both
components together.
When you select the Data Manager Only option, this
menu entry is equivalent to the Insight.Invoke_Data-
_Manager command, which allows you to invoke the
components separately. Your system manager can tell
you whether this is necessary.
The Insight Invoke options and text boxes are
described below. See the introduction to package
Insight in the Insight User's Manual for complete
information about what you need to start Insight.
>>OPTIONS
-------
>>Data Manager Only
-----------------
Leave this option unselected if you want standard
Insight startup. Under standard startup, the Data
Manager on the R1000 invokes the Illustrator on the
workstation using rsh (remote shell).
Select this option if you want nonstandard Insight
startup (necessary only if your site does not allow
the use of rsh.) Nonstandard startup invokes only
the Data Manager on the R1000; you must enter a
command such as the following on your workstation
to start the Illustrator:
/vendor/rational/insight/release.1_3_0/illustrator R1000 port
* See the output window on the Environment for the
value of R1000 and port.
* See your system manager for the illustrator
command's actual pathname at your site.
>>Object Context
--------------
Fill in this entry box with the Environment context
that contains the objects you want to diagram.
Insight commands use this context to resolve
relative names when creating diagrams.
You can specify any Environment naming expression
that resolves to a unique subsystem, view, world,
or directory. By default, this entry box names the
library that contains the Environment cursor at the
time the dialog box is brought up.
From an Insight window, you can later change the
object context interactively using the
Options:Object Context command.
>>Diagram Context
---------------
Fill in this entry box with the Environment
location for storing and retrieving diagrams.
Insight commands use the diagram context to resolve
relative names when saving or opening diagram
files.
You can specify any Environment naming expression
that resolves to a unique subsystem, view, world,
or directory. By default, this entry box names the
library that contains the Environment cursor at the
time the dialog box is brought up.
From an Insight window, you can later change the
diagram context interactively using the
Options:Diagram Context command.
>>X Display
---------
Fill in this entry box with the name of the X
display to be used for displaying Insight windows.
You must specify a string that has the same syntax
as the value of the -display option common to all X
applications.
Example: if your X display is on a workstation
called unicorn and that workstation is not the one
running the Illustrator, you enter unicorn:0.
By default, this entry box specifies the local
display of the workstation running the Illustrator.
To determine the default, Insight appends the
suffix :0 to the name specified by the Remote
Machine entry box.
>>Remote Machine
--------------
Fill in this entry box with name of the workstation
that runs the Illustrator.
By default, this entry box displays the workstation
name specified in the Ftp.Remote_Machine library
switch for the library entered in the Object
Context entry box. If no name is specified by this
switch, the value of the Session_Ftp-
.Remote_Machine session switch is displayed. If no
known workstation name is specified or found, the
entry box is left blank.
>>Remote Username
---------------
Fill in this entry box with your username on the
workstation that runs the Illustrator.
By default, this entry box displays the username
specified in the Ftp.Remote_Machine library switch
for the library entered in the Object Context entry
box. If no name is specified by this switch, an
attempt is made to obtain the username via the
Rpc_Access_Utilities.Remote_Username procedure. If
this attempt fails, the username for the current
R1000 session is displayed.
>>SEE ALSO
--------
Insight User's Manual
procedure Insight.Invoke
procedure Insight.Invoke_Data_Manager
#Insight Create Diagram
Tools:Insight:Create Diagram creates and saves an
Insight diagram as an Environment file. The diagram
is generated as a windowless operation -- that is,
you do not need to be logged into an X display in
order to generate the diagram. When you want to
see the diagram you generated, you must invoke
Insight for interactive use and then use
interactive commands to open the diagram file.
When you select the Defining Diagram option, this
menu entry is equivalent to the
Insight_Batch.Create_Defining_Diagram command. When
you select the Composite Diagram option, this menu
entry is equivalent to the
Insight_Batch.Create_New_Diagram command.
The Insight Create Diagram options and entry boxes
are described below. See the Package Insight_Batch
chapter of the Insight User's Manual for complete
information.
>>OPTIONS
-------
>>Defining Diagram
----------------
Select this option to generate the defining diagram
for an Environment subsystem, world, or directory.
A defining diagram shows the contents (which is in
a sense the definition) of an Environment
structure. When you start Insight for interactive
use, you can open defining diagrams directly or you
can traverse to them from other diagrams.
Selecting this option causes the related entry box
to be labeled Naming Expression for Subsystem or
Library.
>>Composite Diagram
-----------------
Select this option to generate a composite diagram
for a set of Environment objects. A composite
diagram is composed of icons, one for each
specified object. You must select the Composite
Diagram option if you want to generate a diagram
for objects that do not reside in the same
subsystem or library.
Selecting this option causes the related entry box
to be labeled Naming Expression.
>>Object Context
--------------
Fill in this entry box with the desired context for
specifying the objects to be diagrammed.
* This context is used for name resolution if you
specify a simple name or relative name in the entry
box labeled Naming Expression/Naming Expression for
Subsystem or Library.
* This context is ignored if you specify a fully
qualified pathname in that entry box.
You can specify any Environment naming expression
that resolves to a unique subsystem, view, world,
or directory. By default, this entry box names the
library that contains the Environment cursor at the
time the dialog box is brought up.
Whenever you enter a different object context in
this text box, click on Filter to update the list
box so that it displays the contents of the context
you just specified.
>>Naming Expression
-----------------
Appears when you select the Composite Diagram
option. (If you selected the Defining Diagram
option, see Naming Expression for Subsystem or
Library, below.)
Fill in this entry box with a naming expression
that resolves to the set of Environment objects you
want represented in the composite diagram. This
naming expression must resolve to one or more
subsystems, worlds, directories, and/or Ada units.
Multiple objects can be specified using wildcards,
indirect files, context prefixes, set notation, and
attributes. If you specify a simple name or other
relative pathname, the name is resolved relative to
the Object Context. If you specify a fully
qualified pathname, the Object Context is ignored.
By default, this entry box contains the name of the
object context. You can click on one of the names
in the list box to put that name into the entry
box. Because you normally want to diagram more than
just a single object, you can then enter additional
naming expression characters around this name.
Following are examples of some useful naming
expressions:
* All the objects in the current object context: @
* All the objects in a library:
!users.sjl.my_library.@
* All the subsystems in a library except SS1 (a
utilities subsystem that has dependencies from all
other subsystems):
!users.sjl.my_library[@'C(subsystem), ~ss1]
* All the Ada units in a specific load view of a
subsystem in the current object context:
my_subsystem.rev1_3_0.units.?'c(ada)
* All the Ada units in the load view listed for the
subsystem in the current activity:
my_subsystem'view.units.?'c(ada)
* All the Ada units in the Tools subdirectory of
the same load view:
my_subsystem'view.tools.?'c(ada)
* All the Ada units in the Units directories of the
spec and load views of the subsystems SS1 and SS2:
[ss1,ss2].['spec_view,'view].units.?'c(ada)
>>Naming Expression for Subsystem or Library
------------------------------------------
Appears when you select the Defining Diagram
option. (If you selected the Composite Diagram
option, see Naming Expression, above.)
Fill in this entry box with a naming expression
that resolves to the Environment subsystem, world,
or directory whose contents you want represented in
the defining diagram.
The naming expression must resolve to a unique
object, although it can include wildcards and
attributes. If you specify a simple name or other
relative pathname, the name is resolved relative to
the Object Context. If you specify a fully
qualified pathname, the Object Context is ignored.
By default, this entry box contains the name of the
object context. You can click on one of the names
in the list box to put that name into the entry
box.
>>Diagram Context
---------------
Fill in this entry box with the Environment
location in which you save diagrams:
* This context is used for name resolution if you
specify a simple name or relative name in the
Diagram Name text box.
* This context is ignored if you specify a fully
qualified pathname in the Diagram Name entry box.
You can specify any Environment naming expression
that resolves to a unique subsystem, view, world,
or directory. By default, this entry box names the
library that contains the Environment cursor at the
time the dialog box is brought up.
Whenever you enter a different diagram context in
this entry box, click on Filter to update the list
box so that it lists the diagrams in the context
you just specified.
>>Diagram Name
------------
Fill in this entry box with the Environment name
for the diagram you are generating.
If you specify a simple name or other relative
pathname, the name is resolved relative to the
Diagram Context. If you specify a fully qualified
pathname, the Diagram Context is ignored.
You can click on one of the names in the list box
to put that name into the entry box. Note that the
list box contains only diagram names.
>>Caption
-------
Fill in this entry box with a caption for the
diagram.
You can use a caption to associate descriptive
commentary with the diagram. When the diagram is
displayed, the caption appears in the status area
at the bottom of the diagram.
>>Remote Machine
--------------
Fill in this entry box with name of the workstation
that runs the Illustrator.
By default, this entry box displays the workstation
name specified in the Ftp.Remote_Machine library
switch for the library entered in the Object
Context entry box. If no name is specified by this
switch, the value of the Session_Ftp.Remote_Machine
session switch is displayed. If no known
workstation name is specified or found, the entry
box is left blank.
>>Remote Username
---------------
Fill in this entry box with your username on the
workstation that runs the Illustrator.
By default, this entry box displays the username
specified in the Ftp.Remote_Machine library switch
for the library entered in the Object Context entry
box. If no name is specified by this switch, an
attempt is made to obtain the username via the
Rpc_Access_Utilities.Remote_Username procedure. If
this attempt fails, the username for the current
R1000 session is displayed.
>>Filter
------
Click on Filter after specifying a different Object
Context and/or Diagram Context. Clicking on Filter
updates the appropriate list boxes so that they
list the contents of the currently specified
contexts.
>>SEE ALSO
--------
Insight User's Manual
package Insight_Batch
procedure Insight_Batch.Create_Defining_Diagram
procedure Insight_Batch.Create_New_Diagram
#Insight Delete Diagram
Tools:Insight:Delete Diagram deletes one or more
diagram files from the Environment. This operation
deletes only diagram files, unlike the more general
Environment delete operations.
This menu entry is equivalent to the
Insight_Batch.Delete_Diagram command.
Note: Do not attempt to delete an individual group
diagram, even though you can specify such a diagram
by name. Deleting an individual group diagram
corrupts the group-diagram tree and causes icons to
be lost from it irrecoverably. The only safe way to
delete a group diagram is to delete the composite
or defining diagram in which it is rooted; deleting
a root diagram automatically deletes all group
diagrams associated with it.
The Insight Delete Diagram options and entry boxes
are described below. See the Package Insight_Batch
chapter of the Insight User's Manual for complete
information.
>>OPTIONS
-------
>>Diagram Context
---------------
Fill in this entry box with the Environment
location that contains the diagrams you want to
delete:
* This context is used for name resolution if you
specify a simple name or relative name in the
Diagram Name text box.
* This context is ignored if you specify a fully
qualified pathname in the Diagram Name entry box.
You can specify any Environment naming expression
that resolves to a unique subsystem, view, world,
or directory. By default, this entry box names the
library that contains the Environment cursor at the
time the dialog box is brought up.
Whenever you enter a different diagram context in
this text box, click on Filter to update the list
box so that it displays the contents of the context
you just specified.
>>Diagram Name
------------
Fill in this entry box with the Environment name of
one or more diagrams to be deleted.
You can specify any Environment naming expression
that resolves to one or more Environment objects;
however, of these object, only diagrams are
deleted.
Multiple objects can be specified using wildcards,
indirect files, context prefixes, set notation and
attributes. For example, you can use the wildcard @
to delete all of the diagrams located in the
diagram context. (Note that although @ matches all
simple names in the Diagram Context, only diagrams
are deleted.)
If you specify a simple name or other relative
pathname, the name is resolved relative to the
Diagram Context. If you specify a fully qualified
pathname, the Diagram Context is ignored.
You can click on one of the names in the list box
to put that name into the entry box. Note that the
list box contains only diagram names.
>>Filter
------
Click on Filter after specifying a different
Diagram Context. Clicking on Filter updates the
list box so that it lists the contents of the
currently specified diagram context.
>>SEE ALSO
--------
Insight User's Manual
package Insight_Batch
procedure Insight_Batch.Delete_Diagram
#Insight Print Diagram
Tools:Insight:Print Diagram queues the specified
diagram directly to a printer *or* generates and
saves a printable diagram file for that diagram. In
either case, the operation is windowless -- that
is, you do not need to be logged into an X display
in order to print the diagram.
When you select the File option, this menu entry is
equivalent to the Insight_Batch.Generate_Postscript
command. When you select the Queue option, this
menu entry is equivalent to the
Insight_Batch.Queue_Postscript command.
By default, this menu entry prints large,
multi-page diagrams on standard U.S. letter-sized
paper. Click on the Options button to change format
characteristics such as the diagram's orientation
on the page, the desired paper size, margins,
scale, fonts, and so on. If you want to format a
diagram for inclusion in a document, you must
select the Encapsulated Postscript print option.
The Insight Print Diagram options and entry boxes
are described below. See the Package Insight_Batch
chapter of the Insight User's Manual for complete
information.
>>OPTIONS
-------
>>Queue
-----
Select this option to send to a diagram to a
printer. A temporary printable diagram file is
generated and then discarded after the print job
completes. If you want to save a printable diagram
file, for example, to include in a document, select
the File option instead.
Selecting this option automatically deselects the
File option and causes the related entry box to be
labeled Printer.
>>Printer
-------
Appears when you select the Queue option. (If you
selected the File option, see Filename, below.)
Fill in this entry box with the name of the printer
to which you want to send the diagram. You can
enter the desired name or select the name from the
list box. See your system manager if the printer
you want does not appear in the list box.
>>File
----
Select this option to generate and save a printable
diagram file. You must then use Environment print
operations (available in Access as File:Print) to
queue the printable diagram file to a printer.
Selecting this option automatically deselects the
Queue option and causes the related entry box to be
labeled Filename.
>>Filename
--------
Appears when you select the File option. (If you
selected the Queue option, see Printer, above.)
Fill in this entry box with the name under which
the printable diagram file is to be saved.
By default, the text field contains the filename
that initially appears in the Diagram Name entry
box, with the suffix _Ps appended.
If you specify a simple name or other relative
pathname, the name is resolved relative to the
Diagram Context. For example, if you specify a
simple name, the printable diagram file is saved
with that name in the Diagram Context. If you
specify a fully qualified pathname, the Diagram
Context is ignored.
>>Diagram Context
---------------
Fill in this entry box with the Environment
location that contains the diagram to be printed or
put into printable form:
* This context is used for name resolution if you
specify a simple name or relative name in the
Diagram Name text box.
* This context is ignored if you specify a fully
qualified pathname in the Diagram Name entry box.
You can specify any Environment naming expression
that resolves to a unique subsystem, view, world,
or directory. By default, this entry box names the
library that contains the Environment cursor at the
time the dialog box is brought up.
Whenever you enter a different diagram context in
this entry box, click on Filter to update the list
box so that it displays the contents of the context
you just specified.
>>Diagram Name
------------
Fill in this entry box with the Environment name of
the diagram you want to print or put into printable
form.
If you specify a simple name or other relative
pathname, the name is resolved relative to the
Diagram Context. If you specify a fully qualified
pathname, the Diagram Context is ignored.
You can click on one of the names in the list box
to put that name into the entry box. Note that the
list box contains only diagram names.
>>Remote Machine
--------------
Fill in this entry box with name of the workstation
that runs the Illustrator.
By default, this entry box displays the workstation
name specified in the Ftp.Remote_Machine library
switch for the library entered in the Diagram
Context entry box. If no name is specified by this
switch, the value of the Session_Ftp.Remote_Machine
session switch is displayed. If no known
workstation name is specified or found, the entry
box is left blank.
>>Remote Username
---------------
Fill in this entry box with your username on the
workstation that runs the Illustrator.
By default, this entry box displays the username
specified in the Ftp.Remote_Machine library switch
for the library entered in the Diagram Context
entry box. If no name is specified by this switch,
an attempt is made to obtain the username via the
Rpc_Access_Utilities.Remote_Username procedure. If
this attempt fails, the username for the current
R1000 session is displayed.
>>Filter
------
Click on Filter after specifying a different
Diagram Context. Clicking on Filter updates the
list box so that it lists the contents of the
currently specified context.
>>Options
-------
Click on this button to bring up the Print Options
dialog box. You can use this dialog box
characteristics such as the diagram's orientation
on the page, the desired paper size, margins,
scale, fonts, and so on.
>>SEE ALSO
--------
Insight User's Manual
package Insight_Batch
procedure Insight_Batch.Generate_Postscript
procedure Insight_Batch.Queue_Postscript
#Insight Options
The Insight Options dialog box (produced by the
Options button in the Tools:Insight:Print Diagram
dialog box) allows you to set various format
characteristics of printed diagrams and printable
diagram files.
The Insight Print Options dialog box options and
entry boxes are described below. See the Package
Insight_Batch chapter of the Insight User's Manual
for complete information. See also File:Print in
the Insight User's Manual.
>>OPTIONS
-------
>>Best
----
Select this option to let Insight choose the
orientation (Landscape or Portrait) that requires
the least number of pages. If the two orientations
result in the same number of pages, Insight chooses
the orientation that results in the largest scale.
>>Landscape
---------
Select this option to print the diagram so that its
pages are wider than they are high, giving the
diagram a horizontal orientation.
>>Portrait
--------
Select this option to print the diagram so that its
pages are higher than they are wide, giving the
diagram a vertical orientation.
>>Bitmap Icon
-----------
Select this option to print icons exactly as they
appear on the screen (that is, as bitmaps). Note
that bitmap icons do not scale well. If you turn
this option off, icons are drawn so that they can
be scaled well. Drawn icons are not identical to
the icons as they appear on the screen.
>>Encapsulated Postscript
-----------------------
Select this option to format the diagram so that it
can be included in a document. A diagram in
encapsulated PostScript prints on a single page.
Leave this option unselected to format the diagram
so that it can span multiple pages if necessary.
The resulting diagram can only be printed by
itself; it cannot be included in a document.
The setting of this option affects how Insight uses
the minimum and maximum scale values that you
specify (see the description of the Scale option
below).
>>Erase Behind Labels
-------------------
Select this option to improve the readability of
icon labels by leaving extra white space behind
them.
>>Include Description
-------------------
Select this option to include the diagram
description in the print able diagram. The diagram
description consists of the diagram's name, an
Environment naming expression that identifies its
contents, the username and date associated with the
creation of the printable diagram file, and the
diagram's caption (if it has one).
>>Scale
-----
Adjust the two scale bars to set the minimum and
maximum scale (in per cent of screen size) to be
used in the printable diagram. A scale value of 100
prints icons about 1 inch high. The dialog box does
not allow you to set the minimum to be greater than
the maximum.
Insight chooses a scale value between the specified
minimum and maximum that results in the largest
icons possible on the fewest pages:
* When the Encapsulated Postscript option is turned
off, Insight first uses the minimum value to
calculate the minimum number of pages on which the
diagram will fit. The printable diagram is then
formatted with the largest scale between the mini-
mum and maximum that still allows the diagram to
fit on the minimum number of pages.
* When the Encapsulated Postscript option is
selected, Insight formats the printable diagram
using the largest scale between the minimum and
maximum that allows the diagram to fit on a single
page. Insight will not choose a smaller scale than
the specified minimum, even if the diagram
overflows the page. When the diagram is included in
a document, further scaling may be performed using
the scaling capability of the tool you are using to
produce the document.
>>Paper Size
----------
Select the option corresponding to the desired
standard paper size, or select Custom to specify
nonstandard measurements:
* A0, A1, A2, A3, A4, and A5 define standard paper
sizes used in Europe. A4 is the paper size closest
to U.S. letter-sized paper.
* Us_Letter and Us_Legal define standard paper
sizes used in the United States.
* Custom allows you to specify measurements in the
Width and Height text-entry boxes. Measurements are
expressed in the units specified by the selected
Units option.
Note that when you select the option for a standard
paper size, the paper's measurements are displayed
as nonmodifiable text in the Width and Height entry
boxes. The labels of these boxes are grayed out
when they are nonmodifiable.
>>Margins
-------
Specifies the margins of the printable diagram.
Margins are the amount of white space between the
diagram content and an edge of the page. Margin
measurements are expressed in the units specified
by the selected Units option.
>>Units
-----
Select the option corresponding to the unit of
measurement (inches, centimeters, points, or picas)
you want to use for specifying paper size and
margins.
>>Icon Labels
-----------
Enter the font and size to be used for characters
in icon labels and in the body text of the diagram
description (if you have selected Include
Description). You can specify any font that is
available on your printer. You must type the font
name exactly as your printer expects it (that is,
with the correct case and punctuation).
>>Description Labels
------------------
Enter the font and size to be used for labels in
the diagram description (if you have selected
Include Description). You can specify any font that
is available on your printer. You must type the
font name exactly as your printer expects it (that
is, with the correct case and punctuation).
>>Caption
-------
Enter the font and size to be used for characters
in the diagram's caption, if it has one. You can
specify any font that is available on your printer.
You must type the font name exactly as your printer
expects it (that is, with the correct case and
punctuation).
>>Page Numbers
------------
Enter the font and size to be used for page
numbers. Page numbers are included only if a
diagram spans multiple pages. They appear outside
the cut border printed on the page. You can specify
any font that is available on your printer. You
must type the font name exactly as your printer
expects it (that is, with the correct case and
punctuation).
>>OK
--
Click OK to preserve your print option settings
until you log out from the Environment. These
settings are updated each time you click OK.
>>Cancel
------
Click Cancel to revert the print option settings to
they way they were the last time you clicked OK.
>>SEE ALSO
--------
Insight User's Manual
package Insight_Batch
menu command File:Print
#Tools RDF Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>PDL Definition
--------------
Displays in a window the high-level component,
file, or document in which the information is
defined.
>>PDL Enclosing
-------------
Displays in a window the enclosing Design Facility
high-level component. (Note that this is not the
enclosing library structure of the enclosing Ada
unit). Before executing this command, the cursor
must point to a @COMPONENT_KIND annotation.
The following table illustrates the relationships
of the enclosing high-level component:
Cursor Location Enclosing Design Component
--------------- --------------------------
On the @COMPONENT_KIND There is no enclosing com-
annotation of the ponent; the RDF will dis-
System hierarchical play a message indicating
component. that.
On the @COMPONENT_KIND The package specification
annotation of the for the System hierarchi-
Segment hierarchical cal component from which
component. the Segment was allocated.
On the @COMPONENT_KIND The package specification
annotation of the CSCI for the Segment (or System
hierarchical component. if there is no Segment)
hierarchical component
from which the CSCI was
allocated.
On the @COMPONENT_KIND The package specification
annotation of the HWCI for the Segment (or System
hierarchical component. if there is no Segment)
hierarchical component
from which the HWCI was
allocated.
On the @COMPONENT_KIND The specification for the
annotation of the CSC CSCI or CSC hierarchical
hierarchical component. component from which the
CSC was allocated.
On the @COMPONENT_KIND The specification for the
annotation of the CSC or sublevel CSC com-
sublevel CSC hierar- poenent from which the
chical component. sublevel CSC component
was allocated.
On the @COMPONENT_KIND The specification for the
annotation of the CSU CSC or sublevel CSC com-
hierarchical component. ponent from which the CSU
was allocated.
>>PDL Show Usage
--------------
Displays all allocations and satisfactions of a
requirement. Before executing this command, the
cursor must point to an @REQUIREMENT annotation.
>>PDL Explain
-----------
Displays information about the structure or
annotation on which the cursor is located.
In a preview document, this command displays
information about the document structure on which
the cursor is located.
In PDL, this command displays information about the
annotation (and its argument) on which the cursor
is located.
>>PDL Complete
------------
Inserts required annotations for the current
lifecycle phase into the design element image.
>>PDL Complete (Annotate)
-----------------------
Inserts required and optional annotations for the
current lifecycle phase into the design element
image.
>>Target Key/Phase...
-------------------
Allows you to set the target key and phase for the
specified view.
>>Generate Document...
--------------------
Allows you to generate abstract documents, generate
markup, and print documents.
There are three independent activities that can be
initiated from this menu. You can:
* Generate/update the document database (create and
abstract document).
* Create Interleaf or Compose markup.
* Print
>>Display Hierarchy...
--------------------
Displays the 2167A static hierarchy of the
specified component.
>>Check Consistency...
--------------------
Verifies that the specified high-level component
(System, Segment, HWCI, or CSCI) is structurally
and hierarchically consistent with the Design
Facility requirements.
>>Component Hierarchy...
----------------------
Allows you to change the children of a Rational
system.
>>New 2167A Component...
----------------------
Creates and initializes a high-level component of
the specified kind (System, Segment,
Multi_Subsystem_CSCI, Single_Subsystem_CSCI, or
CSCI_Child_Sybsystem). The following operations are
performed during creation and initialization:
* Creation of the CMVC system object types as
described in the table below.
* Building of the appropriate library structure for
the design target.
* Possible creation of an empty high-level
component (see the table below).
* Setting of the design target for the subsystem to
the design target of model specified in the Model
entry box.
* Setting of the lifecycle phase to
Requirements_Analysis.
* Setting of the appropriate parental relationship
as specified by the Parent Component entry box.
#RDF Target Key and Design Phase
Tools:RDF:Target Key/Phase sets the target key and
phase for the specified view.
#RDF Generate Document
Tools:RDF:Generate Document allows you to generate
abstract documents, generate markup, and print
documents.
There are three independent activities that can be
initiated from this menu. You can:
* Build Database: Generates/updates the document
database (creates and abstracts document).
* Generate_Markup: Creates Interleaf or Compose
markup.
* Print: Prints the specified pages of the document
to the selected printer with the specified printer
options.
If you select all three checkboxes, the RDF will
first build the document database, then generate
markup based on the new database, and finally print
the new document according to the print options you
supply (pages, "Other Options", and "Selected
Printer").
The "Print" command uses Compose markup to generate
the postscript. If you select the "Print" checkbox
without also selecting the "Generate_Markup"
checkbox and choosing "Compose" format, then the
old markup will be used (regardless of whether you
select the "Build_Database" checkbox).
If you select the "Generate_Markup" checkbox
without also selecting the "Build_Database"
checkbox, the old document database will be used.
#RDF Display Hierarchy
Tools:RDF:Display Hierarchy shows the 2167A static
hierarchy of the specified component.
>>OPTIONS
-------
>>Component
---------
Enter the name of component for which to display
the 2167A static hierarchy.
>>Compose CSCIs
---------------
Check this option if you want any high-level
component specified in the @DECOMPOSITION
annotation of any CSCIs in the specified hierarchy
to be included in the display. If this option is
not chosen, the static structure is shown only to
the CSCI level.
>>Transitive
----------
Check this option if you want the transitive
closure of the specified component to be included
in the display. If this option is not chosen, only
the immediate children of the specified component
are shown.
#RDF Check Consistency
Tools:RDF:Check Consistency verifies that the
specified high-level component is structurally and
hierarchically consistent with the Design Facility
requirements.
>>OPTIONS
-------
>>Component
---------
Enter the name of the high-level component (System,
Segment, HWCI, or CSCI) to be checked.
>>Attempt Repair
--------------
Check this box if you want any inconsistencies
detected to be corrected, to the extent possible.
#RDF Component Hierarchy
Tools:RDF:Component Hierarchy allows you to change
the children of a Rational system.
>>OPTIONS
-------
>>System or Subsystem
-------------------
Enter the name of the system or subsystem for which
the children are to be changed.
>>Current Children
----------------
Lists the current children of the specified system
or subsystem.
>>Remove Children
---------------
Lists the children that are to be removed from the
specified system or subsystem. To indicate the
children that are to be removed, select the
unwanted children from the top Current Children
list and click on the arrow that points to the
Remove Children list.
>>Add Children
------------
Lists the children that are to be added to the
specified system or subsystem. To indicate the
children that are to be added, select the desired
children from the bottom Current Children list and
click on the arrow that points to the Add Children
list.
>>OK
--
Executes the changes, making them take effect.
>>Filter
------
Regenerates the list of Current Children. To
abandon the current system and change the children
of a different system, type in the name of the new
system in the System or Subsystem text entry box
and click on the Filter button.
>>Cancel
------
Cancels the command without changing any children.
#RDF New 2167A Component
Tools:RDF:New 2167A Components creates and
initializes a high-level component of the specified
kind (System, Segment, Multi_Subsystem_CSCI,
Single_Subsystem_CSCI, or CSCI_Child_Sybsystem).
The following operations are performed during
creation and initialization:
* Creation of the CMVC system object types as
described in the table below.
* Building of the appropriate library structure for
the design target.
* Possible creation of an empty high-level
component (see the table below).
* Setting of the design target for the subsystem to
the design target of model specified in the Model
entry box.
* Setting of the lifecycle phase to
Requirements_Analysis.
* Setting of the appropriate parental relationship
as specified by the Parent Component entry box.
The following tables shows what objects are created
when each type of high-level component is
initialized.
| |
>> ---------------------------------------------------
| 2167A Hierarchical | CMVC Object Created |
| Component Kind | |
|-------------------------------------------------|
| System | Rational System |
| Segment | Rational System |
| Multi_Subsystem_CSCI | Rational System |
| Single_Subsystem_CSCI | Rational Subsystem |
| CSCI_Child_Subsystem | Rational Subsystem |
---------------------------------------------------
>> ---------------------------------------------------
| 2167A Hierarchical | 2167A Hierarchical |
| Component Kind | Component Created |
|-------------------------------------------------|
| System | System package spec |
| Segment | Segment package spec |
| Multi_Subsystem_CSCI | None |
| Single_Subsystem_CSCI | CSCI package spec |
| CSCI_Child_Subsystem | CSCI package spec |
---------------------------------------------------
>>OPTIONS
-------
>>Name
----
Enter the name of the high-level component to be
created. The name must be an Ada simple name.
>>Initial View Name
-----------------
Enter the base name for the working view of the
subsystem/system created. For example,
"Rev1_Working" might be the name of the working
view and "Ssr1_0_1", "Ssr1_0_2", and "Pdr1_0_1" all
might be names of released views.
>>Component Kind
--------------
Choose the kind of high-level component to be
created: system, segment, multi-subsystem CSCI,
single-subsystem CSCI, or CSCI child subsystem.
>>Model
-----
Enter which model to use when the subsystem/system
is created. The default model,
!Model.Rational_2167a_R1000, has a set of links
identical to !Model.R1000_Portable, so that code
can be run on machines other than R1000s.
!Model.Rational_2167a_R1000 has a design target
RATIONAL_2167A_R1000 registered with it and the
lifecycle phase library switch is set to
Requirements_Analysis. Finally, the model contains
the library structure required by the Design
Facility -- namely, the Documentation, Files and
Graphics directories.
>>Parent Component
----------------
Enter the name of the previously initialized parent
high-level component that is to be linked. Leaving
this empty specifies that the component has no
parent. The parental relationships can later be
changed with the Tools:RDF:Component Hierarchy
command.
>>Comments
--------
Enter comments to be put into the CMVC
configuration database on creations of the
subsystem/system.
#Tools RPI Menu
Help not available for the Tools:RPI menu.
#RPI Put Changes
Help not available for the Tools:RPI:RPI Put
Changes dialog box.
#RPI Accept Changes
Help not available for the Tools:RPI:RPI Accept
Changes dialog box.
#RPI Show Out Of Date
Help not available for the Tools:RPI:Show Out of
Date dialog box.
#Tools RPI Create Menu
Help not available for the Tools:RPI:Create menu.
#RPI Create Gateways from Document Database
Help not available for the
Tools:RPI:Create:Gateways from Document Database
dialog box.
#RPI Create View Gateway
Help not available for the Tools:RPI:Create:View
Gateway dialog box.
#RPI Create File Gateway
Help not available for the Tools:RPI:Create:File
Gateway dialog box.
#RPI Create Graphic Gateway
Help not available for the Tools:RPI:Create:Graphic
Gateway dialog box.
#RPI Connect
Help not available for the Tools:RPI:RPI Connect
dialog box.
#RPI Disconnect
Help not available for the Tools:RPI:RPI Disconnect
dialog box.
#RPI Save Archive
Help not available for the Tools:RPI:Save Archive
dialog box.
#RPI Restore Archive
Help not available for the Tools:RPI:Restore
Archive dialog box.
#Tools RTI Menu
Help not available for the Tools:RTI menu.
#RTI Import Model
Help not available for the Tools:RTI:Import Model
dialog box.
#RTI Accept Changes
Help not available for the Tools:RTI:RTI Accept
Changes dialog box.
#RTI Prepare Document
Help not available for the Tools:RTI:Prepare
Document dialog box.
#RTI Baseline Model
Help not available for the Tools:RTI:Baseline Model
dialog box.
#RTI Increment Model
Help not available for the Tools:RTI:Increment
Model dialog box.
#RTI Destroy Model
Help not available for the Tools:RTI:Destroy Model
dialog box.
#RTI Options
Help not available for the Tools:RTI:Options dialog
box.
#Tools Macro Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Begin Macro Def
---------------
Begins a macro definition.
A macro is a sequence of Environment keystrokes
that can be bound to and invoked with a single
keystroke or key combination. All keystrokes
pressed after this command is executed and before
the End Macro Def command is executed are part of
the macro.
The Begin Macro Def command also can be executed by
pressing [Meta][[].
>>End Macro Def
-------------
Ends a macro definition.
The End Macro Def command also can be executed by
pressing [Meta][]].
>>Execute Macro
-------------
Executes the current macro.
The Environment allows only one unbound keyboard
macro definition at a time. This macro is sometimes
referred to as the current macro and can be
executed using this command or by pressing
[Meta][X]. A new definition replaces an existing
definition. However, macros can be bound to other
keys or key combinations using the Bind Macro to
Key command.
>>Bind Macro to Key
-----------------
Binds the current macro to a key or key combination
and assigns it a number. When prompted in the
message window for the key to which to bind the
current macro, simply press that key or key
combination.
Each macro that has been bound has a number. This
number is displayed when the Bind Macro to Key
command is executed. This number is also displayed
when the Execute Macro command is used to execute
macros. The current macro is number 0.
Note that the binding created by this command, by
default, lasts only until you log out. To save
macros so that they are available the next time you
log in, use the Macro.Save command.
For more information, see package Editor.Macro in
the Editing Images (EI) book of the Environment
Reference Manual.
#Tools Operator Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Backup...
---------
Saves the current Environment state to a tape.
Regular backups ensure that you can restore the
Environment with minimal loss after a catastrophic
system or Environment failure. The Backup command
copies the entire Environment onto tape. It allows
you to make either of two kinds of backups: full or
incremental. Full and incremental backups are
described in the online help for the Backup dialog
box.
>>Verify Backup...
----------------
Reads a backup tape and performs a series of checks
to verify that the backup is complete and
recoverable. The command mimics the backup recovery
procedure, reading all appropriate data, but does
not actually restore the data. Verify Backup is
appropriate for any Environment backup, full or
incremental, on either 9-track or 8mm tapes.
>>Backup History
--------------
Displays history for the ten most recent full and
incremental backups.
>>Create/Edit User...
-------------------
Allows you to create a new user account, modify the
characteristics of an existing user account
(including changing the associated password or the
access-control groups to which the user belongs),
or delete an existing user account. Operations on
user accounts other than your own require operator
capability.
>>Create/Edit Group...
--------------------
Allows you to:
* Create a new access-control group
* Modify an existing access-control group by adding
and/or removing usernames
* Delete an existing access-control group
An access-control group is a list of usernames.
Each object in the Environment is associated with a
list of groups that are permitted access to that
object. (This list is the object's access-control
list.) Only users who belong to one of the groups
listed in an object's access-control list are
permitted access to that object.
Note that you must have operator capability to
execute this command.
>>Force Logoff...
---------------
Terminates the Environment user session active on
the specified line (port). Note that to log off a
session other than your own, you must have operator
capability.
>>Report Generation...
--------------------
Creates a report on system availability, usage,
devices, daemons, outages, and/or trouble. The
report is based on the information contained in the
system error logs. The kind of information reported
is determined by the Report option menu.
>>Shutdown System...
------------------
Shuts down the system on the specified date and
time. When the system is shut down, users are
logged off, all terminal lines are disabled, and a
snapshot is taken to preserve the Environment
state.
Note that you must have operator capability to
execute this command.
>>Cancel Shutdown...
------------------
Cancels a system shutdown initiated by the Shutdown
System command. This command can be entered at any
time during the interval before the actual shutdown
takes place. When this command is executed,
messages are sent to users that shutdown is
canceled.
Note that you must have operator capability to
execute this command.
#Backup
Tools:Operator:Backup saves the current Environment
state to a tape. Regular backups ensure that you
can restore the Environment with minimal loss after
a catastrophic system or Environment failure.
The Backup command copies the entire Environment
onto tape. You can make either of two kinds of
backups: full or incremental. Full and incremental
backups are described in the OPTIONS section below.
Regardless of the kind of backup created, the
Backup command writes two kinds of information onto
the tape:
* Backup Index, which records the system structure
* Data, which is all information contained in the
Environment
If you take backups on a 9-track tape drive, the
backup index is written on a separate tape (also
called a blue tape in previous Environment
releases). If you take backups on an 8-millimeter
tape drive, the backup index is written immediately
following the data on the last data-tape cartridge.
The Backup command can initiate a backup
immediately or after some specified amount of time,
but it cannot perform any system adjustments before
or after the backup. Therefore, system managers
often create and/or use commands such as the
!Commands.Abbreviations.Do_Backup command, which
are implemented using the !Commands.System_Backup-
.Backup_Generic procedure.
Note that execution of the Backup command requires
that you have operator capability.
Note also that backups and disk collection cannot
be run at the same time. If you have begun a backup
and disk collection needs to begin, the backup will
be terminated by default. To change this default,
use the !Tools.Disk_Daemon.Set_Backup_Killing
(False) procedure, which causes the last data tape
to be written before disk collection can begin. If
the disk daemon is running and a backup is
attempted, disk collection must complete before the
backup can begin.
For further information, see your System Manager's
Guide.
>>OPTIONS
-------
>>Starting Time
-------------
Enter the date and time at which the backup is to
begin. The default is the current date and time.
>>Full
----
Choose this radio button to save the complete
Environment, including all user data and system
information.
You must make a full backup if you are making the
first backup after the system has been recovered
from backup tapes. The default is to take a full
backup. If full is chosen, Incremental cannot be
chosen simultaneously.
>>Incremental
-----------
Choose this radio button to save any changes since
the last full backup.
You cannot make an incremental backup if you are
making the first backup on a system that has been
recovered from backup tapes. The default is not to
take an incremental backup. If incremental is
chosen, Full cannot be chosen simultaneously.
Multiple incremental backups can be based on a
single full backup; however, only one of these
incremental backups can be restored with the full
backup.
>>SEE ALSO
--------
System Manager's Guide
System Management Utilities (SMU) book
package System_Backup
procedure System_Backup.Backup
procedure System_Backup.Backup_Generic
#Verify Backup
Tools:Operator:Verify Backup reads a backup tape
and performs a series of checks to verify that the
backup is complete and recoverable. The command
mimics the backup recovery procedure, reading all
appropriate data, but does not actually restore
the data.
Verify Backup is appropriate for any Environment
backup, full or incremental, on either 9-track or
8mm tapes. Tapes should be loaded in the following
order: Backup Index (Blue) tape first, then data
tapes in sequence. You should mount the first tape
immediately. The Verify Backup command then pauses
until the time specified in the Wait Until box.
Tape mount requests are generated on the operator
console.
For more information about system backups, see your
System Manager's Guide.
>>OPTIONS
-------
>>Wait Until
----------
Enter the amount of time that Verify Backup is to
wait before starting to read the backup tape and
perform validity checks. The default is to start
immediately.
>>SEE ALSO
--------
System Manager's Guide
procedure
System_Maintenance'Spec_View.Units.Verify_Backup
#Create/Edit User
Tools:Operator:Create/Edit User allows you to:
* Create a new user account
* Modify the characteristics of an existing user
account, including changing the associated
password or the access-control groups to which
the user belongs
* Delete an existing user account
The following sections describe each of these
operations. They are followed by an OPTIONS
section describing each of the elements in the
Create/Edit User dialog box.
Note that to create a new user account, to modify a
user account other than your own, or to delete a
user account, you must have operator capability.
For more information about managing user accounts,
see your System Manager's Guide or package Operator
in the System Management Utilities (SMU) book of
the Environment Reference Manual.
>>Creating a New User Account
---------------------------
To create a new user account:
1. Choose the Create New User radio button. Access
responds by greying out the Old Password and
Remove From Group entry boxes, indicating that
they are not applicable.
2. In the User entry box, enter the username for
the new user account. (See OPTIONS for legal
values.)
3. In the New Password entry box, enter the initial
password to be associated with the specified
username. (See OPTIONS for legal values.)
The first time the user logs in, he or she
should use Tools:Operator:Create/Edit User to
change his or her password.
4. In the Add to Group entry box, enter the name of
the access-control group(s) to which the user-
name is to belong.
Even if no access-control groups are explicitly
entered, a group with the same name as the
username is created and the new user is added to
this group. Thus, each user has his or her own
group with at least that user as a member.
The new user is also added to groups Public and
Network_Public, unless some other groups are
entered in the Add to Group entry box.
5. If the user is to receive electronic mail
through the Rational Environment, choose Create
Mailbox.
6. Click OK.
The command creates:
* A home library for the user, with the name
!Users.User, where User is the username you
entered in the User entry box. Links from
!Model.R1000 are copied into the new user's home
world.
* A default session, S_1, for the user.
* An entry for the user in !Machine.Users in which
the system stores vital user account information.
>>Modifying an Existing User Account
----------------------------------
To modify the characteristics of an existing user
account:
1. Choose the Modify Existing User radio button.
Access responds by ungreying any elements that
may have been greyed out.
2. In the User entry box, enter the username
associated with the account to be modified. (See
OPTIONS for legal values.)
3. If you are changing the password associated with
the username:
a. In the New Password entry box, enter the new
password. (See OPTIONS for legal values.)
b. In the Old Password entry box, enter the
password currently associated with the user-
name. If the old password has been forgotten,
the Operator's password can be used in its
place.
If the user has encrypted entries in a
remote-passwords, be aware that these entries
will have to be re-encrypted (using the
!Commands.Remote_Passwords.Update command) after
the user's password is changed.
4. If you are adding the username to one or more
access-control groups, enter the names of those
groups in the Add to Group entry box. (See
OPTIONS for legal values.)
Note that identities are established at login.
Adding a user to a group will not be effective
until the user's next login.
5. If you are removing the username from one or
more access-control groups, enter the names of
those groups in the Remove from Group entry box.
(See OPTIONS for legal values.)
Note that identities are established at login.
Removing a user from a group will not be
effective until the user's next login.
6. Click OK.
Note that you cannot use this command to create a
mailbox for an existing user. To create a mailbox,
use File:New:Mailbox.
>>Deleting a User Account
-----------------------
To delete a user account:
1. Ensure that the user is logged out. You cannot
delete the account of a user that is currently
logged in.
2. Choose the Delete User radio button. Access
responds by greying out all the entry boxes
except the User entry box, indicating that they
are not applicable.
3. In the User entry box, enter the username to be
deleted. (See OPTIONS for legal values.)
4. Click OK.
The command deletes the user's default session,
S_1, and the entry in !Machine.Users for the user;
thus, the user is not permitted to log in. The
user's home library and it's contents, however, are
preserved. To delete the user's home library, use
File:Delete File.
Note that the user Operator cannot be deleted using
this command.
>>OPTIONS
-------
>>User
----
Enter the username for the account to be created,
modified, or deleted:
* If you are creating a new user account, the name
must be a legal Ada simple name and must be
unique.
* If you are modifying existing user accounts, you
can specify multiple usernames using wildcards,
set notation, and indirect files.
When an indirect file containing a list of
usernames is specified, the usernames listed in
the indirect file are automatically resolved to
their proper context. This means that a system
manager does not have to specify the fully
qualified pathname of each entry in the file.
* If you are deleting a user account, the name must
be unique.
>>New Password
------------
If you are creating a new user account or if you
are modifying an existing user account and want to
change the user's password, enter the new password
to be associated with the User.
The password can be any arbitrary string. This
password is subject to the minimum password length
set by the current password policy, if one has been
set (see the !Commands-
.Operator.Set_Password_Policy command). The default
is the null string--in other words, no password.
This element is greyed out if you are deleting a
user account.
>>Old Password
------------
If you are modifying an existing user account and
want to change the user's password, enter the
password currently associated with the User.
If you do not know the old password, then the
password for the username Operator can be used. The
default is the null string--in other words, no
password. This element is greyed out if you are
creating a new user account.
Note that if the old password has expired because
of the current password policy, it can still be
specified.
>>Add to Group
------------
If you are creating a new user account, enter the
names of the access-control group(s) to which the
User is to belong. Even if no access-control
groups are explicitly entered, a group with the
same name as the username is created and the new
user is added to this group. Thus, each user has
his or her own group with at least that user as a
member. The new user is also added to groups Public
and Network_Public unless some other groups are
entered in this entry box.
If you are modifying an existing user and want to
add the user to one or more additional
access-control groups, enter the names of those
groups. Multiple groups can be specified using
wildcards, set notation, and indirect files.
The specified group names must exist before this
command is executed.
>>Remove from Group
-----------------
If you are modifying an existing user and want to
remove the user from one or more access-control
groups, enter the names of those groups. Multiple
groups can be specified using wildcards, set
notation, and indirect files.
The specified group names must exist before this
command is executed.
>>Create Mailbox
--------------
If you are creating a new user account and that
user is to receive electronic mail through the
Rational Environment, choose this box. The command
creates a mailbox named Main in which the user can
receive mail. The mailbox is created in the
specified user's home library in a directory called
Mailbox. If the directory does not exist, it is
created.
You cannot use this command to create a mailbox for
an existing user. To create a mailbox, see
File:New:Mailbox.
>>Create New User
---------------
Choose this radio button if you want to create a
new user account. You cannot choose Create New
User, Modify Existing User, and Delete User
simultaneously.
>>Modify Existing User
--------------------
Choose this radio button if you want to modify an
existing user account. You cannot choose Create New
User, Modify Existing User, and Delete User
simultaneously.
>>Delete User
-----------
Choose this radio button if you want to delete an
existing user account. You cannot choose Create New
User, Modify Existing User, and Delete User
simultaneously.
>>SEE ALSO
--------
Network Mail User's Guide
procedure Mail.Create
System Management Utilities (SMU) book
package Operator
procedure Operator.Add_To_Group
procedure Operator.Change_Password
procedure Operator.Create_User
procedure Operator.Delete_User
procedure Operator.Remove_From_Group
#Create/Edit Group
Tools:Operator:Create/Edit Group allows you to:
* Create a new access-control group
* Modify an existing access-control group by adding
and/or removing usernames
* Delete an existing access-control group
The following sections describe access-control
groups and each of these operations. They are
followed by an OPTIONS section describing each of
the elements in the Create/Edit Group dialog box.
Note that you must have operator capability to
execute this command.
For more information about access-control groups,
see package Operator in the System Management
Utilities (SMU) book of the Environment Reference
Manual.
>>Access-Control Groups
---------------------
An access-control group is a list of usernames.
Each object in the Environment is associated with a
list of groups that are permitted access to that
object. (This list is the object's access-control
list.) Only users who belong to one of the groups
listed in an object's access-control list are
permitted access to that object.
Groups are defined either automatically by the
Environment (such as groups Public and
Network_Public) or explicitly using the Create/Edit
Group command. Group objects are stored in the
!Machine.Groups world.
For more information on assigning access to groups,
see the introduction to package Access_List in the
Library Management (LM) book of the Environment
Reference Manual.
>>Creating a New Group
--------------------
To create a new access-control group:
1. Choose the Create Group radio button. Access
responds by greying out the Remove Users entry box,
indicating that it is not applicable.
2. In the Group entry box, enter the name of the
new access-control group. The group cannot already
exist. (See OPTIONS for legal values.)
3. In the Add Users entry box, enter the name(s) of
the users that are to belong to the new group. If
this entry box is empty, no users are added. (See
OPTIONS for legal values.)
4. Click OK.
A maximum of 1,000 group names is allowed per
system. Once this maximum has been reached, no
further group names can be added. An error message
is issued if this command is executed after the
system has reached the maximum allowable number of
groups. Once the limit has been reached,
access-list compaction must be run before you can
create new groups (even if you have removed
unneeded groups). See the introduction to package
Daemon in the System Management Utilities (SMU)
book for further information on access-list
compaction.
>>Deleting a Group
----------------
To delete an existing access-control group:
1. Choose the Delete Group radio button. Access
responds by greying out the Add Users and Remove
Users entry boxes, indicating that they are not
applicable.
2. In the Group entry box, enter the name of the
access-control group to be deleted. The group must
already exist. (See OPTIONS for legal values.)
3. Click OK.
ACL entries that refer to a deleted group are
reclaimed during the next access-list compaction.
See package Daemon in the System Management
Utilities (SMU) book of the Environment Reference
Manual for further information on access-list
compaction.
>>Modifying a Group
-----------------
To modify an existing access-control group:
1. Choose the Modify Group radio button.
2. In the Group entry box, enter the name of the
access-control group to modify. The group must
already exist. (See OPTIONS for legal values.)
3. In the Add Users entry box, enter the name(s) of
the users that are to be added to the group. If
this entry box is empty, no users are added. (See
OPTIONS for legal values.)
4. In the Remove Users entry box, enter the name(s)
of the users that are to be removed from the group.
If this entry box is empty, no users are removed.
(See OPTIONS for legal values.)
5. Click OK.
To see if the username is already a member of a
particular group, you can use the
Operator.Display_Group command.
>>OPTIONS
-------
>>Group
-----
Enter the name(s) of the access-control group(s) to
be modified. Multiple groups can be specified using
wildcards, set notation, and indirect files. If you
are deleting or modifying a group, that group name
must already exist.
>>Add Users
---------
Enter the username(s) that are to added to the
specified group(s).
Multiple names can be specified using wildcards,
set notation, and indirect files. When an indirect
file containing a list of usernames is specified,
the usernames listed in the indirect file are
automatically resolved to their proper context.
This means that you do not have to specify the
fully qualified pathname of each entry in the file.
The usernames must exist before this command is
executed. Note that groups can contain only
usernames -- not other groups.
>>Remove Users
------------
Enter the username(s) that are to be removed from
the specified group(s).
Multiple names can be specified using wildcards,
set notation, and indirect files. When an indirect
file containing a list of usernames is specified,
the usernames listed in the indirect file are
automatically resolved to their proper context.
This means that you do not have to specify the
fully qualified pathname of each entry in the file.
The usernames must exist before this command is
executed.
>>Action
------
Choose the operation to be performed on the
specified group(s):
* Create Group: Creates a new access-control group,
with the usernames specified in the Add Users entry
box as members. When this radio button is chosen,
the Remove Users entry box is not applicable.
* Delete Group: Deletes an existing access-control
group. When this radio button is chosen, the Add
Users and Remove Users entry boxes are not
applicable.
* Modify Group: Changes the members of an existing
access-control group. Usernames entered in the Add
Users entry box are made members of the specified
group, and users in the Remove Users entry box are
removed from membership.
Note that identities are established at login.
Adding or removing a user from a group will not be
effective until the user's next login.
>>SEE ALSO
--------
System Management Utilities (SMU) book
package Operator
procedure Operator.Add_To_Group
procedure Operator.Create_Group
procedure Operator.Delete_Group
procedure Operator.Remove_From_Group
#Force Logoff
Tools:Operator:Force Logoff terminates the
Environment user session active on the specified
line (port).
Uncommitted changes to images are saved if the
Commit Buffers box is checked. The user's
background jobs (if any) continue to run, and any
foreground jobs that do not require interactive
input are put in the background. Foreground jobs
that attempt interactive input are killed.
To log off a session other than your own, you must
have operator capability.
>>OPTIONS
-------
>>Physical Line
-------------
Enter the line (port) number through which the user
is logged in. If the user is logged into more than
one Environment session, make sure that you enter
the line number for the session to be logged out.
To display a list of the users that are currently
logged in and the lines through which they are
logged in, use the Tools:System Info:Users command.
>>Commit Buffers
-------------
Check this box to ensure that uncommitted changes
that the user has made to any images will be
committed before the user is logged out. If this
box is not checked and the user has uncommitted
changes, those changes are lost.
>>SEE ALSO
--------
System Management Utilities (SMU) book of the Environ-
ment Reference Manual
procedure Operator.Force_Logoff
#Report Generation
Tools:Operator:Report Generation creates a report
on system usage, problems, and daemons. The report
is based on the information contained in the system
error logs. The kind of information reported is
determined by the Report option menu.
For more information about generating system
reports, see your System Manager's Guide.
>>OPTIONS
-------
>>Report
------
From this option menu, choose the kind of report
you want to generate:
* Everything: Generates a report for all the
available kinds of information.
* Availability: Generates a report including the
uptime and downtime of the system by classes.
* Usage: Generates a report of the number of users
logged into the system, at hourly intervals.
* Devices: Generates a report of errors from
devices such as disks, memory, and tape.
* Daemons: Generates a report of the daemon sizes,
and schedules.
* Outages: Generates a report of system outages,
including the reasons and explanations for the
outages.
* Trouble: Generates a report of potential trouble
areas, based on all the information collected in
the logs.
* Advice: Not described because the reports
generated are either incomplete or not applicable.
* Tape_Mounts: Not described because the reports
generated are either incomplete or not applicable.
>>Start Time
----------
Enter the day and time of the least recent error
log to be included in the report.
The day should be in the format mn/dy/yr, and the
time should be in military format. For example, to
generate a report beginning at 10 A.M. on May 8,
1992, use the value "05/08/92 10:00". To generate a
report beginning at 10 P.M. that day, use the
value "05/08/92 22:00".
If you do not specify a day and time in this entry
box, the command generates a report beginning with
the earliest day and time for which information is
available.
>>End Time
--------
Enter the day and time of the most recent error log
to be included in the report.
The day should be in the format mn/dy/yr, and the
time should be in military format. For example, to
generate a report ending at 10 A.M. on August 16,
1992, use the value "08/16/92 10:00". To generate a
report ending at 10 P.M. that day, use the value
"08/16/92 22:00".
If you do not specify a day and time in this entry
box, the command generates a report up to the
latest day and time available.
>>Log Directory
-------------
Enter the name of the library that contains the log
files from which the report will be generated.
Unless you have moved your log files to another
library, you do not need to change this value from
it's default value, !Machine.Error_Logs.
>>SEE ALSO
--------
System Manager's Guide
#Shutdown System
Tools:Operator:Shutdown shuts down the system on
the specified date and time.
The Shutdown System command issues several warnings
to users. The first warning occurs when the command
is executed, the next occurs after 3/4 of the
interval has passed, the next occurs when 3/4 of
the remaining time has passed, and so on, until the
system is shut down. Note that a warning interval
of 30 seconds or less results in immediate
shutdown.
When the system is shut down, users are logged off,
all terminal lines are disabled, and a snapshot is
taken to preserve the Environment state.
>>OPTIONS
-------
>>Time
----
Enter the date and time at which the system is to
shut down. The time should be of the form shown in
this example:
November 11, 1992 at 12:33:25 AM
>>Reason
------
From this option menu, choose a reason for shutting
down the system:
* Cops indicates a customer operation
* Release indicates the loading of a new release
* Maint indicates scheduled maintenance
* Crash indicates that the system crashed
* Hang indicates that the system was hung
* Other indicates any other reason
The cause is entered into the machine's error log.
>>Explanation
-----------
Enter an explanation to be entered into the
system's error log. Your explanation can include
other relevant information, such as the Environment
state at the time of shutdown. The default, "No
reason given", should be replaced.
>>RESTRICTIONS
------------
Execution of this command requires that you have
operator capability.
>>SEE ALSO
--------
System Manager's Guide
System Management Utilities (SMU) book of the
Environment Reference Manual
procedure Operator.Shutdown
#Tools Files Info Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Name/Version
------------
Displays the fully qualified name of the object in
the current image. This command also displays the
current version number of the object.
Environment objects such as Ada units and files can
have multiple versions. In particular, a new
version is created when:
* An Ada unit in the source state is opened for
editing
* An Ada unit in the installed or coded state is
incrementally edited
* A text file is committed or promoted
Versions are numbered starting with 1, which
represents the oldest version (the object at
creation). In the display produced by this command,
the object's version number is displayed in the 'V
attribute after the name. For example, if 12 was
the current version of a file called Library_Rdf,
it would be displayed as Library_Rdf'V(12).
Note that versions are different from CMVC
generations. For more information about versions,
see package Library in the Library Management (LM)
book of the Environment Reference Manual.
>>Locks
-----
Displays the locks that exist on the object in the
current image.
The Environment places a lock on an object when a
job or user is accessing the object. This command
displays the locks that exist on the specified
object. You may want to use this command to check
for the locks on an object if:
* An Io.Open command raises the
Io_Exceptions.Use_Error error (lock error)
* The editor reports a lock error
* Other operations indicate problems accessing the
object
The locks are identified by job identity, job
number, and kind. "Reader" signifies that the
indicated job or user is viewing the object but has
not opened it for editing. "Updater" signifies
that the indicated job or user is making changes to
the object, such as editing or compiling it.
Note that the editor maintains separate locks on
the DIANA representation of an Ada unit and its
image. Locks on the image of an Ada unit are
indicated by the suffix "'Image" attached to the
unit's name in the locks display.
For more information, see the documentation for the
What.Locks Environment command in the Session and
Job Management (SJM) book of the Environment
Reference Manual.
#Tools System Info Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Users
-----
Displays a list of users who are currently logged
into the Environment. For each user session, the
display includes:
* The name of the session, in the form
"username.session"
* The port (line) number through which the user is
logged in.
* The job number for the user's editor job. You can
think of an editor job representing the user's
session to the Environment in terms of a job
number.
* The elapsed time since the user's editor job
began; that is, the elapsed time since the user
logged into that session.
* The input and output (I/O) count for the session.
The display also includes the Environment release
number and the date and time the system was last
rebooted.
>>Disk
----
Displays disk data. The display includes:
* The volume number for each disk drive
* The capacity, in pages of 1 Kb each, of each disk
* The amount of space, in pages of 1 Kb each, that
is still available on each disk
* The amount of space, in pages of 1 Kb each, that
is already used on each disk
* The percentage of space that is available on each
disk
* The totals for capacity, space available, space
used, and percentage of space available for all
disk volumes combined.
For more information, see the documentation for the
Operator.Disk_Space command in the System
Management Utilities (SMU) book of the Environment
Reference Manual.
>>Configuration
-------------
Displays information about the system's
configuration and load. The display includes:
* The name of the system
* The machine ID for the system
* The number of the Environment release running on
the system
* The date of the last backup
* The capacity, amount of space used, amount of
space free, percentage of space free, and retargets
for each disk.
>>System Load
-----------
Displays the current system load. The display
includes:
* The average number of runnable tasks; that is,
the average number of tasks eligible for CPU time.
* The average number of tasks waiting on disk
operations.
* The average number of tasks that were withheld
from running. A task is withheld from running if it
is consuming more than its share of resources or if
it has been queued or disabled (see the System
Management Utilities (SMU) book, package
Scheduler).
For each category, the command displays the number
of tasks averaged over one of four sampling
intervals: the last 100 milliseconds, the last
minute, the last five minutes, and the last fifteen
minutes.
For more information, see the documentation for the
What.Load command in the Session and Job Management
(SJM) book of the Environment Reference Manual.
#Help Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>Explain
-------
Provides explanatory information regarding the
designated item in the current window.
Specifically, this command has the following
effects:
* Ada images: Provides an explanation of the error
designated by the cursor position in the Ada unit
in the current window. Used after syntactic or
semantic errors have been discovered, the command
displays an explanation of those errors in the
Message window.
* Command images: Provides an explanation of errors
in the command in the current window. Used after
syntactic or semantic errors have been discovered,
the command displays an explanation of those errors
in the Message window.
* Help and job windows: Adds an entry to the Help
window for the designated item in a Help window
menu. This command has no effect on displays
created by What.Jobs.
* Library images: Changes the level of detail
displayed for the designated object(s) in the
library.
* Links: Inserts an explanation below the current
link that explains what units use the linked unit.
This command is useful for determining what
dependencies on links exist. If there already is an
explanation explaining the link, this command
removes that explanation.
* Switches: Inserts, below the current switch, an
explanation of that switch. If an explanation is
already there, this command will remove it.
* Xref images: Displays the full name of the
currently designated unit in the Message window.
>>On Help...
----------
Describes the mechanisms for obtaining online
information. Rational Access provides online help
and information about the Access menus,
window-control buttons, dialog boxes, and mouse and
key bindings. Access also supports the basic
Environment help facilities.
>>On Getting Started...
---------------------
Introduces the Access Window and describes how to
choose entries from menus and use special features
in Access.
>>On Key
------
Allows you to find what command is bound to a
specified key or key combination, and displays help
for the command from the Environment Reference
Manual.
>>On Key Bindings...
------------------
Lists the Access key bindings and their functions.
>>On Function Keys...
-------------------
Lists the function keys and item-operation keys and
the commands they are bound to.
>>On Mouse...
-----------
Lists the mouse bindings and their functions.
>>On Window Panel...
------------------
Allows you to get help for the window-control
buttons, located under the menu bar.
>>On Menu=>
---------
Displays help for the menu you select.
>>On Environment...
-----------------
Provides an interface to the Environment's online
help and to Access Help available locally.
>>On Version...
-------------
Shows the current version of Rational Access.
#On Help
Rational Access provides online help and
information about the Access menus,
window-control buttons, dialog boxes, and mouse and
key bindings. Access also supports the basic
Environment help facilities.
This help entry contains information about:
* The Access Help Window
* Obtaining information about Access
* Obtaining information about the Environment
>>THE ACCESS HELP WINDOW
----------------------
Information about Access is displayed in the Access
help window, which is a separate window managed by
Access and your window manager. A single help
window is associated with each Access window.
From the Access help window, you can:
* Scroll to see other sections of the help text by
using the scroll bars on the right and bottom of
the window.
* Skip to the next section or subsection within the
help text for the current topic by clicking on the
down arrow button at the top of the help window.
* Go back to the previous section or subsection
within the help text for the current topic by
clicking on the up arrow button at the top of the
help window.
Note that information about the Environment is
displayed in an Environment help window within the
Environment area of the Access window.
>>OBTAINING INFORMATION ABOUT ACCESS
-----------------------------------
* To obtain a description of all the items on a
menu, you can pull down the menu and can press [F1]
or the [Help] key to obtain information.
Alternatively, you can choose the name of the menu
in question from the Help:On Menu submenu.
* To obtain information about a dialog box,
including a description of each field, you can
click on the Help button or press [F1] or the
[Help] key from the dialog box in question.
* To find out what operations are performed by the
function keys (as delivered by Access), you can
click on the [F?] button on the main Access window.
Clicking on this button displays the Function Key
Palette. The palette serves as an active set of
buttons as well as a template. For a textual list
of command bound to function keys, including the
item operations that are supported, choose Help:On
Function Keys.
* To find out what command is bound to a particular
key or key combination, choose Help:On Key. The
Environment then prompts you (in the message
window) for the key to be described. The
description is displayed in an Environment help
window.
* To find out about other key or mouse bindings,
choose Help:On Key Bindings or Help:On Mouse.
* To obtain a description of each of the
window-control buttons at the top of the Access
window, choose Help:On Window Panel. Choosing this
menu changes the mouse pointer to a ?. Placing the
pointer on the button in question and clicking will
display information about that button.
>>OBTAINING INFORMATION ABOUT THE ENVIRONMENT
-------------------------------------------
* To obtain information about the current
underlined error, choose Help:Explain or press the
[Explain] key (generally bound to [F3]).
* To obtain additional information in a library
image or in the CMVC editor, choose Help:Explain or
press the [Explain] key (generally bound to [F3]).
* To obtain information about a specific
Environment command, enter
What.Does("command_name") in a command window and
press [Promote] (generally bound to [F8]).
If you are uncertain of name of the command for
which you would like information or if you would
like to browse through a related set of command
names, choose Help:On Environment. On Environment
displays a static dialog box. Choosing a topic
area and clicking on the Filter button displays a
list of topics in that area. Clicking OK displays
help for the selected topic in an Environment
help window. (See the help for the On Environment
dialog box for more information.)
#Getting Started
Rational Access is a Motif-style graphical user
interface to the Rational Environment. Access
allows you to perform standard Environment
operations using such Motif conventions as a mouse,
pull-down menus, dialog boxes, and persistent
control panels. Access also supports existing
Environment paradigms such as item operations and
command windows.
This Help on Getting Started contains:
* Introduction to the Access Window
* Choosing Entries from Menus
* Special Features in Access
* See Also
>>INTRODUCTION TO THE ACCESS WINDOW
---------------------------------
The Access window is composed of:
* A title bar, indicating the name of the Access
window. You can specify the title when starting
Access by using the -title option.
* The main menu bar, home of Access's nine
pull-down menus.
* A window-control panel, containing buttons for
controlling the size and contents of Environment
windows and for displaying special-purpose Access
windows, such as the Image Palette, the Function
Key Palette, and the Debugger Palette.
* A user-defined button panel, in which users may
place buttons for commonly-used menu items. To
create a button, hold down the [Control] key
while using the mouse to click on the desired
menu command. To save your buttons, choose
Session:Screen:Save Button Panel.
* The Environment area, containing one or more
Environment windows. The Environment area is the
same as the Environment area of other Rational
interfaces.
>>CHOOSING ENTRIES FROM MENUS
---------------------------
You can use either the mouse or keyboard to choose
commands from the Access menus. To use the mouse:
1. Put the pointer on the appropriate title in the
menu bar and click the #1 (usually left) mouse
button.
2. Put the pointer on the name of the desired
command and click.
Alternatively, you can hold down the mouse button
and drag on the menu instead of clicking. Menus and
submenus are displayed as you drag on them; the
chosen command executes when you release the mouse
button.
To use the keyboard:
1. Notice the underlined characters in the menu
title. These are the "mnemonics" for the menus.
To pull down a menu, press [Meta] and the
mnemonic for the menu you want to view.
2. Again notice the underlined characters in the
entries. Press the letter for the entry you want
to execute. You do not need to hold down any
other key while pressing the mnemonic for an
entry on a menu.
Alternatively, you can press [F10] to move the
keyboard focus to the menu bar. Once the focus in
on the menu bar, you can use the arrow keys to
choose a menu title. The space bar opens the
designated menu and the [Return] key executes the
chosen entry.
>>SPECIAL FEATURES
----------------
Rational Access provides several features that are
not offered in any of Rational's other interfaces:
* Window-control buttons
* User-defined buttons
* Image Palette
* Function Key Palette
* Debug Palette
* Just-Do-It mode
>>Window-Control Buttons
----------------------
Window-control buttons are located on the main
Access window immediately below the menu bar. They
allow you to move within Environment images, change
the number and size of Environment windows within
the Access window, and bring up special-purpose
Access windows. To find out what a particular
button does, choose Help:On Window Panel.
>>User-Defined Buttons
--------------------
The area below the window-control buttons is
reserved for user-created buttons. You can create a
button for any command on the Access menus.
* To create a button for a menu command, hold down
the [Control] key while clicking the left mouse
button on the menu command.
* To remove a button, hold down the [Control] key
while clicking on the button.
* To save the buttons you have created, choose
Session: Screen:Save Button Panel.
>>Image Palette
-------------
The Image Palette provides a list of Environment
images which you can redisplay in an Environment
window. To display an image, place the cursor on
the image name and double click.
To bring up the Image Palette, click on the
window-control button fifth from the right. In the
Image Palette:
* The bottom panel contains a list of all images
that have been displayed since login and that have
not been released. (This is the same list displayed
by the Environment command Window.Directory.)
* The top panel contains a user-created list of
images that will continue to be listed even if the
images are released. To add an image from the
bottom panel to the top panel, click once on the
image name to select it and then click the Add
button. This list persists until you log out.
* The Refresh button refreshes the contents of the
bottom panel, to ensure that they match the correct
set of images. Releasing an image does not
automatically remove its name from the Image
Palette; thus, you will need to refresh the Image
Palette to remove the listing.
* The Search box allows you to enter part of an
image name and locate that image in the bottom
panel. To activate the search, click on an arrow
button, indicating the direction in which to
search.
>>Function Key Palette
--------------------
The Function Key Palette is an online template for
the Access function keys. In addition to providing
useful information about key bindings, this
template is active; clicking on a particular "key",
executes that key sequence.
To display the Function Key Palette, click on the
F? window-control button (fourth from the right).
>>Debugger Palette
----------------
The Debugger Palette is a static control panel
containing commands for using the Environment
debugger.
>>Just-Do-It Mode
---------------
Sometimes you may want to execute the same menu
command multiple times with the same settings. In
such a case, the dialog boxes may be unnecessary.
Just-Do-It mode allows you to execute certain menu
commands without seeing the dialog box; the
settings last entered into the dialog box are
assumed.
Just-Do-It mode has been implemented for the
following commands:
File:Print
Program:Promote to Coded
Program:Promote to Installed
Program:Promote to Source
Program:Demote to Installed
Program:Demote to Source
Program:Demote to Archived
CMVC:Accept Changes
To execute the command in Just-Do-It mode, press
the [Meta] key while clicking on the menu entry.
>>SEE ALSO
--------
For more information about using Rational Access,
see the Rational Access User's Guide.
For information about a particular menu item or
dialog box, see the online help for that menu or
dialog box. You can get online help by opening that
menu or dialog box and pressing the [Help] key.
For information about X defaults and the options
available when starting an Access window, see the
"man" page for the command "rational" on your
workstation.
#Mouse Bindings
Below are the mouse operations available in the
Environment area of the Access window.
This information is also found in the Rational
Access Quick Reference.
Mouse operations in menus and dialog boxes follow
OSF/Motif standards; they are described in Appendix
B of the Rational Access User's Guide.
>> ---------------------------------------------------
| Left (#1) Button | Operation |
|--------------------------|----------------------|
| Click | Position cursor |
| Double click | Definition |
| Drag | Motif selection |
| [Shift] + click | End Motif selection |
| [Shift] + double click | Definition in place |
| [Control] + click | Start Env region |
| [Control] + double click | Select object/parent |
| [Control] + drag | Env region selection |
---------------------------------------------------
>> ---------------------------------------------------
| Middle (#2) Button | Operation |
|--------------------------|----------------------|
| Click | Copy Motif selection |
| Double click | |
| Drag | |
| [Shift] + click | |
| [Shift] + double click | |
| [Control] + click | Copy Env region |
| [Control] + double click | |
| [Control] + drag | |
---------------------------------------------------
>> ---------------------------------------------------
| Right (#3) Button | Operation |
|--------------------------|----------------------|
| Click | |
| Double click | Enclosing |
| Drag | |
| [Shift] + click | |
| [Shift] + double click | Enclosing in place |
| [Control] + click | End Env region |
| [Control] + double click | Select child |
| [Control] + drag | |
---------------------------------------------------
#Key Bindings
Below are the standard Rational Access key bindings
for:
* Alphabetic Keys
* Numeric and Symbol Keys
* Special Keys (such as [Return])
For information about function-key bindings, see
Help:On Function Keys or the Function Key Palette.
This information is also found in the Rational
Access Quick Reference.
>> ----------------------------------------------------
| ALPHABETIC KEYS |
|--------------------------------------------------|
| Key | [Ctrl] | [Meta] | [Ctrl][Meta] |
|-----|--------------|--------------|--------------|
| A | beg of line | | |
| B | cursor left | Debug menu | |
| C | copy region | command win | copy line |
| D | del next char| delete word | delete line |
| E | end of line | Edit menu | unlock win |
|-----|--------------|--------------|--------------|
| F | cursor right | File menu | |
| G | interrupt job| kill job | |
| H | cursor left | Help menu | |
| I | | Navigate menu| |
| J | cursor right | next word | |
|-----|--------------|--------------|--------------|
| K | del to eol | del to eow | kill window |
| L | repaint wins | clear wins | |
| M | push mark | CMVC menu | go to mark |
| N | cursor down | next item | next window |
| O | open new line| Tools menu | |
|-----|--------------|--------------|--------------|
| P | | Program menu | lock window |
| Q | help on key | prompt for | |
| R | search prev | | replace prev |
| S | search next | Session menu | replace next |
| T | trans chars | trans words | trans lines |
|-----|--------------|--------------|--------------|
| U | cursor up | prev item | prev window |
| V | scroll down | scroll up | |
| W | cut region | | |
| X | deselect | execute macro| |
| Y | paste region | paste next | |
| Z | scroll up | | |
----------------------------------------------------
>> ----------------------------------------------------
| NUMERIC AND SYMBOL KEYS |
|--------------------------------------------------|
| Key | [Ctrl] | [Meta] | [Ctrl][Meta] |
|-----|--------------|--------------|--------------|
|0..9 | numeric arg | | |
| ! | | expand image | expand window|
| @ | push mark | ins RDF ann | |
| ^ | | cap word | |
| ( | insert (" | | |
| ) | insert ") | elide image | shrink window|
|-----|--------------|--------------|--------------|
| \ | deselect | | |
| | | insert --| | | |
|-or_ | numeric neg | prev undline | |
|=or+ | insert => | next undline | bind macro |
| [ | start region | start macro | |
| ] | end region | end macro | |
|-----|--------------|--------------|--------------|
|;or: | insert := | | |
|'or" | quote char | | |
|,or< | shrink window| lwrcase word | prev hist/cmd|
|.or> | expand window| uprcase word | next hist/cmd|
|/or? | window dir | explain | |
----------------------------------------------------
>> ----------------------------------------------------
| SPECIAL KEYS - PART 1 |
|--------------------------------------------------|
| Key | Unmod | [Shift] | [Control] |
|--------|-------------|-------------|-------------|
| Return | return | return | commit |
| Tab | tab | tab | |
| Delete | del prv char| del region | del to eol |
| Up | cursor up | scroll up | select prev |
| Down | cursor down | scroll down | select next |
| Left | cursor left | scroll left | select prnt |
| Right | cursor right| scroll right| select child|
| Home | beg of line | beg of image| line info |
| End | end of line | end of image| end input |
| Page Up| scroll up | beg of image| |
| Page Dn| scroll down | end of image| |
----------------------------------------------------
>> ----------------------------------------------------
| SPECIAL KEYS - PART 2 |
|--------------------------------------------------|
| Key | [Meta] | [Control][Meta] |
|--------|-------------|---------------------------|
| Return | debug | |
| Tab | | |
| Delete | del prv word| delete white space * |
| Up | prev item | previous window |
| Down | next item | next window |
| Left | prev word | enclosing in place |
| Right | next word | definition in place (body)|
| Home | | top of window |
| End | | bottom of window |
| Page Up| | |
| Page Dn| | |
----------------------------------------------------
* CAUTION: This kills the window manager on an
IBM RS/6000 workstation.
#Function Keys
Below are descriptions of the standard Rational
Access function key bindings, including the item
operation combinations.
This information is also found in the Rational
Access Quick Reference. Active buttons for the
function keys are available in the Function Key
Palette (press the F? button on the top of the
Access window).
>> ----------------------------------------------------
| FUNCTION KEYS |
|--------------------------------------------------|
| Key | Unmodified | [Shift] | [Control] |
|-----|--------------|--------------|--------------|
| F1 | help | prompt for | object |
| F2 | open | edit | region |
| F3 | explain | undlines off | window |
| F4 | check out | check in | image |
|-----|--------------|--------------|--------------|
| F5 | definition | def in place | line |
| F6 | command win | complete | word |
| F7 | enclosing | encl in place| mark |
| F8 | promote | demote | |
|-----|--------------|--------------|--------------|
| F9 | format | semanticize | |
| F10 | menu bar | home library | |
| F11 | create text | create Ada | |
| F12 | next item | prev item | |
----------------------------------------------------
>> ----------------------------------------------------
| OBJECT OPERATIONS |
|--------------------------------------------------|
| [Control][F1] + Key | Operation |
|---------------------|----------------------------|
| a | select first child |
| b | select first child |
| c | copy object |
| d | delete object |
| e | select last child |
| g | abandon object |
| h | select object/parent |
| i | insert object |
| j | select child |
| k | delete object |
| m | move object |
| n | select next |
| r | redo |
| s | sort object |
| u | undo |
| v | redo |
| x | release object |
|---------------------|----------------------------|
| 1 or ! | expand object |
| . or > | elide object |
| / or ? | explain |
|---------------------|----------------------------|
| Tab | tab to comment |
| Return | commit object |
| Up | select previous |
| Down | select next |
| Left | select object/parent |
| Right | select child |
----------------------------------------------------
>> ----------------------------------------------------
| REGION OPERATIONS |
|--------------------------------------------------|
| [Control][F2] + Key | Operation |
|---------------------|----------------------------|
| a | beginning of region |
| b | beginning of region |
| c | copy region |
| d | delete region |
| e | end of region |
| f | fill region |
| h | previous region on stack |
| j | next region on stack |
| k | delete region |
| m | move region |
| n | push region onto stack |
| p | copy top region onto stack |
| q | justify region |
| r | move bottom region to top |
| t | exchange top two regions |
| u | paste region |
| x | deselect region |
|---------------------|----------------------------|
| 6 or ^ | capitalize region |
| 9 or ( | start region |
| 0 or ) | finish region |
| - or _ | make region into comment |
| = or + | uncomment region |
| [ or { | start region |
| ] or } | finish region |
| ' or " | capitalize region |
| , or < | lowercase region |
| . or > | uppercase region |
|---------------------|----------------------------|
| Delete | remove region from stack |
| Up | paste region |
| Down | push region onto stack |
| Left | paste previous region |
| Right | paste next region |
| Home | beginning of region |
| End | end of region |
----------------------------------------------------
>> ----------------------------------------------------
| WINDOW OPERATIONS |
|--------------------------------------------------|
| [Control][F3] + Key | Operation |
|---------------------|----------------------------|
| a | beginning of window |
| b | beginning of window |
| c | copy window |
| d | remove window |
| e | end of window |
| f | format windows |
| h | enclosing |
| j | join next window |
| k | remove window |
| m | promote/lock window |
| n | next window |
| o | join next window |
| t | transpose windows |
| u | previous window |
| v | child window |
| w | remove window |
| x | remove window |
| y | demote/unlock window |
| z | promote/lock window |
|---------------------|----------------------------|
| 1 or ! | expand window |
| . or > | shrink window |
| / or ? | window directory |
|---------------------|----------------------------|
| Delete | join previous window |
| Return | promote/lock window |
| Up | previous window |
| Down | next window |
| Left | parent window |
| Right | child window |
| Home | beginning of window |
| End | end of window |
----------------------------------------------------
>> ----------------------------------------------------
| IMAGE OPERATIONS |
|--------------------------------------------------|
| [Control][F4] + Key | Operation |
|---------------------|----------------------------|
| a | beginning of image |
| b | beginning of image |
| e | end of image |
| f | fill mode on |
| h | scroll left |
| i | insert mode |
| j | scroll right |
| n | scroll down |
| o | overwrite mode |
| u | scroll up |
| x | fill mode off |
|---------------------|----------------------------|
| Up | scroll up |
| Down | scroll down |
| Left | scroll left |
| Right | scroll right |
| Home | beginning of image |
| End | end of iamge |
----------------------------------------------------
>> ----------------------------------------------------
| LINE OPERATIONS |
|--------------------------------------------------|
| [Control][F5] + Key | Operation |
|---------------------|----------------------------|
| a | beginning of line |
| b | beginning of line |
| c | copy line |
| d | delete line |
| e | end of line |
| i | insert line |
| j | join lines |
| k | delete to end-of-line |
| o | open new line |
| t | transpose lines |
|---------------------|----------------------------|
| 4 or $ | center line |
| 6 or ^ | capitalize line |
| , or < | lowercase line |
| . or > | uppercase line |
| / or ? | line information |
|---------------------|----------------------------|
| Delete | delete to end-of-line |
| Up | previous line |
| Down | next line |
| Home | beginning of line |
| End | end of line |
----------------------------------------------------
>> ----------------------------------------------------
| WORD OPERATIONS |
|--------------------------------------------------|
| [Control][F6] + Key | Operation |
|---------------------|----------------------------|
| a | beginning of word |
| b | beginning of word |
| c | copy word |
| d | delete word |
| e | end of word |
| i | speller learn word |
| j | next word |
| k | delete to end-of-word |
| m | speller check image |
| n | speller explain next |
| r | speller learn replacement |
| t | transpose words |
| w | speller window |
| x | speller exchange word |
|---------------------|----------------------------|
| 6 or ^ | capitalize word |
| , or < | lowercase word |
| . or > | uppercase word |
| / or ? | speller check text |
|---------------------|----------------------------|
| Delete | delete to end-of-word |
| Down | speller explain next |
| Left | previous word |
| Right | next word |
| Home | beginning of word |
| End | end of word |
----------------------------------------------------
>> ----------------------------------------------------
| MARK OPERATIONS |
|--------------------------------------------------|
| [Control][F7] + Key | Operation |
|---------------------|----------------------------|
| a | start macro |
| b | start macro |
| e | finish macro |
| f | bind macro to key |
| h | previous mark |
| j | next mark |
| m | execute macro |
| n | push mark |
| p | copy top mark |
| r | rotate top marks |
| t | swap marks |
| u | top mark |
| x | execute macro |
|---------------------|----------------------------|
| 9 or ( | start macro |
| 0 or ) | finish macro |
| [ or { | start macro |
| ] or } | finish macro |
|---------------------|----------------------------|
| Delete | delete mark |
| Return | execute macro |
| Up | top mark |
| Down | push mark |
| Left | previous mark |
| Right | next mark |
----------------------------------------------------
#Window Control Button Panel
Transforms the pointer into a question mark which
you can click on a window-control button and get
help on the button.
For help on a specific button, position the
question-mark pointer over the button and click.
(The window-control buttons are located directly
under the menus.)
To change the pointer back to its original state,
close this box or click in an Environment window.
From left to right, the window-control buttons are:
Scroll Up
Scroll Down
Scroll Left
Scroll Right
Top of Image
Bottom of Image
Copy Window
Join Previous Window
Join Next Window
Expand Window
Shrink Window
Realign Windows
Lock Window
Unlock Window
Show Image Palette
Show Function Key Palette
Show Debugger Palette
Remove Window
Fully Expand Window
#Rational Environment Help
Through the Access help facility, you can obtain
information on Environment commands and packages.
(Environment commands are Ada subprograms that you
usually execute through command windows.) You can
also obtain information on Rational Access topics.
The Rational Environment Help box allows you to
generate a list of help topics from which you can
select a specific command or item of interest and
display help for that command or item.
If you are not sure of the exact name of the
command or item of interest you want help for, you
can progressively narrow down the filtered list of
topics until you find the topic you want, or you
can generate a large list and scroll through it
manually using the slider and search arrows (see
"Searching for a Specific Topic," below).
For example, if you want to get Environment help on
copying a library but are not sure of the exact
Environment command name, you can use the following
options to find the desired command (which happens
to be !Commands.Library.Copy).
>>GETTING A LIST OF TOPICS
------------------------
Click the Topic option menu to choose the topic
area that contains the command or item for which
you want help:
* To generate a list of all available help topics,
choose All_Topics.
* To generate a list of all Access-specific topics,
choose #Rational Access.
* To choose an area of Environment operations,
choose the name of that area. The areas correspond
to the books of the Rational Environment
Reference Manual and other Rational documenents:
Reference Summary
Editing Images
Editing Specific Types
Debugging
Session and Job Management
Library Management
Text Input/Output
Data and Device Input/Output
String Tools
Programming Tools
System Management Utilities
Project Management
Mail
Network Tools
Design Facility
Returning to our example, if you're looking for
information about copying an object, you might
choose Library Management. Clicking on this topic
causes it to appear as the label for the option
menu.
>>FILTERING A LIST
----------------
Click the Filter button to generate a list of
commands in the Filtered Topics field for the
specified topic. The first command in the list is
highlighted.
If you chose the Library Management help topic, for
example, a list of all the commands and packages in
the Library Management (LM) book of the Environment
Reference Manual appears in the Filtered Topics
field.
To filter a list that displays only commands that
match a designated pattern, enter a string to
search for in the Pattern entry box, using
pattern-matching wildcards, if desired (see below).
Then click the Filter button.
For example, replace the @ sign with the word
"copy" to filter a list with only topics that have
the word "copy" in them. Click the Filter button to
generate the new list. It appears with the
You can use the following pattern-matching
wildcards in the Pattern box.
? Matches any character.
% Matches any character that is a legal Ada
identifier.
{ Matches the beginning of a line when used at
the beginning of a pattern.
} Matches the end of a line when used at the end
of a pattern.
[] Defines a set of characters, of which any
one can be matched. For example [xyz] or
[x-z].
\ Quotes the next wildcard character, causing
it to have a literal, not wildcard,
interpretation.
* Matches zero or more occurrences of the
previous character or set of characters.
@ Is a synonym for "?*". This matches zero or
more occurrences of anything.
Note that if nothing is in the Pattern entry box,
no list will be filtered. To list all subtopics
within the specified topic, enter the @ sign.
>>SEARCHING FOR A SPECIFIC TOPIC
------------------------------
To find the topic you want help for, you can scroll
the filtered list manually by dragging the slider
(the slider only appears if the list is longer than
the Filtered Topics field).
You can also scroll through the list stopping only
at a specific command or at commands that match a
designated pattern. Enter a specific command name
or name fragment in the Search Pattern entry box.
You may use pattern-matching wildcards, if desired
(see above).
For example, if you did not know that information
about copying libraries is located in the Library
Management category and you chose All Topics
instead, you could quickly search through the long
list:
1. Enter the word "copy" in the Search Pattern
entry box.
2. Click the search arrow on the right to scroll
down in the list, or the one on the left to
scroll up in the list.
3. Repeat step 2 to go to the next occurrence.
The location cursor (highlighted box) will stop
only at commands with the word "copy" in them. Note
that an empty search pattern matches nothing.
>>DISPLAYING HELP
---------------
To display help for the specified topic in the
Selected Topic box:
1. Select the topic with the location cursor by
clicking on it. The name of the topic appears in
the Selected Topic entry box. You may also type
directly into the Selected Topic entry box.
2. Click OK. The Environment help window displays
help for Environment topics, and the Access help
window displays help for Access topics
(designated by a # sign before the topic).
For example, if you have filtered a list from the
Library Management topic and specified "copy" in
the Pattern box, or if you filtered a list for all
topics and scrolled through the list, you will
notice that there is an entry for
!Commands.Library.Copy. Select it and click the OK
button to display help for copying a library.
>>CLOSING THE ENVIRONMENT HELP DIALOG BOX
---------------------------------------
Click the Remove Window button in the upper-right
corner of the dialog box. (The button looks like
four arrows pointing inwards.)
#Help on Menu
------------------------------------------------------
Legend:
... Indicates that the item brings up a dialog box.
You can obtain additional information by
clicking on the Help button in the dialog box.
=> Indicates that the item brings up a submenu. You
can obtain additional information by displaying
the submenu and pressing the [Help] key
(generally bound to [F1]).
_ Indicates the letter used to represent the item
from the keyboard. [Meta] + underlined letter
displays the corresponding menu. When a menu is
displayed, typing a letter activates the
corresponding item on that menu.
------------------------------------------------------
>>File Menu Help
--------------
Provides help for creating, manipulating, saving,
and maintaining files.
>>Edit Menu Help
--------------
Provides help for editing files, including
searching for and replacing text strings, changing
case, cutting and pasting text, and using the
spelling checker.
>>Navigate Menu Help
------------------
Provides help for traversing within images and
between Environment windows.
>>Program Menu Help
-----------------
Provides help for manipulating and maintaining Ada
units.
>>CMVC Menu Help
--------------
Provides help for Configuration Management and
Version Control of Rational subsystems.
>>Debug Menu Help
---------------
Provides help for debugging Ada programs using the
Rational Debugger.
>>Session Menu Help
-----------------
Provides help for customizing your current
Environment session.
>>Tools Menu Help
---------------
Provides help for Rational layered products.
>>Help Menu Help
--------------
Provides help for obtaining information from the
online help and information available through
Rational Access and the Environment.
#Rational Access Version
Help:On Version displays the current version of
Rational Access. The display includes, in this
order:
* The release (rev) number and date of the Access X
client software running on the workstation.
* The release (rev) number of the Access server
running on the R1000.
* The version of the keymap located on the R1000
in !Machine.Editor_Data.Rational_Access_Commands.
When you are done reading the Rational Access
Version dialog box, click OK.
#On Compatibility
The Help on Version dialog box indicates that there
is a compatibility problem among the three main
Access components:
* The Access X client running on the workstation.
* The Access server running on the R1000.
* The Rational_Access_Commands keymap procedure in
!Machine.Editor_Data on the R1000.
If the box indicates that your problem is with the
keymap, you should click OK and continue logging
in. Note, however, that certain keyboard and mouse
operations may not work as expected until you
obtain the proper keymap.
If the box indicates that your problem is with the
Access server on the R1000, alert your system
manager. Continue logging in at your own risk.
#Scroll Up Button
Moves your view of the current image up. There will
be overlap between what is currently visible and
what is visible after the operation. The operation
never moves the first line of the image lower than
the first line of the window.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Image.Up
#Scroll Down Button
Moves your view of the current image down. There
will be overlap between what is currently visible
and what is visible after the operation. The
operation may move the last line of the image out
of your view; you can scroll down into the white
space below the last character in the file.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Image.Down
#Scroll Left Button
Moves your view of the current image to the left,
if the left margin is not already visible.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Image.Left
#Scroll Right Button
Moves your view of the current image to the right.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Image.Right
#Top of Image Button
Moves the Environment cursor to the top line of the
current image, subsequently moving your view to
encompass that area of the image.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
Editor.Image.Beginning_Of
#Bottom of Image Button
Moves the Environment cursor to the bottom of the
current image, subsequently moving your view to
encompass that area of the image.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Image.End_Of
#Copy Window Button
Divides the current Environment window into two
windows with identical images. Each image can be
scrolled independently. Making changes to one of
these images affects both of them.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Copy
#Join Next Window Button
Expands the current Environment window to the size
of the current window frame plus the window frame
below, replacing any window that might have been in
that frame. Unless the window is locked, the window
frame returns to its normal size automatically when
the next object is viewed.
If your current window is at the bottom of the
Environment area, pressing this button will expand
the window over the window directly above.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Join
#Join Previous Window Button
Expands the current Environment window to the size
of the current window frame plus the window frame
above, replacing any window that might have been in
that frame. Unless the window is locked, the window
frame returns to its normal size automatically when
the next object is viewed.
If your current window is at the top of the
Environment area, pressing this button will expand
the window over the window directly below.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Join
#Expand Window Button
Expands the current Environment window by four
lines (thereby shrinking the neighboring
Environment window by four lines).
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Expand
#Shrink Window Button
Shrinks the current Environment window by four
lines (thereby expanding the neighboring
Environment window by four lines).
>>SEE ALSO
--------
Editing Images (EI) book of the Rational Reference
Manual
procedure Editor.Window.Expand
#Realign Windows Button
Makes all visible major Environment windows the
same size.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Focus
#Lock Window Button
Makes the current Environment window unable to be
replaced unless you explicitly remove or unlock it.
An "at" sign (@) appears in the window banner,
signifying that the window is locked.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Promote
#Unlock Window Button
Makes the current Environment window able to
replaced without you explicitly removing it. The
"at" sign (@) disappears from the window banner,
signifying that the window is unlocked.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Demote
#Show Image Palette Button
Displays the Image Palette, a control palette that
provides an updatable listing of the images open
under your current Environment session.
#Show Function Key Palette Button
Displays the Function Key Palette, an active online
set of function "keys" from which you can perform
any of the operations bound to Access function
keys, including item-operation combinations.
#Show Debugger Palette Button
Displays the Debugger Palette, a control palette
that allows you to debug Ada programs.
#Remove Window Button
Removes a window temporarily from the Environment
area. The image contained in the window remains
listed in the Image Palette and Environment Window
Directory.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Delete
#Fully Expand Window Button
Makes the current window fill the entire
Environment area, encompassing all window frames.
>>SEE ALSO
--------
Editing Images (EI) book of the Environment Reference
Manual
procedure Editor.Window.Join
#Button Panel
Depending on which menu commands you use often, you
may want to create your own user-defined buttons.
These buttons allow you to execute a menu command
by clicking on the button.
The user-defined buttons are displayed as the name
of the command enclosed in a rectangular border,
and appear directly below the window-control
buttons and above the sash. You may create as many
buttons as you wish, making space for them by
pulling down the sash in the Environment area. The
buttons appear left to right, in the order that you
create them. Buttons can be saved and deleted
between logins, and are user-specific, not
session-specific.
>>Creating A User-Defined Button
------------------------------
Place the pointer on a menu command and
[Control]+click.
>>Activating A User-Defined Button
--------------------------------
Place the pointer on the button and click.
>>Deleting A User-Defined Button
------------------------------
Place the pointer on the button and
[Control]+click.
>>Saving User-Defined Buttons
---------------------------
Choose the Session:Screen:Save Button Panel menu
command. The current button configuration will
reappear when you log in again to Access.
>>SEE ALSO
--------
Rational Access User's Guide
Chapter 14, "Customizing Your Workspace"
#Function Key Palette
The Function Key Palette brings up a list of the
commands that are bound to each function key and
allows you to execute a function key command by
clicking on its entry in the palette.
The top seven [Control] buttons on the palette
support the item-operation paradigm used in other
Rational user interfaces. Clicking on one of these
buttons brings up a second-level control palette
with item-specific operations buttons.
To execute a function key command, click the
command on the palette.
To close the Function Key Palette, click its Remove
Window button. (This is located in the top, right
corner of the palette and looks like four arrows
pointing inwards.)
#Object Operations
Object operations are a kind of item operation. Item
operation refers to particular key combinations that
consist of a special kind of key, called an item key
(in this case, [Object]), followed by another key
indicating the operation to be performed on that
item.
Object operations include those operations that can
be performed on entire Environment objects,
including libraries, text files, and Ada units.
For example, object operations allow you to copy,
move, and delete objects. Object operations also
allow you to make selections based on the underlying
type-specific structures of the objects.
From the Object Operations dialog box, you can
execute a particular operation either by clicking on
the operation to be performed or pressing the key
corresponding to the underlined character in the
operation's label. Object operations can also be
performed by pressing [Control][F1] and then
pressing the key corresponding to the desired
operation.
Object operations are available on all Rational
interfaces, including Access, although many Access
commands offer alternatives to the item-operation
technique. Access equivalents for most Object
operations are found on the File menu.
>>Expand (Object-!)
-----------------
Increases the level of detail displayed in the
image for the currently designated item.
>>Elide (Object->)
----------------
Reduces the level of detail displayed in the image
for the currently designated item.
>>Explain (Object-?)
------------------
Provides explanatory information regarding the
designated item in the current window.
>>Copy (Object-C)
---------------
Copies the selected item to the position of the
Environment cursor.
>>Move (Object-M)
---------------
Moves the selected item to the position of the
Environment cursor.
>>Delete (Object-D)
-----------------
Deletes the designated item.
>>Release (Object-X)
------------------
Ends editing on the current image and makes changes
permanent.
This operation releases any locks the Rational
Editor may have in the object being edited,
destroys the window, and removes the image from the
Image Palette and the Environment Window Directory.
>>Parent (Object-H)
-----------------
Selects the parent of the designated item.
The parent is the item at the next higher level.
>>Child (Object-J)
-----------------
Selects the child of the designated item.
The child is the item at the next lower level, in a
syntactic sense, from the current item. The child
that encloses the cursor is selected unless no such
child exists.
>>Last Child (Object-E)
---------------------
Selects the last child of the designated item.
The last child is the last one of the set of items
at the next lower level, in a syntactic sense, from
the current item.
>>Abandon (Object-G)
------------------
Abandons editing of the current image and does not
save changes.
This operation abandons any changes made to the
image in the current window since the last commit,
releases any locks held by the Rational Editor on
the object corresponding to the image, destroys the
window, and removes the image from the Image
Palette and the Environment Window Directory.
>>Insert (Object-I)
-----------------
Insert a new item.
>>Next (Object-N)
---------------
Selects the next item.
The next item is the item at the same level, in a
syntactic sense, as the designated item that
appears immediately after the designated item.
>>Previous (Object-Up Arrow)
--------------------------
Selects the previous item.
The previous item is the item at the same level, in
a syntactic sense, as the designated item that
appears immediately before the designated item.
>>Redo (Object-R)
---------------
Redoes the changes previously made to an image.
The Rational Editor maintains histories of the
temporary copies of some image types as images of
these types are changed. These histories allow
changes to be undone, going back in time through
each set of changes to the beginning of time for
the image. Change histories can be stepped forward
or backward with the Redo and Undo commands,
respectively.
Change histories are retained by the Rational
Editor, depending on the type of image. These
histories are destroyed or restarted when the
session ends and at other times, depending on the
type of image being edited.
>>Undo (Object-U)
---------------
Undoes the previous sets of changes to the current
image.
The Rational Editor maintains histories of the
temporary copies of some image types as images of
these types are changed. These histories allow
changes to be undone, going back in time through
each set of changes to the beginning of time for
the image. Change histories can be stepped forward
or backward with the Redo and Undo commands,
respectively.
Change histories are retained by the Rational
Editor, depending on the type of image. These
histories are destroyed or restarted when the
session ends and at other times, depending on the
type of image being edited.
>>Tab To Comment (Object-Tab)
--------------------------
Moves the cursor to the first character of the text
in the comment, if there is a comment on the
current line.
If there is no comment on the line and no text
currently located at the comment column (set by the
Comment_Column library switch), this command
inserts the comment characters (-- ) and leaves the
cursor at the first character position for the
comment. Otherwise, if there is text at the comment
column, the command moves the cursor to the
beginning of the text, inserts the comment
characters (-- ), and leaves the cursor after the
inserted characters.
>>Sort Image (Object-S)
---------------------
Sorts the display by increasing values.
>>Commit (Object-Return)
----------------------
Makes permanent any changes made to the image in
the current window.
>>SEE ALSO
--------
Rational Access User's Guide
Appendix D, Access Equivalents: Key Bindings
Editing Specific Types (EST) book of the Environment
Reference Manual
package Common.Object
#Region Operations
Region operations are a kind of item operation. Item
operation refers to particular key combinations that
consist of a special kind of key, called an item key
(in this case, [Region]), followed by another key
indicating the operation to be performed on that
item.
Region operations allow you to make and manipulate
Environment selections. To make a selection with the
Region operations, indicate the beginning with the
Start command, and then move the cursor to the end
and indicate it with the Finish command. The
Rational Editor highlights the selection in a
different font. It highlights only one selection at
a time. You can use the Off and On commands to
unselect and reselect a selection.
The locations of selections of text can be stored
in the hold stack. See below for hold stack
operations.
From the Region Operations dialog box, you can
execute a particular operation either by clicking on
the operation to be performed or pressing the key
corresponding to the underlined character in the
operation's label. Region operations can also be
performed by pressing [Control][F2] and then
pressing the key corresponding to the desired
operation.
Region operations are available on all Rational
interfaces, including Access, although many Access
commands offer alternatives to the item-operation
technique. Access equivalents for most Region
operations are found on the Edit menu.
>>Beginning (Region-B)
--------------------
Moves the cursor to the beginning of the current
selection,
>>End (Region-E)
--------------
Moves the cursor to the end of the current
selection.
>>Capitalize (Region-6)
---------------------
Capitalizes the first letter in each of the words
in the selection.
>>Start (Region-[)
----------------
Marks the start of a selection.
>>Finish (Region-])
-----------------
Marks the endpoint of a selection and highlights
the selection.
>>Comment (Region- -)
-------------------
Puts comment characters (--) and a blank space
before the leftmost character of each line in the
current selection. If a line is already commented in
that selection, additional comment characters are
inserted in front of it.
>>Uncomment (Region-+)
--------------------
Removes comment characters (-- ) from lines in which
they are the leftmost three nonblank characters.
This command does not remove comments from the end
of lines containing Ada code.
>>Lowercase (Region-<)
--------------------
Converts all characters in the selection to
lowercase.
>>Uppercase (Region->)
--------------------
Converts all characters in the selection to
uppercase.
>>Copy (Region-C)
---------------
Copies the current selection to the cursor location.
The selection and the cursor can be in different
windows.
>>Move (Region-M)
---------------
Deletes the current selection and copies it to the
location of the Environment cursor.
>>Delete (Region-D)
-----------------
Deletes the current selection and pushes it onto
the hold stack.
>>Fill (Region-F)
---------------
Adjusts the placement of all words in the selection
to fill completely the column between the left edge
of the image and defined right margin. The right
margin is set by a session switch, but this can be
overridden for a single image using Edit:Typing
Modes and adjusting the Fill Column value.
The Fill command puts as many words as possible on
a line, but it leaves a ragged right margin.
By default, the Fill command does not compress
extra spaces after the period (.), exclamation mark
(!), and question mark (?) when filling an image.
However, this default can be changed by modifying
the Image_Fill_Extra_Space session switch. (See
"Session Switches" in the Session and Job
Management book (SJM) of the Environment Reference
Manual for more information on session switches.)
Also by default, the Fill command indents
subsequent lines to the indent level of the first
line of the region. However, this default can be
changed by modifying the Image_Fill_Indent session
switch. A value of -1 for this switch (the default)
specifies that the indentation of the first line of
the region should be used for subsequent lines.
Values greater than or equal to 0 indent the region
the number of spaces that is the value of the
switch.
>>Justify (Region-Q)
------------------
Adjusts the placement of all words in the selection
to justify the selection flush left between the
left edge of the image and the defined right
margin. The right margin is set by a session
switch, but this can be overridden for a single
image using Edit:Typing Modes and adjusting the
Fill Column value.
The Justify command puts as many words as possible
on a line and inserts spaces so that the right
margin is even.
By default, the Justify command does not compress
extra spaces after the period (.), exclamation mark
(!), and question mark (?) when filling an image.
However, this default can be changed by modifying
the Image_Fill_Extra_Space session switch. (See
"Session Switches" in the Session and Job
Management book (SJM) of the Environment Reference
Manual for more information on session switches.)
Also by default, the Justify command indents
subsequent lines to the indent level of the first
line of the region. However, this default can be
changed by modifying the Image_Fill_Indent session
switch. A value of -1 for this switch (the default)
specifies that the indentation of the first line of
the region should be used for subsequent lines.
Values greater than or equal to 0 indent the region
the number of spaces that is the value of the
switch.
>>Off (Region-X)
--------------
Unselects the current selection. The Environment
cursor and the selection may be in different
windows.
>>HOLD STACK OPERATIONS
---------------------
Package Hold_Stack provides a mechanism for
recovering deletions. The Rational Editor saves the
100 most recent deletions (larger that a single
character) in the hold stack. Deleted selections of
any size are also saved. Items in the stack can be
retrieved and inserted at the cursor with Top,
Next, or Previous commands.
An item retrieved from the hold stack is displayed
and treated as a selection.
>>Delete Top (Region-Delete)
--------------------------
Removes the top item from the hold stack. The item
next to the top of the hold stack becomes the top
item of the hold stack.
>>Push (Region-N)
---------------
Pushes the current selection onto the hold stack.
>>Previous (Region-H)
-------------------
Retrieves the previous item from the hold stack and
copies it at the current cursor location. At the top
of the stack, this command wraps to the bottom.
>>Top (Region-U)
--------------
Retrieves the top item in the hold stack, leaving
that item on the hold stack. The retrieved item is
copied at the current Environment cursor location.
>>Copy Top (Region-P)
-------------------
Copies the top item of the hold stack onto the top
of the hold stack. The result is that there are two
copies of the same item on top of the hold stack.
>>Next (Region-J)
---------------
Retrieves the next item from the hold stack and
copies it at the current Environment cursor
location. At the bottom of the stack, this command
wraps to the top.
>>Rotate (Region-R)
-----------------
Takes the item from the bottom of the stack and
places it on the top of the hold stack.
>>Swap (Region-T)
---------------
Swaps the top two items on the hold stack.
The item next to the top of the hold stack becomes
the top item of the hold stack. The original top
item becomes the item next to the top of the hold
stack.
>>SEE ALSO
--------
Rational Access User's Guide
Appendix D, Access Equivalents: Key Bindings
Editing Images (EI) book of the Environment Reference
Manual
package Editor.Hold_Stack
package Editor.Region
#Window Operations
Window operations are a kind of item operation. Item
operation refers to particular key combinations that
consist of a special kind of key, called an item key
(in this case, [Window]), followed by another key
indicating the operation to be performed on that
item.
Window operations provide facilities for managing
Environment windows and include a number of commands
that control Environment window size and
disposition.
From the Window Operations dialog box, you can
execute a particular operation either by clicking on
the operation to be performed or pressing the key
corresponding to the underlined character in the
operation's label. Window operations can also be
performed by pressing [Control][F3] and then
pressing the key corresponding to the desired
operation.
Window operations are available on all Rational
interfaces, including Access, although many Access
commands offer alternatives to the item-operation
technique. Access equivalents for most Window
operations are found on the Window Control Button
Panel.
>>Expand (Window-!)
-----------------
Enlarges the window by four lines, taking lines
from an adjacent frame or neighboring window.
>>Contract (Window->)
-------------------
Shrinks the current Environment window by four
lines, adding lines to an adjacent frame or
neighboring window.
>>Join (Window-J)
--------------
Expands the current Environment window to the size
of the current window plus the window frame below,
replacing any window that might have been in that
frame. Unless the window is locked, the window
frame returns to its normal size automatically when
the next object is viewed.
If your current window is at the bottom of the
Environment area, it will expand over the window
directly above.
>>Join Previous (Window-O)
------------------------
Expands the current Environment window to the size
of the current window plus the window frame above,
replacing any window that might have been in that
frame. Unless the window is locked, the window
frame returns to its normal size automatically when
the next object is viewed. If your current window
is at the top of the Environment area, it will
expand over the window directly below.
>>Beginning (Object-B)
--------------------
Moves the Environment cursor to the top line of the
image. Your view moves accordingly.
>>End (Object-E)
--------------
Moves the Environment cursor to the bottom line of
the image. Your view moves accordingly.
>>Copy (Window-C)
---------------
Divides the current Environment window into two
windows with identical images. Each image can be
scrolled independently. Making changes to one of
the images affects both of them.
>>Delete (Window-D)
-----------------
Removes a window temporarily from the Environment
area. The image contained in the window remains
listed in the Image Palette and the Environment
Window Directory.
>>Transpose (Window-T)
--------------------
Exchanges the current frame with another.
The cursor position that results depends on the
value of the Cursor_Transpose_Moves session switch.
If the value is True, the cursor is left in the
window that was the current window or, if no
windows are below it, the first window on the
screen below the message window. If the value is
False, the cursor is left in the window that
replaces the window that was the current window.
See "Session Switches" in the Session and Job
Management (SJM) book of the Environment Reference
Manual for more information on session switches.
>>Next (Window-N)
---------------
Moves the Environment cursor to the frame directly
below. From the bottom frame, the cursor wraps to
the top frame.
>>Previous (Window-U)
-------------------
Moves the Environment cursor to the frame directly
above. From the top frame, the cursor wraps to the
bottom frame.
>>Directory (Window-?)
--------------------
Displays a list of the currently active Environment
images.
This image, called the Window Directory, allows
various operations on these active images. See the
Editing Specific Types (EST) book of the
Environment Reference Manual for more information.
>>Enclosing Object (Window-H)
---------------------------
Displays the enclosing object in an Environment
window.
>>Parent (Window-Left Arrow)
--------------------------
Moves the Environment cursor to the previous window
in the current frame.
>>Child (Window-V)
----------------
Moves the Environment cursor to the next window in
the current frame.
>>Promote (Window-M)
------------------
Changes the current window to the next higher
state.
A window can be in one of three states (ordered
from highest to lowest):
* Frozen (banner symbol: @)
* Normal
* Replace (banner symbol: ~)
The Promote and Demote commands change the state of
a window to the next higher or lower level.
In the frozen state, the window will not be
replaced and will be split only if there is no
other space available for bringing up a new window.
In the normal state, the window can become eligible
for replacement if it becomes the least recently
visited window (in this case, it will automatically
be changed to the replace state). If it is in the
replace state, the window will be replaced the next
time the editor needs to bring a new window on the
screen (only one window can be in the replace
state).
>>Demote (Window-Y)
-----------------
Changes the state of the current window to the next
lower state (see "Promote," above, for a list of
states and their descriptions).
>>Format (Window-F)
-----------------
Divides the Environment area equally among the
current number of frames.
>>SEE ALSO
--------
Rational Access User's Guide
Appendix D, Access Equivalents: Key Bindings
Editing Images (EI) book of the Environment Reference
Manual
package Editor.Window
#Image Operations
Image operations are a kind of item operation. Item
operation refers to particular key combinations that
consist of a special kind of key, called an item key
(in this case, [Image]), followed by another key
indicating the operation to be performed on that
item.
Image operations allow you to find and scroll
images of Environment objects.
From the Image Operations dialog box, you can
execute a particular operation either by clicking on
the operation to be performed or pressing the key
corresponding to the underlined character in the
operation's label. Image operations can also be
performed by pressing [Control][F4] and then
pressing the key corresponding to the desired
operation.
Image operations are available on all Rational
interfaces, including Access, although many Access
commands offer alternatives to the item-operation
technique. Access equivalents for most Image
operations are found on the Window Control Button
Panel.
>>Beginning (Image-B)
-------------------
Moves the cursor to the beginning of the image.
>>End (Image-E)
-------------
Moves the cursor to the end of the image.
>>Fill On (Image-F)
-----------------
Turns on fill mode. Fill mode wraps long text lines
at the column position specified in the Fill Column
entry box in the Edit:Typing Modes menu command.
The default fill column is 72.
>>Fill Off (Image-X)
------------------
Turns off fill mode.
>>Left Scroll (Image-H)
---------------------
Scrolls your view of the image to the left, if the
left margin is not visible.
>>Rt Scroll (Image-J)
-------------------
Scrolls your view of the image to the right.
>>Up Scroll (Image-U)
-------------------
Scrolls your view of the image up.
>>Down Scroll (Image-N)
---------------------
Scrolls your view of the image down.
>>Insert On (Image-I)
-------------------
Turns on insert mode. This allows you insert text
when you type without writing over existing text.
>>Overwrite (Image-O)
-------------------
Turns on overwrite mode. This allows you to type
over existing text.
>>SEE ALSO
--------
Rational Access User's Guide
Appendix D, Access Equivalents: Key Bindings
Editing Images (EI) book of the Environment Reference
Manual
package Editor.Image
#Line Operations
Line operations are a kind of item operation. Item
operation refers to particular key combinations that
consist of a special kind of key, called an item key
(in this case, [Line]), followed by another key
indicating the operation to be performed on that
item.
Line operations allow you to manipulate lines in an
image. Except for the Delete, Center, and Copy
commands, editing operations affect the line
starting at the cursor. The Beginning, End, Delete,
Center, and Copy commands affect the entire line
regardless of where the cursor is on the line.
From the Line Operations dialog box, you can
execute a particular operation either by clicking on
the operation to be performed or pressing the key
corresponding to the underlined character in the
operation's label. Line operations can also be
performed by pressing [Control][F5] and then
pressing the key corresponding to the desired
operation.
Line operations are available on all Rational
interfaces, including Access, although many Access
commands offer alternatives to the item-operation
technique. Access equivalents for most Line
operations are bound to [Control][Meta] key
combinations.
>>Beginning (Line-B)
------------------
Moves the Environment cursor to the first nonblank
character in the line.
>>End (Line-E)
------------
Moves the Environment cursor to the first space
after the last nonblank character in the line.
>>Center (Line-$)
---------------
Centers from the first nonblank character on the
line to the last nonblank character on the line.
This command centers the nonblank characters of the
entire line between the first column and the
specified right margin as set in the fill column
entry box of the Edit:Typing Modes menu command.
The default is 72.
>>Lowercase (Line-<)
------------------
Converts the line to uppercase from the location of
the Environment cursor to the end of the line.
>>Uppercase (Line->)
------------------
Converts the line to lowercase from the location of
the Environment cursor to the end of the line.
>>Capitalize (Line-^)
-------------------
Capitalizes the first letter of every word in the
line, starting with the word that the Environment
cursor is on.
>>Join (Line-J)
-------------
Joins the next line to the current line, leaving
the cursor on the first character that came from
the line below.
>>Transpose (Line-T)
------------------
Exchanges the current and previous lines.
>>Open (Line-O)
-------------
Opens a new line. If the Environment cursor is in
the middle of a line, it moves the portion after
the cursor to a new line below.
>>Copy (Line-C)
-------------
Copies the current line and places the new copy
immediately below the current line, pushing all
remaining lines down in the image.
>>Insert (Line-I)
---------------
Inserts a new line before the current line and
indents to the previous indentation.
>>What Line (Line-?)
------------------
Displays in the message window the line and column
number of the location of the Environment cursor.
>>Delete Bwd (Line-Delete)
------------------------
Deletes from the Environment cursor back to the
left margin.
>>Delete Fwd (Line-K)
-------------------
Deletes from the Environment cursor to the end of
the line.
>>Delete (Line-D)
---------------
Deletes the entire line the Environment cursor is
on.
>>SEE ALSO
--------
Rational Access User's Guide
Appendix D, Access Equivalents: Key Bindings
Editing Images (EI) book of the Environment Reference
Manual
package Editor.Line
#Word Operations
Word operations are a kind of item operation. Item
operation refers to particular key combinations that
consist of a special kind of key, called an item key
(in this case, [Word]), followed by another key
indicating the operation to be performed on that
item.
Word operations allow you to manipulate strings of
characters separated by word delimiters. The
default includes blank and Ada delimiters.
Except for the Delete command, which erases an
entire word, the editing and movement commands
affect the next, previous, or current word from the
cursor forward to the next end word or from the
cursor back to the previous beginning of word.
From the Word Operations dialog box, you can
execute a particular operation either by clicking on
the operation to be performed or pressing the key
corresponding to the underlined character in the
operation's label. Word operations can also be
performed by pressing [Control][F6] and then
pressing the key corresponding to the desired
operation.
Word operations are available on all Rational
interfaces, including Access, although many Access
commands offer alternatives to the item-operation
technique. Access equivalents for most Word
operations are bound to [Meta] key combinations.
>>Beginning (Word-B)
------------------
Moves the Environment cursor to the first character
of the current word.
>>End (Word-E)
------------
Moves the Environment cursor to the last character
in the current word.
>>Transpose (Word-T)
------------------
Exchanges the word the Environment cursor is on
with the previous word.
>>Exchange (Word-X)
-----------------
Replaces the misspelled word the Environment cursor
is on with the first replacement choice in the
Environment dictionary.
>>Lowercase (Word-<)
------------------
Converts the word the Environment cursor is on to
lowercase.
>>Uppercase (Word->)
------------------
Converts the word the Environment cursor is on to
uppercase.
>>Capitalize (Word-6)
-------------------
Capitalizes the first letter of the word the
Environment cursor is on.
>>Next Word (Word-J)
------------------
Moves the Environment cursor to the next word.
>>Delete Fwd (Word-D)
--------------------
Deletes the current word from the Environment
cursor forward.
>>Delete (Word-D)
---------------
Deletes the word the Environment cursor is on.
>>Del Bwd (Word-Delete)
---------------------
Deletes the word from the Environment cursor
backwards.
>>Spell Chk (Word-?)
------------------
Checks the word for spelling using the Environment
dictionary. If the Environment cannot find the word
in the dictionary, it displays alternatives in the
message window and underlines the misspelled word.
>>Add Dict (Word-I)
-----------------
Adds the word the Environment cursor is on into the
Environment dictionary. If the word is
spell-checked again, no error will register.
>>Chk Image (Word-M)
------------------
Checks the image for misspelled words. All
suspicious spellings are underlined.
>>Nxt Spell (Word-N)
------------------
Moves the Environment cursor to the next underlined
suspicious spelling and displays alternatives in
the message window.
>>Learn (Word-R)
--------------
Trains the spelling checker to correct the current
spelling error automatically.
>>Spell Win (Word-W)
------------------
Displays the speller options window, which contains
status information about the spelling checker.
>>SEE ALSO
--------
Rational Access User's Guide
Appendix D, Access Equivalents: Key Bindings
Editing Images (EI) book of the Environment Reference
Manual
package Editor.Word
#Mark Operations
Mark operations are a kind of item operation. Item
operation refers to particular key combinations that
consist of a special kind of key, called an item key
(in this case, [Mark]), followed by another key
indicating the operation to be performed on that
item.
A mark is a remembered image position. The Rational
Editor remembers marks as absolute image positions
on one quadrant of a plane. Mark positions do not
change to adjust for inserted or deleted lines and
characters; the position is relative to the
beginning of the image, not specific characters.
The mark stack holds up to 100 marks. Since there
is only one mark stack for all images, marks can be
used to move your Environment cursor from image to
image as well as from point to point within an
image. Your view of the image moves accordingly, or
the undisplayed image appears in an Environment
window.
Mark operations also manage keyboard macros,
allowing you to create, bind, and execute macros
that execute series of keystrokes in a single
keystroke.
From the Mark Operations dialog box, you can
execute a particular operation either by clicking on
the operation to be performed or pressing the key
corresponding to the underlined character in the
operation's label. Mark operations can also be
performed by pressing [Control][F7] and then
pressing the key corresponding to the desired
operation.
Mark operations are available on all Rational
interfaces, including Access, although many Access
commands offer alternatives to the item-operation
technique. Access equivalents for Mark operations
that manage macros are found on the Tools:Macro
menu.
>>Mark Next (Mark-J)
------------------
Moves the Environment cursor to the position
specified by the next mark closest to the bottom of
the stack.
At the bottom of the stack, this command wraps to the top.
>>Mark Previous (Mark-H)
----------------------
Moves the Environment cursor to the position
specified by the next mark closest to the top of
the stack.
At the top of the stack, this command wraps to the
bottom.
>>Mark Push (Mark-N)
--------------------
Sets a repeat mark at the cursor and pushes it onto
the stack.
>>Rotate (Mark-R)
---------------
Rotates repeat number of marks from the bottom of
the stack to the top of the stack.
>>Swap (Mark-T)
-------------
Swaps the top two marks on the mark stack.
>>Top (Mark-U)
------------
Moves the Environment cursor to the top of the
stack.
>>Delete Top (Mark-Delete)
------------------------
Deletes the top item in the mark stack.
>>Copy Top (Mark-P)
-----------------
Makes another copy of the top mark of the mark
stack on the top of the mark stack. The result is
that there are two copies of the top item on the
top of the mark stack.
>>Macro Start (Mark-A)
--------------------
Prompts you to enter the key sequence that you want
to make into a macro.
>>Macro End (Mark-E)
------------------
Ends the key sequence that will become a macro.
>>Macro Bind (Mark-F)
-------------------
Prompts you to press the key that the macro will be
bound to.
>>Macro Execute (Mark-X)
----------------------
Executes the most recently created macro.
>>SEE ALSO
--------
Rational Access User's Guide
Appendix D, Access Equivalents: Key Bindings
Editing Images (EI) book of the Environment Reference
Manual
package Editor.Macro
package Editor.Mark
#Image Palette
The Rational Access Image Palette provides an
updatable listing of the images open under your
Environment session. The Image Palette gives you the
ability to list all the current images, including
those that are not currently displayed in an
Environment window, and the ability to recall any of
these images to the Environment area.
To open the Image Palette, click the Show Image
Palette window-control button. (The button resembles
stacked sheets of paper and is to the left of the F?
button.)
>>Parts of the Image Palette
--------------------------
The top panel of the palette--the button
panel--contains buttons which control the palette.
The Refresh button must be pressed every time you
want to update the Image Palette to include new
images brought up in the Environment area. (The
Image Palette is not kept current automatically.)
The middle panel--the user area--contains a
user-defined list of Environment windows that can
be recalled to the associated main Access window.
You can keep a list of important images in the user
area by using the Add and Remove buttons.
The bottom panel--the full image list--contains a
list of the Environment windows that are on the
associated main Access window or have been replaced
by other windows but not closed. You can change the
relative size of the bottom two panels by placing
the pointer on the sash control and dragging it up
or down.
>>Working in the Image Palette
-----------------------------
In the Image Palette:
* To search through the full image list, use
the scroll bar or search for a specific image
using the search box and search arrows.
* To redisplay a listed image, double-click the
entry in the image list.
* To manually search through the image list, drag
the scroll bars.
* To search for a specific image in the list, enter
a character string in the search box, using
wildcards if desired, and direct the search with
the search arrows.
* To add an image from the image list into the user
area, click the image name (highlight it), and
click the Add button.
* To remove an image from the user area, click the
image and click the Remove button.
* To update the Image Palette, click the Refresh
button.
* To close the Image Palette, click its Remove
Window button. (This button is located in the top,
right corner of the palette and looks like four
arrows pointing inwards.)
>>SEE ALSO
--------
Rational Access User's Guide
Chapter 3, Using Special Features
#Just-Do-It Mode
You can suppress the dialog box for certain
commands. This is especially useful if you execute
the command with the same dialog box settings many
times in a row, or if you use the default settings.
Users who wish to bypass a dialog box when
executing a menu operation can use the Just-Do-It
mode, which executes the command without displaying
the dialog box.
To execute with Just-Do-It mode, press the [Meta]
key while executing the command. The Environment
completes the command using the default settings in
the dialog box.
You can change the default settings of a dialog box
by setting the new options in the box and executing
the command or pressing the Cancel button. The next
time you execute the command with Just-Do-It mode,
it will execute using the new default options.
Note that this mode has no effect on most menu
commands. The following commands, however, can be
executed with Just-Do-It mode:
* File:Print
* CMVC:Accept Changes
* Program:Promote To Coded
* Program:Promote To Installed
* Program:Promote To Source
* Program:Demote To Installed
* Program:Demote To Source
* Program:Demote To Archived
>>SEE ALSO
--------
Rational Access User's Guide
Chapter 3, Using Special Features