summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/glossaries/makeglossaries.1
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/glossaries/makeglossaries.1')
-rw-r--r--macros/latex/contrib/glossaries/makeglossaries.1124
1 files changed, 23 insertions, 101 deletions
diff --git a/macros/latex/contrib/glossaries/makeglossaries.1 b/macros/latex/contrib/glossaries/makeglossaries.1
index 77aa4f7060..d43c1b1268 100644
--- a/macros/latex/contrib/glossaries/makeglossaries.1
+++ b/macros/latex/contrib/glossaries/makeglossaries.1
@@ -1,4 +1,5 @@
-.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -15,29 +16,12 @@
.ft R
.fi
..
-.\" Set up some character translations and predefined strings. \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. \*(C+ will
-.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
-. ds -- \(*W-
-. ds PI pi
-. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-. ds L" ""
-. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
-. ds -- \|\(em\|
-. ds PI \(*p
-. ds L" ``
-. ds R" ''
. ds C`
. ds C'
'br\}
@@ -68,85 +52,23 @@
. \}
.\}
.rr rF
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear. Run. Save yourself. No user-serviceable parts.
-. \" fudge factors for nroff and troff
-.if n \{\
-. ds #H 0
-. ds #V .8m
-. ds #F .3m
-. ds #[ \f1
-. ds #] \fP
-.\}
-.if t \{\
-. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
-. ds #F 0
-. ds #[ \&
-. ds #] \&
-.\}
-. \" simple accents for nroff and troff
-.if n \{\
-. ds ' \&
-. ds ` \&
-. ds ^ \&
-. ds , \&
-. ds ~ ~
-. ds /
-.\}
-.if t \{\
-. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-. \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-. \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-. \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-. ds : e
-. ds 8 ss
-. ds o a
-. ds d- d\h'-1'\(ga
-. ds D- D\h'-1'\(hy
-. ds th \o'bp'
-. ds Th \o'LP'
-. ds ae ae
-. ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MAKEGLOSSARIES 1"
-.TH MAKEGLOSSARIES 1 "2022-11-03" "perl v5.34.1" "makeglossaries Perl Script"
+.TH MAKEGLOSSARIES 1 2023-10-01 "perl v5.36.1" "makeglossaries Perl Script"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
-.SH "NAME"
+.SH NAME
makeglossaries \- Calls makeindex/xindy for LaTeX documents using glossaries package
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBmakeglossaries\fR [\fB\-o\fR \fIfile\fR] [\fB\-q\fR] [\fB\-Q\fR] [\fB\-k\fR] [\fB\-n\fR]
[\fB\-s\fR \fIfile\fR] [\fB\-t\fR \fIfile\fR] [\fB\-L\fR \fIlanguage\fR] [\fB\-c\fR] [\fB\-g\fR] [\fB\-l\fR]
[\fB\-p\fR \fInum\fR] [\fB\-r\fR] [\fB\-d\fR \fIaux dir\fR] [\fB\-m\fR \fIfile\fR] [\fB\-x\fR \fIfile\fR]
[\fB\-e\fR] [\fB\-\-version\fR] [\fB\-\-help\fR] \fIbasename\fR
-.SH "DESCRIPTION"
+.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBmakeglossaries\fR is designed for use with LaTeX documents that
use the glossaries package. The mandatory argument \fIbasename\fR should
@@ -156,26 +78,26 @@ be the name of the LaTeX document without the .tex extension.
required to be passed to the relevant indexing application should
also be contained in the auxiliary file, but may be overridden by
the option arguments to \fBmakeglossaries\fR.
-.SH "OPTIONS"
+.SH OPTIONS
.IX Header "OPTIONS"
-.IP "\fB\-e\fR" 4
+.IP \fB\-e\fR 4
.IX Item "-e"
Don't attempt to repair multiple encaps or illegal page number (\fBmakeindex\fR only).
-.IP "\fB\-c\fR" 4
+.IP \fB\-c\fR 4
.IX Item "-c"
Compress intermediate blanks (\fBmakeindex\fR only).
.IP "\fB\-d\fR \fIaux dir\fR" 4
.IX Item "-d aux dir"
Specify the directory the .aux, .glo etc files are located.
Defaults to the parent directory of the base file \fIfilename\fR.
-.IP "\fB\-g\fR" 4
+.IP \fB\-g\fR 4
.IX Item "-g"
Employ German word ordering (\fBmakeindex\fR only).
-.IP "\fB\-k\fR" 4
+.IP \fB\-k\fR 4
.IX Item "-k"
Don't try forking with piped redirection. (Lessens the
effect of \-q)
-.IP "\fB\-l\fR" 4
+.IP \fB\-l\fR 4
.IX Item "-l"
Letter ordering.
.IP "\fB\-L\fR \fIlanguage\fR" 4
@@ -186,7 +108,7 @@ language. See \fBxindy\fR documentation for further details.
.IX Item "-m file"
Specify the full path name for \fBmakeindex\fR to \fIfile\fR in the
event that \fBmakeindex\fR isn't on the operating system's path.
-.IP "\fB\-n\fR" 4
+.IP \fB\-n\fR 4
.IX Item "-n"
Print the commands that would normally be executed but don't run them.
.IP "\fB\-o\fR \fIfile\fR" 4
@@ -197,13 +119,13 @@ overridden.)
.IP "\fB\-p\fR \fInum\fR" 4
.IX Item "-p num"
Sets the starting page number to be \fInum\fR (\fBmakeindex\fR only).
-.IP "\fB\-q\fR" 4
+.IP \fB\-q\fR 4
.IX Item "-q"
Quiet mode. Reduces chatter to standard output.
-.IP "\fB\-Q\fR" 4
+.IP \fB\-Q\fR 4
.IX Item "-Q"
Silences warning about being unable to fork.
-.IP "\fB\-r\fR" 4
+.IP \fB\-r\fR 4
.IX Item "-r"
.PD 0
.IP "\fB\-s\fR \fIfile\fR" 4
@@ -221,22 +143,22 @@ Disable implicit page range formation (\fBmakeindex\fR only).
.IX Item "-x file"
Specify the full path name for \fBxindy\fR to \fIfile\fR in the
event that \fBxindy\fR isn't on the operating system's path.
-.IP "\fB\-\-version\fR" 4
+.IP \fB\-\-version\fR 4
.IX Item "--version"
Prints version number and exits.
-.IP "\fB\-\-help\fR" 4
+.IP \fB\-\-help\fR 4
.IX Item "--help"
Prints help message and exits.
-.SH "REQUIRES"
+.SH REQUIRES
.IX Header "REQUIRES"
Perl, Getopt::Std, and makeindex or xindy (depending on glossaries
package options).
-.SH "LICENSE"
+.SH LICENSE
.IX Header "LICENSE"
This is free software distributed under the LaTeX Project Public
-License. There is \s-1NO WARRANTY.\s0
+License. There is NO WARRANTY.
See <http://www.latex\-project.org/lppl.txt> for details.
-.SH "AUTHOR"
+.SH AUTHOR
.IX Header "AUTHOR"
Nicola L. C. Talbot,
<http://www.dickimaw\-books.com/>