From: Tobias Brunner <tobias@strongswan.org>
Date: Fri, 14 Oct 2022 08:54:04 +0000 (+0200)
Subject: conf: Document accepted number and time formats
X-Git-Tag: 5.9.9rc1~40^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=64b10dfb28393ebac3f617742728493fc1202bdb;p=thirdparty%2Fstrongswan.git

conf: Document accepted number and time formats
---

diff --git a/conf/strongswan.conf.5.head.in b/conf/strongswan.conf.5.head.in
index 9337c19e22..31231c99a1 100644
--- a/conf/strongswan.conf.5.head.in
+++ b/conf/strongswan.conf.5.head.in
@@ -59,6 +59,27 @@ An example file in this format might look like this:
 .PP
 Indentation is optional, you may use tabs or spaces.
 
+.SH NUMBER FORMATS
+Options that define an integer value can be specified as decimal (the default)
+or hexadecimal ("0x" prefix, upper- or lowercase letters are accepted).
+Locale-dependent strings (e.g. the thousands separator of the current locale)
+may also be accepted in locales other than "C".
+.PP
+Options that define a floating-point value can be specified as decimal (the
+default) or hexadecimal ("0x" prefix, upper- or lowercase letters are accepted).
+The radix character (decimal separator) in either case is locale-dependent,
+usually ".".
+
+.SH TIME FORMATS
+Unless stated otherwise, options that define a time are specified in seconds.
+The "s", "m", "h" and "d" suffixes may be used to automatically convert values
+given in seconds, minutes, hours or days (for instance, instead of configuring
+a rekey time of 4 hours as "14400" seconds, "4h" may be used).
+.PP
+There are some global options that don't accept these suffixes as they are
+configured as integer values in seconds or milliseconds, or even as
+floating-point numbers (e.g. the retransmission timeout). Options that accept
+the suffixes have a corresponding default value.
 
 .SH REFERENCING OTHER SECTIONS
 It is possible to inherit settings and sections from another section. This
diff --git a/src/swanctl/swanctl.conf.5.head.in b/src/swanctl/swanctl.conf.5.head.in
index a14225df04..8ac7b1e6ba 100644
--- a/src/swanctl/swanctl.conf.5.head.in
+++ b/src/swanctl/swanctl.conf.5.head.in
@@ -6,20 +6,11 @@ swanctl.conf is the configuration file used by the
 .BR swanctl (8)
 tool to load configurations and credentials into the strongSwan IKE daemon.
 
-For a description of the basic file syntax, including how to reference sections
-or split the configuration in multiple files by including other files, refer to
+For a description of the basic file syntax, including numer/time formats, or how
+to reference sections or split the configuration in multiple files by including
+other files, refer to
 .BR strongswan.conf (5).
 
-.SH TIME FORMATS
-For all options that define a time, the time is specified in seconds. The
-.RI "" "s" ","
-.RI "" "m" ","
-.RI "" "h" ""
-and
-.RI "" "d" ""
-suffixes explicitly define the units for seconds, minutes, hours and days,
-respectively.
-
 .SH SETTINGS
 The following settings can be used to configure connections, credentials and
 pools.