bordeaux.conf(5)

🎀 NAME 🎀

okay so this is bordeaux.conf(5), bestie, and it's the manual page for bordeaux.conf — literally the configuration file for the bordeaux service. that's the whole name vibe 💅

✨ SYNOPSIS ✨

The bordeaux.conf file is the configuration file for the bordeaux service. You'll typically find it at /etc/bordeaux.conf, and there's also an optional custom.conf that can be placed in the server prefix directory to override values and sections in it. slay.

🦋 FILE FORMAT 🦋

The file consists of sections which contain key value pairs. A section begins with the section name in square brackets and continues until the next section name. so like:

[section-name]

key-name = value

The file is line-based — that is, each newline-terminated line represents either a comment, a section name, or a parameter. no sneaky multi-line business, periodt.

Section and key names are not case sensitive 👑

Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is retained verbatim. verbatim, bestie, for real.

Any line beginning with a semicolon (;) or a hash (#) character is ignored, as are lines containing only whitespace.

An entire key value pair, comment, or section name must fit on one line. no spilling over 🙈

The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or true/false. Case is not significant in boolean values, but is preserved in string values. Some items such as create modes are numeric. noted 💜

🌸 SECTION DESCRIPTIONS 🌸

Each section in the configuration file, except for special sections, describes the configuration parameters needed for a loadable Bordeaux driver. These typically might be the interfaces and ports to bind local side network services to, and the IP telephony server to connect with. These are generally documented with each driver itself. iykyk.

👑 SPECIAL SECTIONS 👑

TODO

that's it. that's the section. literal TODO energy, and I respect the honesty 🙈

💖 COPYRIGHT 💖

Copyright © 2020 Tycho Softworks.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. like, zero warranty, bestie, not even the implied kind 😭

---

💖 that's the whole page — source/version: Tycho Softworks · Bordeaux · bordeaux.conf(5) · date: not listed in the original footer, so I'm not making one up 🫶✨