{ "mode": "man", "parameter": "HITEX", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/HITEX/1/json", "generated": "2026-10-21T03:13:35Z", "synopsis": "hitex [options] [&format] [file|\\commands]", "sections": { "NAME": { "content": "hitex - HINT output from TeX\n", "subsections": [] }, "SYNOPSIS": { "content": "hitex [options] [&format] [file|\\commands]\n", "subsections": [] }, "DESCRIPTION": { "content": "Run the HiTeX typesetter on file, usually creating file.hnt. If the file argument has no ex‐\ntension, \".tex\" will be appended to it. Instead of a file name, a set of HiTeX commands can\nbe given, the first of which must start with a backslash. With a &format argument HiTeX uses\na different set of precompiled commands, contained in format.fmt; it is usually better to use\nthe -fmt format option instead.\n\nHiTeX is a version of TeX that creates HINT files. The HINT file format is designed for on-\nscreen reading of documents. Using a HINT viewer (see https://hint.userweb.mwn.de) to display\na HINT file its content will dynamically adapt to the available display area.\n\nThe typical use of HiTeX is with pre generated formats. The hitex command uses the equiva‐\nlent of the plain TeX format, and the hilatex command uses the equivalent of the LaTeX for‐\nmat. To generate formats, use the -ini switch.\n\nHiTeX's handling of its command-line arguments is similar to that of of the other TeX pro‐\ngrams in the web2c implementation.\n\nHiTeX incorporates the e-TeX extensions (see etex(1)) if used with the -etex switch.\n\nHiTeX incorporates the extensions needed for LaTeX (see latex(1)) if used with the -ltx\nswitch.\n", "subsections": [] }, "OPTIONS": { "content": "This version of HiTeX understands the following command line options.\n", "subsections": [ { "name": "-cnf-line _", "content": "Parse string as a texmf.cnf configuration line. See the Kpathsea manual.\n" }, { "name": "-compress", "content": "Enable the use of compression for the HINT file. Compressed files are smaller but re‐\nquire decompression when viewing. Use only for large files if the file size matters.\n" }, { "name": "-empty-page", "content": "When writing books, often empty pages are inserted - for example to begin chapters on\na right hand side page. These empty pages are a nuisance for on-screen reading where\nthere are no left or right hand side pages. This option keeps empty pages in the out‐\nput.\n" }, { "name": "-no-empty-page", "content": "This option tries to eliminate empty pages in the output. It is set as a default.\n" }, { "name": "-etex -ini", "content": "See etex(1).\n" }, { "name": "-file-line-error", "content": "Print error messages in the form file:line:error which is similar to the way many com‐\npilers format them.\n" }, { "name": "-no-file-line-error", "content": "Disable printing error messages in the file:line:error style.\n" }, { "name": "-fmt _", "content": "Use format as the name of the format to be used, instead of the name by which HiTeX\nwas called or a %& line.\n" }, { "name": "-help", "content": "" }, { "name": "-hint-debug _", "content": "Sets HINT file debugging flags according to the bitmask. See the -hint-debug-help op‐\ntion for details.\n" }, { "name": "-hint-debug-help", "content": "Print an explanation of the HINT debugging flags and exit.\n" }, { "name": "-hyphenate-first-word", "content": "TeX will usually not attempt to insert hyphenation points into the first word of a\nparagraph. If a HINT file must be displayed on a very small device such hyphenation\npoints might prove necessary. This option is set by default and enables the generation\nof these hyphenation points.\n" }, { "name": "-no-hyphenate-first-word", "content": "Disable the automatic insertion of hyphenation points in the first word of a para‐\ngraph. Needed only if complete compatibility with TeX is required.\n" }, { "name": "-ini", "content": "setting, but no format is preloaded, and basic initializations like setting catcodes\nmay be required.\n" }, { "name": "-interaction _", "content": "Sets the interaction mode. The mode can be either batchmode, nonstopmode, scrollmode,\nand errorstopmode. The meaning of these modes is the same as that of the correspond‐\ning \\commands.\n" }, { "name": "-jobname _", "content": "Use name for the job name, instead of deriving it from the name of the input file.\n" }, { "name": "-kpathsea-debug _", "content": "Sets path searching debugging flags according to the bitmask. See the Kpathsea manual\nfor details.\n" }, { "name": "-ltx -ini", "content": "See latex(1).\n" }, { "name": "-mfmode _", "content": "Use mode as the Metafont mode when generating missing fonts. See mf(1) for details.\n" }, { "name": "-mktex _", "content": "Enable mktexfmt, where fmt must be either tex, tfm, fmt, or pk.\n" }, { "name": "-no-mktex _", "content": "Disable mktexfmt, where fmt must be either tex, tfm, fmt, or pk.\n" }, { "name": "-output-directory _", "content": "Write output files in directory instead of the current directory. Look up input files\nin directory first, then along the normal search path.\n" }, { "name": "-parse-first-line", "content": "If the first line of the main input file begins with %& parse it to look for a dump\nname.\n" }, { "name": "-no-parse-first-line", "content": "Disable parsing of the first line of the main input file.\n" }, { "name": "-progname _", "content": "Pretend to be program name. This affects both the format used and the search paths.\n" }, { "name": "-resolution _", "content": "When using Metafont to generate missing pk fonts, use a resolution of number DPI. See\nmf(1) for details.\n" }, { "name": "-version", "content": "Print version information and exit.\n" } ] }, "ENVIRONMENT": { "content": "See the Kpathsea library documentation (e.g., the `Path specifications' node) for precise de‐\ntails of how the environment variables are used. The kpsewhich utility can be used to query\nthe values of the variables.\n\nOne caveat: In most HiTeX formats, you cannot use ~ in a file name you give directly to Hi‐\nTeX, because ~ is an active character in TeX, and hence is expanded, not taken as part of the\nfile name. Other programs, such as Metafont, do not have this problem.\n\nTEXMFOUTPUT\nNormally, HiTeX puts its output files in the current directory. If any output file\ncannot be opened there, it tries to open it in the directory specified in the environ‐\nment variable TEXMFOUTPUT. There is no default value for that variable. For example,\nif you say hitex paper and the current directory is not writable and TEXMFOUTPUT has\nthe value /tmp, HiTeX attempts to create /tmp/paper.log (and /tmp/paper.hnt, if any\noutput is produced.) TEXMFOUTPUT is also checked for input files, as TeX often gener‐\nates files that need to be subsequently read; for input, no suffixes (such as\n``.tex'') are added by default, the input name is simply checked as given.\n\nTEXINPUTS\nSearch path for \\input and \\openin files. This normally starts with ``.'', so that\nuser files are found before system files. An empty path component will be replaced\nwith the paths defined in the texmf.cnf file. For example, set TEXINPUTS to\n\".:/home/user/tex:\" to prepend the current directory and ``/home/user/tex'' to the\nstandard search path.\n\nTEXFORMATS\nSearch path for format files.\n\nTFMFONTS\nSearch path for font metric (.tfm) files.\n\nSOURCEDATEEPOCH\nIf set, its value, taken to be in epoch-seconds, will be used for the creation date\nand as the reference moment for the time related primitives of LaTeX. This is useful\nfor making reproducible builds.\n\nFORCESOURCEDATE\nIf set to the value \"1\", the time-related TeX primitives (\\year, \\month, \\day, \\time)\nare also initialized from the value of SOURCEDATEEPOCH. This is not recommended if\nthere is any viable alternative.\n\nMany, many more environment variables may be consulted related to path searching. See the\nKpathsea manual.\n", "subsections": [] }, "FILES": { "content": "The location of the files mentioned below varies from system to system. Use the kpsewhich\nutility to find their locations.\n\n*.tfm Metric files for HiTeX's fonts.\n\n*.fmt Predigested HiTeX format files.\n\n*.pk *.pfb\nFont files used by HiTeX.\n", "subsections": [] }, "NOTES": { "content": "This manual page is not meant to be exhaustive. The complete documentation for HiTeX can be\nfound in the HiTeX user manual Further information can be found in the manual of the Kpath‐\nsea library and in HINT: The file format which is available as a book or in electronic form\nfrom the HINT project home page at https://hint.userweb.mwn.de.\n", "subsections": [] }, "BUGS": { "content": "This version of HiTeX fails to handle correctly glues and kerns with a width that depends on\n\\hsize or \\vsize. Similarly, when the layout of table entries or mathematical formulas de‐\npends on \\hsize or \\vsize their output might be distorted.\n", "subsections": [] }, "AVAILABILITY": { "content": "HiTeX should compile on a large variety of machine architectures and operating systems. Hi‐\nTeX is part of the TeX Live distribution.\n\nThe HiTeX home page is at https://hint.userweb.mwn.de. There you find additional software,\nmost importantly viewers for HINT files, and further information.\n", "subsections": [] }, "SEE ALSO": { "content": "histretch(1), hishrink(1), latex(1), tex(1), kpsewhich(1),\n", "subsections": [] }, "AUTHORS": { "content": "The primary author of HiTeX is Martin Ruckert, with eTeX extensions by Peter Breitenlohner,\nLaTeX extensions by Thierry Laronde, and the kpathsearch library by Karl Berry.\n\nTeX was designed by Donald E. Knuth, who implemented it using his Web system for Pascal pro‐\ngrams.\n\nMany, many more contributed to the typesetting system now known as TeX; far too many to name\nall of them here.\n\nVersion 1.0 11 November 2021 HITEX(1)", "subsections": [] } }, "summary": "hitex - HINT output from TeX", "flags": [ { "flag": "", "long": null, "arg": null, "description": "Parse string as a texmf.cnf configuration line. See the Kpathsea manual." }, { "flag": "", "long": null, "arg": null, "description": "Enable the use of compression for the HINT file. Compressed files are smaller but re‐ quire decompression when viewing. Use only for large files if the file size matters." }, { "flag": "", "long": null, "arg": null, "description": "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 out‐ put." }, { "flag": "", "long": null, "arg": null, "description": "This option tries to eliminate empty pages in the output. It is set as a default." }, { "flag": "", "long": null, "arg": null, "description": "See etex(1)." }, { "flag": "", "long": null, "arg": null, "description": "Print error messages in the form file:line:error which is similar to the way many com‐ pilers format them." }, { "flag": "", "long": null, "arg": null, "description": "Disable printing error messages in the file:line:error style." }, { "flag": "", "long": null, "arg": null, "description": "Use format as the name of the format to be used, instead of the name by which HiTeX was called or a %& line." }, { "flag": "", "long": null, "arg": null, "description": "" }, { "flag": "", "long": null, "arg": null, "description": "Sets HINT file debugging flags according to the bitmask. See the -hint-debug-help op‐ tion for details." }, { "flag": "", "long": null, "arg": null, "description": "Print an explanation of the HINT debugging flags and exit." }, { "flag": "", "long": null, "arg": null, "description": "TeX 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." }, { "flag": "", "long": null, "arg": null, "description": "Disable the automatic insertion of hyphenation points in the first word of a para‐ graph. Needed only if complete compatibility with TeX is required." }, { "flag": "", "long": null, "arg": null, "description": "setting, but no format is preloaded, and basic initializations like setting catcodes may be required." }, { "flag": "", "long": null, "arg": null, "description": "Sets the interaction mode. The mode can be either batchmode, nonstopmode, scrollmode, and errorstopmode. The meaning of these modes is the same as that of the correspond‐ ing \\commands." }, { "flag": "", "long": null, "arg": null, "description": "Use name for the job name, instead of deriving it from the name of the input file." }, { "flag": "", "long": null, "arg": null, "description": "Sets path searching debugging flags according to the bitmask. See the Kpathsea manual for details." }, { "flag": "", "long": null, "arg": null, "description": "See latex(1)." }, { "flag": "", "long": null, "arg": null, "description": "Use mode as the Metafont mode when generating missing fonts. See mf(1) for details." }, { "flag": "", "long": null, "arg": null, "description": "Enable mktexfmt, where fmt must be either tex, tfm, fmt, or pk." }, { "flag": "", "long": null, "arg": null, "description": "Disable mktexfmt, where fmt must be either tex, tfm, fmt, or pk." }, { "flag": "", "long": null, "arg": null, "description": "Write output files in directory instead of the current directory. Look up input files in directory first, then along the normal search path." }, { "flag": "", "long": null, "arg": null, "description": "If the first line of the main input file begins with %& parse it to look for a dump name." }, { "flag": "", "long": null, "arg": null, "description": "Disable parsing of the first line of the main input file." }, { "flag": "", "long": null, "arg": null, "description": "Pretend to be program name. This affects both the format used and the search paths." }, { "flag": "", "long": null, "arg": null, "description": "When using Metafont to generate missing pk fonts, use a resolution of number DPI. See mf(1) for details." }, { "flag": "", "long": null, "arg": null, "description": "Print version information and exit." } ], "examples": [], "see_also": [ { "name": "histretch", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/histretch/1/json" }, { "name": "hishrink", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/hishrink/1/json" }, { "name": "latex", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/latex/1/json" }, { "name": "tex", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/tex/1/json" }, { "name": "kpsewhich", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/kpsewhich/1/json" } ], "tldr": { "source": "not_found", "examples": [] } }