texfot (11oct14)

git-svn-id: svn://tug.org/texlive/trunk@35356 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 42 insertions, 33 deletions

diff --git a/Master/texmf-dist/doc/man/man1/texfot.1 b/Master/texmf-dist/doc/man/man1/texfot.1
index b0b18cd683d..70795a88e24 100644
--- a/Master/texmf-dist/doc/man/man1/texfot.1
+++ b/Master/texmf-dist/doc/man/man1/texfot.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
+.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -133,7 +133,7 @@
 .\" ========================================================================
 .\"
 .IX Title "TEXFOT 1"
-.TH TEXFOT 1 "2014-03-10" "texfot" "Karl Berry"
+.TH TEXFOT 1 "2014-10-10" "texfot" "Karl Berry"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -150,28 +150,31 @@ filtering the online output for ``interesting'' messages.  Its exit
 value is that of \fItexcmd\fR.  Examples:
 .PP
 .Vb 2
-\&  # Basic invocation:
+\&  # Sample basic invocation:
 \&  texfot pdflatex file.tex
 \&  
-\&  # Ordinarily the output is copied to /tmp/fot before filtering;
+\&  # Ordinarily all output is copied to /tmp/fot before filtering;
 \&  # omit that:
 \&  texfot \-\-tee=/dev/null file.tex
 \&  
