From ea7f43e60caac621aa2b01edd176999d6d99676e Mon Sep 17 00:00:00 2001 From: Martin Lund Date: Sat, 17 Dec 2022 16:58:24 +0100 Subject: [PATCH] Update configuration file documentation Rename .tiorc to .tioconfig, tiorc to config, etc. --- README.md | 8 ++++---- example/{tiorc => config} | 7 ++++++- 2 files changed, 10 insertions(+), 5 deletions(-) rename example/{tiorc => config} (88%) diff --git a/README.md b/README.md index c58d4b4..7625e85 100644 --- a/README.md +++ b/README.md @@ -198,9 +198,9 @@ If needed, the prefix key (ctrl-t) can be remapped via configuration file. Options can be set via the configuration file first found in any of the following locations in the order listed: - - $XDG_CONFIG_HOME/tio/tiorc - - $HOME/.config/tio/tiorc - - $HOME/.tiorc + - $XDG_CONFIG_HOME/tio/config + - $HOME/.config/tio/config + - $HOME/.tioconfig The configuration file supports sub-configurations using named sections which can be activated via the command-line by name or pattern. A sub-configuration @@ -240,7 +240,7 @@ Or by pattern match: $ tio usb12 ``` -Another more elaborate configuration file example is available [here](example/tiorc). +Another more elaborate configuration file example is available [here](example/config). ## 4. Installation diff --git a/example/tiorc b/example/config similarity index 88% rename from example/tiorc rename to example/config index 78a197b..05f96c9 100644 --- a/example/tiorc +++ b/example/config @@ -2,7 +2,12 @@ # tio - https://tio.github.io # ############################### -# Example configuration file +# Example tio configuration file +# +# Place file in any of the following locations: +# $XDG_CONFIG_HOME/tio/config +# $HOME/.config/tio/config +# $HOME/.tioconfig # Defaults baudrate = 115200