Skip to content
Matthew edited this page Mar 28, 2025 · 1 revision

Welcome to the Quail wiki! Feel free to issue changes to the wiki.

Flow of Configuration files

A fresh installation of Quail will produce 2 files for your use:

  • config.txt
  • global.txt

Global files are always read, but when it comes to config files only the project defining config and all of its includes are read. Thus I recommend to use global files only for specifying constants with local paths to software. So that you can keep your project files without any user machine dependant hassle.

General Rules

Quail configuration files are read from top to bottom. Therefore it is recommended to stick to the following order:

(Otherwise program will struggle to find matching keys. This however might be intended.)

  1. Includes
  2. Constants
  3. Projects
  4. Commands
  5. Queues

You can use spaces, tabs, new lines as you want, but each definition must be preceded by a new line.

Syntax

  • Inlude &(relative_filename)

  • Constant %(key) = (value)

  • Absolute_project ^+(project_name) = (absolute_project_dir) (project_quail_file_location)

  • Relative_project ^-(project_name) = (relative_project_dir) (project_quail_file_location)

  • Command !(key) = (value)

  • Queue |(key) = (key_command),(key_command)

Constants can be used in other (new) constants, projects & commands inside their value syntax. The key itself cannot be changed.

To encapsulate a constant inside an alias simply write the following inside the value field of said alias: %constant_key%. During read quail will encapsulate value of used constant into the value field of an alias. A constant itself might use different constants.

Clone this wiki locally