summaryrefslogtreecommitdiff
path: root/support/texlogsieve/texlogsieve.1
diff options
context:
space:
mode:
Diffstat (limited to 'support/texlogsieve/texlogsieve.1')
-rw-r--r--support/texlogsieve/texlogsieve.143
1 files changed, 29 insertions, 14 deletions
diff --git a/support/texlogsieve/texlogsieve.1 b/support/texlogsieve/texlogsieve.1
index 4628d1ec54..b39e33eff2 100644
--- a/support/texlogsieve/texlogsieve.1
+++ b/support/texlogsieve/texlogsieve.1
@@ -1,4 +1,4 @@
-.TH TEXLOGSIEVE "1" "July 2022" "texlogsieve 1.2.0" "User Commands"
+.TH TEXLOGSIEVE "1" "August 2022" "texlogsieve 1.3.0" "User Commands"
.SH NAME
@@ -198,8 +198,13 @@ severity level of many different messages.
.TP
\fB\-c\fR \fI\,CFGFILE\/\fR, \fB\-\-config\-file\fR=\fI\,CFGFILE\/\fR
-Read options from the given configuration file in addition to
-\fI\,texlogsieverc\/\fR.
+Read options from the given configuration file in addition to the
+default config files (see the \fBCONFIGURATION FILE\fR section).
+
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Print the list of configuration files read and a short summary of the
+most important active configuration options.
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -226,13 +231,14 @@ list of messages known to the program.
.SH CONFIGURATION FILE
texlogsieve always searches automatically for the (optional)
-\fI\,texlogsieverc\/\fR configuration file in the TeX path (i.e., it searches
-using Kpathsea). In the default configuration, the current directory is in
-the search path, so adding a config file with that name to the project
-directory is enough to make it work. Options in the config file are exactly
-the same as the long command-line options described above, but without the
-preceding \[lq]\-\-\[rq] characters. Lines starting with a \[lq]#\[rq] sign
-are comments. An example configuration file:
+\fI\,texlogsieverc\/\fR configuration file in \fI\,$TEXINPUTS\/\fR (i.e.,
+it searches using Kpathsea). In the default configuration, the current
+directory is in \fI\,$TEXINPUTS\/\fR, so adding a config file with that
+name to the project directory is enough to make it work. Options in
+the config file are exactly the same as the long command-line options
+described above, but without the preceding \[lq]\-\-\[rq] characters.
+Lines starting with a \[lq]#\[rq] sign are comments. An example
+configuration file:
.RS
.EX
@@ -256,13 +262,22 @@ silence\-files = *.sty
.EE
.RE
+If you'd like to also have a generic configuration file for all your projects
+(a good idea), put it at \fI\,$HOME/.texlogsieverc\/\fR in unix-like systems;
+in Windows, put it either at \fI\,%LOCALAPPDATA%\etexlogsieverc\/\fR
+(\fI\,C:\eUsers\e<username>\eAppData\eLocal\/\fR)
+or \fI\,%APPDATA%\etexlogsieverc\/\fR (\fI\,C:\eDocuments and
+Settings\e<username>\eApplication Data\/\fR or
+\fI\,C:\eUsers\e<username>\eAppData\eRoaming).
+
.SH LIMITATIONS
texlogsieve does not try to do anything smart about error messages (but it
-shows a warning in the summary if one is detected); if there is an error,
-you probably want to take a look directly at the log file anyway. It also
-cannot detect if LaTeX stops for user input, so you should \fBreally\fR
-run LaTeX in \fI\,nonstopmode\/\fR when texlogsieve is reading from a pipe.
+shows a warning in the summary if one is detected; check the \fBTIPS\fR
+section of the pdf documentation regarding this); if there is an error, you
+probably want to take a look directly at the log file anyway. It also cannot
+detect if LaTeX stops for user input, so you should \fBreally\fR run LaTeX
+in \fI\,nonstopmode\/\fR when texlogsieve is reading from a pipe.
Since it needs to know what messages to expect, texlogsieve is currently
geared towards LaTeX; I have no idea how it would work with ConTeXt or plain