From f78b8bf89ff3f6a4fbb057e3cb92342a199ff8af Mon Sep 17 00:00:00 2001 From: Dominik Guhr <89905860+DGuhr@users.noreply.github.com> Date: Wed, 9 Feb 2022 14:39:53 +0100 Subject: [PATCH] Add note about escaping in CLI (#10083) Closes #9999 --- docs/guides/src/main/server/configuration.adoc | 2 ++ docs/guides/src/main/server/db.adoc | 1 + docs/guides/src/main/server/logging.adoc | 2 +- 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/guides/src/main/server/configuration.adoc b/docs/guides/src/main/server/configuration.adoc index bbb21b5074..bd684722b7 100644 --- a/docs/guides/src/main/server/configuration.adoc +++ b/docs/guides/src/main/server/configuration.adoc @@ -97,6 +97,8 @@ The second stage involves starting the server using any **configuration option** At this stage, you are free to set any value you want to any of the configuration options. +Be aware that you need to escape characters when invoking commands containing special shell characters such as `;` using the CLI, so you might want to set it in the configuration file instead. + == Configuring the server for an optimal startup time In addition to the optimizations performed when you run the `build` command, you might want to avoid using CLI options when running the diff --git a/docs/guides/src/main/server/db.adoc b/docs/guides/src/main/server/db.adoc index 6bfe804aaa..4805aac858 100644 --- a/docs/guides/src/main/server/db.adoc +++ b/docs/guides/src/main/server/db.adoc @@ -55,6 +55,7 @@ The server uses JDBC as the underlying technology to communicate with the relati .Starting the server <@kc.start parameters="--db-url jdbc:postgresql://mypostgres/mydatabase"/> +Be aware that you need to escape characters when invoking commands containing special shell characters such as `;` using the CLI, so you might want to set it in the configuration file instead. == Configuring the database for Unicode diff --git a/docs/guides/src/main/server/logging.adoc b/docs/guides/src/main/server/logging.adoc index f618c0ff7f..4b580600b4 100644 --- a/docs/guides/src/main/server/logging.adoc +++ b/docs/guides/src/main/server/logging.adoc @@ -80,7 +80,7 @@ The format string supports the following symbols: === Set the logging format To set the logging format for a logged line, build your desired format template using the table above and run the following command: <@kc.start parameters="--log-format=\"\'\'\""/> -Be aware that you need to escape characters when invoking the command using the CLI, so you might want to set it in the configuration file instead. +Be aware that you need to escape characters when invoking commands containing special shell characters such as `;` using the CLI, so you might want to set it in the configuration file instead. .Example: Abbreviate the fully qualified category name <@kc.start parameters="\"\'%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n\'\""/>