OpenSolaris Distribution Constructor Guide
Previous Next

distro_const Command Reference

The following table summarizes the distro_const command options.

Table 3-3 distro_const Command

Command Options

Description

distro_const build manifest

Creates a full image, using the specified manifest file as the blueprint for that image. The subcommand build is required. The manifest field is required.

distro_const build [-l] manifest

Lists valid steps at which the user can choose to pause or resume building an image if checkpointing is active. This command option queries the manifest file for valid steps. Use the step names provided by this command as valid values for the other checkpointing command options. The build subcommand is required. The manifest field is required.


Note - Checkpointing is active by default, but requires ZFS filesystems.

Step values other than the first value correspond to finalizer script entries in the manifest file.


For example, the manifest, slim_cd/all_lang_slim_cd_x86.xml, includes the following steps:

  • im-pop – Populate the image with packages

  • im-mod – Image area modifications

  • slim-im-mod – Slim CD image area modifications

  • br-init – Boot-root initialization

  • slim-br-config – Slim CD boot-root configuration

  • br-config – Boot-root configuration

  • br-arch – Boot-root archiving

  • slim-post-mod – Slim CD post-boot-root image area modifications

  • grub-setup – GRUB menu setup

  • post-mod – Post-boot-root image area modification

  • gen-slim-cont – Generate Slim CD image content list

  • iso – ISO image creation

When additional scripts are added, additional default checkpoint steps are added in the manifest file.


Note - You can edit the checkpoint step names in the manifest file. Use meaningful names for custom checkpoint steps in the manifest file instead of using step numbers. If new scripts are added, the new steps for those new scripts will disrupt a prior numbered step order.

For example, the following reference in a manifest file specifies the checkpoint name of “br-arch” for a boot root archiving script:

<script name="/usr/share/distro_const/bootroot_archive.py">
<checkpoint name="br-arch" message="Boot root archiving"/>

In this example, when you build your image, you could refer to the “br-arch” checkpoint in the distro_const command. This checkpoint would enable you to pause building the image just before the boot root archiving script performs its task.


distro_const build [-p step] manifest

Builds an image and pauses building the image at the specified step if checkpointing is active. The step and manifest fields are required. The build subcommand is required.

distro_const build [-r step] manifest

Resumes building the image from the specified step if checkpointing is active. The specified step must be either the step at which the previous build stopped executing, or an earlier step. A later step is not valid. The step and manifest fields are required. The build subcommand is required.

distro_const build [-R] manifest

Resumes building the image from the last step executed if checkpointing is active. The manifest field is required. The build subcommand is required.

See also the distro_const(1M) man page.

Previous Next