bionic (3) md_src_plugins_hexcode_README.3elektra.gz

NAME

       md_src_plugins_hexcode_READMEREADME
        -

       • infos = Information about hexcode plugin is in keys below

       • infos/author = Markus Raab elektra@libelektra.org

       • infos/licence = BSD

       • infos/needs =

       • infos/provides = code

       • infos/placements = postgetstorage presetstorage

       • infos/description = Decoding/Encoding engine which escapes unwanted characters.

       This code plugin translates each unwanted character into a two cypher hexadecimal character. The escape
       character itself always needs to be encoded, otherwise the plugin would try to interpret the following
       two characters in the text as a hexadecimal sequence.

   Restrictions
       • The escape character itself always needs to be encoded, otherwise the plugin would try to interpret the
         following two characters in the text as a hexadecimal sequence.

       • The length of the resulting string increases. In the worst case the hexcode plugin makes the value
         three times larger.

   Example
       Consider the following value of an key:

           value=abc xyz

       Assuming the escape character is % the input would be encoded to:

           value%3Dabc%20xyz

       The disadvantage is that the length of the resulting string increases. In the worst case the hexcode
       plugin makes the value three times larger.

   Usage
       Add ccode to infos/needs for any plugin that you want to be filtered by ccode.

       Then, additionally define all characters you need to be escaped below config/needs/chars in your
       contract, e.g:

           config/needs/chars/20 = 61

       to transform a space (dec 20) to the escaped letter a (dec 61).

       The escape letter itself can be changed by setting:

           config/needs/escape