diff options
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/man/man1/texlogsieve.1 | 229 | ||||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/texlogsieve.man1.pdf | bin | 0 -> 38464 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/support/texlogsieve/LICENCE.txt | 674 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/texlogsieve/README.md | 143 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/texlogsieve/texlogsieve.pdf | bin | 0 -> 46978 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/support/texlogsieve/texlogsieve.tex | 312 |
6 files changed, 1358 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/man/man1/texlogsieve.1 b/Master/texmf-dist/doc/man/man1/texlogsieve.1 new file mode 100644 index 00000000000..79cdbc68d1c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texlogsieve.1 @@ -0,0 +1,229 @@ +.TH TEXLOGSIEVE "1" "December 2021" "texlogsieve 1.0.0-beta-1" "User Commands" + +.SH NAME + +texlogsieve \- filter and summarize LaTeX log files + +.SH SYNOPSIS + +\fBtexlogsieve\fR [\fI\,OPTION\/\fR]... [\fI\,INPUT FILE\/\fR] + +.SH DESCRIPTION + +texlogsieve reads a LaTeX log file (or the standard input if no file is +specified), filters out less relevant messages, and displays a summary +report. + +texlogsieve \fBmust\fR be run from the same directory as [pdf|lua|xe]latex, +because it searches for the files used during compilation (packages loaded +from the current directory, files included with \einput etc.). + +The program goes to great lengths to correctly handle TeX line wrapping. It +understands the \fI\,max_print_line\/\fR TeX configuration variable and reads +its value from the same places as TeX. Setting \fI\,max_print_line\/\fR to a +value larger than 9999 makes texlogsieve ignore line wrapping. + +The defaults are reasonable; hopefully, you can just do + +.RS 3 +.EX +[pdf|lua|xe]latex myfile.tex | texlogsieve +.EE +.RE + +and be satisfied with the result. + +.SH OPTIONS + +.TP +\fB\-\-page\-delay\fR, \fB\-\-no\-page\-delay\fR +Enable/disable grouping messages by page before display. When enabled, +messages are only output after the current page is finished (shipout). \ +The advantage is that the page number is included in the message (default +enabled). + +.TP +\fB\-\-summary\fR, \fB\-\-no\-summary\fR +Enable/disable final summary (default enabled). + +.TP +\fB\-\-only\-summary\fR +No messages, show only the final summary (default disabled). + +.TP +\fB\-\-shipouts\fR, \fB\-\-no\-shipouts\fR +Enable/disable reporting shipouts (default disabled with page-delay, +enabled with no-page-delay). + +.TP +\fB\-\-repetitions\fR, \fB\-\-no\-repetitions\fR +Allow/prevent repeated messages (default disabled, i.e., repeated messages +are supressed). + +.TP +\fB\-\-heartbeat\fR, \fB\-\-no\-heartbeat\fR +Enable/disable progress gauge in page-delay mode (default enabled). + +.TP +\fB\-l\fR \fI\,LEVEL\/\fR, \fB\-\-minlevel\fR=\fI\,LEVEL\/\fR +Filter out messages with severity level lower than LEVEL. Valid levels +are DEBUG (no filtering), INFO, WARNING, CRITICAL, and UNKNOWN (default +WARNING). + +.TP +\fB\-u\fR, \fB\-\-unwrap\-only\fR +Do not filter messages and do not output the summary, only unwrap long, +wrapped lines. The output should be very similar (but not equal) to the +input file, but with wrapped lines reconstructed. This activates \-l debug, +\-\-no\-summary, \-\-no\-page\-delay, \-\-repetitions, and \-\-shipouts, and +also supresses the verbose \[lq]open/close file\[rq] and \[lq]shipout\[rq] +messages, simulating instead the TeX format, with parens and square brackets. \ +This is useful if you prefer the reports generated by some other tool but want +to benefit from texlogsieve's line unwrapping algorithm; the output generated +by this option should be parseable by other tools (but you probably need to +coerce the other tool not to try to unwrap lines). + +.TP +\fB\-\-silence\-package\fR=\fI\,PKGNAME\/\fR +Filter out messages that can be identified as coming from the given package. \ +Use this option multiple times to suppress messages from several different +packages. + +.TP +\fB\-\-silence\-string\fR=\fI\,EXCERPT OF UNWANTED MESSAGE\/\fR +Filter out messages that contain the given string (you only need to provide +part of the message text for the whole message to be suppressed). Use this +option multiple times to suppress several different messages. The string +should be a single line, but that is not a problem for multiline log messages: +space characters in the provided string match any sequence of whitespace +characters in the message, including newlines. If needed, you may precede the +string with \[lq]////\[rq], in which case you can use lua-style pattern matching +(\c +.UR https://www.lua.org/pil/20.2.html +.UE ). Note that the string is used verbatim: you need not (and should not) +enclose it in quotes nor escape special characters such as \[lq]\e\[rq]. + +.TP +\fB\-\-silence\-file\fR=\fI\,FILENAME OR FILE GLOB\/\fR +Filter out messages that have been generated while the given file was being +processed. Do \fBnot\fR use absolute or relative paths, only filenames. Simple +file globs, such as \[lq]*.cls\[rq], work as expected. Use this option multiple +times to suppress messages from several different files. + +.TP +\fB\-\-semisilence\-file\fR=\fI\,FILENAME OR FILE GLOB\/\fR +Just like the previous option, but non-recursive. This means that messages +generated while the given file was being processed are excluded, but messages +generated by some other file that was opened by it are not. For example, if +\[lq]chapters.tex\[rq] includes (with \einput) the files \[lq]chapter1.tex\[rq] +and \[lq]chapter2.tex\[rq], using \[lq]\-\-silence\-file=chapters.tex\[rq] +will prevent messages generated by any of the three files from being +displayed. If, however, you use \[lq]\-\-semisilence\-file=chapters.tex\[rq], +messages generated by chapters.tex will be suppressed, but messages generated +by chapter1.tex or chapter2.tex will not. + +.TP +\fB\-\-add\-[debug|info|warning]\-message\fR=\fI\,MESSAGE\/\fR +Add MESSAGE to the list of messages known to the program with the given +severity level; see Section UNRECOGNIZED MESSAGES below for more information +about this. Like \-\-silence\-string, these should be a single line; unlike +\-\-silence\-string, you need to embed \en explicitly to indicate line +breaks. You may precede the string with \[lq]////\[rq] to use lua-style +pattern matching, but embedding \en to indicate line breaks is unavoidable. +Use these options multiple times to add many different messages. + +.TP +\fB\-c\fR \fI\,CFGFILE\/\fR, \fB\-\-config\-file\fR=\fI\,CFGFILE\/\fR +Read options from the given configuration file. Options are exactly the +same as the long command-line options, but without the preceding \[lq]\-\-\[rq] +characters. Lines starting with a \[lq]#\[rq] sign are comments. An example +configuration file: + +.RS +.RS 3 +.EX +no\-page\-delay +.br +# no\-page\-delay enables shipouts, but we do not want that +.br +no\-shipouts +.br +silence\-string = Hyperreferences in rotated content will be misplaced +.br +# no need to escape the \[dq]\e\[dq] (or any other) character +.br +silence\-string = Using \eoverbracket and \eunderbracket from \[ga]mathtools\[aq] +.br +# silence a string using lua pattern matching +.br +silence\-string = ////luaotfload | aux : font no %d+ %(.\-%) +.br +silence\-files = *.cls +.EE +.RE +.RE + +.TP +\fB\-h\fR, \fB\-\-help\fR +Show concise options description. + +.TP +\fB\-\-version\fR +Print program version. + +.SH UNRECOGNIZED MESSAGES + +texlogsieve automatically handles messages such as \[lq]Package blah +Info:...\[rq] or \[lq]LaTeX Warning:...\[rq]. However, many messages do not +follow this pattern. To do its thing, texlogsieve should know about these +other messages beforehand. This is important for three reasons: + +.IP 1. 3 +Unknown messages are given maximum priority; if you do not want to see them, +you have to use \-\-silence\-string; +.IP 2. 3 +If the message has more than one line, each line is treated as an independent +message. This means you need to use \-\-silence\-string multiple times; +.IP 3. 3 +In some rare cases, the line unwrapping algorithm may fail near an +unrecognized message. + +.PP +While texlogsieve recognizes quite a few messages out of the box, you may run +into a message generated by some package that it does not know about (you can +check for this using \[lq]\-l unknown\[rq]). If that is the case, you can use +the \-\-add\-[debug|info|warning]\-message options to add it to the list of +messages known to the program. + +.SH LIMITATIONS + +texlogsieve does not try to do anything smart about error messages (at least +for now); if there is an error, you probably want to take a look directly +at the log file anyway. + +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 +TeX. Still, adding support to them should not be too difficult. + +.SH SEE ALSO + +The pdf documentation (in TeXLive, try \fI\,texdoc texlogsieve\/\fR). + +If you want to know more about the TeX log file and the workings of the +program, check the initial comments in the code. + +.SH BUGS AND DEVELOPMENT + +.UR https://gitlab.com/lago/texlogsieve +.UE + +.SH COPYRIGHT + +Copyright \[co] 2021 Nelson Lago <lago@ime.usp.br> +.br +License GPLv3+: GNU GPL version 3 or later +.UR https://gnu.org/licenses/gpl.html +.UE . + +This is free software: you are free to change and redistribute it. \ +There is NO WARRANTY, to the extent permitted by law. diff --git a/Master/texmf-dist/doc/man/man1/texlogsieve.man1.pdf b/Master/texmf-dist/doc/man/man1/texlogsieve.man1.pdf Binary files differnew file mode 100644 index 00000000000..06f5b53d0da --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texlogsieve.man1.pdf diff --git a/Master/texmf-dist/doc/support/texlogsieve/LICENCE.txt b/Master/texmf-dist/doc/support/texlogsieve/LICENCE.txt new file mode 100644 index 00000000000..f288702d2fa --- /dev/null +++ b/Master/texmf-dist/doc/support/texlogsieve/LICENCE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/Master/texmf-dist/doc/support/texlogsieve/README.md b/Master/texmf-dist/doc/support/texlogsieve/README.md new file mode 100644 index 00000000000..acc3204d907 --- /dev/null +++ b/Master/texmf-dist/doc/support/texlogsieve/README.md @@ -0,0 +1,143 @@ +# texlogsieve - (yet another program to) filter and summarize LaTeX log files + +`texlogsieve` reads a LaTeX log file (or the standard input if no file is +specified), filters out less relevant messages, and displays a summary +report. It is a `texlua` script, similar in spirit to tools such as +`texfot`, `texloganalyser`, `rubber-info`, `textlog_extract`, +`texlogparser`, and others. Highlights: + +* Two reports: the most important messages from the log file followed by + a summary of repeated messages, undefined references etc.; + +* The program goes to great lengths to correctly handle TeX line wrapping + and does a much better job at that than existing tools; + +* Multiline messages are treated as a single entity; + +* Several options to control which messages should be filtered out; + +* No messages are accidentally removed; + +* The summary report is currently simple, but useful. + +`texlogsieve` **must** be run from the same directory as `[pdf|lua|xe]latex`, +because it searches for the files used during compilation (packages loaded +from the current directory, files included with `\input` etc.). + +The defaults are reasonable; hopefully, you can just do + +``` +[pdf|lua|xe]latex myfile.tex | texlogsieve +``` + +and be satisfied with the result. + +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 TeX. Still, adding support to them should not be +too difficult. + +If you want to know more about the TeX log file and the workings of +the program, check the initial comments in the code. + +## Short-term improvements + + * Create tests + + - Synthetic unit tests: these should systematically test the code and the + features it implements with small "fake" log files + + - Real-world files (for example, the docs for some packages or some papers + from arXiv): these should help us detect important log messages and + changes in messages whenever new versions of LaTeX and its packages are + released + + * Include the line number in the summary for messages that have it + + * Consider messages that only differ by "on line XXX" to be repetitions + + * Implement option `--collapse-lines` (show multiline messages as a single + line) + + * Implement option `--no-redundant` (makes messages that are going to be + summarized, such as `undefined reference blah`, not appear in the filtered + report, only in the summary) + +## Other improvements + + * Improve the final summary format - we should look at other tools for + inspiration + + * Filter the summary report too; look at `texloganalyser` for inspiration + + * Consider indicating filenames more prominently in the filtered report; + something like + + Messages for file ./somefile.tex: + LaTeX Warning: File `blah.txt' already exists on the system. + Messages for file ./someotherfile.tex: + Warning: Missing character: There is no " (U+0022) in font... + but only when there is actually something to report for the given file + + * Do something smart about LaTeX errors (maybe just detecting them and saying + "there was an error here" is enough) - maybe get some inspiration from + <https://github.com/overleaf/latex-log-parser> (the parser from overleaf). + This can get complicated if we account for the possibility that the user + interactively solved whatever was the problem, but do we really want to or + need to handle that? + + * Add colors (see `texlog_extract`) + + * Improve error handling if/where possible + + * Better aggregation in the summary: + + - `under/overfull boxes: p.5 (chap1.tex, L27); p.7 (chap2.tex, L37); p.19 + (chap2.tex, L176)` + + - `missing characters X, Y, Z in font blah` + + * Try to figure out a way to automatically extract possible messages from + LaTeX packages + + * Stuff like + `LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right` + should trigger a specific "please rerun" message in the summary + + * Maybe grep the .fls file first before trying to do `kpse.find_file()`; this + is probably more reliable and works even if the environment has changed, + but can we be sure it works correctly when reading the logfile from a pipe? + +## Refactorings to consider: + + * Modify `heartbeat` to use `os.difftime()` + + * Improve Lines: + + - Eliminate `Lines.current` and instead always use `Lines.get(0)`, + `Lines.get(1)` etc. We might store stuff in indexes 1, 2, 3 etc. and + make something like `Lines:get(val) => return Lines[val +1]` (this is + better than actually using index 0 because the lua standard library + counts from one, so adhering to this convention makes using it easier) + + - Reimplement the logic using <https://www.lua.org/pil/11.4.html> for a + small performance increase + +--- + +Code etc: <https://gitlab.com/lago/texlogsieve> + +Copyright 2021 Nelson Lago <lago@ime.usp.br> + +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 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <https://www.gnu.org/licenses/>. diff --git a/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.pdf b/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.pdf Binary files differnew file mode 100644 index 00000000000..80c47a30378 --- /dev/null +++ b/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.pdf diff --git a/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.tex b/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.tex new file mode 100644 index 00000000000..4d29abf8cc5 --- /dev/null +++ b/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.tex @@ -0,0 +1,312 @@ +% texlogsieve - filter and summarize LaTeX log files +% +% Copyright (C) 2021 Nelson Lago <lago@ime.usp.br> +% +% 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 3 of the License, or +% (at your option) any later version. +% +% This program is distributed in the hope that it will be useful, +% but WITHOUT ANY WARRANTY; without even the implied warranty of +% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +% GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License +% along with this program. If not, see <https://www.gnu.org/licenses/>. +% +% Code etc: https://gitlab.com/lago/texlogsieve + +\documentclass{ltxdoc} + +\usepackage[hyperref,svgnames,x11names,table]{xcolor} +\usepackage{url} +\urlstyle{sf} +\usepackage{hyperref} +\hypersetup{ + colorlinks=true, + citecolor=DarkGreen, + linkcolor=NavyBlue, + urlcolor=DarkRed, + filecolor=green, + anchorcolor=black, +} + +\usepackage{libertinus} +\usepackage[scale=.85]{sourcecodepro} + +\RecordChanges + +\changes{v1.0.0-beta-1}{2021/12/16}{first public prerelease} + +\begin{document} + +\title{\textsf{texlogsieve}:\thanks{This document +corresponds to \textsf{texlogsieve}~1.0.0-beta-1, +dated~2021-12-16.}\\[.3\baselineskip] +{\normalsize(yet another program to)\\[-.6\baselineskip]} +{\large filter and summarize \LaTeX\ log files} +} + +\author{ +Nelson Lago\\ +\texttt{lago@ime.usp.br}\\ +~\\ +\url{https://gitlab.com/lago/texlogsieve} +} + +\maketitle + +\begin{abstract} + +\texttt{texlogsieve} reads a \LaTeX\ log file (or the standard input if +no file is specified), filters out less relevant messages, and displays +a summary report. Highlights: + +\begin{itemize} + \item Two reports: the most important messages from the log file + followed by a summary of repeated messages, undefined + references etc.; + \item The program goes to great lengths to correctly handle \TeX\ line + wrapping and does a much better job at that than existing tools; + \item Multiline messages are treated as a single entity; + \item Several options to control which messages should be filtered out; + \item No messages are accidentally removed; + \item The summary report is currently simple, but useful. +\end{itemize} + +\end{abstract} + +\section{Introduction} + +The \LaTeX\ log file is very verbose, which is useful when debugging but +a hindrance during document preparation, as warnings such as ``missing +character'', ``undefined reference'', and others become buried among lots +of less relevant messages. This program filters out such less relevant +messages and outputs the rest, together with a final summary for the +specially important ones. It is a \texttt{texlua} script, similar in +spirit to tools such as \texttt{texfot}, \texttt{texloganalyser}, +\texttt{rubber-info}, \texttt{textlog\_extract}, \texttt{texlogparser}, +and others. Note that it does not try to do anything smart about error +messages (at least for now); if there is an error, you probably want to +take a look directly at the log file anyway. + +\texttt{texlogsieve} \textbf{must} be run from the same directory as +\verb/[pdf|lua|xe]latex/, because it searches for the files used during +compilation (packages loaded from the current directory, files included +with \verb|\input| etc.). + +\pagebreak[1] +The defaults are reasonable; hopefully, you can just do + +\begin{quote} +\verb/[pdf|lua|xe]latex myfile.tex | texlogsieve/ +\end{quote} + +and be satisfied with the result. + +Since it needs to know what messages to expect, \texttt{texlogsieve} is +currently geared towards \LaTeX; I have no idea how it would work with +Con\TeX{}t or plain \TeX. Still, adding support to them should not be +too difficult. + +If you want to know more about the \TeX\ log file and the workings of the +program, check the initial comments in the code. + +\section{Unwrapping long lines} + +\TeX\ wraps (breaks) lines longer than \texttt{max\_print\_line} (by +default, 79 characters). Most tools detect lines that are exactly 79 +characters long and treat the next line as a continuation, but that fails +in quite a few cases (check the comments in the \texttt{texlogsieve} code +for a discussion on that). So, if at all possible, it is a very good idea +to set \texttt{max\_print\_line} to a really large value (such as 100,000), +effectively disabling line wrapping. It was useful in the 1980s, but not +anymore (your terminal or editor wraps automatically). + +Still, \texttt{texlogsieve} goes to great lengths to correctly handle +\TeX{} line wrapping and does a pretty good job at that. It understands +the \texttt{max\_print\_line} \TeX{} configuration variable and reads its +value from the same places as \TeX. Setting \texttt{max\_print\_line} to +a value larger than 9999 makes \texttt{texlogsieve} ignore line wrapping. + +\section{Options} + +\begin{description} +\item[\texttt{-\/-page-delay}, \texttt{-\/-no-page-delay}]~\\ +Enable/disable grouping messages by page before display. When enabled, messages +are only output after the current page is finished (shipout). The advantage is +that the page number is included in the message (default enabled). +\end{description} + +\begin{description} +\item[\texttt{-\/-summary}, \texttt{-\/-no-summary}]~\\ +Enable/disable final summary (default enabled). +\end{description} + +\begin{description} +\item[\texttt{-\/-only-summary}]~\\ +No messages, show only the final summary (default disabled). +\end{description} + +\begin{description} +\item[\texttt{-\/-shipouts}, \texttt{-\/-no-shipouts}]~\\ +Enable/disable reporting shipouts (default disabled with page-delay, enabled +with no-page-delay). +\end{description} + +\begin{description} +\item[\texttt{-\/-repetitions}, \texttt{-\/-no-repetitions}]~\\ +Allow/prevent repeated messages (default disabled, i.e., repeated messages +are supressed). +\end{description} + +\begin{description} +\item[\texttt{-\/-heartbeat}, \texttt{-\/-no-heartbeat}]~\\ +Enable/disable progress gauge in page-delay mode (default enabled). +\end{description} + +\begin{description} +\item[\texttt{-l LEVEL}, \texttt{-\/-minlevel=LEVEL}]~\\ +Filter out messages with severity level lower than \texttt{LEVEL}. Valid +levels are \texttt{DEBUG} (no filtering), \texttt{INFO}, \texttt{WARNING}, +\texttt{CRITICAL}, and \texttt{UNKNOWN} (default \texttt{WARNING}). +\end{description} + +\begin{description} +\item[\texttt{-u}, \texttt{-\/-unwrap-only}]~\\ +Do not filter messages and do not output the summary, only unwrap long, +wrapped lines. The output should be very similar (but not equal) to the +input file, but with wrapped lines reconstructed. This activates \texttt{-l +debug}, \texttt{-\/-no-summary}, \texttt{-\/-no-page-delay}, +\texttt{-\/-repetitions}, and \texttt{-\/-shipouts}, and also supresses the +verbose ``open/close file'' and ``shipout'' messages, simulating instead +the \TeX{} format, with parens and square brackets. This is useful if you +prefer the reports generated by some other tool but want to benefit from +texlogsieve's line unwrapping algorithm; the output generated by this option +should be parseable by other tools (but you probably need to coerce the other +tool not to try to unwrap lines). +\end{description} + +\begin{description} +\item[\texttt{-\/-silence-package=PKGNAME}]~\\ +Filter out messages that can be identified as coming from the given package. +Use this option multiple times to suppress messages from several different +packages. +\end{description} + +\begin{description} +\item[\texttt{-\/-silence-string=EXCERPT OF UNWANTED MESSAGE}]~\\ +Filter out messages that contain the given string (you only need to provide +part of the message text for the whole message to be suppressed). Use this +option multiple times to suppress several different messages. The string +should be a single line, but that is not a problem for multiline log +messages: space characters in the provided string match any sequence of +whitespace characters in the message, including newlines. If needed, you +may precede the string with ``////'', in which case you can use lua-style +pattern matching (\url{https://www.lua.org/pil/20.2.html}). Note that the +string is used verbatim: you need not (and should not) enclose it in quotes +nor escape special characters such as ``\textbackslash''. +\end{description} + +\begin{description} +\item[\texttt{-\/-silence-file=FILENAME OR FILE GLOB}]~\\ +Filter out messages that have been generated while the given file was being +processed. Do \textbf{not} use absolute or relative paths, only filenames. +Simple file globs, such as ``\texttt{*.cls}'', work as expected. Use this +option multiple times to suppress messages from several different files. +\end{description} + +\begin{description} +\item[\texttt{-\/-semisilence-file=FILENAME OR FILE GLOB}]~\\ +Just like the previous option, but non-recursive. This means that messages +generated while the given file was being processed are excluded, but messages +generated by some other file that was opened by it are not. For example, +if ``\texttt{chapters.tex}'' includes (with \textbackslash input) the +files ``\texttt{chapter1.tex}'' and ``\texttt{chapter2.tex}'', using +``\texttt{-\/-silence-file=chapters.tex}'' will prevent messages generated +by any of the three files from being displayed. If, however, you use +``\texttt{-\/-semisilence-file=chapters.tex}'', messages generated by +\texttt{chapters.tex} will be suppressed, but messages generated by +\texttt{chapter1.tex} or \texttt{chapter2.tex} will not. +\end{description} + +\begin{description} +\item[\texttt{-\/-add-[debug\textbar info\textbar warning]-message=MESSAGE}]~\\ +Add \texttt{MESSAGE} to the list of messages known to the program with the given +severity level; see Section \ref{unrecognized} below for more information +about this. Like \texttt{-\/-silence-string}, these should be a single line; +unlike \texttt{-\/-silence-string}, you need to embed \verb|\n| explicitly +to indicate line breaks. You may precede the string with ``////'' to use +lua-style pattern matching, but embedding \verb|\n| to indicate line breaks +is unavoidable. Use these options multiple times to add many different +messages. +\end{description} + +\begin{description} +\item[\texttt{-c CFGFILE}, \texttt{-\/-config-file=CFGFILE}]~\\ +Read options from the given configuration file. Options are exactly the +same as the long command-line options, but without the preceding ``-\/-'' +characters. Lines starting with a ``\#'' sign are comments. An example +configuration file: + +\begin{quote} +\begin{verbatim} +no-page-delay +# no-page-delay enables shipouts, but we do not want that +no-shipouts +silence-string = Hyperreferences in rotated content will be misplaced +# no need to escape the "\" (or any other) character +silence-string = Using \overbracket and \underbracket from `mathtools' +# silence a string using lua pattern matching +silence-string = ////luaotfload | aux : font no %d+ %(.-%) +silence-files = *.cls +\end{verbatim} +\end{quote} +\end{description} + +\begin{description} +\item[\texttt{-h}, \texttt{-\/-help}] +Show concise options description. +\end{description} + +\begin{description} +\item[\texttt{-\/-version}] +Print program version. +\end{description} + +\section{Unrecognized Messages} +\label{unrecognized} + +\texttt{texlogsieve} automatically handles messages such as ``Package blah +Info:\dots'' or ``LaTeX Warning:\dots''. However, many messages do not +follow this pattern. To do its thing, \texttt{texlogsieve} should know about +these other messages beforehand. This is important for three reasons: + +\begin{enumerate} + \item Unknown messages are given maximum priority; if you do not want to + see them, you have to use -\/-silence-string; + \item If the message has more than one line, each line is treated as an + independent message. This means you need to use -\/-silence-string + multiple times; + \item In some rare cases, the line unwrapping algorithm may fail near an + unrecognized message. +\end{enumerate} + +While \texttt{texlogsieve} recognizes quite a few messages out of the box, +you may run into a message generated by some package that it does not know +about (you can check for this using \texttt{-l unknown}). If that is the +case, you can use the \verb/--add-[debug|info|warning]-message/ options to +add it to the list of messages known to the program. + +\section{License} + +Copyright © 2021 Nelson Lago \textless lago@ime.usp.br\textgreater\\ +License GPLv3+: GNU GPL version 3 or later +\url{https://gnu.org/licenses/gpl.html}.\\ +This is free software: you are free to change and redistribute it.\\ +There is NO WARRANTY, to the extent permitted by law. + +\PrintChanges + +\end{document} |