-\&  # Example with more complex engine invocation:
+\&  # Example of more complex engine invocation:
 \&  texfot lualatex \-\-recorder \*(Aq\enonstopmode\einput file\*(Aq
 .Ve
 .PP
 Aside from its own options, described below, \f(CW\*(C`texfot\*(C'\fR just runs the
 given command with the given arguments (same approach to command line
-syntax as \f(CW\*(C`nice\*(C'\fR, \f(CW\*(C`time\*(C'\fR, \f(CW\*(C`timeout\*(C'\fR, etc.).  Thus, \f(CW\*(C`texfot\*(C'\fR works
-with any engine and any command line options.
+syntax as \f(CW\*(C`env\*(C'\fR, \f(CW\*(C`nice\*(C'\fR, \f(CW\*(C`time\*(C'\fR, \f(CW\*(C`timeout\*(C'\fR, etc.).  Thus, \f(CW\*(C`texfot\*(C'\fR
+works with any engine and any command line options.
 .PP
 \&\f(CW\*(C`texfot\*(C'\fR does not look at the log file or any other possible output
-file(s); it only looks at standard output from the command.
+file(s); it only looks at the standard output and standard error from
+the command.  stdout is processed first, then stderr.  Lines from stderr
+have an identifying prefix.  \f(CW\*(C`texfot\*(C'\fR writes all accepted lines to its
+stdout.
 .PP
-The messages shown are intended to be those which probably deserve some
-action by the author: error messages, overfull and underfull boxes,
-undefined citations, missing characters from fonts, etc.
+The messages shown are intended to be those which likely need action by
+the author: error messages, overfull and underfull boxes, undefined
+citations, missing characters from fonts, etc.
 .SH "FLOW OF OPERATION"
 .IX Header "FLOW OF OPERATION"
 Here is the order in which lines of output are checked:
@@ -190,15 +193,18 @@ followed by a line with specific detail about the error.
 .IP "4." 4
 Otherwise, if the line matches the list of regexps to show, show it.
 .IP "5." 4
-Otherwise, ignore this line.
+Otherwise, the default: if the line came from stdout, ignore it; if the
+line came from stderr, print it (to stdout).  (This distinction is made
+because TeX engines write relatively few messages to stderr, and it's
+not unlikely that any such should be considered.
 .PP
-Once a particular check matches, the program moves on process the next
-line.
+Once a particular check matches, the program moves on to process the
+next line.
 .PP
 Don't hesitate to peruse the source to the script, which is essentially
-a straightforward loop matching against the different regexp lists as
-above.  You can see all the messages in the different categories in the
-source.
+a straightforward loop matching against the different lists as above.
+You can see the exact regexps being matched in the different categories
+in the source.
 .PP
 Incidentally, although nothing in this basic operation is specific to
 TeX engines, all the regular expressions included in the program are
@@ -209,9 +215,11 @@ anything else as verbose as TeX to make that useful).
 .IX Header "OPTIONS"
 The following are the options to \f(CW\*(C`texfot\*(C'\fR itself (not the TeX engine
 being invoked; consult the TeX documentation or the engine's \f(CW\*(C`\-\-help\*(C'\fR
-output for that).  The first non-option terminates \f(CW\*(C`texfot\*(C'\fR's option
-parsing, and the remainder of the command line is invoked as the TeX
-command, without further parsing.  For example, \f(CW\*(C`texfot \-\-debug tex
+output for that).
+.PP
+The first non-option terminates \f(CW\*(C`texfot\*(C'\fR's option parsing, and the
+remainder of the command line is invoked as the TeX command, without
+further parsing.  For example, \f(CW\*(C`texfot \-\-debug tex
 \&\-\-debug\*(C'\fR will output debugging information from both \f(CW\*(C`texfot\*(C'\fR and
 \&\f(CW\*(C`tex\*(C'\fR.
 .PP
@@ -233,7 +241,7 @@ Output (or not) what is being done on standard error.  Off by default.
 Ignore lines in the TeX output matching (Perl) \fIregexp\fR.  Can be
 repeated.  Adds to the default set of ignore regexps rather than
 replacing.  These regexps are not automatically anchored (or otherwise
-altered), just used as-is.
+altered), simply used as-is.
 .ie n .IP """\-\-interactive""" 4
 .el .IP "\f(CW\-\-interactive\fR" 4
 .IX Item "--interactive"
@@ -254,7 +262,7 @@ never happens.  Giving \f(CW\*(C`\-\-interactive\*(C'\fR allows interaction to h
 .IX Item "--no-quiet"
 .PD
 By default, the TeX command being invoked is reported on standard output.
-\&\f(CW\*(C`\-\-quiet\*(C'\fR omits that.
+\&\f(CW\*(C`\-\-quiet\*(C'\fR omits that reporting.
 .ie n .IP """\-\-tee"" \fIfile\fR" 4
 .el .IP "\f(CW\-\-tee\fR \fIfile\fR" 4
 .IX Item "--tee file"
@@ -274,12 +282,12 @@ Display this help and exit successfully.
 .SH "RATIONALE"
 .IX Header "RATIONALE"
 I wrote this because, in my work as a TUGboat editor
-(<http://tug.org/TUGboat>, submissions welcome), I end up running and
-rerunning many papers, many times.  It was too easy to lose warnings I
-needed to see in the mass of unvarying and uninteresting output from
-TeX, such as all the style files being read and all the fonts being
-used.  I wanted to see all and only those messages which actually needed
-some action by me.
+(<http://tug.org/TUGboat>, submissions welcome, by the way), I end up
+running and rerunning many papers, many times each.  It was too easy to
+lose warnings I needed to see in the mass of unvarying and uninteresting
+output from TeX, such as all the style files being read and all the
+fonts being used.  I wanted to see all and only those messages which
+actually needed some action by me.
 .PP
 I found some other programs of a similar nature, the \f(CW\*(C`silence\*(C'\fR LaTeX
 package, and plenty of other (La)TeX wrappers, but it seemed none of
@@ -287,15 +295,16 @@ them did what I wanted.  Either they read the log file (I wanted the
 online output only), or they output more or less than I wanted, or they
 required invoking TeX differently (I wanted to keep my build process
 exactly the same, definitely including the TeX invocation, which can get
-complicated).  Hence I finally went ahead and wrote this.
+complicated).  Hence I wrote this.
 .PP
 Here are some keywords if you want to explore other options:
 texloganalyser, pydflatex, logfilter, latexmk, rubber, arara, and
 searching for \f(CW\*(C`log\*(C'\fR at <http://ctan.org/search>.
 .PP
 \&\f(CW\*(C`texfot\*(C'\fR is written in Perl, and runs on Unix, and does not work on
-Windows.  (If by some chance anyone wants to run this on Windows, please
-make your own fork; I'm not interested in supporting it.)
+Windows.  (If by some chance anyone wants to use this program on
+Windows, please make your own fork; I'm not interested in supporting
+it.)
 .PP
 The name comes from the \f(CW\*(C`trip.fot\*(C'\fR and \f(CW\*(C`trap.fot\*(C'\fR files that are part
 of Knuth's trip and trap torture tests, which record the online output
@@ -304,7 +313,7 @@ trap, but I can pretend that it stands for \*(L"filter online transcript\*(R" in
 the present case\ :).
 .SH "AUTHORS AND COPYRIGHT"
 .IX Header "AUTHORS AND COPYRIGHT"
-This script and its documentation were written by Karl Berry and both are
-released to the public domain.  Email \f(CW\*(C`karl@freefriends.org\*(C'\fR with
+This script and its documentation were written by Karl Berry and both
+are released to the public domain.  Email \f(CW\*(C`karl@freefriends.org\*(C'\fR with
 bug reports.  There is no home page beyond the package on \s-1CTAN:
 \&\s0<http://www.ctan.org/pkg/texfot>.