{ "content": [ { "type": "text", "text": "# ALEPH (man)\n\n## NAME\n\naleph - extended Unicode TeX\n\n## SYNOPSIS\n\naleph [options] [&format] [file|\\commands]\n\n## DESCRIPTION\n\nRun the Aleph typesetter on file, usually creating file.dvi. If the file argument has no ex‐\ntension, \".tex\" will be appended to it. Instead of a filename, a set of Aleph commands can\nbe given, the first of which must start with a backslash. With a &format argument Aleph uses\na different set of precompiled commands, contained in format.fmt; it is usually better to use\nthe -fmt format option instead.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (7 subsections)\n- **ENVIRONMENT**\n- **NOTES**\n- **BUGS**\n- **SEE ALSO**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "ALEPH", "section": "", "mode": "man", "summary": "aleph - extended Unicode TeX", "synopsis": "aleph [options] [&format] [file|\\commands]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "", "long": null, "arg": null, "description": "Parse string as a texmf.cnf configuration line. See the Kpathsea manual. --fmt format Use format as the name of the format to be used, instead of the name by which Aleph was called or a %& line." }, { "flag": "", "long": "--halt-on-error", "arg": null, "description": "Exit with an error code when an error is encountered during processing. --help Print help message and exit. --ini Be `initial' Aleph for dumping formats; this is implicitly true if the program is called as inialeph. --interaction mode Sets the interaction mode. The mode can be one of batchmode, nonstopmode, scrollmode, and errorstopmode. The meaning of these modes is the same as that of the correspond‐ ing \\commands. --ipc Send DVI output to a socket as well as the usual output file. Whether this option is available is the choice of the installer." }, { "flag": "", "long": "--ipc-start", "arg": null, "description": "As --ipc, and starts the server at the other end as well. Whether this option is available is the choice of the installer. --kpathsea-debug bitmask Sets path searching debugging flags according to the bitmask. See the Kpathsea manual for details. --maketex fmt Enable mktexfmt, where fmt must be one of tex or tfm. --no-maketex fmt Disable mktexfmt, where fmt must be one of tex or tfm. --output-comment string Use string for the DVI file comment instead of the date. --output-directory directory Write output files in directory instead of the current directory. Look up input files in directory first, the along the normal search path." }, { "flag": "", "long": "--parse-first-line", "arg": null, "description": "If the first line of the main input file begins with %& parse it to look for a dump name. --progname name Pretend to be program name. This affects both the format used and the search paths." }, { "flag": "", "long": "--recorder", "arg": null, "description": "Enable the filename recorder. This leaves a trace of the files opened for input and output in a file with extension .ofl. (This option is always on.)" }, { "flag": "", "long": "--shell-escape", "arg": null, "description": "Enable the \\write18{command} construct. The command can be any Bourne shell command. By default, this construct is enabled in a restricted mode, for security reasons." }, { "flag": "", "long": "--version", "arg": null, "description": "Print version information and exit." } ], "examples": [], "see_also": [ { "name": "tex", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/tex/1/json" }, { "name": "mf", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/mf/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 13, "subsections": [] }, { "name": "OPTIONS", "lines": 2, "subsections": [ { "name": "-cnf-line", "lines": 6 }, { "name": "--halt-on-error", "lines": 15, "long": "--halt-on-error" }, { "name": "--ipc-start", "lines": 20, "long": "--ipc-start" }, { "name": "--parse-first-line", "lines": 6, "long": "--parse-first-line" }, { "name": "--recorder", "lines": 3, "long": "--recorder" }, { "name": "--shell-escape", "lines": 3, "long": "--shell-escape" }, { "name": "--version", "lines": 2, "long": "--version" } ] }, { "name": "ENVIRONMENT", "lines": 29, "subsections": [] }, { "name": "NOTES", "lines": 4, "subsections": [] }, { "name": "BUGS", "lines": 9, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "AUTHORS", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "aleph - extended Unicode TeX\n", "subsections": [] }, "SYNOPSIS": { "content": "aleph [options] [&format] [file|\\commands]\n", "subsections": [] }, "DESCRIPTION": { "content": "Run the Aleph typesetter on file, usually creating file.dvi. If the file argument has no ex‐\ntension, \".tex\" will be appended to it. Instead of a filename, a set of Aleph commands can\nbe given, the first of which must start with a backslash. With a &format argument Aleph uses\na different set of precompiled commands, contained in format.fmt; it is usually better to use\nthe -fmt format option instead.\n\nAleph is a version of the TeX program modified for multilingual typesetting. It uses Uni‐\ncode, and has additional primitives for (among other things) bidirectional typesetting.\n\nAleph's command line options are similar to those of TeX.\n\nAleph is no longer being actively developed; see LuaTeX for current activity.\n", "subsections": [] }, "OPTIONS": { "content": "Run aleph --help to see the complete list of options; this is not exhaustive.\n", "subsections": [ { "name": "-cnf-line", "content": "Parse string as a texmf.cnf configuration line. See the Kpathsea manual.\n\n--fmt format\nUse format as the name of the format to be used, instead of the name by which Aleph\nwas called or a %& line.\n" }, { "name": "--halt-on-error", "content": "Exit with an error code when an error is encountered during processing.\n\n--help Print help message and exit.\n\n--ini Be `initial' Aleph for dumping formats; this is implicitly true if the program is\ncalled as inialeph.\n\n--interaction mode\nSets the interaction mode. The mode can be one of batchmode, nonstopmode, scrollmode,\nand errorstopmode. The meaning of these modes is the same as that of the correspond‐\ning \\commands.\n\n--ipc Send DVI output to a socket as well as the usual output file. Whether this option is\navailable is the choice of the installer.\n", "long": "--halt-on-error" }, { "name": "--ipc-start", "content": "As --ipc, and starts the server at the other end as well. Whether this option is\navailable is the choice of the installer.\n\n--kpathsea-debug bitmask\nSets path searching debugging flags according to the bitmask. See the Kpathsea manual\nfor details.\n\n--maketex fmt\nEnable mktexfmt, where fmt must be one of tex or tfm.\n\n--no-maketex fmt\nDisable mktexfmt, where fmt must be one of tex or tfm.\n\n--output-comment string\nUse string for the DVI file comment instead of the date.\n\n--output-directory directory\nWrite output files in directory instead of the current directory. Look up input files\nin directory first, the along the normal search path.\n", "long": "--ipc-start" }, { "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\n--progname name\nPretend to be program name. This affects both the format used and the search paths.\n", "long": "--parse-first-line" }, { "name": "--recorder", "content": "Enable the filename recorder. This leaves a trace of the files opened for input and\noutput in a file with extension .ofl. (This option is always on.)\n", "long": "--recorder" }, { "name": "--shell-escape", "content": "Enable the \\write18{command} construct. The command can be any Bourne shell command.\nBy default, this construct is enabled in a restricted mode, for security reasons.\n", "long": "--shell-escape" }, { "name": "--version", "content": "Print version information and exit.\n", "long": "--version" } ] }, "ENVIRONMENT": { "content": "See the Kpathsearch library documentation (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 Aleph formats, you cannot use ~ in a filename you give directly to Aleph,\nbecause ~ is an active character, and hence is expanded, not taken as part of the filename.\nOther programs, such as Metafont, do not have this problem.\n\nTEXMFOUTPUT\nNormally, Aleph 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 tex paper and the current directory is not writable, if TEXMFOUTPUT has the\nvalue /tmp, Aleph attempts to create /tmp/paper.log (and /tmp/paper.dvi, if any output\nis produced.) TEXMFOUTPUT is also checked for input files, as TeX often generates\nfiles that need to be subsequently read; for input, no suffixes (such as ``.tex'') are\nadded by default, the input name is simply checked as given.\n\nTEXINPUTS\nSearch path for \\input and \\openin files. This should start with ``.'', so that user\nfiles are found before system files. An empty path component will be replaced with\nthe 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\nTEXEDIT\nCommand template for switching to editor. The default, usually vi, is set when Aleph\nis compiled.\n", "subsections": [] }, "NOTES": { "content": "This manual page is not meant to be exhaustive. The complete documentation for this version\nof Aleph can be found in the info manual Web2C: A TeX implementation. See\nhttp://tug/org/web2c.\n", "subsections": [] }, "BUGS": { "content": "This version of Aleph implements a number of optional extensions. In fact, many of these ex‐\ntensions conflict to a greater or lesser extent with the definition of Aleph. When such ex‐\ntensions are enabled, the banner printed when Aleph starts is changed to print Alephk instead\nof Aleph.\n\nThis version of Aleph fails to trap arithmetic overflow when dimensions are added or sub‐\ntracted. Cases where this occurs are rare, but when it does the generated DVI file will be\ninvalid.\n", "subsections": [] }, "SEE ALSO": { "content": "tex(1), mf(1)\n", "subsections": [] }, "AUTHORS": { "content": "The primary authors of Aleph are John Plaice and Yannis Haralambous.\n\n\n\nWeb2C 2022/dev 6 August 2019 ALEPH(1)", "subsections": [] } } } }