1FINDHYPH(1)                                                        FINDHYPH(1)
2
3
4

NAME

6       findhyph – find words hyphenated by TeX in a document
7

INSTALLATION

9       Copy findhyph or findhyph.bat (depending on OS used) to a directory
10       included in system PATH. Perl interpreter is required to be in
11       "/usr/bin/" for Unix-like systems or in PATH when using findhyph.bat.
12

SYNOPSIS

14       findhyph [options] foo.log
15

DESCRIPTION

17       To use this program:
18
19       1)  set "\tracingparagraphs=1" in a TeX document foo.tex and run:
20
21       2)  tex foo.tex
22
23       3)  findhyph [options] foo.log
24
25       If you are setting "\looseness=<N>" to optimize paragraphs, you need to
26       pass that information to the file foo.log in a form "@looseness=<N>"
27       (on a separate line). You can use a macro like
28       "\def\setlooseness#1{\looseness=#1 \immediate\write-1{@looseness=#1}}"
29       for this purpose. If the paragraph contains material in display math
30       mode, you need to use the macro in all split parts of the paragraph.
31

OPTIONS

33       -c  display hyphenated words in context
34
35       -f  display font selectors and other strings starting with a backslash
36           character
37
38       -v  display program version
39
40       -p  generate file containing information about one-letter prepositions
41           and conjunctions left at the end of line
42
43       -l=STRING
44           use prepositions/conjunctions listed in STRING instead of default
45           list of prepositions and conjunctions "kKsSvVzZoOuUiIA" used for
46           Slovak and Czech language
47

OUTPUT FILES

49       foo.hyph
50           List of hyphenated words. All punctuation characters, parentheses
51           and other character immediately preceding or following displayed
52           words are included in this list. TeX constructs which are too
53           difficult to display ("\hbox{}", "\mark{}" etc.) are shown as "[]".
54           Math mode is indicated by "$" sign.
55
56           Page numbers in square brackets refer to LOG file and may
57           occasionally differ from the typeset document. The reason is that
58           TeX may need to break more paragraphs than it would eventually fit
59           on the page in order to find a page break.
60
61           Words hyphenated in footnotes are listed before the words
62           hyphenated in the paragraph in which the footnote is referenced.
63
64       foo.prep
65           List of prepositions if option -p is used.
66

HISTORY

68       1.0 (2001-04-08)
69
70       ·   public release
71
72       2.0 (2009-08-10)
73
74       ·   fixes in line breaks detection algorithm; support for the third
75           pass of line breaking algorithm in TeX (positive
76           "\emergencystretch"); support for discretionary breaks in the first
77           pass
78
79       ·   page number detection improved (recognized negative page numbers,
80           compound page numbers when "\count1" to "\count9" registers are
81           non-zero and "[nn{mapfile}]", "[nn<picture>]" and "[nn<newline>"
82           formats used by pdfTeX; false page number detection should be much
83           more rare)
84
85       ·   configurable list of prepositions and conjunctions
86
87       ·   hyphenated words can be displayed in context
88
89       ·   suggestions and testing by Pavel Stříž
90
91       3.0 (2012-02-01)
92
93       ·   fixed a bug when total paragraph demerits are negative
94
95       ·   "\looseness" setting is now taken into account (thanks to Karel
96           Horák for identifying the issue)
97
98       3.1 (2012-11-03)
99
100       ·   fixed displaying of hyphenated ligatures (bug reported by Karel
101           Horák)
102
103       3.2 (2012-11-21)
104
105       ·   improved example definition of the "\setlooseness" macro (thanks to
106           Karl Berry)
107
108       3.3 (2013-06-18)
109
110       ·   fixed the manual page as suggested by Eric S. Raymond
111
112       3.4 (2015-10-18)
113
114       ·   fixed processing of logs produced using ε-TeX's "\lastlinefit"
115           option (bug reported by Karel Horák)
116
117       ·   fixed cross-platform handling of linebreaks in the input file
118

LICENSE

120       This program is free software; you can redistribute it and/or modify it
121       under the terms of the GNU General Public License as published by the
122       Free Software Foundation; either version 2 of the License, or any later
123       version.
124

AUTHOR

126       Copyright (c) Martin Budaj <m.b@speleo.sk> 2000, 2001, 2009, 2012, 2015
127
128
129
130perl v5.20.2                      2015-10-18                       FINDHYPH(1)
Impressum