.. _prop-system-bom:
.. _properties.system.bom:

$bom
====

.. index::
   single: properties; $bom
   single: $bom

.. summary-start

Emits the UTF-8 byte-order mark for use in templates when required.

.. summary-end

This property belongs to the **System Properties** group.

:Name: $bom
:Category: System Properties
:Type: string

Description
-----------
The UTF-8 encoded Unicode byte-order mask (BOM). This may be useful in templates
for RFC5424 support, when the character set is known to be Unicode.

Usage
-----
.. _properties.system.bom-usage:

.. code-block:: rsyslog

   template(name="example" type="list") {
       property(name="$bom")
   }

See also
--------
See :doc:`../../configuration/properties` for the category overview.