From 808385fb6dd68bdadca52f7e81b74a4759c9cece Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Sun, 25 Sep 2022 23:39:34 +0100 Subject: [PATCH] docs: wip markdown Signed-off-by: Ian Jackson --- docs/{config.rst => config.md} | 42 +++++++++++++++++----------------- docs/index.rst | 2 +- 2 files changed, 22 insertions(+), 22 deletions(-) rename docs/{config.rst => config.md} (53%) diff --git a/docs/config.rst b/docs/config.md similarity index 53% rename from docs/config.rst rename to docs/config.md index 08d5d77..49a9b33 100644 --- a/docs/config.rst +++ b/docs/config.md @@ -2,12 +2,12 @@ Configuration scheme ==================== Configuration is in an INI-like format. Sections start with lines -``[...]``. Every setting must be in a section. ``#`` and ``;`` -comment lines are supported. Settings ``nmae = value``. Whitespace +`[...]`. Every setting must be in a section. `#` and `;` +comment lines are supported. Settings are `nmae = value`. Whitespace around the name and value is ignored. The configuration files are resolved to a configuration for each -pairwise link between a client and a server. +pairwise **link** between a client and a server. Sections -------- @@ -19,36 +19,36 @@ Unless otherwise specified, any particular config setting for a particular link is the value from the first of the following applicable sections, or failing that the built-in default: - * ``[ ]`` - * ``[]`` - * ``[]`` (often ``[SERVER]``) - * ``[COMMON]`` + * `[ ]` + * `[]` + * `[]` (often `[SERVER]`) + * `[COMMON]` -```` is the client's virtual address in IPv4 or IPv6 literal -syntax (without any surrounding ``[..]``. +`` is the client's virtual address in IPv4 or IPv6 literal +syntax (without any surrounding `[..]`. -```` must be in the syntrax of a valid lowercase DNS -hostname (and not look like an address), or be literally ``SERVER``. +`` must be in the syntrax of a valid lowercase DNS +hostname (and not look like an address), or be literally `SERVER`. There are also these special sections: - * ``[ LIMIT]`` - * ``[LIMIT]`` + * `[ LIMIT]` + * `[LIMIT]` Files ----- Both client and server read the files - * ``/etc/hippotat/main.cfg`` (if it exists) - * ``/etc/hippotat/config.d/*`` - * ``/etc/hippotat/secrets.d/*`` + * `/etc/hippotat/main.cfg` (if it exists) + * `/etc/hippotat/config.d/*` + * `/etc/hippotat/secrets.d/*` -Here ``*`` means all contained files whose names consists of only -ascii alphanumerics plus ``-`` and ``_``. +Here `*` means all contained files whose names consists of only +ascii alphanumerics plus `-` and `_`. -The ``--config`` option can be used to override the directory (usually -``/etc/hippotat``). Additonally each ``--extra-config`` option names +The `--config` option can be used to override the directory (usually +`/etc/hippotat`). Additonally each `--extra-config` option names an existing file or directory to be processed analagously. The ini file format sections from these files are all unioned. Later @@ -60,5 +60,5 @@ server or client to be in a file named after that endpoint, there is no semantic link: all the files are always read and the appropriate section from each is applied to every link. -(If ``main.cfg`` does not exist, ``master.cfg`` will be tried for +(If `main.cfg` does not exist, `master.cfg` will be tried for backward compatibility reasons.) diff --git a/docs/index.rst b/docs/index.rst index 31973fa..2f4ff63 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ Hippotat - Asinine IP over HTTP :caption: Contents: README - config.rst + config.md settings.rst Indices and tables -- 2.30.2