From 312b400275fcb3524f3188d52f48aae532215799 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 26 Feb 2022 17:51:21 +0000 Subject: 2022 pretest start git-svn-id: svn://tug.org/texlive/trunk@62186 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/man/man1/hishrink.1 | 201 +++++++++++++++ Master/texmf-dist/doc/man/man1/histretch.1 | 239 ++++++++++++++++++ Master/texmf-dist/doc/man/man1/hitex.1 | 384 +++++++++++++++++++++++++++++ Master/texmf-dist/doc/man/man1/twill.1 | 75 ++++++ 4 files changed, 899 insertions(+) create mode 100644 Master/texmf-dist/doc/man/man1/hishrink.1 create mode 100644 Master/texmf-dist/doc/man/man1/histretch.1 create mode 100644 Master/texmf-dist/doc/man/man1/hitex.1 create mode 100644 Master/texmf-dist/doc/man/man1/twill.1 (limited to 'Master/texmf-dist/doc/man') diff --git a/Master/texmf-dist/doc/man/man1/hishrink.1 b/Master/texmf-dist/doc/man/man1/hishrink.1 new file mode 100644 index 00000000000..bf29ca9f440 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/hishrink.1 @@ -0,0 +1,201 @@ +.TH HISHRINK 1 "11 November 2021" "Version 1.3" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF Metafont +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP +.el .ds OX TeX +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX +.if n .ds AX AmSTeX +.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX +.if n .ds AY AmSLaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +hishrink\- translating ASCII HINT files to binary files +.SH SYNOPSIS +.B hishrink +.RI [ options ] +.RI [ file ] +.\"===================================================================== +.SH DESCRIPTION +Shrinking converts an ASCII HINT file, usually with the extension +.BR .hint , +into a binary HINT file, with the extension +.BR .hnt . +.PP +The ASCII based HINT file format - also called `long' format - is optimized +for readability. It can be edited using a text editor. Hence it allows +simple modifications that would be difficult to achieve when using the binary +format. It is also convenient when debugging. +.PP +The binary HINT file format - also called `short' format - is optimized +for displaying HINT files. It can be parsed equally well in forward +and backward direction to enable fast forward or backward navigation in the file. +.PP +The binary HINT file format is designed for on-screen reading of documents. +Using a HINT viewer to display a HINT file, its content will dynamically +adapt to the available display area. For complete information on the +HINT file format and programs to view HINT files, see +.BR https://hint.userweb.mwn.de . +.\"===================================================================== +.SH OPTIONS +This version of +.B hishrink +understands the following command line options: +.TP +.B -a +Use only the localized names for auxiliary files as explained in the +.B FILES +section below. + +If you know that the auxiliary files can be found using the localized names, +for example after creating them with +.B histretch +using the +.B -a +option, you can use +.B hishrink +with the +.B -a +option to limit the search for the auxiliar files. +If you are unsure, you should use neither the +.B -a +nor the +.B -g +option. +.B hishrink +will then search for auxiliar files first using the localized path names +and then using the path names as given. +.TP +.B -c +Enable the use of compression for the HINT file. Compressed files are +smaller but require decompression when viewing. Use only for large +files if the file size matters. +.TP +.BI -d \ bitmask +Sets HINT file debugging flags according to the +.IR bitmask . +Use the +.B --help +option for details. +.TP +.B -g +Do not use the localized names for auxiliary files as explained in the +.B FILES +section below. + +You may use this option if you know that all auxiliar files +are at the locations described by the path names stored in the HINT file. +If you are unsure, you should use neither the +.B -g +nor the +.B -a +option. +.B hishrink +will then search for auxiliar files first using the localized path names +and then using the path names as given. +.TP +.B --help +Print help message and exit. +.TP +.B -l +Redirect standard error to a log file. The name of the log file is derived from +the name of the input file replacing the extension +.B .hint +by the extension +.BR .log . +.TP +.BI -o \ name +Use +.I name +for the output file instead of deriving it from the name of the input file. +Append the extension +.B .hnt +if the +.I name +does not already has that extension. +.TP +.B --version +Print version information and exit. +.\"===================================================================== +.SH FILES +Binary HINT files must contain all resources necessary to display the file, +for example font and image files. These files are called auxiliary files. +ASCII HINT files contain only the path names of these files. + +When creating a binary HINT file from an ASCII HINT file, it is +necessary to find these files, read them, and include them in the binary output file. +When creating an ASCII HINT file from a binary HINT file, it is +convenient if these files can be extracted and written to the file system. +To avoid clobbering arbitrary directories with files when extracting auxiliary +files, it is possible to map the path names as stored in the HINT file +to +.B localized +path names before writing or reading auxiliar files. + +When computing a localized path name from a given path name, +a distinction is made between global resources, +like fonts, that are referenced by an absolute path name, and local +resources, for example an image, that are referenced by a relative +path name. The directory that starts the localized path name of the former +has the extension +.B .abs +and for the latter the extension +.BR .rel +is used. +To keep auxiliary files in these subdirectories even if their path +contains links to a parent directory, parent links +.RB ` .. ' +are replaced by +.RB ` __ ' +links to subdirectories. + +For example, +given an input file +.BR paper.hint, +the global resources are stored in the +.B paper.abs +directory and local resources are stored in +.BR paper.rel . +An absolute path like +.B /usr/share/fonts/ +will then map to the localized path +.BR paper.abs/usr/share/fonts/ +and a relative path like +.B ../image/img1.jpg +will then map to the localized path +.BR paper.rel/__/image/img1.jpg . +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation can be found in the +.IR "HINT: The file format" . +This document is available as a book or in electronic form from the +HINT project home page at +.BR https://hint.userweb.mwn.de . +There you find additional software, most importantly viewers for HINT files, +and further information. +.\"===================================================================== +.SH AVAILABILITY +.B hishrink +should compile on a large variety of machine architectures +and operating systems. +It is part of the \*(TX Live distribution. +.PP +.\"===================================================================== +.SH "SEE ALSO" +.BR histretch (1), +.BR hitex (1), +.\"===================================================================== +.SH AUTHORS +Martin Ruckert +.\" vim: syntax=nroff diff --git a/Master/texmf-dist/doc/man/man1/histretch.1 b/Master/texmf-dist/doc/man/man1/histretch.1 new file mode 100644 index 00000000000..cbc385f5f01 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/histretch.1 @@ -0,0 +1,239 @@ +.TH HISTRETCH 1 "11 November 2021" "Version 1.3" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF Metafont +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP +.el .ds OX TeX +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX +.if n .ds AX AmSTeX +.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX +.if n .ds AY AmSLaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +histretch \- translating binary HINT files to ASCII files +.SH SYNOPSIS +.B histretch +.RI [ options ] +.RI [ file ] +.\"===================================================================== +.SH DESCRIPTION +Stretching converts a binary HINT file, usually with the extension +.BR .hnt , +into an ASCII based HINT file, with the extension +.BR .hint . +.PP +The binary HINT file format - also called `short' format - is optimized +for displaying HINT files. It can be parsed equally well in forward +and backward direction to enable fast forward or backward navigation in the file. +.PP +The ASCII based HINT file format - also called `long' format - is optimized +for readability. It can be edited using a text editor. Hence it allows +simple modifications that would be difficult to achieve when using the binary +format. It is also convenient when debugging. +.PP +The binary HINT file format is designed for on-screen reading of documents. +Using a HINT viewer to display a HINT file, its content will dynamically +adapt to the available display area. For complete information on the +HINT file format and programs to view HINT files, see +.BR https://hint.userweb.mwn.de . +.\"===================================================================== +.SH OPTIONS +This version of +.B histretch +understands the following command line options: +.TP +.B -a +Write auxiliar files to disk using the localized path names as explained in the +.B FILES +section below. + +Use this option if you are stretching a HINT file that you later want +to shrink back to its binary format unless you know that you have +already all the auxiliary files contained in it. +.TP +.BI -d \ bitmask +Sets HINT file debugging flags according to the +.IR bitmask . +See the +.B --help +option for details. +.TP +.B -f +Force the replacement of existing auxiliary files. +Use this option together with the +.B -g +or +.B -a +option to make sure that already exiting auxiliary files are replaced by the +auxiliary files contained in the HINT file. + +.BR WARNING : +This is a dangerous option especially together with the +.B -g +option. Never use it on a HINT file of unknown +origin. It will possibly replace any file on your machine you have +write access to. If in doubt, don't use the +.B -f +option. +.TP +.B -g +Write auxiliar files to disk using the path names as stored in the HINT file. +This option is an alternative to the +.B -a +option and takes precedence if given. +If in doubt, don't use the +.B -g +option. +If you just want to stretch the HINT file, then edit it, and then shrink +it back to the binary format, you should use the +.B -a +option. + +You may use this option if you are stretching a HINT file on the same machine and in +the same directory where you have created the HINT file. Then all files +will be copied to the location they came from in case they were deleted +in the meantime. + +If you are stretching a HINT file on one machine and the file was created +on a different machine, +.B histretch +will try to copy an auxiliary file +into the same directory that was used when the HINT file was created, provided that +you have the necessary writing rights. +This is probably where you want the auxiliary file assuming that both machines have the +same directory structure. + +.BR WARNING : +This is a dangerous option especially together with the +.B -f +option. Never use it on a HINT file of unknown +origin. It can possibly write (and replace) any file on your machine where you have +write access. +.TP +.B --help +Print help message and exit. +.TP +.B -l +Redirect standard error to a log file. The name of the log file is derived from +the name of the input file replacing the extension +.B .hnt +by the extension +.BR .log . +.TP +.BI -o \ name +Use +.I name +for the output file instead of deriving it from the name of the input file. +Append the extension +.B .hint +if the +.I name +does not already has that extension. +.TP +.B -u +Enable the use of UTF8 character codes. +Without this option, the output file is a pure ASCII file, because character codes +outside the ASCII range are written using their numeric representation. +With this option, the file will always represent printable characters using their UTF8 +character codes. This might make the output file more readable if displayed +using an UTF8 enabled program; but it might be less readable if displayed +by a program that does not handle UTF8 characters properly. See also the +.B -x +option. +.TP +.B --version +Print version information and exit. +.TP +.B -x +Enable the use of hexadecimal character codes. +Without this option, characters that are not represented using their +character codes are represented using a decimal representation of +the character code. With this option a hexadecimal representation is used. +The range of character codes that have a numeric representation includes +the non printable characters (character codes smaller than 32) +and unless the +.B -u +option is given, the character codes with a value of 127 and above. +.\"===================================================================== +.SH FILES +Binary HINT files must contain all resources necessary to display the file, +for example font and image files. These files are called auxiliary files. +ASCII HINT files contain only the path names of these files. + +When creating a binary HINT file from an ASCII HINT file, it is +necessary to find these files, read them, and include them in the binary output file. +When creating an ASCII HINT file from a binary HINT file, it is +convenient if these files can be extracted and written to the file system. +To avoid clobbering arbitrary directories with files when extracting auxiliary +files, it is possible to map the path names as stored in the HINT file +to +.B localized +path names before writing or reading auxiliar files. + +When computing a localized path name from a given path name, +a distinction is made between global resources, +like fonts, that are referenced by an absolute path name, and local +resources, for example an image, that are referenced by a relative +path name. The directory that starts the localized path name of the former +has the extension +.B .abs +and for the latter the extension +.BR .rel +is used. +To keep auxiliary files in these subdirectories even if their path +contains links to a parent directory, parent links +.RB ` .. ' +are replaced by +.RB ` __ ' +links to subdirectories. + +For example, +given an input file +.BR paper.hint, +the global resources are stored in the +.B paper.abs +directory and local resources are stored in +.BR paper.rel . +An absolute path like +.B /usr/share/fonts/ +will then map to the localized path +.BR paper.abs/usr/share/fonts/ +and a relative path like +.B ../image/img1.jpg +will then map to the localized path +.BR paper.rel/__/image/img1.jpg . +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation can be found in +.IR "HINT: The file format" . +This document is available as a book or in electronic form from the +HINT project home page at +.BR https://hint.userweb.mwn.de . +There you find additional software, most importantly viewers for HINT files, +and further information. +.\"===================================================================== +.SH AVAILABILITY +.B histretch +should compile on a large variety of machine architectures +and operating systems. +It is part of the \*(TX Live distribution. +.PP +.\"===================================================================== +.SH "SEE ALSO" +.BR hishrink (1), +.BR hitex (1), +.\"===================================================================== +.SH AUTHORS +Martin Ruckert +.\" vim: syntax=nroff diff --git a/Master/texmf-dist/doc/man/man1/hitex.1 b/Master/texmf-dist/doc/man/man1/hitex.1 new file mode 100644 index 00000000000..ef1655d1b82 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/hitex.1 @@ -0,0 +1,384 @@ +.TH HITEX 1 "11 November 2021" "Version 1.0" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF Metafont +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP +.el .ds OX TeX +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX +.if n .ds AX AmSTeX +.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX +.if n .ds AY AmSLaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +hitex \- HINT output from TeX +.SH SYNOPSIS +.B hitex +.RI [ options ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] +.\"===================================================================== +.SH DESCRIPTION +Run the Hi\*(TX typesetter on +.IR file , +usually creating +.IR file.hnt . +If the file argument has no extension, ".tex" will be appended to it. +Instead of a file name, a set of Hi\*(TX commands can be given, the first +of which must start with a backslash. +With a +.BI & format +argument Hi\*(TX uses a different set of precompiled commands, +contained in +.IR format\fB.fmt\fP ; +it is usually better to use the +.B -fmt +.I format +option instead. +.PP +Hi\*(TX is a version of \*(TX that creates HINT files. The HINT file +format is designed for on-screen reading of documents. Using a HINT +viewer (see +.BR https://hint.userweb.mwn.de ) +to display a HINT file its content will dynamically adapt to the +available display area. +.PP +The typical use of Hi\*(TX is with pre generated formats. +The +.B hitex +command uses the equivalent of the plain \*(TX format, and the +.B hilatex +command uses the equivalent of the \*(LX format. +To generate formats, use the +.B -ini +switch. +.PP +Hi\*(TX's handling of its command-line arguments is similar to that of +of the other \*(TX programs in the +.I web2c +implementation. +.PP +Hi\*(TX incorporates the e-\*(TX +extensions (see +.BR etex (1)) +if used with the +.B -etex +switch. +.PP +Hi\*(TX incorporates the extensions needed for \*(LX +(see +.BR latex (1)) +if used with the +.B -ltx +switch. +.\"===================================================================== +.SH OPTIONS +This version of Hi\*(TX understands the following command line options. +.TP +.BI -cnf-line \ string +Parse +.I string +as a +.I texmf.cnf +configuration line. See the Kpathsea manual. +.TP +.B -compress +Enable the use of compression for the HINT file. Compressed files are +smaller but require decompression when viewing. Use only for large +files if the file size matters. +.TP +.B -empty-page +When writing books, often empty pages are inserted - for example to +begin chapters on a right hand side page. These empty pages are +a nuisance for on-screen reading where there are no left or right +hand side pages. This option keeps empty pages in the output. +.TP +.B -no-empty-page +This option tries to eliminate empty pages in the output. It is set as a default. +.TP +.B -etex +Enable the e-\*(TX extensions. This option is only effective in +combination with +.BR -ini . +See +.BR etex (1). +.TP +.B -file-line-error +Print error messages in the form +.I file:line:error +which is similar to the way many compilers format them. +.TP +.B -no-file-line-error +Disable printing error messages in the +.I file:line:error +style. +.TP +.BI -fmt \ format +Use +.I format +as the name of the format to be used, instead of the name by which +Hi\*(TX was called or a +.I %& +line. +.TP +.B -help +Print help message and exit. +.TP +.BI -hint-debug \ bitmask +Sets HINT file debugging flags according to the +.IR bitmask . +See the +.B -hint-debug-help +option for details. +.TP +.B -hint-debug-help +Print an explanation of the HINT debugging flags and exit. +.TP +.B -hyphenate-first-word +\*(TX will usually not attempt to insert hyphenation points into the first +word of a paragraph. If a HINT file must be displayed on a very small device +such hyphenation points might prove necessary. This option is set by default +and enables the generation of these hyphenation points. +.TP +.B -no-hyphenate-first-word +Disable the automatic insertion of hyphenation points in the first word +of a paragraph. Needed only if complete compatibility with \*(TX is required. +.TP +.B -ini +Start in +.I INI +mode, which is used to dump formats. The +.I INI +mode can be used for typesetting, but no format is preloaded, and +basic initializations like setting catcodes may be required. +.TP +.BI -interaction \ mode +Sets the interaction mode. The mode can be either +.IR batchmode , +.IR nonstopmode , +.IR scrollmode , +and +.IR errorstopmode . +The meaning of these modes is the same as that of the corresponding +\ecommands. +.TP +.BI -jobname \ name +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.B -ltx +Enable the \*(LX extensions. This option is only effective in +combination with +.BR -ini . +See +.BR latex (1). +.TP +.BI -mfmode \ mode +Use +.I mode +as the \*(MF +.I mode +when generating missing fonts. See +.BR mf (1) +for details. +.TP +.BI -mktex \ fmt +Enable +.RI mktex fmt , +where +.I fmt +must be either +.IR tex , +.IR tfm , +.IR fmt , +or +.IR pk . +.TP +.BI -no-mktex \ fmt +Disable +.RI mktex fmt , +where +.I fmt +must be either +.IR tex , +.IR tfm , +.IR fmt , +or +.IR pk . +.TP +.BI -output-directory \ directory +Write output files in +.I directory +instead of the current directory. Look up input files in +.I directory +first, then along the normal search path. +.TP +.B -parse-first-line +If the first line of the main input file begins with +.I %& +parse it to look for a dump name. +.TP +.B -no-parse-first-line +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.BI -resolution \ number +When using \*(MF to generate missing pk fonts, use a resolution of +.I number +DPI. See +.BR mf (1) +for details. +.TP +.B -version +Print version information and exit. +.\"===================================================================== +.SH ENVIRONMENT +See the Kpathsea library documentation (e.g., the `Path specifications' +node) for precise details of how the environment variables are used. +The +.B kpsewhich +utility can be used to query the values of the variables. +.PP +One caveat: In most Hi\*(TX formats, you cannot use ~ in a file name you +give directly to Hi\*(TX, because ~ is an active character in \*(TX, +and hence is expanded, not taken as part of the file name. Other +programs, such as \*(MF, do not have this problem. +.PP +.TP +.B TEXMFOUTPUT +Normally, Hi\*(TX puts its output files in the current directory. If +any output file cannot be opened there, it tries to open it in the +directory specified in the environment variable TEXMFOUTPUT. +There is no default value for that variable. For example, if you say +.I hitex paper +and the current directory is not writable and TEXMFOUTPUT has +the value +.IR /tmp , +Hi\*(TX attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.hnt , +if any output is produced.) TEXMFOUTPUT is also checked for input +files, as \*(TX often generates files that need to be subsequently +read; for input, no suffixes (such as ``.tex'') are added by default, +the input name is simply checked as given. +.TP +.B TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This normally starts with ``.'', so +that user files are found before system files. An empty path +component will be replaced with the paths defined in the +.I texmf.cnf +file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the +current directory and ``/home/user/tex'' to the standard search path. +.TP +.B TEXFORMATS +Search path for format files. +.TP +.B TFMFONTS +Search path for font metric +.RI ( .tfm ) +files. +.TP +.B SOURCE_DATE_EPOCH +If set, its value, taken to be in epoch-seconds, will be used for the +creation date and as the reference moment for the time related +primitives of \*(LX. This is useful for making reproducible builds. +.TP +.B FORCE_SOURCE_DATE +If set to the value "1", the time-related \*(TX primitives +.RI ( \eyear , +.IR \emonth , +.IR \eday , +.IR \etime ) +are also initialized from the value of SOURCE_DATE_EPOCH. This is not +recommended if there is any viable alternative. +.PP +Many, many more environment variables may be consulted related to path +searching. See the Kpathsea manual. +.\"===================================================================== +.SH FILES +The location of the files mentioned below varies from system to +system. Use the +.B kpsewhich +utility to find their locations. +.TP +.I *.tfm +Metric files for Hi\*(TX's fonts. +.TP +.I *.fmt +Predigested Hi\*(TX format files. +.TP +.I *.pk *.pfb +Font files used by Hi\*(TX. +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation for Hi\*(TX can be found in the +.IR "Hi\*(TX user manual" +Further information can be found in the manual of the +.I "Kpathsea library" +and in +.I "HINT: The file format" +which is available as a book or in electronic form from the +HINT project home page at +.BR https://hint.userweb.mwn.de . +.\"===================================================================== +.SH BUGS +This version of Hi\*(TX fails to handle correctly glues and kerns with a +width that depends on \ehsize or \evsize. Similarly, when +the layout of table entries or mathematical formulas depends on \ehsize +or \evsize their output might be distorted. +.\"===================================================================== +.SH AVAILABILITY +Hi\*(TX should compile on a large variety of machine architectures +and operating systems. +Hi\*(TX is part of the \*(TX Live distribution. +.PP +The Hi\*(TX home page is at +.BR https://hint.userweb.mwn.de . +There you find additional software, most importantly viewers for HINT files, +and further information. +.\"===================================================================== +.SH "SEE ALSO" +.BR histretch (1), +.BR hishrink (1), +.BR latex (1), +.BR tex (1), +.BR kpsewhich (1), +.\"===================================================================== +.SH AUTHORS +The primary author of Hi\*(TX is Martin Ruckert, +with e\*(TX extensions by Peter Breitenlohner, +\*(LX extensions by Thierry Laronde, and +the kpathsearch library by Karl Berry. +.PP +\*(TX was designed by Donald E. Knuth, +who implemented it using his \*(WB system for Pascal programs. +.PP +Many, many more contributed to the typesetting system now known as \*(TX; +far too many to name all of them here. +.\" vim: syntax=nroff diff --git a/Master/texmf-dist/doc/man/man1/twill.1 b/Master/texmf-dist/doc/man/man1/twill.1 new file mode 100644 index 00000000000..6aabc5e40a1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/twill.1 @@ -0,0 +1,75 @@ +.TH WEAVE 1 "09 January 2022" "Web2C 2022" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF Metafont +.if n .ds TX TeX +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP +.el .ds OX TeX +.\" BX definition must follow TX so BX can use TX +.if n .ds BX BibTeX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.\" LX definition must follow TX so LX can use TX +.if n .ds LX LaTeX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +twill \- translate WEB to TeX +.SH SYNOPSIS +.B twill +.RB [ \-x ] +.IR webfile [ \fB.web\fP ] +.RI [ changefile [ \fB.ch\fP ]] +.\"===================================================================== +.SH DESCRIPTION +The +.B twill +program is used to create a \*(TX file for viewing a \*(WB program. +It takes appropriate care of typographic details like page +layout and the use of indentation, italics, boldface, etc., and it supplies +extensive cross-index information in the form of 'mini-indexes' for each +spread of pages and a 'master index' at the end that it gathers automatically. +.PP +The command line arguments are the same as for +.B tangle +except for the option: +.B \-x +says to omit the indexes, module name list, and table of contents pages. +(A +.I CONTENTS.tex +file will still be written when the \*(TX file is processed, +however, unless some macros in +.I webmac.tex +are redefined.) +.PP +The output \*(TX file name is formed by adding +.B .tex +to the root of the \*(WB file name. +.PP +There are several macros +that probably should be redefined by +the programmer at the beginning of the \*(WB file. +It is a good idea to set \\title +to the name of the program. +And, to cause output of only changed modules, one can say +\\let\\maybe=\\iffalse (usually as the first change in the +change file). +.\"===================================================================== +.SH ENVIRONMENT +The environment variable WEBINPUTS is used to search for the input files, +or the system default if WEBINPUTS is not set. See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH FILES +.TP \w'@@'u+2n +.I $TEXMFMAIN/tex/plain/knuth-lib/twimac-web.tex +\*(TX macros used by +.B twill +output. +.\"===================================================================== +.SH "SEE ALSO" +.BR tangle (1) +for references, authors, and other information. -- cgit v1.2.3