Add note about escaping in CLI (#10083)

Closes #9999
This commit is contained in:
Dominik Guhr 2022-02-09 14:39:53 +01:00 committed by GitHub
parent c54920fd0e
commit f78b8bf89f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 1 deletions

View file

@ -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. 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 == 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 In addition to the optimizations performed when you run the `build` command, you might want to avoid using CLI options when running the

View file

@ -55,6 +55,7 @@ The server uses JDBC as the underlying technology to communicate with the relati
.Starting the server .Starting the server
<@kc.start parameters="--db-url jdbc:postgresql://mypostgres/mydatabase"/> <@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 == Configuring the database for Unicode

View file

@ -80,7 +80,7 @@ The format string supports the following symbols:
=== Set the logging format === 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: 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=\"\'<format>\'\""/> <@kc.start parameters="--log-format=\"\'<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 .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\'\""/> <@kc.start parameters="\"\'%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n\'\""/>