<commit_before>Configuring
===========

You'll need to configure Todoman before the first usage. Required values are a
path where your todos are stored and the date format you prefer.


The configuration file should be placed in
``$XDG_CONFIG_DIR/todoman/todoman.conf``. ``$XDG_CONFIG_DIR`` defaults to
``~/.config`` is most situations.

The below example should serve as a reference.

Sample configuration
--------------------

.. literalinclude:: ../todoman.conf.sample
  :language: ini

Color and displayname
---------------------

- You can set a color for each task list by creating a ``color`` file containing
  a colorcode in the format ``#RRGGBB``.
- A file named ``displayname`` decides how the task list should be named. The
  default is the directory name.

See also `this discussion about metadata for collections in
vdirsyncer <https://github.com/untitaker/vdirsyncer/issues/125>`_.<commit_msg>Properly document the configuration file<commit_after>Configuring
===========

You'll need to configure Todoman before the first usage, using its simple
ini-like configuration file.

Configuration File
------------------

The configuration file should be placed in
``$XDG_CONFIG_DIR/todoman/todoman.conf``. ``$XDG_CONFIG_DIR`` defaults to
``~/.config`` is most situations, so this will generally be
``~/.config/todoman/todoman.conf``.

Main section
~~~~~~~~~~~~

 * ``path``: The path to where your todos are located. It can also be a glob
   expresion if you wish to include mutiple directories.
 * ``date_format``: The date format used both for displaying dates, and parsing
   input dates.
   If this option is not specified the ISO-8601 (``%Y-%m-%d``) format is used.

Sample configuration
--------------------

The below example should serve as a reference. It will read ics files from any
directory inside ``~/.local/share/calendars/``, and use the ISO-8601 date
format (note that this is the default format, so this particular declaration is
redundant).

.. literalinclude:: ../todoman.conf.sample
  :language: ini

Color and displayname
---------------------

- You can set a color for each task list by creating a ``color`` file containing
  a colorcode in the format ``#RRGGBB``.
- A file named ``displayname`` decides how the task list should be named. The
  default is the directory name.

See also `this discussion about metadata for collections in
vdirsyncer <https://github.com/untitaker/vdirsyncer/issues/125>`_.
{'fraction_non_alphanumeric': 0.13675564681724847, 'fraction_numerical': 0.005749486652977412, 'mean_word_length': 3.561797752808989, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, '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': '4467572', 'n_tokens_mistral': 682, 'n_tokens_neox': 652, 'n_words': 296}