SYNTAX

CheckOutDir [directory | -x] [-project project | -m] [-r]

DESCRIPTION

The CheckOutDir command allows you to set or display the checkout directory associated with a project. If you specify the directory parameter, CheckOutDir sets the checkout directory for the current project to the HFS pathname directory. If the directory does not already exist, Projector creates it.

If you omit directory, CheckOutDir displays the checkout directory for the current project. (To set or display the checkout directory for a different project--not the current project--you must specify the -project option.)

Projector normally sets a project's checkout directory to the current directory when it is initially mounted; however, CheckOutDir allows you to override this, enabling you to check files out into any directory. When you change a project's checkout directory, the new checkout directory becomes the default.

It is recommended that you place CheckOutDir commands immediately after the corresponding MountProject commands used for project initialization. Since these commands do not persist beyond the current MPW session, you might want to place them in one of your UserStartup•name files so that they are executed every time you launch MPW.

INPUT

None

OUTPUT

None, unless you omit the directory parameter. In this case, Projector displays the current checkout directory (or the directory specified by -project) in the form of a CheckOutDir command.

The resulting CheckOutDir command displays both the project and the checkout directory. For example, by omitting directory, the command line

CheckOutDir -project Moof

produces

CheckOutDir -project Moof Bovine:

To display only the root projects, you can omit the directory parameter and specify the -m option. To display all projects recursively, you can omit the directory parameter and specify the -r option.

STATUS

CheckOutDir can return the following status codes:

PARAMETERS

directory

Specifies by HFS pathname the checkout directory for the current project.

OPTIONS

-m

Lists the checkout directories for all mounted root projects.

-project project

Identifies the project with which to associate the checkout directory. This overrides the default project to become the current project for this command.

-r

Sets or lists checkout directories for the current project recursively.

-x

Makes the checkout directory dynamic by setting it to the value of the current directory at the time of the checkout. Note that this option provides an alternative to setting the checkout directory with the directory parameter; you cannot use both.

EXAMPLES

The following command line sets the checkout directory of the current project to {MPW}Projects:. Subsequently any files checked out of this project are automatically placed in this directory.

CheckOutDir "{MPW}Projects:"

Using -x, the following command line sets the checkout directory of the current project to the value of the current directory at the time of the checkout. This means that the checkout directory is always " : ".

CheckOutDir -x

Notice, however, that this command line is not equivalent to

CheckOutDir :

In the latter case, the checkout directory is static. The command sets the checkout directory to the value of the current directory at the time the CheckOutDir command is executed.

By omitting all parameters and options, the command line

CheckOutDir

writes the checkout directory and current project in the form of a CheckOutDir command such as the following:

CheckOutDir -project Project∫Apps HD:MPW:Projects

The CheckOutDir command above displays only a single project, ProjectApps; however, using -r (recursive) in the command line

CheckOutDir -project Project∫ -r

lets you display the checkout directory for the current project and all its subprojects:

CheckOutDir -project Project∫ :
CheckOutDir -project Project∫Apps HD:MPW:Projects
CheckOutDir -project Project∫Tools :

You can also use -r to set the checkout directories of a complex project to mirror the project's own hierarchical structure. For example,

CheckOutDir HD:MPW: -project Project∫ -r

yields the following list of checkout directories. Notice how the directory structure resembles the project structure.

CheckOutDir -project Project∫ -r
CheckOutDir -project Project∫ HD:MPW:
CheckOutDir -project Project∫Apps HD:MPW:Apps
CheckOutDir -project Project∫Tools HD:MPW:Tools
CheckOutDir -project Project∫Tools∫Test HD:MPW:Tools:Test

SEE ALSO

CheckIn

CheckOut

MountProject