[latex3-commits] [git/LaTeX3-latex3-latex2e] bm-ifnextchar: document package options (c230270f)

[David Carlisle]

Repository : https://github.com/latex3/latex2e
On branch  : bm-ifnextchar
Link       : https://github.com/latex3/latex2e/commit/c230270fbc1cf2c4258fe59861068b32e7c99fde

>---------------------------------------------------------------

commit c230270fbc1cf2c4258fe59861068b32e7c99fde
Author: David Carlisle <d.p.carlisle at gmail.com>
Date:   Thu Apr 29 21:07:26 2021 +0100

    document package options


>---------------------------------------------------------------

c230270fbc1cf2c4258fe59861068b32e7c99fde
 required/tools/bm.dtx | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/required/tools/bm.dtx b/required/tools/bm.dtx
index fb62cf1b..2b56b92b 100644
--- a/required/tools/bm.dtx
+++ b/required/tools/bm.dtx
@@ -295,6 +295,23 @@
 % between these two packages, this package defines |\boldsymbol| and
 % |\heavysymbol| as alternative names for |\bm| and |\hm|.
 %
+% \section{Package Options}
+%
+% \subsection{Logging level}
+% As described above, the \textsf{bm} package has to interrogate the font
+% setup to try to find matching bold fonts for each font used in the |normal|
+% math version. This can fail in various ways as there may be no bold font
+% or a bold font may be found but no room is available to allocate it.
+% The options |warn|, |info| and |silent| control whether messages that \textsf{bm}
+% produces are sent to the terminal, or just to the log file (the default) or suppressed.
+%
+% \subsection{Poor Man's Bold}
+% As discussed above, by default, if no real bold font is available, \textsf{bm} will use
+% ``poor man's bold''. That is, over-printing the character with slight offsets.
+% Since version 1.2e, the package now warns if a font is set up to use this over-printing and
+% the package option |nopbm|  is available which prevents its use in which case |\bm| will
+% use the non-bold for characters from the affected font,
+%
 % \StopEventually{}
 %
 % \section{Implementation}