Debian Codegraph @

texmf-dist/doc/man/man1/findhyph.1

raw
1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 . if \nF \{
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\" ========================================================================
72 .\"
73 .IX Title "FINDHYPH 1"
74 .TH FINDHYPH 1 "2015-10-18" "perl v5.20.2" ""
75 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
76 .\" way too many mistakes in technical documents.
77 .if n .ad l
78 .nh
79 .SH "NAME"
80 findhyph – find words hyphenated by TeX in a document
81 .SH "INSTALLATION"
82 .IX Header "INSTALLATION"
83 Copy \fBfindhyph\fR or \fBfindhyph.bat\fR (depending on \s-1OS\s0 used) to a directory
84 included in system \s-1PATH.\s0 Perl interpreter is required to be in
85 \&\f(CW\*(C`/usr/bin/\*(C'\fR for Unix-like systems or in \s-1PATH\s0 when using \fBfindhyph.bat\fR.
86 .SH "SYNOPSIS"
87 .IX Header "SYNOPSIS"
88 \&\fBfindhyph [options]\fR \fIfoo.log\fR
89 .SH "DESCRIPTION"
90 .IX Header "DESCRIPTION"
91 To use this program:
92 .IP "1)" 4
93 .IX Item "1)"
94 set \f(CW\*(C`\etracingparagraphs=1\*(C'\fR in a TeX document \fIfoo.tex\fR and run:
95 .IP "2)" 4
96 .IX Item "2)"
97 \&\fBtex\fR \fIfoo.tex\fR
98 .IP "3)" 4
99 .IX Item "3)"
100 \&\fBfindhyph [options]\fR \fIfoo.log\fR
101 .PP
102 If you are setting \f(CW\*(C`\elooseness=<N>\*(C'\fR to optimize paragraphs,
103 you need to pass that information to the file \fIfoo.log\fR in a form
104 \&\f(CW\*(C`@looseness=<N>\*(C'\fR (on a separate line). You can use a macro like
105 \&\f(CW\*(C`\edef\esetlooseness#1{\elooseness=#1 \eimmediate\ewrite\-1{@looseness=#1}}\*(C'\fR
106 for this purpose. If the paragraph contains material in display math mode,
107 you need to use the macro in all split parts of the paragraph.
108 .SH "OPTIONS"
109 .IX Header "OPTIONS"
110 .IP "\fB\-c\fR" 4
111 .IX Item "-c"
112 display hyphenated words in context
113 .IP "\fB\-f\fR" 4
114 .IX Item "-f"
115 display font selectors and other strings starting with a backslash character
116 .IP "\fB\-v\fR" 4
117 .IX Item "-v"
118 display program version
119 .IP "\fB\-p\fR" 4
120 .IX Item "-p"
121 generate file containing information about one-letter prepositions and
122 conjunctions left at the end of line
123 .IP "\fB\-l=STRING\fR" 4
124 .IX Item "-l=STRING"
125 use prepositions/conjunctions listed in \s-1STRING\s0 instead of default list of
126 prepositions and conjunctions \f(CW\*(C`kKsSvVzZoOuUiIA\*(C'\fR used for Slovak and Czech
127 language
128 .SH "OUTPUT FILES"
129 .IX Header "OUTPUT FILES"
130 .IP "\fIfoo.hyph\fR" 4
131 .IX Item "foo.hyph"
132 List of hyphenated words. All punctuation characters, parentheses and
133 other character immediately preceding or following displayed words are included
134 in this list. TeX constructs which are too difficult to display (\f(CW\*(C`\ehbox{}\*(C'\fR,
135 \&\f(CW\*(C`\emark{}\*(C'\fR etc.) are shown as \f(CW\*(C`[]\*(C'\fR. Math mode is indicated by \f(CW\*(C`$\*(C'\fR sign.
136 .Sp
137 Page numbers in square brackets refer to \s-1LOG\s0 file and may occasionally differ
138 from the typeset document. The reason is that TeX may need to break more
139 paragraphs than it would eventually fit on the page in order to find a page
140 break.
141 .Sp
142 Words hyphenated in footnotes are listed before the words hyphenated in the
143 paragraph in which the footnote is referenced.
144 .IP "\fIfoo.prep\fR" 4
145 .IX Item "foo.prep"
146 List of prepositions if option \fB\-p\fR is used.
147 .SH "HISTORY"
148 .IX Header "HISTORY"
149 1.0 (2001\-04\-08)
150 .IX Subsection "1.0 (2001-04-08)"
151 .IP "\(bu" 4
152 public release
153 .PP
154 2.0 (2009\-08\-10)
155 .IX Subsection "2.0 (2009-08-10)"
156 .IP "\(bu" 4
157 fixes in line breaks detection algorithm; support for the third pass of line
158 breaking algorithm in TeX (positive \f(CW\*(C`\eemergencystretch\*(C'\fR); support for
159 discretionary breaks in the first pass
160 .IP "\(bu" 4
161 page number detection improved (recognized negative page numbers, compound page
162 numbers when \f(CW\*(C`\ecount1\*(C'\fR to \f(CW\*(C`\ecount9\*(C'\fR registers are non-zero
163 and \f(CW\*(C`[nn{mapfile}]\*(C'\fR, \f(CW\*(C`[nn<picture>]\*(C'\fR and \f(CW\*(C`[nn<newline>\*(C'\fR
164 formats used by pdfTeX; false page number detection should be much more rare)
165 .IP "\(bu" 4
166 configurable list of prepositions and conjunctions
167 .IP "\(bu" 4
168 hyphenated words can be displayed in context
169 .IP "\(bu" 4
170 suggestions and testing by Pavel Stříž
171 .PP
172 3.0 (2012\-02\-01)
173 .IX Subsection "3.0 (2012-02-01)"
174 .IP "\(bu" 4
175 fixed a bug when total paragraph demerits are negative
176 .IP "\(bu" 4
177 \&\f(CW\*(C`\elooseness\*(C'\fR setting is now taken into account (thanks to Karel Horák
178 for identifying the issue)
179 .PP
180 3.1 (2012\-11\-03)
181 .IX Subsection "3.1 (2012-11-03)"
182 .IP "\(bu" 4
183 fixed displaying of hyphenated ligatures (bug reported by Karel Horák)
184 .PP
185 3.2 (2012\-11\-21)
186 .IX Subsection "3.2 (2012-11-21)"
187 .IP "\(bu" 4
188 improved example definition of the \f(CW\*(C`\esetlooseness\*(C'\fR macro
189 (thanks to Karl Berry)
190 .PP
191 3.3 (2013\-06\-18)
192 .IX Subsection "3.3 (2013-06-18)"
193 .IP "\(bu" 4
194 fixed the manual page as suggested by Eric S. Raymond
195 .PP
196 3.4 (2015\-10\-18)
197 .IX Subsection "3.4 (2015-10-18)"
198 .IP "\(bu" 4
199 fixed processing of logs produced using ε\-TeX's \f(CW\*(C`\elastlinefit\*(C'\fR option
200 (bug reported by Karel Horák)
201 .IP "\(bu" 4
202 fixed cross-platform handling of linebreaks in the input file
203 .SH "LICENSE"
204 .IX Header "LICENSE"
205 This program is free software; you can redistribute it and/or modify
206 it under the terms of the \s-1GNU\s0 General Public License as published by
207 the Free Software Foundation; either version 2 of the License, or
208 any later version.
209 .SH "AUTHOR"
210 .IX Header "AUTHOR"
211 Copyright (c) Martin Budaj <[email protected]> 2000, 2001, 2009, 2012,
212 2015