.. role:: ref(emphasis)

.. _mse4-config-reference(7):

=====================
mse4-config-reference
=====================

------------------------------------
Reference of MSE4 configuration keys
------------------------------------

:Manual section: 7

Value types
===========

These are the different value types used by the configuration keys and
their expected value format.

unsigned
~~~~~~~~

Unquoted unsigned number.

double
~~~~~~

Unquoted floating point number.

bool
~~~~

``true`` or ``false``.

string
~~~~~~

Quoted string.

id
~~~

Quoted string where the first character has to be a letter.

bytes
~~~~~

Quoted string containing an integer number, optionally followed by a unit
like "``m``".

categories
~~~~~~~~~~

Takes a configuration group. Each key in the group can itself be a child
category group. Keys named as "``*<property-name>*``" set properties on
the category.

Category properties:

* ``*memory_weight*``

  Sets the memory weight of the category

* ``*subdivisions*``

  Set the number of subdivisions to apply to this category.

* ``*stores*``

  Set the list of stores belonging to this category.

* ``*store_select*``

  Specify the algorithm to use when selecting a store from the available
  stores in this category.

See :ref:``mse4-categories(7)`` for more information.

books
~~~~~

Takes a list of configuration groups, where each group defines a book
instance.

stores
~~~~~~

Takes a list of configuration groups, where each group defines a store
instance.

Section: Environment
====================

.. include:: ../include/mse4-params-env.rst

Section: Book
=============

.. include:: ../include/mse4-params-book.rst

Section: Store
==============

.. include:: ../include/mse4-params-store.rst

See also
========

:ref:`mse4-config(7)`
