summaryrefslogtreecommitdiff
path: root/support/makeglossariesgui/makeglossariesgui.1
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-03-11 03:01:11 +0000
committerNorbert Preining <norbert@preining.info>2020-03-11 03:01:11 +0000
commit5412d52974c365e2d5bc1a8320816a729f7c10ab (patch)
tree5c8cee6076f9589a9d372c0ee08d16210251ac9a /support/makeglossariesgui/makeglossariesgui.1
parent877268a0de707a979be934d888518f6cc02d73a6 (diff)
CTAN sync 202003110301
Diffstat (limited to 'support/makeglossariesgui/makeglossariesgui.1')
-rw-r--r--support/makeglossariesgui/makeglossariesgui.1205
1 files changed, 205 insertions, 0 deletions
diff --git a/support/makeglossariesgui/makeglossariesgui.1 b/support/makeglossariesgui/makeglossariesgui.1
new file mode 100644
index 0000000000..af47de67a2
--- /dev/null
+++ b/support/makeglossariesgui/makeglossariesgui.1
@@ -0,0 +1,205 @@
+.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.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'
+.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\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.if !\nF .nr F 0
+.if \nF>0 \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+.\}
+.\"
+.\" 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 "MAKEGLOSSARIESGUI 1"
+.TH MAKEGLOSSARIESGUI 1 "2018-05-19" "perl v5.26.2" "makeglossariesgui"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBmakeglossariesgui\fR [\fIoption\fR]+ [\fIfilename\fR]
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+MakeGlossariesGUI is a Java \s-1GUI\s0 diagnostic tool for the glossaries
+LaTeX package. It can check for common problems that can cause the
+entries within the glossary or the entire glossary to be omitted. In
+\&\s-1GUI\s0 mode it parses both the .aux and the .log file for known error
+and warning messages.
+.PP
+When run in batch mode, it can be used as alternative to the
+makeglossaries Perl script and the makeglossaries\-lite.lua Lua
+script supplied by the glossaries package. (It doesn't parse the log
+file in batch mode or show all the diagnostic information that the
+\&\s-1GUI\s0 mode provides.)
+.PP
+Note that if you are opting to use MakeGlossariesGUI because you
+don't want to install Perl, then you are limiting yourself to
+makeindex as xindy also requires Perl.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-\-version\fR (or \fB\-v\fR)" 4
+.IX Item "--version (or -v)"
+Show the version number and exit.
+.IP "\fB\-\-help\fR (or \fB\-h\fR)" 4
+.IX Item "--help (or -h)"
+Show the help and exit.
+.IP "\fB\-\-debug\fR" 4
+.IX Item "--debug"
+Print debug messages to \s-1STDOUT.\s0
+.IP "\fB\-\-batch\fR (or \fB\-b\fR)" 4
+.IX Item "--batch (or -b)"
+Run in batch mode. The \fIfilename\fR must be supplied with this option
+and should be the name of the .aux file. (The extension may be omitted.)
+.IP "\fB\-\-gui\fR" 4
+.IX Item "--gui"
+Run in \s-1GUI\s0 mode (default).
+.IP "\fB\-\-quiet\fR" 4
+.IX Item "--quiet"
+Suppress messages that would otherwise be written to \s-1STDOUT.\s0
+.IP "\fB\-\-dry\-run\fR (or \fB\-n\fR)" 4
+.IX Item "--dry-run (or -n)"
+Switch dry run mode on.
+.IP "\fB\-\-nodry\-run\fR" 4
+.IX Item "--nodry-run"
+Switch dry run mode off (default).
+.SH "REQUIRES"
+.IX Header "REQUIRES"
+Java 7 and a TeX distribution.
+.SH "LICENSE"
+.IX Header "LICENSE"
+License GPLv3+: \s-1GNU GPL\s0 version 3 or later
+<http://gnu.org/licenses/gpl.html>
+This is free software: you are free to change and redistribute it.
+There is \s-1NO WARRANTY,\s0 to the extent permitted by law.
+.SH "RECOMMENDED READING"
+.IX Header "RECOMMENDED READING"
+The MakeGlossariesGUI manual (available as a \s-1PDF\s0 or through the \s-1GUI\s0).
+.PP
+The glossaries manual:
+.PP
+.Vb 1
+\& texdoc glossaries
+.Ve
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Nicola L. C. Talbot,
+<http://www.dickimaw\-books.com/>