Issues in thinkfan manpages

[hmartink]

Dear thinkfan maintainer,
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including thinkfan) as
well for a large variety of target languages.

During their work translators notice different possible issues in the
original (english) man pages. Sometimes this is a straightforward
typo, sometimes a hard to read sentence, sometimes this is a
convention not held up and sometimes we simply do not understand the
original.

We use several distributions as sources and update regularly (at
least every 2 month). This means we are fairly recent (some
distributions like archlinux also update frequently) but might miss
the latest upstream version once in a while, so the error might be
already fixed. We apologize and ask you to close the issue immediately
if this should be the case, but given the huge volume of projects and
the very limited number of volunteers we are not able to double check
each and every issue.

Secondly we translators see the manpages in the neutral po format,
i.e. converted and harmonized, but not the original source (be it man,
groff, xml or other). So we cannot provide a true patch (where
possible), but only an approximation which you need to convert into
your source format.

Finally the issues I'm reporting have accumulated over time and are
not always discovered by me, so sometimes my description of the
problem my be a bit limited - do not hesitate to ask so we can clarify
them.

I'm now reporting the errors for your project. If future reports
should use another channel, please let me know.

Man page: thinkfan.1
Issue:    thinkfan → B<thinkfan>

"With the help of libatasmart, if thinkfan was compiled with B<-"
"DUSE_ATASMART=ON>"

"The thinkfan config manpage:\n"
"B<thinkfan.conf>(5)\n"
--
Man page: thinkfan.1
Issue:  ``.yaml'' → I<.yaml>  

"If this option is specified, thinkfan attempts to load the config only from "
"I<FILE>.  If its name ends in ``.yaml'', it must be in YAML format.  "
"Otherwise, it can be either YAML or legacy syntax.  See B<thinkfan.conf>(5)  "
"and B<thinkfan.conf.legacy>(5)  for details."
--
Man page: thinkfan.1
Issue:    -D USE_ATASMART → B<-D USE_ATASMART> 

"Do not read temperature from sleeping disks. Instead, 0 \\[char176]C is used "
"as that disk's temperature. This is needed if reading the temperature causes "
"your disk to wake up unnecessarily.  NOTE: This option is only available if "
"thinkfan was built with -D USE_ATASMART."
--
Man page: thinkfan.1
Issue 1:  documenation → documentation
Issue 2:  thinkpad_acpi → I<thinkpad_acpi>

"The thinkpad_acpi interface documenation:\n"
"https://www.kernel.org/doc/html/latest/admin-guide/laptops/thinkpad-acpi.html\n"
--
Man page: thinkfan.1
Issue 1:  thinkpad_acpi → I<thinkpad_acpi>  

"The thinkpad_acpi interface documentation:\n"
"https://www.kernel.org/doc/html/latest/admin-guide/laptops/thinkpad-acpi.html\n"
--
Man page: thinkfan.conf.5
Issue:    Thinkfan → B<thinkfan>

"YAML is a very powerful, yet concise notation for structured data.  Its full "
"specification is available at https://yaml.org/spec/1.2/spec.html.  Thinkfan "
"uses only a small subset of the full YAML syntax, so it may be helpful, but "
"not strictly necessary for users to take a look at the spec."
--
Man page: thinkfan.conf.5
Issue:    thinkfan → B<thinkfan>

"The thinkfan config has three main sections:"
--
Man page: thinkfan.conf.5
Issue:    thinkfan → B<thinkfan>

"Maps temperatures to fan speeds.  A ``simple mapping'' just specifies one "
"temperature as the lower and upper bound (respectively) for a given fan "
"speed.  In a ``detailed mapping'', the upper and lower bounds are specified "
"for each driver/sensor configured under B<sensors:>.  This mode should be "
"used when thinkfan is monitoring multiple devices that can tolerate "
"different amounts of heat."

"For thinkfan to work, it first needs to know which temperature sensor "
"drivers and which fan drivers it should use.  The mapping between "
"temperature readings and fan speeds is specified in a separate config "
"section (see the B<FAN SPEEDS> section below)."

"Currently, thinkfan supports only one fan, so there can be only one entry in "
"the list.  Support for multiple fans is currently in development and planned "
"for a future release.  The fan is either an B<hwmon> fan:"

"A directory that contains multiple or all of the hwmon drivers, for example "
"``/sys/class/hwmon''.  Here, both the ``B<name:>I< hwmon-name>'' and "
"``B<indices:>I< index-list>'' entries are required to tell thinkfan which "
"interface to select below that path, and which sensors or which fan to use "
"from that interface."

"NOTE: only available if thinkfan was compiled with USE_NVML enabled."

"NOTE: only available if thinkfan was compiled with USE_ATASMART enabled."

"Full path to a device file for a hard disk that supports S.M.A.R.T.  See "
"also the B<-d> option in B<thinkfan>(1)  that prevents thinkfan from waking "
"up sleeping (mechanical) disks to read their temperature."

"A truth value (B<yes>/B<no>/B<true>/B<false>)  that specifies whether "
"thinkfan should accept errors when reading from this sensor.  Normally, "
"thinkfan will exit with an error message if reading the temperature from any "
"configured sensor fails.  Marking a sensor as optional may be useful for "
"removable hardware or devices that may get switched off entirely to save "
"power."

"The B<levels:> section specifies a list of fan speeds with associated lower "
"and upper temperature bounds.  If temperature(s) drop below the lower bound, "
"thinkfan switches to the previous level, and if the upper bound is reached, "
"thinkfan switches to the next level."

