Janet 1.37.1-83e8aab Documentation
(Other Versions: 1.36.0 1.35.0 1.34.0 1.31.0 1.29.1 1.28.0 1.27.0 1.26.0 1.25.1 1.24.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.1 1.17.1 1.16.1 1.15.0 1.13.1 1.12.2 1.11.1 1.10.1 1.9.1 1.8.1 1.7.0 1.6.0 1.5.1 1.5.0 1.4.0 1.3.1 )

Config

Commands Configuration Generation

Index

config/builtin-configs config/config-checkers config/config-docs config/config-options config/config-parsers config/config-set config/defconf config/dyn:ar config/dyn:auto-shebang config/dyn:binpath config/dyn:build-type config/dyn:buildpath config/dyn:c++ config/dyn:c++-link config/dyn:cc config/dyn:cc-link config/dyn:cflags config/dyn:cflags-verbose config/dyn:config-file config/dyn:cppflags config/dyn:curlpath config/dyn:dest-dir config/dyn:dynamic-cflags config/dyn:dynamic-lflags config/dyn:gitpath config/dyn:headerpath config/dyn:is-msvc config/dyn:janet config/dyn:janet-cflags config/dyn:janet-importlib config/dyn:janet-lflags config/dyn:ldflags config/dyn:lflags config/dyn:libpath config/dyn:local config/dyn:manpath config/dyn:modext config/dyn:modpath config/dyn:nocolor config/dyn:offline config/dyn:optimize config/dyn:pkglist config/dyn:silent config/dyn:statext config/dyn:tarpath config/dyn:test config/dyn:tree config/dyn:update-pkgs config/dyn:use-batch-shell config/dyn:verbose config/dyn:workers config/load-config config/load-config-file config/load-default config/load-options config/opt config/read-env-variables config/save-config config/shorthand-mapping

config/builtin-configs table source 
Table of all built-in options, as opposed to project deifned options.
config/config-checkers table source 
A table of all of the dynamic config bindings to checkers (validators).
config/config-docs table source 
Table of all of the help text for each config option.
config/config-options table source 
A table of possible options for enum option types.
config/config-parsers table source 
A table of all of the dynamic config bindings to parsers.
config/config-set table source 
Listing of all config dyns.
config/defconf macro source 
(defconf kw &opt parser docs options)

Define a function that wraps (dyn :keyword). This will allow use of dynamic bindings with static runtime checks.
config/dyn:ar function source 
(dyn:ar &opt dflt)
config/dyn:auto-shebang function source 
(dyn:auto-shebang &opt dflt)
config/dyn:binpath function source 
(dyn:binpath &opt dflt)
config/dyn:build-type function source 
(dyn:build-type &opt dflt)
config/dyn:buildpath function source 
(dyn:buildpath &opt dflt)
config/dyn:c++ function source 
(dyn:c++ &opt dflt)
config/dyn:c++-link function source 
(dyn:c++-link &opt dflt)
config/dyn:cc function source 
(dyn:cc &opt dflt)
config/dyn:cc-link function source 
(dyn:cc-link &opt dflt)
config/dyn:cflags function source 
(dyn:cflags &opt dflt)
config/dyn:cflags-verbose function source 
(dyn:cflags-verbose &opt dflt)
config/dyn:config-file function source 
(dyn:config-file &opt dflt)
config/dyn:cppflags function source 
(dyn:cppflags &opt dflt)
config/dyn:curlpath function source 
(dyn:curlpath &opt dflt)
config/dyn:dest-dir function source 
(dyn:dest-dir &opt dflt)
config/dyn:dynamic-cflags function source 
(dyn:dynamic-cflags &opt dflt)
config/dyn:dynamic-lflags function source 
(dyn:dynamic-lflags &opt dflt)
config/dyn:gitpath function source 
(dyn:gitpath &opt dflt)
config/dyn:headerpath function source 
(dyn:headerpath &opt dflt)
config/dyn:is-msvc function source 
(dyn:is-msvc &opt dflt)
config/dyn:janet function source 
(dyn:janet &opt dflt)
config/dyn:janet-cflags function source 
(dyn:janet-cflags &opt dflt)
config/dyn:janet-importlib function source 
(dyn:janet-importlib &opt dflt)
config/dyn:janet-lflags function source 
(dyn:janet-lflags &opt dflt)
config/dyn:ldflags function source 
(dyn:ldflags &opt dflt)
config/dyn:lflags function source 
(dyn:lflags &opt dflt)
config/dyn:libpath function source 
(dyn:libpath &opt dflt)
config/dyn:local function source 
(dyn:local &opt dflt)
config/dyn:manpath function source 
(dyn:manpath &opt dflt)
config/dyn:modext function source 
(dyn:modext &opt dflt)
config/dyn:modpath function source 
(dyn:modpath &opt dflt)
config/dyn:nocolor function source 
(dyn:nocolor &opt dflt)
config/dyn:offline function source 
(dyn:offline &opt dflt)
config/dyn:optimize function source 
(dyn:optimize &opt dflt)
config/dyn:pkglist function source 
(dyn:pkglist &opt dflt)
config/dyn:silent function source 
(dyn:silent &opt dflt)
config/dyn:statext function source 
(dyn:statext &opt dflt)
config/dyn:tarpath function source 
(dyn:tarpath &opt dflt)
config/dyn:test function source 
(dyn:test &opt dflt)
config/dyn:tree function source 
(dyn:tree &opt dflt)
config/dyn:update-pkgs function source 
(dyn:update-pkgs &opt dflt)
config/dyn:use-batch-shell function source 
(dyn:use-batch-shell &opt dflt)
config/dyn:verbose function source 
(dyn:verbose &opt dflt)
config/dyn:workers function source 
(dyn:workers &opt dflt)
config/load-config function source 
(load-config settings &opt override)

Load a configuration from a table or struct.
config/load-config-file function source 
(load-config-file path &opt override)

Load a configuration from a file. If override is set, will override already set values. Otherwise will prefer the current value over the settings from the config file.
config/load-default function source 
(load-default &opt override)

Load the default configuration.
config/load-options function source 
(load-options &opt path)

Load a file that contains config options that can be set. If no such file exists, then do nothing.
config/opt function source 
(opt opts key &opt dflt)

Get an option, allowing overrides via dynamic bindings AND some default value dflt if no dynamic binding is set.
config/read-env-variables function source 
(read-env-variables)

Read environment variables that correspond to config variables into dyns.
config/save-config function source 
(save-config path)

Write the current configuration information to a file.
config/shorthand-mapping struct source 
Map some single characters to long options.
Commands Configuration Generation