Bug#1071647: mendex.1: some remarks and editorial changes for this man page

To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: Bug#1071647: mendex.1: some remarks and editorial changes for this man page
From: Bjarni Ingi Gislason <bjarniig@simnet.is>
Date: Wed, 22 May 2024 22:24:33 +0000
Message-id: <[🔎] 171641658713.3377.5853445520132937778.reportbug@kassi.invalid.is>
Reply-to: Bjarni Ingi Gislason <bjarniig@simnet.is>, 1071647@bugs.debian.org

Package: texlive-binaries
Version: 2023.20230311.66589-9+b2
Severity: minor
Tags: patch

Dear Maintainer,

  here are some notes and editorial fixes for the manual.

The patch is in the attachment.

-.-

The difference between the formatted outputs can be seen with:

  nroff -man <file1> > <out1>
  nroff -man <file2> > <out2>
  diff -u <out1> <out2>

and for groff, using

"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "

instead of "nroff -man"

  Add the option "-t", if the file contains a table.

  Read the output of "diff -u" with "less -R" or similar.

-.-.

  If "man" (man-db) is used to check the manual for warnings,
the following must be set:

  The option "-warnings=w"

  The environmental variable:

export MAN_KEEP_STDERR=yes (or any non-empty value)

  or

  (produce only warnings):

export MANROFFOPT="-ww -z"

export MAN_KEEP_STDERR=yes (or any non-empty value)

-.-.

Output from "mandoc -T lint mendex.1": (possibly shortened list)