"The thinkfan manpage:\n"
"B<thinkfan>(1)\n"
--
Man page: thinkfan.conf.5
Issue 1:  B<hwmon,> → B<hwmon>,
Issue 2:  B<thinkpad_acpi,> → B<thinkpad_acpi>,

"The entries under the B<sensors:> section can specify B<hwmon,> "
"B<thinkpad_acpi,> B<NVML> or B<atasmart> drivers, where the latter two must "
"be enabled at compile-time.  There can be any number (greater than zero) and "
"combination of B<hwmon>, B<tpacpi>, B<nvml> and B<atasmart> entries.  "
"However there may be at most one instance of the B<tpacpi> entry."
--
Man page: thinkfan.conf.5
Issue 1:  folder → directory
Issue 2:  thinkfan → B<thinkfan>

"A directory that contains a specific hwmon driver, for example ``/sys/"
"devices/platform/nct6775.2592''.  Note that this path does not contain the "
"load-order dependent ``hwmonI<X>'' folder.  As long as it contains only a "
"single hwmon driver/interface it is sufficient to specify the ``B<indices:"
">I< index-list>'' entry to tell thinkfan which specific sensors to use from "
"that interface.  The ``B<name:>I< hwmon-name>'' entry is unnecessary."
--
Man page: thinkfan.conf.5
Issue:    folder → directory

"For B<hwmon> entries, this is required if I<hwmon-path> does not refer "
"directly to a single ``tempI<Xi>_input'' file, but to a folder that contains "
"one or more of them.  In this case, I<index-list> specifies the I<Xi> for "
"the ``tempI<Xi>_input'' files that should be used.  A hwmon interface may "
"also contain multiple PWM controls for fans, so in that case, I<index-list> "
"must contain exactly one entry."
--
Man page: thinkfan.conf.5
Issue:    thinkpad_acpi → I<thinkpad_acpi>

"The thinkpad_acpi interface documentation:\n"
"https://www.kernel.org/doc/html/latest/admin-guide/laptops/thinkpad-acpi.html\n"
--
Man page: thinkfan.conf.legacy.5
Issue:    known temperature → known temperatures

"The thinkfan config file specifies one or more temperature input(s), exactly "
"one fan to control and the fan levels.  A fan level associates a certain fan "
"speed to a lower and an upper temperature bound.  If the temperature reaches "
"the upper bound, we switch to the next fan level, and if it drops below the "
"lower bound, we switch to the previous fan level.  Temperature bounds can "
"either be a single tempature (I<simple mode>) or consist of multiple "
"temperatures (I<complex mode>).  In simple mode, only the highest of all "
"known temperature is compared to the upper & lower bound.  If you have "
"devices with very different temperature ratings (e.g. CPU vs.  mechanical "
"hard drives), you should specify correction values to equalize their "
"temperature ranges, or better: use complex mode.  In complex mode, the upper "
"and lower bounds of each fan level are specified for each sensor "
"individually.  Thinkfan then switches to the next fan level if one of the "
"upper bounds is reached, and to the previous fan level if all temperatures "
"have dropped below their respective lower bounds."
--
Man page: thinkfan.conf.legacy.5
Issue:    thinkfan → B<thinkfan>

"NOTE: only available if thinkfan was compiled with USE_ATASMART enabled."

"NOTE: only available if thinkfan was compiled with USE_NVML enabled."
--
Man page: thinkfan.conf.legacy.5
Issue:    to to → do to

"Complex mode is generally the preferred mode of operation since it allows "
"you to specify precisely what the fan should to to keep each component "
"within its specified temperature range."

[hmartink]

Additionally fix replace the first line of thinkfan(1), as it claims to be a man page of section 5 (instead of the correct one):

--- thinkfan.1.cmake.orig 2022-02-05 16:12:20.000000000 +0100 +++ thinkfan.1.cmake 2022-09-16 20:45:08.566292930 +0200 @@ -1,4 +1,4 @@ -.TH THINKFAN "5" "December 2021" "thinkfan @THINKFAN_VERSION@" "thinkfan" +.TH THINKFAN "11111111111" "December 2021" "thinkfan @THINKFAN_VERSION@" "thinkfan" .SH NAME thinkfan \- A simple fan control program .SH SYNOPSIS

[hmartink]

Sorry for the broken formatting, 2nd try: ''''--- thinkfan.1.cmake.orig 2022-02-05 16:12:20.000000000 +0100 +++ thinkfan.1.cmake 2022-09-16 20:45:08.566292930 +0200 @@ -1,4 +1,4 @@ -.TH THINKFAN "5" "December 2021" "thinkfan @THINKFAN_VERSION@" "thinkfan" +.TH THINKFAN "11111111111" "December 2021" "thinkfan @THINKFAN_VERSION@" "thinkfan" .SH NAME thinkfan - A simple fan control program .SH SYNOPSIS

[hmartink]

Seems like a bad day, now the correct patch: ''--- thinkfan.1.cmake.orig 2022-02-05 16:12:20.000000000 +0100 +++ thinkfan.1.cmake 2022-09-16 20:46:40.649590925 +0200 @@ -1,4 +1,4 @@ -.TH THINKFAN "5" "December 2021" "thinkfan @THINKFAN_VERSION@" "thinkfan" +.TH THINKFAN "1" "December 2021" "thinkfan @THINKFAN_VERSION@" "thinkfan" .SH NAME thinkfan - A simple fan control program .SH SYNOPSIS ''