From c8879322b0da1ed293ffe02d3af8ad6ab08e5ee3 Mon Sep 17 00:00:00 2001 From: Harald Freudenberger Date: Tue, 14 May 2024 09:08:15 +0200 Subject: [PATCH] pvapconfig: Escape hyphens in man page correctly Insert backslash(es) to escape the hyphens used in the pvapconfig man page correctly. Suggested-by: Jan Hoeppner Signed-off-by: Harald Freudenberger Reviewed-by: Steffen Eiden Signed-off-by: Steffen Eiden --- rust/pvapconfig/man/pvapconfig.1 | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/rust/pvapconfig/man/pvapconfig.1 b/rust/pvapconfig/man/pvapconfig.1 index 73ce8cea..39a68b4c 100644 --- a/rust/pvapconfig/man/pvapconfig.1 +++ b/rust/pvapconfig/man/pvapconfig.1 @@ -34,7 +34,7 @@ to support the feature. .TP 3 3. Read in and validate the AP configuration file. By default if not -overwritten by the --config option the AP configuration is read from +overwritten by the \-\-config option the AP configuration is read from .I /etc/pvapconfig.yaml and syntactically verified. See section CONFIGFILE for details about the syntax and semantic of the configuration file. @@ -71,31 +71,31 @@ AP config entry from the configuration and pvapconfig will return successfully. .SH OPTIONS .TP 8 -.B -c, --config +.B \-c, \-\-config Use as the AP config file for pvapconfig. If pvapconfig is run without this option the default configuration file /etc/pvapconfig.yaml is used. .TP 8 -.B -h, --help +.B \-h, \-\-help Print pvapconfig usage information and exit. .TP 8 -.B -n, --dry-run +.B \-n, \-\-dry\-run Do not bind, unbind or associate APQNs but only process the configuration and the available APQNs and secrets and simulate the bind, unbind or associate action on the chosen APQN. Use it together with the verbose option to see which actions pvapconfig would do if unleashed. .TP 8 -.B -s, --strict +.B \-s, \-\-strict All AP config entries need to be satisfied to have pvapconfig terminate with success. Without this option one applied AP config entry is enough to meet the expectations. .TP 8 -.B -v, --verbose +.B \-v, \-\-verbose Print out informational messages about what pvapconfig is actually doing. .TP 8 -.B -V, --version +.B \-V, \-\-version Print version information and exit. .SH CONFIGFILE The pvapconfig yaml configuration file consists of a list of AP config