summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex163
1 files changed, 104 insertions, 59 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
index 21cad036a5d..fcb488792cd 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
@@ -75,6 +75,8 @@
\newcommand{\itempar}[1]{\item[{#1}]\mbox{}\par}
+\newcommand{\pkgoptdef}[1]{\hypertarget{pkgopt:#1}{\pkgopt{#1}}}
+
\newcommand{\glslike}{\hyperref[sec:gls-like]{\cs{gls}-like}}
\newcommand{\glstextlike}{\hyperref[sec:glstext-like]{\cs{glstext}-like}}
@@ -448,11 +450,11 @@ and~\hyperlink{option#2}{#2}}
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{User Manual for glossaries.sty v4.40}
+ \title{User Manual for glossaries.sty v4.41}
\author{Nicola L.C. Talbot\\%
\url{http://www.dickimaw-books.com/}}
- \date{2018-06-01}
+ \date{2018-07-23}
\maketitle
\begin{abstract}
@@ -543,7 +545,7 @@ package.
\item[\url{glossaries-code.pdf}]
Advanced users wishing to know more about the inner workings of all the
packages provided in the \styfmt{glossaries} bundle should read
-\qt{Documented Code for glossaries v4.40}.
+\qt{Documented Code for glossaries v4.41}.
\item[INSTALL] Installation instructions.
@@ -2844,7 +2846,7 @@ resulting file onto the man path. Alternatively do
\begin{important}
When upgrading the \styfmt{glossaries} package, make sure you also
upgrade your version of \gls{makeglossaries}. The current version is
-4.40.
+4.41.
\end{important}
\subsection{Using the makeglossaries-lite Lua Script}
@@ -3094,16 +3096,16 @@ package. Options that aren't \meta{key}=\meta{value} (such as
\label{sec:pkgopts-general}
\begin{description}
-\item[\pkgopt{nowarn}] This suppresses all warnings generated by
+\item[\pkgoptdef{nowarn}] This suppresses all warnings generated by
the \styfmt{glossaries} package. Don't use this option if you're new to using
\styfmt{glossaries} as the warnings are designed to help detect
common mistakes (such as forgetting to use \ics{makeglossaries}).
Note that the \pkgopt[true]{debug} and \pkgopt[showtargets]{debug} will override this option.
-\item[\pkgopt{nolangwarn}] This suppresses the warning generated by
+\item[\pkgoptdef{nolangwarn}] This suppresses the warning generated by
a missing language module.
-\item[\pkgopt{noredefwarn}] If you load \styfmt{glossaries} with
+\item[\pkgoptdef{noredefwarn}] If you load \styfmt{glossaries} with
a~class or another package that already defines glossary related
commands, by default \styfmt{glossaries} will warn you that it's
redefining those commands. If you are aware of the consequences of
@@ -3112,7 +3114,7 @@ want to be warned about it, use this option to suppress those
warnings. Other warnings will still be issued unless you use the
\pkgopt{nowarn} option described above.
-\item[\pkgopt{debug}] Introduced in version 4.24.
+\item[\pkgoptdef{debug}] Introduced in version 4.24.
The default setting is \pkgopt[false]{debug}.
This was a boolean option but as from v4.32 it now accepts the
values: \pkgoptfmt{false}, \pkgoptfmt{true} and
@@ -3189,7 +3191,7 @@ glossary but you're sure you used commands like \cs{glsadd}
or \cs{glsaddall}, try switching on the \pkgopt{debug} option
and see if any information has been written to the log file.
-\item[\pkgopt{seenoindex}] Introduced in version 4.24, this option
+\item[\pkgoptdef{seenoindex}] Introduced in version 4.24, this option
may take one of three values: \pkgoptfmt{error}, \pkgoptfmt{warn} or
\pkgoptfmt{ignore}. The \gloskey{see} key automatically indexes the
cross-referenced entry using \cs{glsadd}. This means that it suffers
@@ -3203,7 +3205,7 @@ ignore it (\pkgopt[ignore]{seenoindex}) if, for example, you want
to temporarily comment out \cs{makeglossaries} to speed up the
compilation of a draft document by omitting the indexing.
-\item[\pkgopt{nomain}] This suppresses the creation of the main
+\item[\pkgoptdef{nomain}] This suppresses the creation of the main
glossary and associated \texttt{.glo} file, if unrequired. Note that
if you use this option, you must create another glossary in which to
put all your entries (either via the \pkgopt{acronym} (or
@@ -3228,7 +3230,7 @@ If you did actually want to use the main glossary and you see this
warning, check that you have referenced the entries in that glossary
via commands such as \ics{gls}.
-\item[\pkgopt{sanitizesort}] This is a boolean option that
+\item[\pkgoptdef{sanitizesort}] This is a boolean option that
determines whether or not to \gls{sanitize} the sort value when
writing to the external glossary file. For example, suppose you
define an entry as follows:
@@ -3255,7 +3257,7 @@ is sorted according to \texttt{AAA}, then use the package option
The default for \optsand23 is \pkgopt[true]{sanitizesort}, and the
default for \opt1 is \pkgopt[false]{sanitizesort}.
-\item[\pkgopt{savewrites}] This is a boolean option to minimise the
+\item[\pkgoptdef{savewrites}] This is a boolean option to minimise the
number of write registers used by the \styfmt{glossaries} package.
(Default is \pkgopt[false]{savewrites}.) There are only a limited
number of write registers, and if you have a large number of
@@ -3293,7 +3295,7 @@ document to avoid rewriting the files. For example:
\end{important}
In general, this package option is best avoided.
-\item[\pkgopt{translate}] This can take the following values:
+\item[\pkgoptdef{translate}] This can take the following values:
\begin{description}
\item[{\pkgopt[true]{translate}}] If \sty{babel} has been loaded
@@ -3333,11 +3335,11 @@ specified, \pkgopt[true]{translate} is assumed if \sty{babel},
See \sectionref{sec:fixednames} for further details.
-\item[\pkgopt{notranslate}] This is equivalent to
+\item[\pkgoptdef{notranslate}] This is equivalent to
\pkgopt[false]{translate} and may be passed via the document class
options.
-\item[\pkgopt{nohypertypes}] Use this option if you have multiple
+\item[\pkgoptdef{nohypertypes}] Use this option if you have multiple
glossaries and you want to suppress the entry hyperlinks for a
particular glossary or glossaries. The value of this option should
be a comma-separated list of glossary types where \ics{gls} etc
@@ -3356,7 +3358,7 @@ The values must be fully expanded, so \textbf{don't} try
instead or additionally.
See \sectionref{sec:glslink} for further details.
-\item[\pkgopt{hyperfirst}] This is a boolean option that specifies
+\item[\pkgoptdef{hyperfirst}] This is a boolean option that specifies
whether each term has a hyperlink on \firstuse. The default is
\pkgopt[true]{hyperfirst} (terms on \gls{firstuse} have a hyperlink,
unless explicitly suppressed using starred versions of commands
@@ -3415,7 +3417,7 @@ Note that this hook isn't used by the commands that don't check the
\ics{glslinkpostsetkeys}, which is used by both the \glslike\ and
\glstextlike\ commands.)
-\item[\pkgopt{indexonlyfirst}] This is a boolean option that specifies
+\item[\pkgoptdef{indexonlyfirst}] This is a boolean option that specifies
whether to only add information to the external glossary file on
\gls{firstuse}. The default is \pkgopt[false]{indexonlyfirst},
which will add a line to the file every time one of the
@@ -3458,7 +3460,7 @@ entries in the \texttt{acronym} glossary and not in the
Here I've used \cs{ifthenelse} to ensure the arguments of
\cs{equal} are fully expanded before the comparison is made.
-\item[\pkgopt{savenumberlist}] This is a boolean option that
+\item[\pkgoptdef{savenumberlist}] This is a boolean option that
specifies whether or not to gather and store the \gls{numberlist}
for each entry. The default is \pkgopt[false]{savenumberlist}. (See
\ics{glsentrynumberlist} and \ics{glsdisplaynumberlist} in
@@ -3471,7 +3473,7 @@ use \opt1.
\label{sec:pkgopts-sec}
\begin{description}
-\item[\pkgopt{toc}] Add the glossaries to the table of contents.
+\item[\pkgoptdef{toc}] Add the glossaries to the table of contents.
Note that an extra \LaTeX\ run is required with this option.
Alternatively, you can switch this function on and off using
\begin{definition}[\DescribeMacro{\glstoctrue}]
@@ -3482,7 +3484,7 @@ and
\cs{glstocfalse}
\end{definition}
-\item[\pkgopt{numberline}] When used with \pkgopt{toc}, this will
+\item[\pkgoptdef{numberline}] When used with \pkgopt{toc}, this will
add \ics{numberline}\verb|{}| in the final argument of
\ics{addcontentsline}. This will align the table of contents entry
with the numbered section titles. Note that this option has no
@@ -3490,7 +3492,7 @@ effect if the \pkgopt{toc} option is omitted. If \pkgopt{toc} is
used without \pkgopt{numberline}, the title will be aligned with
the section numbers rather than the section titles.
-\item[\pkgopt{section}] This is a \meta{key}=\meta{value} option. Its
+\item[\pkgoptdef{section}] This is a \meta{key}=\meta{value} option. Its
value should be the name of a sectional unit (e.g.\ chapter).
This will make the glossaries appear in the named sectional unit,
otherwise each glossary will appear in a chapter, if chapters
@@ -3539,7 +3541,7 @@ be fixed by redefining \DescribeMacro\glsclearpage\cs{glsclearpage}:
\renewcommand*{\glsclearpage}{\clearpage}
\end{verbatim}
-\item[\pkgopt{ucmark}] This is a boolean option (default:
+\item[\pkgoptdef{ucmark}] This is a boolean option (default:
\pkgopt[false]{ucmark}, unless \cls{memoir} has been loaded, in
which case it defaults to \pkgopt[true]{ucmark}). If
set, \ics{glsglossarymark} uses
@@ -3565,7 +3567,7 @@ For example:
If \cls{memoir} has been loaded and \pkgopt{ucfirst} is set, then
\cls{memoir}'s \ics{memUChead} is used.
-\item[\pkgopt{numberedsection}]
+\item[\pkgoptdef{numberedsection}]
The glossaries are placed in unnumbered sectional units by default,
but this can be changed using \pkgopt{numberedsection}. This option can take
one of the following values:
@@ -3644,7 +3646,7 @@ redefine \cs{glsautoprefix} to provide a prefix for the label.
\label{sec:pkgopts-printglos}
\begin{description}
-\item[\pkgopt{entrycounter}] This is a boolean option. (Default
+\item[\pkgoptdef{entrycounter}] This is a boolean option. (Default
is \pkgopt[false]{entrycounter}.) If set, each main (level~0)
glossary entry will be numbered when using the standard glossary
styles. This option creates the counter
@@ -3670,7 +3672,7 @@ creating the glossary files using \gls{makeglossaries},
up-to-date.
\end{important}
-\item[\pkgopt{counterwithin}] This is a \meta{key}=\meta{value}
+\item[\pkgoptdef{counterwithin}] This is a \meta{key}=\meta{value}
option where \meta{value} is the name of a counter. If used, this
option will automatically set \pkgopt[true]{entrycounter} and the
\ctr{glossaryentry} counter will be reset every time \meta{value} is
@@ -3708,7 +3710,7 @@ glossary preamble, as required. For example:
}
\end{verbatim}
-\item[\pkgopt{subentrycounter}] This is a boolean option. (Default
+\item[\pkgoptdef{subentrycounter}] This is a boolean option. (Default
is \pkgopt[false]{subentrycounter}.) If set, each level~1
glossary entry will be numbered when using the standard glossary
styles. This option creates the counter
@@ -3719,7 +3721,7 @@ reference the number within the document using
\ics{glsrefentry}\marg{label} where \meta{label} is the label
associated with the sub-entry.
-\item[\pkgopt{style}] This is a \meta{key}=\meta{value} option.
+\item[\pkgoptdef{style}] This is a \meta{key}=\meta{value} option.
(Default is \pkgopt[list]{style}, unless \sty{classicthesis}
has been loaded, in which case the default is \pkgopt[index]{style}.) Its value should be the name of
the glossary style to use. This key may only be used for styles
@@ -3731,7 +3733,7 @@ set the style using
\end{definition}
(See \sectionref{sec:styles} for further details.)
-\item[\pkgopt{nolong}] This prevents the \styfmt{glossaries} package
+\item[\pkgoptdef{nolong}] This prevents the \styfmt{glossaries} package
from automatically loading \sty{glossary-long} (which means that
the \sty{longtable} package also won't be loaded). This reduces
overhead by not defining unwanted styles and commands. Note that if
@@ -3739,7 +3741,7 @@ you use this option, you won't be able to use any of the
glossary styles defined in the \styfmt{glossary-long} package (unless
you explicitly load \sty{glossary-long}).
-\item[\pkgopt{nosuper}] This prevents the \styfmt{glossaries} package
+\item[\pkgoptdef{nosuper}] This prevents the \styfmt{glossaries} package
from automatically loading \sty{glossary-super} (which means that
the \sty{supertabular} package also won't be loaded). This reduces
overhead by not defining unwanted styles and commands. Note that if
@@ -3747,7 +3749,7 @@ you use this option, you won't be able to use any of the
glossary styles defined in the \styfmt{glossary-super} package
(unless you explicitly load \sty{glossary-super}).
-\item[\pkgopt{nolist}] This prevents the \styfmt{glossaries} package
+\item[\pkgoptdef{nolist}] This prevents the \styfmt{glossaries} package
from automatically loading \sty{glossary-list}. This reduces
overhead by not defining unwanted styles. Note that if
you use this option, you won't be able to use any of the
@@ -3758,7 +3760,7 @@ Note that since the default style is \glostyle{list} (unless
also need to use the \pkgopt{style} option to set the style to
something else.
-\item[\pkgopt{notree}] This prevents the \styfmt{glossaries} package
+\item[\pkgoptdef{notree}] This prevents the \styfmt{glossaries} package
from automatically loading \sty{glossary-tree}. This reduces
overhead by not defining unwanted styles. Note that if
you use this option, you won't be able to use any of the
@@ -3767,7 +3769,7 @@ glossary styles defined in the \styfmt{glossary-tree} package
\sty{classicthesis} has been loaded, the default style is
\glostyle{index}, which is provided by \sty{glossary-tree}.
-\item[\pkgopt{nostyles}] This prevents all the predefined styles
+\item[\pkgoptdef{nostyles}] This prevents all the predefined styles
from being loaded. If you use this option, you need to load a
glossary style package (such as \sty{glossary-mcols}). Also if you
use this option, you can't use the \pkgopt{style} package option.
@@ -3780,7 +3782,7 @@ Instead you must either use \ics{setglossarystyle}\marg{style} or the
\setglossarystyle{mcoltree}
\end{verbatim}
-\item[\pkgopt{esclocations}] This is a boolean option. (The default
+\item[\pkgoptdef{esclocations}] This is a boolean option. (The default
is \pkgopt[true]{esclocations}, but \ics{makenoidxglossaries}
changes it to \pkgopt[false]{esclocations}.) Both \gls{makeindex} and \gls{xindy}
are fussy about the location formats (\gls{makeindex} more so than
@@ -3798,7 +3800,7 @@ use \pkgopt[false]{esclocations} to avoid the complex escaping
of location values. (See \ifpdf section~\ref*{sec:wrgloss}\fi \qt{Writing information to associated files} in the documented
code for further details.)
-\item[\pkgopt{nonumberlist}] This option will suppress the
+\item[\pkgoptdef{nonumberlist}] This option will suppress the
associated \glspl{numberlist} in the glossaries (see also
\sectionref{sec:numberlists}). Note that if you use \optsor23
(\gls{makeindex} or \gls{xindy}) then the locations must still be
@@ -3809,7 +3811,7 @@ indexed. Remember that \gls{numberlist} includes any
cross-references, so suppressing the \gls{numberlist} will also hide
the cross-references (see below).
-\item[\pkgopt{seeautonumberlist}] If you suppress the
+\item[\pkgoptdef{seeautonumberlist}] If you suppress the
\glspl{numberlist} with \pkgopt{nonumberlist}, described above, this
will also suppress any cross-referencing information supplied by the
\gloskey{see} key in \ics{newglossaryentry} or \ics{glssee}. If you
@@ -3818,18 +3820,18 @@ automatically implement \gloskey{nonumberlist=false} for that entry.
(Note this doesn't affect \cs{glssee}.) For further details see
\sectionref{sec:crossref}.
-\item[\pkgopt{counter}] This is a \meta{key}=\meta{value} option.
+\item[\pkgoptdef{counter}] This is a \meta{key}=\meta{value} option.
(Default is \pkgopt[page]{counter}.) The value should be the name of
the default counter to use in the \glspl{numberlist}
(see \sectionref{sec:numberlists}).
-\item[\pkgopt{nopostdot}] This is a boolean option. If no value is
+\item[\pkgoptdef{nopostdot}] This is a boolean option. If no value is
specified, \texttt{true} is assumed. When set to \texttt{true}, this
option suppresses the default post description dot used by some of
the predefined styles. The default setting is
\pkgopt[false]{nopostdot}.
-\item[\pkgopt{nogroupskip}] This is a boolean option. If no value is
+\item[\pkgoptdef{nogroupskip}] This is a boolean option. If no value is
specified, \texttt{true} is assumed. When set to \texttt{true}, this
option suppresses the default vertical gap between groups used by
some of the predefined styles. The default setting is
@@ -3841,7 +3843,7 @@ some of the predefined styles. The default setting is
\label{sec:pkgopts-sort}
\begin{description}
-\item[\pkgopt{sort}] If you use \optsor23, this package option is
+\item[\pkgoptdef{sort}] If you use \optsor23, this package option is
the only way of specifying how to sort the glossaries. Only \opt1
allows you to specify sort methods for individual glossaries
via the \gloskey[printnoidxglossary]{sort} key in the optional
@@ -4019,7 +4021,7 @@ Now the entries can be defined:
For a complete document, see the sample file \samplefile{People}.
\end{example}
-\item[\pkgopt{order}] This may take two values:
+\item[\pkgoptdef{order}] This may take two values:
\pkgoptval{word}{order} or \pkgoptval{letter}{order}. The default
is word ordering.
@@ -4040,7 +4042,7 @@ Alternatively, you can specify the order for individual glossaries:
\printnoidxglossary[type=acronym,sort=letter]
\end{verbatim}
-\item[\pkgopt{makeindex}] (\opt2) The glossary information and
+\item[\pkgoptdef{makeindex}] (\opt2) The glossary information and
indexing style file will be written in \gls{makeindex} format. If
you use \gls{makeglossaries}, it will automatically detect that it
needs to call \gls*{makeindex}. If you don't use
@@ -4052,7 +4054,7 @@ You may omit this package option if you are using \opt2 as this is the
default. It's available in case you need to override the effect of an earlier
occurrence of \pkgopt{xindy} in the package option list.
-\item[\pkgopt{xindy}] (\opt3) The glossary information and indexing style
+\item[\pkgoptdef{xindy}] (\opt3) The glossary information and indexing style
file will be written in \gls{xindy} format. If you use
\gls{makeglossaries}, it will automatically detect that it needs to
call \gls*{xindy}. If you don't use \gls*{makeglossaries}, you need to
@@ -4077,17 +4079,17 @@ language, codepage and number group settings are unchanged. See
\sectionref{sec:xindy} for further details on using \gls{xindy} with
the \styfmt{glossaries} package.
-\item[\pkgopt{xindygloss}] (\opt3) This is equivalent to
+\item[\pkgoptdef{xindygloss}] (\opt3) This is equivalent to
\verb|xindy={}| (that is, the \pkgopt{xindy} option without any value
supplied) and may be used as a document class option. The language
and code page can be set via \ics{GlsSetXdyLanguage} and
\ics{GlsSetXdyCodePage} (see \sectionref{sec:langenc}.)
-\item[\pkgopt{xindynoglsnumbers}] (\opt3) This is equivalent to
+\item[\pkgoptdef{xindynoglsnumbers}] (\opt3) This is equivalent to
\verb|xindy={glsnumbers=false}| and may be used as a document class
option.
-\item[\pkgopt{automake}] This is a boolean option (new to version
+\item[\pkgoptdef{automake}] This is a boolean option (new to version
4.08) that will attempt to run \gls{makeindex} or \gls{xindy} using
\TeX's \ics{write18} mechanism at the end of the document. Since
this mechanism can be a security risk, some \TeX\ distributions
@@ -4121,7 +4123,7 @@ into their document build. The default value for this option is
\label{sec:pkgopts-acronym}
\begin{description}
-\item[\pkgopt{acronym}] This creates a new glossary with the
+\item[\pkgoptdef{acronym}] This creates a new glossary with the
label \texttt{acronym}. This is equivalent to:
\begin{verbatim}
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
@@ -4159,11 +4161,11 @@ interested in using this \texttt{acronym} glossary. (That is, you
don't intend to use the \texttt{main} glossary.)
\end{important}
-\item[\pkgopt{acronyms}] This is equivalent to
+\item[\pkgoptdef{acronyms}] This is equivalent to
\pkgopt[true]{acronym} and may be used in the document class option
list.
-\item[\pkgopt{acronymlists}] By default, only the \cs{acronymtype}
+\item[\pkgoptdef{acronymlists}] By default, only the \cs{acronymtype}
glossary is considered to be a list of acronyms. If you have other
lists of acronyms, you can specify them as a comma-separated list
in the value of \pkgopt{acronymlists}. For example, if you use the
@@ -4198,7 +4200,7 @@ of acronyms using:
\cs{glsIfListOfAcronyms}\marg{label}\marg{true part}\marg{false part}
\end{definition}
-\item[\pkgopt{shortcuts}] This option provides shortcut commands
+\item[\pkgoptdef{shortcuts}] This option provides shortcut commands
for acronyms. See \sectionref{sec:acronyms} for further details.
Alternatively you can use:
\begin{definition}[\DescribeMacro\DefineAcronymSynonyms]
@@ -4214,7 +4216,7 @@ are kept for backward-compatibility. Use \ics{setacronymstyle}
instead. See \sectionref{sec:acronyms} for further details.
\begin{description}
-\item[\pkgopt{description}] This option changes the definition of
+\item[\pkgoptdef{description}] This option changes the definition of
\ics{newacronym} to allow a description.
This option may be replaced by
\begin{verbatim}
@@ -4245,7 +4247,7 @@ or (with \pkgopt{dua})
\setacronymstyle{dua-desc}
\end{verbatim}
-\item[\pkgopt{smallcaps}] This option changes the definition of
+\item[\pkgoptdef{smallcaps}] This option changes the definition of
\ics{newacronym} and the way that acronyms are displayed.
This option may be replaced by:
\begin{verbatim}
@@ -4260,7 +4262,7 @@ or (with \pkgopt{description} and \pkgopt{footnote})
\setacronymstyle{footnote-sc-desc}
\end{verbatim}
-\item[\pkgopt{smaller}] This option changes the definition of
+\item[\pkgoptdef{smaller}] This option changes the definition of
\ics{newacronym} and the way that acronyms are displayed.
\begin{important}
If you use this option, you will need to include the \sty{relsize}
@@ -4280,7 +4282,7 @@ or (with \pkgopt{description} and \pkgopt{footnote})
\setacronymstyle{footnote-sm-desc}
\end{verbatim}
-\item[\pkgopt{footnote}] This option changes the definition of
+\item[\pkgoptdef{footnote}] This option changes the definition of
\ics{newacronym} and the way that acronyms are displayed.
This option may be replaced by:
\begin{verbatim}
@@ -4308,7 +4310,7 @@ or (with \pkgopt{smaller} and \pkgopt{description})
\end{verbatim}
-\item[\pkgopt{dua}] This option changes the definition of
+\item[\pkgoptdef{dua}] This option changes the definition of
\ics{newacronym} so that acronyms are always expanded.
This option may be replaced by:
\begin{verbatim}
@@ -4327,7 +4329,7 @@ or (with \pkgopt{description})
Other available options that don't fit any of the above categories
are:
\begin{description}
-\item[\pkgopt{symbols}] This option defines a new glossary type with
+\item[\pkgoptdef{symbols}] This option defines a new glossary type with
the label \texttt{symbols} via
\begin{verbatim}
\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
@@ -4358,7 +4360,7 @@ version of this option which additionally provides \ics{glsxtrnewsymbol}
as a convenient shortcut method for defining symbols. See the
\styfmt{glossaries-extra} manual for further details.
-\item[\pkgopt{numbers}] This option defines a new glossary type with
+\item[\pkgoptdef{numbers}] This option defines a new glossary type with
the label \texttt{numbers} via
\begin{verbatim}
\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
@@ -4389,7 +4391,7 @@ version of this option which additionally provides \ics{glsxtrnewnumber}
as a convenient shortcut method for defining numbers. See the
\styfmt{glossaries-extra} manual for further details.
-\item[\pkgopt{index}] This option defines a new glossary type with
+\item[\pkgoptdef{index}] This option defines a new glossary type with
the label \texttt{index} via
\begin{verbatim}
\newglossary[ilg]{index}{ind}{idx}{\indexname}%
@@ -4439,12 +4441,55 @@ the package option \pkgopt[index]{nohypertypes} or the command
The example file \samplefile{-index} illustrates the use of the
\pkgopt{index} package option.
-\item[\pkgopt{compatible-2.07}] Compatibility mode for old documents
+\item[\pkgoptdef{compatible-2.07}] Compatibility mode for old documents
created using version 2.07 or below.
-\item[\pkgopt{compatible-3.07}] Compatibility mode for old documents
+\item[\pkgoptdef{compatible-3.07}] Compatibility mode for old documents
created using version 3.07 or below.
+\item[\pkgoptdef{kernelglossredefs}] As a legacy from the precursor
+\sty{glossary} package, the standard glossary commands provided
+by the \LaTeX\ kernel (\cs{makeglossary} and \cs{glossary}) are
+redefined in terms of the \styfmt{glossaries} package's commands.
+However, they were never documented in this user manual, and the
+conversion guide (\htmldoc{Upgrading from the glossary package to the
+glossaries package}{glossary2glossaries}) explicitly discourages
+their use.
+
+The use of those kernel commands (instead of the appropriate
+commands documented in this user guide) are deprecated, and you will
+now get a warning if you try using them.
+
+In the event that you require the original form of these kernel
+commands, for example, if you need to use the \styfmt{glossaries}
+package with another class or package that also performs
+glossary-style indexing, then you can restore these commands to
+their previous definition (that is, their definitions prior to
+loading the \styfmt{glossaries} package) with the package option
+\pkgopt[false]{kernelglossredefs}. You may also need to use the
+\pkgopt{nomain} option in the event of file extension conflicts.
+(In which case, you must provide a new default glossary for use with
+the \sty{glossaries} package.)
+
+This option may take one of three values: \pkgoptfmt{true}
+(redefine with warnings, default), \pkgoptfmt{false} (restore
+previous definitions) or \pkgoptfmt{nowarn} (redefine without
+warnings, not recommended).
+
+Note that the only glossary-related commands provided by the \LaTeX\
+kernel are \cs{makeglossary} and \cs{glossary}. Other packages
+or classes may provide additional glossary-related commands or
+environments that conflict with \styfmt{glossaries} (such as
+\cs{printglossary} and \env{theglossary}). These non-kernel commands
+aren't affected by this package option, and you will have to find
+some way to resolve the conflict if you require both glossary
+mechanisms. (The \sty{glossaries} package will override the existing
+definitions of \cs{printglossary} and \env{theglossary}.)
+
+In general, if possible, it's best to stick with just one package that
+provides a glossary mechanism. (The \styfmt{glossaries} package does
+check for the \sty{doc} package and patches \cs{PrintChanges}.)
+
\end{description}
\section{Setting Options After the Package is Loaded}