Module Bcfg.Out

type cfg

Type for output configuration values.

val config : ?margin:int -> ?indent:int -> ?tab:bool -> ?escape:[ `All_with_hex | `Normal ] -> ?hex:[ `Lower | `Upper ] -> unit -> cfg

config () allows you to define a configuration for how to generate a bcfg configuration file:

  • margin (unlimited by default) is the number of columns after which a long parameter is wrapped, using the RFC 822 continuation of the format (a backslash at the end of the line, inside double quotes);
  • indent (2 by default) is the number of spaces per nesting level, or the width of a tab stop when tab is set;
  • tab (false by default) indents with tab characters instead of spaces;
  • escape (`Normal by default) writes every byte which is not valid UTF-8 as \\xNN when it is `All_with_hex, and otherwise only escapes what has to be;
  • hex (`Lower by default) selects the alphabet of these hexadecimal escapes.

These are the settings behind the corresponding options of bcfg lint.