saz · saz · Oct 20, 2025 · Oct 20, 2025
diff --git a/README.md b/README.md
@@ -4,10 +4,6 @@
 
 Manage locales via Puppet
 
-### Supported Puppet versions
-* Puppet >= 4
-* Last version supporting Puppet 3: v2.4.0
-
 ## Usage
 
 By default, en and de locales will be generated.
@@ -26,7 +22,6 @@ Configure a bunch of locales.
 
 Advanced usage allows you to select which locales will be configured as well as the default one.
 
-
 ```
   class { 'locales':
     default_locale  => 'en_US.UTF-8',
@@ -45,21 +40,3 @@ for available LC_* environment variables and their descriptions:
     lc_paper        => 'de_DE.UTF-8',
   }
 ```
-
-## Other class parameters
-* locales: Name of locales to generate, default: ['en_US.UTF-8 UTF-8', 'de_DE.UTF-8 UTF-8']
-* ensure: present or absent, default: present
-* default_locale: string, default: 'C'. Set the default locale.
-* lc_ctype: string, default: undef. Character classification and case conversion.
-* lc_collate: string, default: undef. Collation order.
-* lc_time: string, default: undef. Date and time formats.
-* ...
-* autoupgrade: true or false, default: false. Auto-upgrade package, if there is a newer version.
-* package: string, default: OS specific. Set package name, if platform is not supported.
-* config_file: string, default: OS specific. Set config_file, if platform is not supported.
-* locale_gen_command: string, default: OS specific. Set locale_gen_command, if platform is not supported.
-* Suse specific:
-  * root_uses_lang: if set to 'ctype', root will be stay POSIX, set to 'yes' to change root to the global language as well. Defaults to 'ctype'.
-  * installed_languages: blank for english, otherwise space seperated list.  Used by Yast2 only.
-  * auto_detect_utf8: Workaround for missing forward of LANG and LC variables of e.g. ssh login connections.  Defaults to 'no'.
-  * input_method: A default input method to be used in X11. For more details see the comments at the top of /etc/X11/xim on a Suse system.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -0,0 +1,323 @@
+# Reference
+
+<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
+
+## Table of Contents
+
+### Classes
+
+* [`locales`](#locales): Manage locales
+* [`locales::params`](#locales--params): Default params for locales
+
+## Classes
+
+### <a name="locales"></a>`locales`
+
+Manage locales
+
+#### Examples
+
+##### Basic usage
+
+```puppet
+class { 'locales':
+  locales        => [ 'en_US.UTF-8 UTF-8', 'de_DE.UTF-8 UTF-8', 'en_GB.UTF-8 UTF-8', ],
+  default_locale => 'en_GB.UTF-8',
+  lc_time        => 'en_DK.UTF-8'
+}
+```
+
+#### Parameters
+
+The following parameters are available in the `locales` class:
+
+* [`locales`](#-locales--locales)
+* [`ensure`](#-locales--ensure)
+* [`default_locale`](#-locales--default_locale)
+* [`lc_ctype`](#-locales--lc_ctype)
+* [`lc_collate`](#-locales--lc_collate)
+* [`lc_time`](#-locales--lc_time)
+* [`lc_numeric`](#-locales--lc_numeric)
+* [`lc_monetary`](#-locales--lc_monetary)
+* [`lc_messages`](#-locales--lc_messages)
+* [`lc_paper`](#-locales--lc_paper)
+* [`lc_name`](#-locales--lc_name)
+* [`lc_address`](#-locales--lc_address)
+* [`lc_telephone`](#-locales--lc_telephone)
+* [`lc_measurement`](#-locales--lc_measurement)
+* [`lc_identification`](#-locales--lc_identification)
+* [`lc_all`](#-locales--lc_all)
+* [`autoupgrade`](#-locales--autoupgrade)
+* [`package`](#-locales--package)
+* [`config_file`](#-locales--config_file)
+* [`locale_gen_cmd`](#-locales--locale_gen_cmd)
+* [`language`](#-locales--language)
+* [`root_uses_lang`](#-locales--root_uses_lang)
+* [`installed_languages`](#-locales--installed_languages)
+* [`auto_detect_utf8`](#-locales--auto_detect_utf8)
+* [`input_method`](#-locales--input_method)
+* [`default_file`](#-locales--default_file)
+* [`update_locale_pkg`](#-locales--update_locale_pkg)
+* [`update_locale_cmd`](#-locales--update_locale_cmd)
+* [`supported_locales`](#-locales--supported_locales)
+* [`manage_package`](#-locales--manage_package)
+
+##### <a name="-locales--locales"></a>`locales`
+
+Data type: `Array[String]`
+
+List of name of locales to generate
+
+Default value: `['en_US.UTF-8 UTF-8', 'de_DE.UTF-8 UTF-8']`
+
+##### <a name="-locales--ensure"></a>`ensure`
+
+Data type: `Enum['present', 'absent']`
+
+Ensure if present or absent.
+
+Default value: `'present'`
+
+##### <a name="-locales--default_locale"></a>`default_locale`
+
+Data type: `Optional[String]`
+
+The value of the LANG environment variable. Used by the locale system as
+default for other LC_* variables that have not been set explicitly. When
+setting this make sure the desired locale exists by specifying it in the
+*locales* parameter.
+
+Default value: `undef`
+
+##### <a name="-locales--lc_ctype"></a>`lc_ctype`
+
+Data type: `Optional[String]`
+
+Character classification and case conversion. How characters are
+classified as letters, numbers etc. This determines things like how
+characters are converted between upper and lower case.
+
+Default value: `$locales::params::lc_ctype`
+
+##### <a name="-locales--lc_collate"></a>`lc_collate`
+
+Data type: `Optional[String]`
+
+Collation order. How strings (file names...) are alphabetically sorted.
+Using the "C" or "POSIX" locale here results in a strcmp()-like sort
+order, which may be preferable to language-specific locales.
+
+Default value: `$locales::params::lc_collate`
+
+##### <a name="-locales--lc_time"></a>`lc_time`
+
+Data type: `Optional[String]`
+
+Date and time formats. How your time and date are formatted. Use for
+example "en_DK.UTF-8" to get a 24-hour-clock in some programs.
+
+Default value: `$locales::params::lc_time`
+
+##### <a name="-locales--lc_numeric"></a>`lc_numeric`
+
+Data type: `Optional[String]`
+
+Non-monetary numeric formats. How you format your numbers. For example,
+in many countries a period (.) is used as a decimal separator, while
+others use a comma (,).
+
+Default value: `$locales::params::lc_numeric`
+
+##### <a name="-locales--lc_monetary"></a>`lc_monetary`
+
+Data type: `Optional[String]`
+
+Monetary formats. What currency you use, its name, and its symbol.
+
+Default value: `$locales::params::lc_monetary`
+
+##### <a name="-locales--lc_messages"></a>`lc_messages`
+
+Data type: `Optional[String]`
+
+Formats of informative and diagnostic messages and interactive responses.
+
+Default value: `$locales::params::lc_messages`
+
+##### <a name="-locales--lc_paper"></a>`lc_paper`
+
+Data type: `Optional[String]`
+
+Paper size.
+
+Default value: `$locales::params::lc_paper`
+
+##### <a name="-locales--lc_name"></a>`lc_name`
+
+Data type: `Optional[String]`
+
+Name formats. How names are represented (surname first or last, etc.).
+
+Default value: `$locales::params::lc_name`
+
+##### <a name="-locales--lc_address"></a>`lc_address`
+
+Data type: `Optional[String]`
+
+Address formats and location information. How addresses are formatted
+(country first or last, where zip code goes etc.).
+
+Default value: `$locales::params::lc_address`
+
+##### <a name="-locales--lc_telephone"></a>`lc_telephone`
+
+Data type: `Optional[String]`
+
+Telephone number formats.
+
+Default value: `$locales::params::lc_telephone`
+
+##### <a name="-locales--lc_measurement"></a>`lc_measurement`
+
+Data type: `Optional[String]`
+
+Measurement units (Metric or Other). What units of measurement are used
+(feet, meters, pounds, kilos etc.).
+
+Default value: `$locales::params::lc_measurement`
+
+##### <a name="-locales--lc_identification"></a>`lc_identification`
+
+Data type: `Optional[String]`
+
+Metadata about the locale information.
+
+Default value: `$locales::params::lc_identification`
+
+##### <a name="-locales--lc_all"></a>`lc_all`
+
+Data type: `Optional[String]`
+
+Primary Language
+
+Default value: `$locales::params::lc_all`
+
+##### <a name="-locales--autoupgrade"></a>`autoupgrade`
+
+Data type: `Boolean`
+
+Upgrade package automatically, if there is a newer version.
+
+Default value: `false`
+
+##### <a name="-locales--package"></a>`package`
+
+Data type: `String`
+
+Name of the package.
+Only set this, if your platform is not supported or you know, what you're doing.
+
+Default value: `$locales::params::package`
+
+##### <a name="-locales--config_file"></a>`config_file`
+
+Data type: `Optional[String]`
+
+Main configuration file.
+Only set this, if your platform is not supported or you know, what you're doing.
+
+Default value: `$locales::params::config_file`
+
+##### <a name="-locales--locale_gen_cmd"></a>`locale_gen_cmd`
+
+Data type: `Optional[String]`
+
+Command to generate locales.
+Only set this, if your platform is not supported or you know, what you're doing.
+
+Default value: `$locales::params::locale_gen_cmd`
+
+##### <a name="-locales--language"></a>`language`
+
+Data type: `Optional[String]`
+
+
+
+Default value: `undef`
+
+##### <a name="-locales--root_uses_lang"></a>`root_uses_lang`
+
+Data type: `Optional[String]`
+
+
+
+Default value: `$locales::params::root_uses_lang`
+
+##### <a name="-locales--installed_languages"></a>`installed_languages`
+
+Data type: `String`
+
+
+
+Default value: `$locales::params::installed_languages`
+
+##### <a name="-locales--auto_detect_utf8"></a>`auto_detect_utf8`
+
+Data type: `String`
+
+
+
+Default value: `$locales::params::auto_detect_utf8`
+
+##### <a name="-locales--input_method"></a>`input_method`
+
+Data type: `String`
+
+
+
+Default value: `$locales::params::input_method`
+
+##### <a name="-locales--default_file"></a>`default_file`
+
+Data type: `String`
+
+
+
+Default value: `$locales::params::default_file`
+
+##### <a name="-locales--update_locale_pkg"></a>`update_locale_pkg`
+
+Data type: `Variant[Boolean, String]`
+
+
+
+Default value: `$locales::params::update_locale_pkg`
+
+##### <a name="-locales--update_locale_cmd"></a>`update_locale_cmd`
+
+Data type: `Optional[String]`
+
+
+
+Default value: `$locales::params::update_locale_cmd`
+
+##### <a name="-locales--supported_locales"></a>`supported_locales`
+
+Data type: `Optional[String]`
+
+
+
+Default value: `$locales::params::supported_locales`
+
+##### <a name="-locales--manage_package"></a>`manage_package`
+
+Data type: `Boolean`
+
+
+
+Default value: `true`
+
+### <a name="locales--params"></a>`locales::params`
+
+Default params for locales
+