diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/findhyph/doc |
Initial commit
Diffstat (limited to 'support/findhyph/doc')
-rw-r--r-- | support/findhyph/doc/Makefile | 11 | ||||
-rw-r--r-- | support/findhyph/doc/findhyph.1 | 212 | ||||
-rw-r--r-- | support/findhyph/doc/findhyph.pdf | bin | 0 -> 34496 bytes | |||
-rw-r--r-- | support/findhyph/doc/findhyph.txt | 115 |
4 files changed, 338 insertions, 0 deletions
diff --git a/support/findhyph/doc/Makefile b/support/findhyph/doc/Makefile new file mode 100644 index 0000000000..70536a4e05 --- /dev/null +++ b/support/findhyph/doc/Makefile @@ -0,0 +1,11 @@ +TEX = '\documentclass{article}\usepackage[a4paper, margin=3cm]{geometry}\usepackage{fontspec}\catcode`\ε=\active\defε{$$\varepsilon$$}\begin{document}\input{fh.tex}\end{document}' + +doc: + pod2man --utf8 -c "" ../findhyph > findhyph.1 + pod2text ../findhyph > findhyph.txt + env echo $(TEX) > findhyph.tex + pod2latex -out fh.tex ../findhyph + sed -i 's/TeX/\\TeX{}/g' fh.tex + xelatex findhyph.tex + xelatex findhyph.tex + rm fh.tex findhyph.aux findhyph.log findhyph.tex diff --git a/support/findhyph/doc/findhyph.1 b/support/findhyph/doc/findhyph.1 new file mode 100644 index 0000000000..a3b6ac4f12 --- /dev/null +++ b/support/findhyph/doc/findhyph.1 @@ -0,0 +1,212 @@ +.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) +.\" +.\" 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 turned on, 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 +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{ +. if \nF \{ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "FINDHYPH 1" +.TH FINDHYPH 1 "2015-10-18" "perl v5.20.2" "" +.\" 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" +findhyph – find words hyphenated by TeX in a document +.SH "INSTALLATION" +.IX Header "INSTALLATION" +Copy \fBfindhyph\fR or \fBfindhyph.bat\fR (depending on \s-1OS\s0 used) to a directory +included in system \s-1PATH.\s0 Perl interpreter is required to be in +\&\f(CW\*(C`/usr/bin/\*(C'\fR for Unix-like systems or in \s-1PATH\s0 when using \fBfindhyph.bat\fR. +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBfindhyph [options]\fR \fIfoo.log\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +To use this program: +.IP "1)" 4 +.IX Item "1)" +set \f(CW\*(C`\etracingparagraphs=1\*(C'\fR in a TeX document \fIfoo.tex\fR and run: +.IP "2)" 4 +.IX Item "2)" +\&\fBtex\fR \fIfoo.tex\fR +.IP "3)" 4 +.IX Item "3)" +\&\fBfindhyph [options]\fR \fIfoo.log\fR +.PP +If you are setting \f(CW\*(C`\elooseness=<N>\*(C'\fR to optimize paragraphs, +you need to pass that information to the file \fIfoo.log\fR in a form +\&\f(CW\*(C`@looseness=<N>\*(C'\fR (on a separate line). You can use a macro like +\&\f(CW\*(C`\edef\esetlooseness#1{\elooseness=#1 \eimmediate\ewrite\-1{@looseness=#1}}\*(C'\fR +for this purpose. If the paragraph contains material in display math mode, +you need to use the macro in all split parts of the paragraph. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-c\fR" 4 +.IX Item "-c" +display hyphenated words in context +.IP "\fB\-f\fR" 4 +.IX Item "-f" +display font selectors and other strings starting with a backslash character +.IP "\fB\-v\fR" 4 +.IX Item "-v" +display program version +.IP "\fB\-p\fR" 4 +.IX Item "-p" +generate file containing information about one-letter prepositions and +conjunctions left at the end of line +.IP "\fB\-l=STRING\fR" 4 +.IX Item "-l=STRING" +use prepositions/conjunctions listed in \s-1STRING\s0 instead of default list of +prepositions and conjunctions \f(CW\*(C`kKsSvVzZoOuUiIA\*(C'\fR used for Slovak and Czech +language +.SH "OUTPUT FILES" +.IX Header "OUTPUT FILES" +.IP "\fIfoo.hyph\fR" 4 +.IX Item "foo.hyph" +List of hyphenated words. All punctuation characters, parentheses and +other character immediately preceding or following displayed words are included +in this list. TeX constructs which are too difficult to display (\f(CW\*(C`\ehbox{}\*(C'\fR, +\&\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. +.Sp +Page numbers in square brackets refer to \s-1LOG\s0 file and may occasionally differ +from the typeset document. The reason is that TeX may need to break more +paragraphs than it would eventually fit on the page in order to find a page +break. +.Sp +Words hyphenated in footnotes are listed before the words hyphenated in the +paragraph in which the footnote is referenced. +.IP "\fIfoo.prep\fR" 4 +.IX Item "foo.prep" +List of prepositions if option \fB\-p\fR is used. +.SH "HISTORY" +.IX Header "HISTORY" +1.0 (2001\-04\-08) +.IX Subsection "1.0 (2001-04-08)" +.IP "\(bu" 4 +public release +.PP +2.0 (2009\-08\-10) +.IX Subsection "2.0 (2009-08-10)" +.IP "\(bu" 4 +fixes in line breaks detection algorithm; support for the third pass of line +breaking algorithm in TeX (positive \f(CW\*(C`\eemergencystretch\*(C'\fR); support for +discretionary breaks in the first pass +.IP "\(bu" 4 +page number detection improved (recognized negative page numbers, compound page +numbers when \f(CW\*(C`\ecount1\*(C'\fR to \f(CW\*(C`\ecount9\*(C'\fR registers are non-zero +and \f(CW\*(C`[nn{mapfile}]\*(C'\fR, \f(CW\*(C`[nn<picture>]\*(C'\fR and \f(CW\*(C`[nn<newline>\*(C'\fR +formats used by pdfTeX; false page number detection should be much more rare) +.IP "\(bu" 4 +configurable list of prepositions and conjunctions +.IP "\(bu" 4 +hyphenated words can be displayed in context +.IP "\(bu" 4 +suggestions and testing by Pavel Stříž +.PP +3.0 (2012\-02\-01) +.IX Subsection "3.0 (2012-02-01)" +.IP "\(bu" 4 +fixed a bug when total paragraph demerits are negative +.IP "\(bu" 4 +\&\f(CW\*(C`\elooseness\*(C'\fR setting is now taken into account (thanks to Karel Horák +for identifying the issue) +.PP +3.1 (2012\-11\-03) +.IX Subsection "3.1 (2012-11-03)" +.IP "\(bu" 4 +fixed displaying of hyphenated ligatures (bug reported by Karel Horák) +.PP +3.2 (2012\-11\-21) +.IX Subsection "3.2 (2012-11-21)" +.IP "\(bu" 4 +improved example definition of the \f(CW\*(C`\esetlooseness\*(C'\fR macro +(thanks to Karl Berry) +.PP +3.3 (2013\-06\-18) +.IX Subsection "3.3 (2013-06-18)" +.IP "\(bu" 4 +fixed the manual page as suggested by Eric S. Raymond +.PP +3.4 (2015\-10\-18) +.IX Subsection "3.4 (2015-10-18)" +.IP "\(bu" 4 +fixed processing of logs produced using ε\-TeX's \f(CW\*(C`\elastlinefit\*(C'\fR option +(bug reported by Karel Horák) +.IP "\(bu" 4 +fixed cross-platform handling of linebreaks in the input file +.SH "LICENSE" +.IX Header "LICENSE" +This program is free software; you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License as published by +the Free Software Foundation; either version 2 of the License, or +any later version. +.SH "AUTHOR" +.IX Header "AUTHOR" +Copyright (c) Martin Budaj <m.b@speleo.sk> 2000, 2001, 2009, 2012, +2015 diff --git a/support/findhyph/doc/findhyph.pdf b/support/findhyph/doc/findhyph.pdf Binary files differnew file mode 100644 index 0000000000..2e544f742c --- /dev/null +++ b/support/findhyph/doc/findhyph.pdf diff --git a/support/findhyph/doc/findhyph.txt b/support/findhyph/doc/findhyph.txt new file mode 100644 index 0000000000..66c6164fb6 --- /dev/null +++ b/support/findhyph/doc/findhyph.txt @@ -0,0 +1,115 @@ +NAME + findhyph – find words hyphenated by TeX in a document + +INSTALLATION + Copy findhyph or findhyph.bat (depending on OS used) to a directory + included in system PATH. Perl interpreter is required to be in + "/usr/bin/" for Unix-like systems or in PATH when using findhyph.bat. + +SYNOPSIS + findhyph [options] foo.log + +DESCRIPTION + To use this program: + + 1) set "\tracingparagraphs=1" in a TeX document foo.tex and run: + + 2) tex foo.tex + + 3) findhyph [options] foo.log + + If you are setting "\looseness=<N>" to optimize paragraphs, you need to + pass that information to the file foo.log in a form "@looseness=<N>" (on + a separate line). You can use a macro like + "\def\setlooseness#1{\looseness=#1 \immediate\write-1{@looseness=#1}}" + for this purpose. If the paragraph contains material in display math + mode, you need to use the macro in all split parts of the paragraph. + +OPTIONS + -c display hyphenated words in context + + -f display font selectors and other strings starting with a backslash + character + + -v display program version + + -p generate file containing information about one-letter prepositions + and conjunctions left at the end of line + + -l=STRING + use prepositions/conjunctions listed in STRING instead of default + list of prepositions and conjunctions "kKsSvVzZoOuUiIA" used for + Slovak and Czech language + +OUTPUT FILES + foo.hyph + List of hyphenated words. All punctuation characters, parentheses + and other character immediately preceding or following displayed + words are included in this list. TeX constructs which are too + difficult to display ("\hbox{}", "\mark{}" etc.) are shown as "[]". + Math mode is indicated by "$" sign. + + Page numbers in square brackets refer to LOG file and may + occasionally differ from the typeset document. The reason is that + TeX may need to break more paragraphs than it would eventually fit + on the page in order to find a page break. + + Words hyphenated in footnotes are listed before the words hyphenated + in the paragraph in which the footnote is referenced. + + foo.prep + List of prepositions if option -p is used. + +HISTORY + 1.0 (2001-04-08) + * public release + + 2.0 (2009-08-10) + * fixes in line breaks detection algorithm; support for the third pass + of line breaking algorithm in TeX (positive "\emergencystretch"); + support for discretionary breaks in the first pass + + * page number detection improved (recognized negative page numbers, + compound page numbers when "\count1" to "\count9" registers are + non-zero and "[nn{mapfile}]", "[nn<picture>]" and "[nn<newline>" + formats used by pdfTeX; false page number detection should be much + more rare) + + * configurable list of prepositions and conjunctions + + * hyphenated words can be displayed in context + + * suggestions and testing by Pavel Stříž + + 3.0 (2012-02-01) + * fixed a bug when total paragraph demerits are negative + + * "\looseness" setting is now taken into account (thanks to Karel + Horák for identifying the issue) + + 3.1 (2012-11-03) + * fixed displaying of hyphenated ligatures (bug reported by Karel + Horák) + + 3.2 (2012-11-21) + * improved example definition of the "\setlooseness" macro (thanks to + Karl Berry) + + 3.3 (2013-06-18) + * fixed the manual page as suggested by Eric S. Raymond + + 3.4 (2015-10-18) + * fixed processing of logs produced using ε-TeX's "\lastlinefit" + option (bug reported by Karel Horák) + + * fixed cross-platform handling of linebreaks in the input file + +LICENSE + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 2 of the License, or any later + version. + +AUTHOR + Copyright (c) Martin Budaj <m.b@speleo.sk> 2000, 2001, 2009, 2012, 2015 + |