Name

configfile — Declare a file that must be configured by the user.

Description

A package may contain configuration files for the packaged software. These files will be configured from the GUI by the user. The configfile will contain several sub tags, which define tokens that will be replaced in the file.

Attributes

  • packagefile (required) - The name of the file as it is contained in the package.

  • remotefile (required) - The name of the file as it should be on the remote system. This can be a relative pathname (ex. src/file.conf).

  • description (optional) - A description of the file's purpose or conventions.

  • forceConfigure (optional) - If forceConfigure="true" the user will be required to edit the file, even if they are not in Advanced Mode in the ReST application. If forceCongfigure is not declated or forceConfigure="false" the defaults will be used for all substitutions.

Parents

The following elements are valid parents of configfile: header.

Children

The following elements are children of configfile: sub.

Example

Example 12. Configfile XML Example

<configfile packagefile="server_config" 
                remotefile="NetSolve-2.0/server_config"
                description="NetSolve Server Configuration File">
  <sub name="nproc" description="Number of processors"
       default="2" type="string"/>
  <sub name="agent" description="The NetSolve Agent hostname"
       default="netsolve.cs.utk.edu" type="string"/>
  <sub name="scratch" description="Scratch Directory"
       default="/tmp/" type="string"/>
  <sub name="mpihosts" description="Number of MPI Hosts"
       default="4" type="string"/>
  <sub name="workloadmax" description="Maximum allowable workload"
       default="-1" type="string"/>
</configfile>

Example 13. Sample Configuration File Stub

@PROC:%nproc%
@AGENT:%agent%
@WORKLOADMAX:%workloadmax%
@SCRATCH:%scratch%
@MPIHOSTS ./MPImachines %mpihosts%