tcl-quill 0.3.0: Quill Project Automation System for Tcl/Tk

config(5): Quill Configuration File Syntax

SYNOPSIS
DESCRIPTION
Location
Editing
Syntax
PARAMETERS
AUTHOR

SYNOPSIS

helper.*
helper.tclsh
helper.teacup
helper.tkcon
helper.tclapp
helper.basekit.tcl
helper.basekit.tk

DESCRIPTION

The Quill configuration file contains parameters used to configure Quill for the user's development environment. The default settings should be appropriate for most users.

Location

The Quill configuration file is located in the user's home directory at "~/.quill/quill.config". NOTE: at some point, quill.config might move to a more appropriate location on Windows systems.

Editing

It is possible to edit the Quill configuration file by hand, in a text file; see Syntax, below. It is more typical to use the quill config tool; see

$ quill help config
for details.

Syntax

The configuration file is a parmset(n) file, and so its syntax is very simple. It consists of a sequence of zero or more parm commands:
parm name value
where name is the name of a configuration parameter, and value is the value.

When changes are made using the quill config tool, only parameters with non-default values are saved.

Note that Quill ignores any errors in this file.

PARAMETERS

The following statements may appear in quill.config.

helper.*
The helper.* parameters tell Quill where to find certain helper applications. Quill can usually find them on its own, but this allows for unusual environments or for use of multiple versions of Tcl on one machine.

helper.tclsh
The full path to the default Tcl shell application. If unset (the default), Quill will look for tclsh on the PATH. Development cannot proceed until tclsh is identified one way or another.

helper.teacup
The full path to the ActiveTcl teacup application. If unset (the default), Quill will look for teacup on the PATH. If the teacup is not identified, Quill will not be able to acquire and manage external dependencies.

helper.tkcon
The full path to the TKcon console application. If unset (the default), Quill will look for tkcon on the PATH. If the TKcon application is not identified, Quill will not be able to support the quill shell tool.

helper.tclapp
The full path to the TclDevKit tclapp application. If unset (the default), Quill will look for tclapp on the PATH. If the tclapp application is not identified, Quill will not be able to build applications for installation and deployment. Note: I hope to relax this constraint in the future.

helper.basekit.tcl
The full path to the ActiveTcl console-mode "basekit", a stub Tcl shell used when building standalone console applications. If unset (the default), Quill will look for the basekit in a manner appropriate for the platform. If the basekit is not identified, Quill will not be able to build non-GUI console applications as standalone executables.

helper.basekit.tk
The full path to the ActiveTcl GUI-mode "basekit", a stub Tcl/Tk shell used when building standalone GUI applications. If unset (the default), Quill will look for the basekit in a manner appropriate for the platform. If the basekit is not identified, Quill will not be able to build GUI applications as standalone executables.

AUTHOR

Will Duquette.


Generated from config.manpage on Sat Nov 08 09:38:04 PST 2014