mandoc: mendex.1:1:2: WARNING: missing date, using "": TH
mandoc: mendex.1:14:2: WARNING: skipping paragraph macro: PP after SH
mandoc: mendex.1:20:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:23:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:26:2: WARNING: skipping paragraph macro: PP empty
mandoc: mendex.1:78:99: STYLE: input text line longer than 80 bytes: (the next odd page t...
mandoc: mendex.1:259:87: STYLE: input text line longer than 80 bytes: Same as \fBlethead_f...
mandoc: mendex.1:350:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:360:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:369:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:434:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:470:2: WARNING: skipping paragraph macro: PP empty
mandoc: mendex.1:472:2: WARNING: skipping paragraph macro: PP after SH
mandoc: mendex.1:476:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:482:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:482:2: WARNING: skipping paragraph macro: br before sp
mandoc: mendex.1:499:87: STYLE: input text line longer than 80 bytes: The delimiter betwee...
mandoc: mendex.1:500:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:515:85: STYLE: input text line longer than 80 bytes: Though some kanji wo...
mandoc: mendex.1:516:146: STYLE: input text line longer than 80 bytes: (ex. \[u300C]\[u3072...
mandoc: mendex.1:518:132: STYLE: input text line longer than 80 bytes: in kana expression (...
mandoc: mendex.1:519:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:521:81: STYLE: input text line longer than 80 bytes: by setting the file ...
mandoc: mendex.1:524:2: WARNING: skipping paragraph macro: PP empty
mandoc: mendex.1:526:2: WARNING: skipping paragraph macro: PP after SH
mandoc: mendex.1:530:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:531:84: STYLE: input text line longer than 80 bytes: Even when sort by ch...
mandoc: mendex.1:533:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:551:2: ERROR: skipping end of block that is not open: RE
mandoc: mendex.1:561:2: WARNING: skipping paragraph macro: PP empty
mandoc: mendex.1:564:2: WARNING: skipping paragraph macro: PP empty
mandoc: mendex.1:577:2: WARNING: skipping paragraph macro: PP empty
mandoc: mendex.1:580:2: WARNING: skipping paragraph macro: PP empty
mandoc: mendex.1:585:2: WARNING: skipping paragraph macro: PP empty

-.-.

Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.  An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-" (end of options) then use "\-\-".

mendex.1:12:\fBmendex\fR [-ilqrcgfEJSU] [\fB-s\fI sty\fR] [\fB-d\fI dic\fR] [\fB-o\fI ind\fR] [\fB-t\fI log\fR] [\fB-p\fI no\fR] [\fB-I\fI enc\fR] [\fB--help\fR] [\fB--\fR] [\fI idx0 idx1 idx2 ...\fR]
mendex.1:97:\fB--help\fR
mendex.1:100:\fB--\fR
mendex.1:101:Arguments after \fB--\fR are not taken as options.
mendex.1:332:"--"

-.-.

Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.

When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.

This marking is robust, and independent of the position on the line.

It corresponds to "\ " in TeX, and to "@:" in Texinfo.


42:(e.g. 1\(en5).
515:Though some kanji words (ex. ã??è¡¨ã??) may have more than one Yomi\'s
516:(ex. ã??ã?²ã??ã??ã?? and ã??ã??ã??ã?¦ã??), only one of them can be registered in the dictionary.
518:in kana expression (ex. \\index{ã?²ã??ã??@è¡¨} or \\index{ã??ã??ã?¦@è¡¨}) on the input file.

-.-.

Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-

12:\fBmendex\fR [-ilqrcgfEJSU] [\fB-s\fI sty\fR] [\fB-d\fI dic\fR] [\fB-o\fI ind\fR] [\fB-t\fI log\fR] [\fB-p\fI no\fR] [\fB-I\fI enc\fR] [\fB--help\fR] [\fB--\fR] [\fI idx0 idx1 idx2 ...\fR]
97:\fB--help\fR

-.-.

Change - to \- if it shall be printed as a minus sign.

mendex.1:253:\'0\', \'1\' and \'-1\' respectively denotes no output, uppercase and lowercase.

-.-.

Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).

118:"\\\\indexentry"
188:\'\\\\\'
196:"\\\\begin{theindex}\\n"
202:"\\n\\n\\\\end{theindex}\\n"
208:"\\n  \\\\setcounter{page}{"
214:"}\\n"
220:"\\n\\n  \\\\indexspace\\n"
263:"\\n  \\\\item "
269:"\\n     \\\\subitem "
275:"\\n       \\\\subsubitem "
281:"\\n    \\\\subitem "
287:"\\n    \\\\subitem "
294:"\\n    \\\\subsubitem "
300:"\\n    \\\\subsubitem "
372:"\\\\"
518:in kana expression (ex. \\index{ã?²ã??ã??@è¡¨} or \\index{ã??ã??ã?¦@è¡¨}) on the input file.

-.-.

Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.

12:\fBmendex\fR [-ilqrcgfEJSU] [\fB-s\fI sty\fR] [\fB-d\fI dic\fR] [\fB-o\fI ind\fR] [\fB-t\fI log\fR] [\fB-p\fI no\fR] [\fB-I\fI enc\fR] [\fB--help\fR] [\fB--\fR] [\fI idx0 idx1 idx2 ...\fR]
97:\fB--help\fR
100:\fB--\fR
101:Arguments after \fB--\fR are not taken as options.
102:This is useful when the input file name starts with '-'.
168:"-"
253:\'0\', \'1\' and \'-1\' respectively denotes no output, uppercase and lowercase.
332:"--"

-.-.

Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.

42:(e.g. 1\(en5).
547:which contains both Japanese kana and other scripts (e.g. Latin script).

-.-.

Wrong distance between sentences.

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").

  The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

E-mail: Easier to quote exactly the relevant lines.

Generally: Easier to edit the sentence.

Patches: Less unaffected text.

Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.

  The amount of space between sentences in the output can then be
controlled with the ".ss" request.

N.B

  The number of lines affected is too large to be in the patch.

18:which can be formatted. It is almost compatible with \fImakeindex\fR, and
32:Set \'sort by character order\'. By default, \'sort by word order\' is used.
40:Disable implicit page range formation. By default, three or
42:(e.g. 1\(en5).
51:of the \fIgojuon\fR table (Japanese syllabary). By default, all 48 characters
61:Employ \fIdic\fR as the dictionary file. The dictionary file is
65:Employ \fIind\fR as the output index file. By default, the file
70:Employ \fIlog\fR as the transcript file. By default, the file name
76:\fIno\fR. The argument \fIno\fR may be numerical or one of
93:Set internal character encoding to \fIenc\fR. The argument \fIenc\fR
107:output file. The format is upper compatible with the one for
108:\fImakeindex\fR. The style file contains a list of
177:\'R\' and \'r\' correspond to Roman. \'n\' corresponds to arabic numeral.
234:Same as \fBlethead_prefix\fR. (compatible with makeindex)
246:Same as \fBlethead_suffix\fR. (compatible with makeindex)
259:Same as \fBlethead_flag\fR. (Note: makeindex uses a different name \fBheadings_flag\fR)
439:Flag to output of symbol. If \'0\', do not output.
455:Japanese and non-Japanese (ex. Latin scripts).
474:Japanese indexes, compared to \fImakeindex\fR. Users can save the effort
515:Though some kanji words (ex. ã??è¡¨ã??) may have more than one Yomi\'s
516:(ex. ã??ã?²ã??ã??ã?? and ã??ã??ã??ã?¦ã??), only one of them can be registered in the dictionary.
518:in kana expression (ex. \\index{ã?²ã??ã??@è¡¨} or \\index{ã??ã??ã?¦@è¡¨}) on the input file.
547:which contains both Japanese kana and other scripts (e.g. Latin script).
583:specified along with the order of page numbers. Otherwise,

-.-.

Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.

mendex.1: line 12 length 188
\fBmendex\fR [-ilqrcgfEJSU] [\fB-s\fI sty\fR] [\fB-d\fI dic\fR] [\fB-o\fI ind\fR] [\fB-t\fI log\fR] [\fB-p\fI no\fR] [\fB-I\fI enc\fR] [\fB--help\fR] [\fB--\fR] [\fI idx0 idx1 idx2 ...\fR]

mendex.1: line 78 length 99
(the next odd page to the end of contents), \fIeven\fR (the next even page to the end of contents).

mendex.1: line 259 length 87
Same as \fBlethead_flag\fR. (Note: makeindex uses a different name \fBheadings_flag\fR)

mendex.1: line 465 length 89
\'S\', \'N\', \'E\' and \'J\' respectively denotes symbol, numbers, English and Japanese.

mendex.1: line 499 length 87
The delimiter between the index word and its reading is one or more tab(s) or space(s).

mendex.1: line 516 length 96
(ex. ã??ã?²ã??ã??ã?? and ã??ã??ã??ã?¦ã??), only one of them can be registered in the dictionary.

mendex.1: line 518 length 92
in kana expression (ex. \\index{ã?²ã??ã??@è¡¨} or \\index{ã??ã??ã?¦@è¡¨}) on the input file.

mendex.1: line 521 length 81
by setting the file name at an environment variable \fIINDEXDEFAULTDICTIONARY\fR.

mendex.1: line 531 length 84
Even when sort by character order, the index at output remains the original sequence

-.-.

The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).

587:tex(1), latex(1), makeindex(1)

-.-.


Name of a manual is set in bold, the section in roman.
See man-pages(7).

587:tex(1), latex(1), makeindex(1)

-.-.


Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -K utf8":

troff: backtrace: file '<stdin>':489
troff:<stdin>:489: warning: special character 'u304B' not defined
troff: backtrace: file '<stdin>':489
troff:<stdin>:489: warning: special character 'u3075_3099' not defined
troff: backtrace: file '<stdin>':489
troff:<stdin>:489: warning: special character 'u3057' not defined
troff: backtrace: file '<stdin>':489
troff:<stdin>:489: warning: special character 'u304D' not defined
troff: backtrace: file '<stdin>':489
troff:<stdin>:489: warning: special character 'u304B_3099' not defined
troff: backtrace: file '<stdin>':489
troff:<stdin>:489: warning: special character 'u3044' not defined
troff: backtrace: file '<stdin>':489
troff:<stdin>:489: warning: special character 'u3083' not defined
troff: backtrace: file '<stdin>':489
troff:<stdin>:489: warning: special character 'u3075' not defined
troff: backtrace: file '<stdin>':489
troff:<stdin>:489: warning: special character 'u3084' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u30DE' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u30C3' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u30AD' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u30F3' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u30C8' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u30B7' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u30E5' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u307E' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u3064' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u3093' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u3068' not defined
troff: backtrace: file '<stdin>':491
troff:<stdin>:491: warning: special character 'u3086' not defined
troff: backtrace: file '<stdin>':493
troff:<stdin>:493: warning: special character 'u30EF' not defined
troff: backtrace: file '<stdin>':493
troff:<stdin>:493: warning: special character 'u30FC' not defined
troff: backtrace: file '<stdin>':493
troff:<stdin>:493: warning: special character 'u30D5_309A' not defined
troff: backtrace: file '<stdin>':493
troff:<stdin>:493: warning: special character 'u30ED' not defined
troff: backtrace: file '<stdin>':493
troff:<stdin>:493: warning: special character 'u308F' not defined
troff: backtrace: file '<stdin>':493
troff:<stdin>:493: warning: special character 'u3042' not defined
troff: backtrace: file '<stdin>':493
troff:<stdin>:493: warning: special character 'u308D' not defined
troff: backtrace: file '<stdin>':505
troff:<stdin>:505: warning: special character 'u6F22' not defined
troff: backtrace: file '<stdin>':505
troff:<stdin>:505: warning: special character 'u5B57' not defined
troff: backtrace: file '<stdin>':505
troff:<stdin>:505: warning: special character 'u3057_3099' not defined
troff: backtrace: file '<stdin>':507
troff:<stdin>:507: warning: special character 'u8AAD' not defined
troff: backtrace: file '<stdin>':507
troff:<stdin>:507: warning: special character 'u307F' not defined
troff: backtrace: file '<stdin>':507
troff:<stdin>:507: warning: special character 'u3088' not defined
troff: backtrace: file '<stdin>':509
troff:<stdin>:509: warning: special character 'u74B0' not defined
troff: backtrace: file '<stdin>':509
troff:<stdin>:509: warning: special character 'u5883' not defined
troff: backtrace: file '<stdin>':509
troff:<stdin>:509: warning: special character 'u3087' not defined
troff: backtrace: file '<stdin>':509
troff:<stdin>:509: warning: special character 'u3046' not defined
troff: backtrace: file '<stdin>':511
troff:<stdin>:511: warning: special character 'u30A2' not defined
troff: backtrace: file '<stdin>':511
troff:<stdin>:511: warning: special character 'u30EB' not defined
troff: backtrace: file '<stdin>':511
troff:<stdin>:511: warning: special character 'u30D5' not defined
troff: backtrace: file '<stdin>':511
troff:<stdin>:511: warning: special character 'u30A1' not defined
troff: backtrace: file '<stdin>':515
troff:<stdin>:515: warning: special character 'u300C' not defined
troff: backtrace: file '<stdin>':515
troff:<stdin>:515: warning: special character 'u8868' not defined
troff: backtrace: file '<stdin>':515
troff:<stdin>:515: warning: special character 'u300D' not defined
troff: backtrace: file '<stdin>':516
troff:<stdin>:516: warning: special character 'u3072' not defined
troff: backtrace: file '<stdin>':516
troff:<stdin>:516: warning: special character 'u304A' not defined
troff: backtrace: file '<stdin>':516
troff:<stdin>:516: warning: special character 'u3082' not defined
troff: backtrace: file '<stdin>':516
troff:<stdin>:516: warning: special character 'u3066' not defined
troff: backtrace: file '<stdin>':557
troff:<stdin>:557: warning: special character 'u30A4' not defined

an-end-check:<stdin>: Warning: Different number of .RS and .RE calls, an-RS-open=-13 at end of file

Bad use of \s0 in a string definition, the string could be resized.

6:.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX

-- System Information:
Debian Release: trixie/sid
  APT prefers testing-proposed-updates
  APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.7.12-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages texlive-binaries depends on:
ii  libc6            2.38-11
ii  libcairo2        1.18.0-3+b1
ii  libfontconfig1   2.15.0-1.1
ii  libfreetype6     2.13.2+dfsg-1+b4
ii  libgcc-s1        14-20240330-1
ii  libgraphite2-3   1.3.14-2
ii  libharfbuzz0b    8.3.0-2+b1
ii  libicu72         72.1-4+b1
ii  libkpathsea6     2023.20230311.66589-9+b2
ii  libmpfr6         4.2.1-1+b1
ii  libpaper1        1.1.29+b1
ii  libpixman-1-0    0.42.2-1+b1
ii  libpng16-16t64   1.6.43-5
ii  libpotrace0      1.16-2+b1
ii  libptexenc1      2023.20230311.66589-9+b2
ii  libstdc++6       14-20240330-1
ii  libsynctex2      2023.20230311.66589-9+b2
ii  libteckit0       2.5.12+ds1-1
ii  libtexlua53-5    2023.20230311.66589-9+b2
ii  libx11-6         2:1.8.7-1+b1
ii  libxaw7          2:1.0.14-1+b2
ii  libxi6           2:1.8.1-1
ii  libxmu6          2:1.1.3-3+b2
ii  libxpm4          1:3.5.17-1+b1
ii  libxt6t64        1:1.2.1-1.2
ii  libzzip-0-13t64  0.13.72+dfsg.1-1.2+b1
ii  perl             5.38.2-4
ii  t1utils          1.41-4
ii  tex-common       6.18
ii  zlib1g           1:1.3.dfsg+really1.3.1-1

Versions of packages texlive-binaries recommends:
pn  dvisvgm       <none>
ii  texlive-base  2023.20240207-1

Versions of packages texlive-binaries suggests:
pn  hintview               <none>
pn  texlive-binaries-sse2  <none>

Versions of packages tex-common depends on:
ii  ucf  3.0043+nmu1

Versions of packages tex-common suggests:
pn  debhelper  <none>

Versions of packages texlive-binaries is related to:
ii  tex-common    6.18
ii  texlive-base  2023.20240207-1

-- no debconf information

--- mendex.1	2024-05-22 15:17:20.900504001 +0000
+++ mendex.1.new	2024-05-22 21:46:41.972050662 +0000
@@ -9,97 +9,98 @@
 .SH NAME
 mendex \- Japanese index processor
 .SH SYNOPSIS
-\fBmendex\fR [-ilqrcgfEJSU] [\fB-s\fI sty\fR] [\fB-d\fI dic\fR] [\fB-o\fI ind\fR] [\fB-t\fI log\fR] [\fB-p\fI no\fR] [\fB-I\fI enc\fR] [\fB--help\fR] [\fB--\fR] [\fI idx0 idx1 idx2 ...\fR]
+\fBmendex\fR [\fB\-ilqrcgfEJSU\fP] [\fB\-s\fI sty\fR] [\fB\-d\fI dic\fR] \
+[\fB\-o\fI ind\fR] [\fB\-t\fI log\fR] [\fB\-p\fI no\fR] [\fB\-I\fI enc\fR] \
+[\fB\-\-help\fR] [\fB\-\-\fR] [\fI idx0 idx1 idx2 ...\fR]
 .SH DESCRIPTION
-.PP
 The program \fImendex\fR is a general purpose hierarchical index generator;
 it accepts one or more input files (\fI.idx\fR; often produced by a text
 formatter such as \*(LX), sorts the entries, and produces an output file
 which can be formatted. It is almost compatible with \fImakeindex\fR, and
 additional feature for handling readings of kanji words is also available.
-.RE
+.LP
 The formats of the input and output files are specified in a style file.
 The readings of kanji words can be specified in a dictionary file.
-.RE
+.LP
 The index can have up to three levels (0, 1, and 2) of subitem nesting.
 .SH OPTIONS
-.PP
 .TP 10
-\fB-i\fR
+\fB\-i\fR
 Take input from stdin, even when index files are specified.
 .TP 10
-\fB-l\fR
+\fB\-l\fR
 Set \'sort by character order\'. By default, \'sort by word order\' is used.
 Details are described below.
 .TP 10
-\fB-q\fR
+\fB\-q\fR
 Quiet mode; send no message to \fIstderr\fR, except error
 messages and warnings.
 .TP 10
-\fB-r\fR
+\fB\-r\fR
 Disable implicit page range formation. By default, three or
 more successive pages are automatically abbreviated as a range
-(e.g. 1\(en5).
+(e.g.\& 1\(en5).
 .TP 10
-\fB-c\fR
+\fB\-c\fR
 Compress sequence of intermediate blanks (space(s) and/or tab(s)) into a space
 and ignore leading and trailing blank(s).
 By default, blanks in the index key are retained.
 .TP 10
-\fB-g\fR
-Make Japanese index head \fIA\fR-line (\fIA, Ka, Sa, ...\fR; 10 characters)
+\fB\-g\fR
+Make Japanese index head \fIA\fR\-line (\fIA, Ka, Sa, ...\fR; 10 characters)
 of the \fIgojuon\fR table (Japanese syllabary). By default, all 48 characters
 in the \fIgojuon\fR table are used.
 .TP 10
-\fB-f\fR
+\fB\-f\fR
 Force to output Kanji characters even non-existent in dictionaries.
 .TP 10
-\fB-s\fI sty\fR
+\fB\-s\fI sty\fR
 Employ \fIsty\fR as the style file.
 .TP 10
-\fB-d\fI dic\fR
+\fB\-d\fI dic\fR
 Employ \fIdic\fR as the dictionary file. The dictionary file is
 composed of lists of <\fIindex_word\fR\ \fIreading\fR>.
 .TP 10
-\fB-o\fI ind\fR
+\fB\-o\fI ind\fR
 Employ \fIind\fR as the output index file. By default, the file
 name is created by appending the extension \fIind\fR to the base
 name of the first input file.
 .TP 10
-\fB-t\fI log\fR
+\fB\-t\fI log\fR
 Employ \fIlog\fR as the transcript file. By default, the file name
 is created by appending the extension \fIilg\fR to the base name
 of the first input file.
 .TP 10
-\fB-p\fI no\fR
+\fB\-p\fI no\fR
 Set the starting page number of the output index list to be
 \fIno\fR. The argument \fIno\fR may be numerical or one of
-the following: \fIany\fR (the next page to the end of contents), \fIodd\fR
-(the next odd page to the end of contents), \fIeven\fR (the next even page to the end of contents).
+the following: \fIany\fR (the next page to the end of contents),
+\fIodd\fR (the next odd page to the end of contents),
+\fIeven\fR (the next even page to the end of contents).
 .TP 10
-\fB-E\fR
+\fB\-E\fR
 Set input/output character encoding to EUC-JP.
 .TP 10
-\fB-J\fR
+\fB\-J\fR
 Set input/output character encoding to JIS (ISO-2022-JP).
 .TP 10
-\fB-S\fR
+\fB\-S\fR
 Set input/output character encoding to Shift_JIS.
 .TP 10
-\fB-U\fR
+\fB\-U\fR
 Set input/output character encoding to UTF-8.
 .TP 10
-\fB-I\fI enc\fR
+\fB\-I\fI enc\fR
 Set internal character encoding to \fIenc\fR. The argument \fIenc\fR
 may be \fIeuc\fR (EUC-JP) or \fIutf8\fR (UTF-8).
 The default is set to \fIutf8\fR.
 .TP 10
-\fB--help\fR
+\fB\-\-help\fR
 Show summary of options.
 .TP 10
-\fB--\fR
-Arguments after \fB--\fR are not taken as options.
-This is useful when the input file name starts with '-'.
+\fB\-\-\fR
+Arguments after \fB\-\-\fR are not taken as options.
+This is useful when the input file name starts with '\-'.
 
 .SH "STYLE FILE"
 The style file informs \fImendex\fR about the format of the
@@ -110,12 +111,11 @@ output file. The format is upper compati
 There are two types of specifiers: input and output.
 Pairs do not have to appear in any particular order.
 A line begun by \'%\' is a comment.
-
 .PP
 \fBInput file style parameter\fR
 .TP 30
 \fBkeyword\fR  <string>
-"\\\\indexentry"
+"\e\eindexentry"
 .RS
 Command with an argument of index entry which is going to be processed.
 .RE
@@ -165,7 +165,7 @@ attached to the page number.
 .RE
 .TP 30
 \fBpage_compositor\fR  <string>
-"-"
+"\-"
 .RS
 Separator between page levels for a style with multi-levels of page numbers.
 .RE
@@ -174,7 +174,7 @@ Separator between page levels for a styl
 "rnaRA"
 .RS
 Priority of expression for page number.
-\'R\' and \'r\' correspond to Roman. \'n\' corresponds to arabic numeral.
+\'R\' and \'r\' correspond to Roman. \'n\' corresponds to Arabic numeral.
 \'A\' and \'a\' correspond to Latin alphabet.
 .RE
 .TP 30
@@ -185,7 +185,7 @@ Escape character for \fImendex\fR parame
 .RE
 .TP 30
 \fBescape\fR  <char>
-\'\\\\\'
+\'\e\e\'
 .RS
 Escape character for general scripts.
 .RE
@@ -193,31 +193,31 @@ Escape character for general scripts.
 \fBOutput file style parameter\fR
 .TP 30
 \fBpreamble\fR  <string>
-"\\\\begin{theindex}\\n"
+"\e\ebegin{theindex}\en"
 .RS
 Preamble of output file.
 .RE
 .TP 30
 \fBpostamble\fR  <string>
-"\\n\\n\\\\end{theindex}\\n"
+"\en\en\e\eend{theindex}\en"
 .RS
 Postamble of output file.
 .RE
 .TP 30
 \fBsetpage_prefix\fR  <string>
-"\\n  \\\\setcounter{page}{"
+"\en  \e\esetcounter{page}{"
 .RS
 Prefix of page number if start page is designated.
 .RE
 .TP 30
 \fBsetpage_suffix\fR  <string>
-"}\\n"
+"}\en"
 .RS
 Suffix of page number if start page is designated.
 .RE
 .TP 30
 \fBgroup_skip\fR  <string>
-"\\n\\n  \\\\indexspace\\n"
+"\en\en  \e\eindexspace\en"
 .RS
 Strings to insert vertical space before new section of index.
 .RE
@@ -250,54 +250,55 @@ Same as \fBlethead_suffix\fR. (compatibl
 0
 .RS
 Flag to control output of heading letters.
-\'0\', \'1\' and \'-1\' respectively denotes no output, uppercase and lowercase.
+\'0\', \'1\' and \'\-1\' respectively denotes no output, uppercase and lowercase.
 .RE
 .TP 30
 \fBheading_flag\fR  <number>
 0
 .RS
-Same as \fBlethead_flag\fR. (Note: makeindex uses a different name \fBheadings_flag\fR)
+Same as \fBlethead_flag\fR.
+(Note: makeindex uses a different name \fBheadings_flag\fR)
 .RE
 .TP 30
 \fBitem_0\fR  <string>
-"\\n  \\\\item "
+"\en  \e\eitem "
 .RS
 Command sequence inserted between primary level entries.
 .RE
 .TP 30
 \fBitem_1\fR  <string>
-"\\n     \\\\subitem "
+"\en     \e\esubitem "
 .RS
 Command sequence inserted between sub level entries.
 .RE
 .TP 30
 \fBitem_2\fR  <string>
-"\\n       \\\\subsubitem "
+"\en       \e\esubsubitem "
 .RS
 Command sequence inserted between subsub level entries.
 .RE
 .TP 30
 \fBitem_01\fR  <string>
-"\\n    \\\\subitem "
+"\en    \e\esubitem "
 .RS
-Command sequence inserted between primaly and sub level entries.
+Command sequence inserted between primary and sub level entries.
 .RE
 .TP 30
 \fBitem_x1\fR  <string>
-"\\n    \\\\subitem "
+"\en    \e\esubitem "
 .RS
 Command sequence inserted between primary and sub level entries
 when main entry does not have page number.
 .RE
 .TP 30
 \fBitem_12\fR  <string>
-"\\n    \\\\subsubitem "
+"\en    \e\esubsubitem "
 .RS
 Command sequence inserted between sub and subsub level entries.
 .RE
 .TP 30
 \fBitem_x2\fR  <string>
-"\\n    \\\\subsubitem "
+"\en    \e\esubsubitem "
 .RS
 Command sequence inserted between sub and subsub level entries
 when sub level entry does not have page number.
@@ -329,7 +330,7 @@ commonly used for any entry level.
 .RE
 .TP 30
 \fBdelim_r\fR  <string>
-"--"
+"\-\-"
 .RS
 Delimiter string between pages to show page range.
 .RE
@@ -345,7 +346,6 @@ Delimiter string output at the end of pa
 .RS
 String to be inserted in place of \fBdelim_n\fR and the next page
 number when the two pages are contiguous.
-.RE
 It works only when the parameter is defined.
 .RE
 .TP 30
@@ -355,7 +355,6 @@ It works only when the parameter is defi
 String to be inserted in place of \fBdelim_r\fR and the third page
 number when the three pages are contiguous.
 The parameter is prior to \fBsuffix_mp\fR.
-.RE
 It works only when the parameter is defined.
 .RE
 .TP 30
@@ -364,12 +363,11 @@ It works only when the parameter is defi
 .RS
 String to be inserted in place of \fBdelim_r\fR and the last page
 number when the three or more pages are contiguous.
-.RE
 It works only when the parameter is defined.
 .RE
 .TP 30
 \fBencap_prefix\fR  <string>
-"\\\\"
+"\e\e"
 .RS
 Prefix for an encapsulating command
 when the encapsulating command is added to the page number.
@@ -428,7 +426,6 @@ when lethead_flag or heading_flag is neg
 .RS
 Strings to output as heading letter for numbers and symbols
 when symbol_flag is non zero.
-.RE
 If specified, the option is prior to symhead_positive and symhead_negative.
 (Extended by mendex)
 .RE
@@ -462,30 +459,27 @@ Japanese sequence and non-Japanese seque
 "SNEJ"
 .RS
 Order of scripts and symbols.
-\'S\', \'N\', \'E\' and \'J\' respectively denotes symbol, numbers, English and Japanese.
+\'S\', \'N\', \'E\' and \'J\' respectively denotes symbol, numbers, English
+and Japanese.
 (Extended by mendex)
 Please make sure that \'S\' and \'N\' are next to each other,
 since \fBmendex\fR considers numbers as part of symbol.
 .RE
-.PP
 .SH ABOUT JAPANESE PROCESSING
-.PP
 \fImendex\fR has an additional feature to simplify the procedure of handling
 Japanese indexes, compared to \fImakeindex\fR. Users can save the effort
 of manually specifying a reading for every kanji word.
-.RE
+.PP
 Japanese kanji words are usually sorted by the syllables of their readings
 (\fI\'Yomi\'\fR), which can be represented by kana (Hiragana, Katakana) scripts.
 \fImendex\fR accepts index words specified in kana expression directly on
 an input file, and also accepts conversion from index words to kana scripts
 by referring to Japanese dictionaries.
-.RE
-
 .LP
 Examples of internal simplification of syllables are shown below.
 .PP
 .RS
-.br
+.\".br
 ã‹ã¶ã—ããŒã„ã—ã‚ƒ		ã‹ãµã—ãã‹ã„ã—ã‚„
 .br
 ãƒžãƒƒã‚ãƒ³ãƒˆãƒƒã‚·ãƒ¥		ã¾ã¤ãã‚“ã¨ã¤ã—ã‚†
@@ -496,8 +490,9 @@ ãƒ¯ãƒ¼ãƒ—ãƒ			ã‚ã‚ãµã‚
 The dictionary file consists of list with <\'index_word\' \'reading\'>.
 The index word can be written in any scripts (kanji, kana, etc),
 and the reading must be in Hiragana or Katakana scripts.
-The delimiter between the index word and its reading is one or more tab(s) or space(s).
-.RE
+The delimiter between the index word and its reading is one or more tab(s)
+or space(s).
+.PP
 An example of a Japanese dictionary is shown below.
 .PP
 .RS
@@ -512,43 +507,43 @@ Î±		ã‚¢ãƒ«ãƒ•ã‚¡
 .RE
 .LP
 Here, each index word is allowed to have only one Yomi.
-Though some kanji words (ex. ã€Œè¡¨ã€) may have more than one Yomi\'s
-(ex. ã€Œã²ã‚‡ã†ã€ and ã€ŒãŠã‚‚ã¦ã€), only one of them can be registered in the dictionary.
+Though some kanji words (ex.\& ã€Œè¡¨ã€) may have more than one Yomi\'s
+(ex.\& ã€Œã²ã‚‡ã†ã€ and ã€ŒãŠã‚‚ã¦ã€),
+only one of them can be registered in the dictionary.
 When some different Yomi\'s are needed, they should be specified explicitly
-in kana expression (ex. \\index{ã²ã‚‡ã†@è¡¨} or \\index{ãŠã‚‚ã¦@è¡¨}) on the input file.
-.RE
+in kana expression (ex.\& \eindex{ã²ã‚‡ã†@è¡¨} or \eindex{ãŠã‚‚ã¦@è¡¨})
+on the input file.
+.LP
 Moreover, a dictionary file is automatically referred
 by setting the file name at an environment variable \fIINDEXDEFAULTDICTIONARY\fR.
 The dictionary set by the environment variable can be used
-together with file(s) specified by \fI-d\fR option.
-.PP
+together with file(s) specified by \fI\-d\fR option.
 .SH ABOUT SORTING PROCEDURE
-.PP
 \fImendex\fR sorts indexes as is (\'sort by word order\') by default.
-Setting \fI-l\fR option, spaces between words in an index are truncated prior to
+Setting \fI\-l\fR option, spaces between words in an index are truncated prior to
 sorting procedure (\'sort by character order\').
-.RE
-Even when sort by character order, the index at output remains the original sequence
-without the truncation.
-.RE
+.PP
+Even when sort by character order,
+the index at output remains the original sequence without the truncation.
+.LP
 Follows show an example.
 .PP
 .RS
 \fIsort by word order		sort by character order\fR
 .br
-X Window			Xlib
+X Window				Xlib
 .br
-Xlib				XView
+Xlib					XView
 .br
 XView				X Window
 .RE
 .LP
 In addition, two sorting methods can be applied for indexes
-which contains both Japanese kana and other scripts (e.g. Latin script).
+which contains both Japanese kana and other scripts (e.g.\& Latin script).
 By setting \fIpriority\fR 0 (default) and 1 at a style file,
 a space between Japanese Kana and other scripts is inserted and
 not inserted respectively, prior to the sorting procedure.
-.RE
+.PP
 Follows show an example.
 .PP
 .RS
@@ -558,10 +553,8 @@ index sort			indãƒ•ã‚¡ã‚¤ãƒ«
 .br
 indãƒ•ã‚¡ã‚¤ãƒ«			index sort
 .RE
-.PP
 .SH ENVIRONMENT VARIABLES
 \fImendex\fR refers environment variables as follows.
-.PP
 .TP 10
 \fIINDEXSTYLE\fR
 Directory where index style files exist.
@@ -574,16 +567,13 @@ Directory where dictionary files exist.
 .TP 10
 \fIINDEXDEFAULTDICTIONARY\fR
 Dictionary file which is automatically read.
-.PP
 .SH DETAIL
 Detailed specification is compatible with \fImakeindex\fR.
-.PP
 .SH KNOWN ISSUES
 When plural page number expression is used, \fI.idx\fR files should be
 specified along with the order of page numbers. Otherwise,
 wrong page numbers might be output.
-.PP
 .SH "SEE ALSO"
-tex(1), latex(1), makeindex(1)
+.BR tex "(1), " latex "(1), " makeindex (1)
 .SH AUTHOR
 This manual page was written by Japanese \*(TX Development Community.

Reply to:

Follow-Ups:
- Bug#1071647: mendex.1: some remarks and editorial changes for this man page
  - From: Preuße@buxtehude.debian.org, Hilmar <hille42@web.de>
- Processed: Re: Bug#1071647: mendex.1: some remarks and editorial changes for this man page
  - From: "Debian Bug Tracking System" <owner@bugs.debian.org>

Prev by Date: Bug#1057407: marked as done (texworks: Intent to drop poppler-qt6 on i386)
Next by Date: Bug#1071649: mflua.1: some remarks and editorial changes for this man page
Previous by thread: Bug#1057407: marked as done (texworks: Intent to drop poppler-qt6 on i386)
Next by thread: Bug#1071647: mendex.1: some remarks and editorial changes for this man page
Index(es):
- Date
- Thread