Configuration

Grascii provides a user-level configuration file to set the defaults for its tools.

Getting Started

Create a configuration file with the following command:

$ grascii config init <preset>

where <preset> is one of:

  • preanniversary: Uses the :preanniversary and :preanniversary-phrases dictionaries for search

  • anniversary: Uses the :anniversary dictionary for search

Locate the file with:

$ grascii config path

Editing the Configuration

To change the defaults, open the generated configuration file and make your desired changes. The available options are described in the starter file:

# This is a starter configuration file for Grascii.
# This configuration currently contains the built-in defaults.
# Any relative paths specified in this file are resolved relative
# to the current working directory at runtime.

[Search]
# The dictionaries that Grascii Search uses by default.
# The value can be either the name of an installed dictionary prefixed with ':'
# or a path to a built dictionary.
# Multiple dictionaries may be listed separated by whitespace
Dictionary = :preanniversary :preanniversary-phrases
# The Uncertainty level that Grascii Search uses when not specified.
# Values: 0-2
Uncertainty = 0
# The Search mode that Grascii Search uses when not specified.
# one of: match, start, contain
SearchMode = match
# The Annotation mode that Grascii Search uses when not specified.
# one of: discard, retain, strict
AnnotationMode = discard
# The Aspirate mode that Grascii Search uses when not specified.
# one of: discard, retain, strict
AspirateMode = discard
# The Disjoiner mode that Grascii Search uses when not specified.
# one of: discard, retain, strict
DisjoinerMode = strict
# How an interpretation(s) is chosen to be used for a search
# when the given Grascii string is ambiguous.
# one of: best, all
Interpretation = best