<commit_before>clicraft.conf(5)
================

Name
----
clicraft.conf - clicraft server wrapper configuration file

Synopsis
--------
$CLICRAFT_CONFIG/clicraft.conf

Description
-----------
Clicraft's main configuration file is +clicraft.conf+, which is stored in a
directory referred to as +$CLICRAFT_CONFIG+. This directory can be specified
through several different methods. In order of preference:

* The argument to the +--config+ command line option
* The +$CLICRAFT_CONFIG+ environment variable
* +$XDG_CONFIG_HOME/foo+, where 'foo' is how clicraft was invoked
* +$XDG_CONFIG_HOME/clicraft+
* +{CONFDIR}+

If +$XDG_CONFIG_HOME+ is not set in your environment, clicraft uses
+~/.config+ instead. Clicraft searches the directories above and uses the
first one it finds for +$CLICRAFT_CONFIG+. If +$CLICRAFT_CONFIG+ is empty and
was not given by the +--config+ option or +$CLICRAFT_CONFIG+ environment
variable, clicraft populates it with default config files from +{CONFDIR}+.

The format for +clicraft.conf+ is bash, so configuration options take the form
+OPTION="value"+ (with no whitespace on either side of the equals sign (`=`)).

This file is sourced from within clicraft before the default values are set,
so you must take care to initialize any options that another option depends
on. For example, if you set `SERVER_JAR=$SERVER_DIR/custom_server.jar` without
setting +SERVER_DIR+ first, clicraft will look for +/custom_server.jar+, which
is probably not what you want.

An example default file is located at +$CLICRAFT_CONFIG/clicraft-defaults.conf+. It
is fairly well-commented, so it may be easiest to simply copy it to
+$CLICRAFT_CONFIG/clicraft.conf+ and follow the directions inside for customization.

Options
-------<commit_msg>Fix CLICRAFT_CONFIG documentation<commit_after>clicraft.conf(5)
================

Name
----
clicraft.conf - clicraft server wrapper configuration file

Synopsis
--------
$CLICRAFT_CONFIG/clicraft.conf

Description
-----------
Clicraft's main configuration file is +clicraft.conf+, which is stored in a
directory referred to as +$CLICRAFT_CONFIG+. This directory can be specified
through several different methods. In order of preference:

* The argument to the +--config+ command line option
* The +$CLICRAFT_CONFIG+ environment variable
* +$XDG_CONFIG_HOME/foo+, where 'foo' is how clicraft was invoked
* +$XDG_CONFIG_HOME/clicraft+
* +{CONFDIR}+

If +$XDG_CONFIG_HOME+ is not set in your environment, clicraft uses
+~/.config+ instead. Clicraft searches the directories above and uses the
first one it finds for +$CLICRAFT_CONFIG+. If the +$CLICRAFT_CONFIG+ directory
is empty, clicraft populates it with default config files from +{CONFDIR}+.

The format for +clicraft.conf+ is bash, so configuration options take the form
+OPTION="value"+ (with no whitespace on either side of the equals sign (`=`)).

This file is sourced from within clicraft before the default values are set,
so you must take care to initialize any options that another option depends
on. For example, if you set `SERVER_JAR=$SERVER_DIR/custom_server.jar` without
setting +SERVER_DIR+ first, clicraft will look for +/custom_server.jar+, which
is probably not what you want.

An example default file is located at +$CLICRAFT_CONFIG/clicraft-defaults.conf+. It
is fairly well-commented, so it may be easiest to simply copy it to
+$CLICRAFT_CONFIG/clicraft.conf+ and follow the directions inside for customization.

Options
-------
{'fraction_non_alphanumeric': 0.09924768518518519, 'fraction_numerical': 0.0005787037037037037, 'mean_word_length': 4.829679595278246, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1037104', 'n_tokens_mistral': 1030, 'n_tokens_neox': 982, 'n_words': 424}