{ "content": [ { "type": "text", "text": "# post-grohtml (man)\n\n## DESCRIPTION\n\nThe GNU roff system's HTML support consists of a preprocessor, pre-grohtml, and an output\ndriver, post-grohtml; together, they translate \u001b]8;;man:roff(7)\u001b\\roff(7)\u001b]8;;\u001b\\ documents to HTML. Because a pre‐\nprocessor is (uniquely) required for this output driver, users should invoke grohtml via the\n\u001b]8;;man:groff(1)\u001b\\groff(1)\u001b]8;;\u001b\\ command with the -Thtml or -Txhtml options. (In this installation, ps is the de‐\nfault output device.) Use groff's -P option to pass any options shown above to grohtml. If\nno operands are given, or if file is “-”, grohtml reads the standard input stream. Output is\nwritten to the standard output stream.\n\n## Sections\n\n- **Name**\n- **Synopsis** (6 subsections)\n- **Description** (3 subsections)\n- **Options** (22 subsections)\n- **Environment**\n- **Files**\n- **Bugs**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "post-grohtml", "section": "", "mode": "man", "summary": null, "synopsis": null, "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-a", "long": null, "arg": null, "description": "Number of bits of antialiasing information to be used by text when generating PNG im‐ ages. The default is 4 but 0, 1, and 2 are also valid. Your system's version of gs must support the -dTextAlphaBits option in order to exploit antialiasing. A value of 0 stops grohtml from issuing antialiasing commands to gs." }, { "flag": "-b", "long": null, "arg": null, "description": "" }, { "flag": "-C", "long": null, "arg": null, "description": "" }, { "flag": "-D", "long": null, "arg": null, "description": "Instruct grohtml to place all image files into directory image-directory." }, { "flag": "-e", "long": null, "arg": null, "description": "This option should not be manually specified; it is synthesized by groff depending on whether it was given the -Thtml or -Txhtml option." }, { "flag": "-F", "long": null, "arg": null, "description": "Prepend directory font-directory/devname to the search path for font and device de‐ scription files; name is the name of the device, usually html." }, { "flag": "-g", "long": null, "arg": null, "description": "Number of bits of antialiasing information to be used by graphics when generating PNG images. The default is 4 but 0, 1, and 2 are also valid. Your system's version of gs must support the -dGraphicAlphaBits option in order to exploit antialiasing. A value of 0 stops grohtml from issuing antialiasing commands to gs." }, { "flag": "-G", "long": null, "arg": null, "description": "" }, { "flag": "-h", "long": null, "arg": null, "description": "rather than HTML H elements." }, { "flag": "-i", "long": null, "arg": null, "description": "Set the image resolution in pixels per inch; the default is 100." }, { "flag": "-I", "long": null, "arg": null, "description": "Determine the image file name stem. If omitted, grohtml uses grohtml-XXXXX (where XXXXX is the process ID). A dash is appended to the stem to separate it from the fol‐ lowing image number." }, { "flag": "-j", "long": null, "arg": null, "description": "Instruct grohtml to split the HTML output into multiple files. Output is written to a new file at each section heading (but see option -S below) named output-stem-n.html." }, { "flag": "-l", "long": null, "arg": null, "description": "" }, { "flag": "-n", "long": null, "arg": null, "description": "the option the anchor value is the textual heading. This can cause problems when a heading contains a “?” on older versions of some browsers. This feature is automati‐ cally enabled if a heading contains an image." }, { "flag": "-o", "long": null, "arg": null, "description": "Specify the vertical offset of images in points." }, { "flag": "-p", "long": null, "arg": null, "description": "number only when an image is required." }, { "flag": "-r", "long": null, "arg": null, "description": "" }, { "flag": "-s", "long": null, "arg": null, "description": "Set the document's base type size in points. When this size is used in the source, it corresponds to the HTML base type size. Every increase of two points in the source will produce a “big” element, and conversely when a decrease of two points is seen, a “small” element is emitted." }, { "flag": "-S", "long": null, "arg": null, "description": "When splitting HTML output (see option -j above), split at each nested heading level defined by heading-level, or higher). The default is 1." }, { "flag": "-V", "long": null, "arg": null, "description": "" }, { "flag": "-x", "long": null, "arg": null, "description": "Select HTML dialect. Currently, html-dialect should be either the digit 4 or the let‐ ter x, which indicates whether grohtml should generate HTML 4 or XHTML, respectively. This option should not be manually specified; it is synthesized by groff depending on whether it was given the -Thtml or -Txhtml option." }, { "flag": "-V", "long": null, "arg": null, "description": "specified)." } ], "examples": [], "see_also": [], "section_outline": [ { "name": "Name", "lines": 2, "subsections": [] }, { "name": "Synopsis", "lines": 4, "subsections": [ { "name": "pre-grohtml --help", "lines": 1 }, { "name": "pre-grohtml -v", "lines": 1 }, { "name": "pre-grohtml --version", "lines": 3 }, { "name": "post-grohtml --help", "lines": 1 }, { "name": "post-grohtml -v", "lines": 1 }, { "name": "post-grohtml --version", "lines": 1 } ] }, { "name": "Description", "lines": 17, "subsections": [ { "name": "Typefaces", "lines": 15 }, { "name": "Font description files", "lines": 3 }, { "name": "Dependencies", "lines": 5 } ] }, { "name": "Options", "lines": 3, "subsections": [ { "name": "-a _", "lines": 5, "flag": "-a" }, { "name": "-b", "lines": 1, "flag": "-b" }, { "name": "-C", "lines": 1, "flag": "-C" }, { "name": "-D _", "lines": 2, "flag": "-D" }, { "name": "-e", "lines": 3, "flag": "-e" }, { "name": "-F _", "lines": 3, "flag": "-F" }, { "name": "-g _", "lines": 5, "flag": "-g" }, { "name": "-G", "lines": 1, "flag": "-G" }, { "name": "-h", "lines": 2, "flag": "-h" }, { "name": "-i _", "lines": 2, "flag": "-i" }, { "name": "-I _", "lines": 4, "flag": "-I" }, { "name": "-j _", "lines": 3, "flag": "-j" }, { "name": "-l", "lines": 1, "flag": "-l" }, { "name": "-n", "lines": 4, "flag": "-n" }, { "name": "-o _", "lines": 2, "flag": "-o" }, { "name": "-p", "lines": 2, "flag": "-p" }, { "name": "-r", "lines": 1, "flag": "-r" }, { "name": "-s _", "lines": 5, "flag": "-s" }, { "name": "-S _", "lines": 3, "flag": "-S" }, { "name": "-V", "lines": 1, "flag": "-V" }, { "name": "-x _", "lines": 6, "flag": "-x" }, { "name": "-y -V", "lines": 2, "flag": "-V" } ] }, { "name": "Environment", "lines": 13, "subsections": [] }, { "name": "Files", "lines": 17, "subsections": [] }, { "name": "Bugs", "lines": 10, "subsections": [] } ], "sections": { "Name": { "content": "grohtml, post-grohtml, pre-grohtml - groff output driver for HTML\n", "subsections": [] }, "Synopsis": { "content": "pre-grohtml [-epV] [-a anti-aliasing-text-bits] [-D image-directory] [-F font-directory] [-g\nanti-aliasing-graphic-bits] [-i resolution] [-I image-stem] [-o image-vertical-\noffset] [-x html-dialect] troff-command troff-argument ...\n", "subsections": [ { "name": "pre-grohtml --help", "content": "" }, { "name": "pre-grohtml -v", "content": "" }, { "name": "pre-grohtml --version", "content": "post-grohtml [-bCGhlnrVy] [-F font-directory] [-j output-stem] [-s base-point-size] [-S\nheading-level] [-x html-dialect] [file ...]\n" }, { "name": "post-grohtml --help", "content": "" }, { "name": "post-grohtml -v", "content": "" }, { "name": "post-grohtml --version", "content": "" } ] }, "Description": { "content": "The GNU roff system's HTML support consists of a preprocessor, pre-grohtml, and an output\ndriver, post-grohtml; together, they translate \u001b]8;;man:roff(7)\u001b\\roff(7)\u001b]8;;\u001b\\ documents to HTML. Because a pre‐\nprocessor is (uniquely) required for this output driver, users should invoke grohtml via the\n\u001b]8;;man:groff(1)\u001b\\groff(1)\u001b]8;;\u001b\\ command with the -Thtml or -Txhtml options. (In this installation, ps is the de‐\nfault output device.) Use groff's -P option to pass any options shown above to grohtml. If\nno operands are given, or if file is “-”, grohtml reads the standard input stream. Output is\nwritten to the standard output stream.\n\ngrohtml invokes groff twice. In the first pass, the preprocessor pre-grohtml renders pic‐\ntures, equations, and tables as images in PostScript format using the ps output device. In\nthe second pass, the output driver post-grohtml translates the output of \u001b]8;;man:troff(1)\u001b\\troff(1)\u001b]8;;\u001b\\ to HTML.\n\ngrohtml writes output encoded in UTF-8 and has built-in HTML entities for all non-composite\nUnicode characters. In spite of this, groff may issue warnings about unknown special charac‐\nters if they can't be found during the first pass. Such warnings can be safely ignored un‐\nless the special characters appear inside a table or equation.\n", "subsections": [ { "name": "Typefaces", "content": "grohtml supports the standard four styles: R (roman), I (italic), B (bold), and BI (\u001b[4mbold-\nitalic). Fonts are grouped into families T and C having members in each style.\n\nTR Times roman\nTI Times italic\nTB Times bold\nTBI Times bold-italic\nCR Courier roman\nCI Courier italic\nCB Courier bold\nCBI Courier bold-italic\n\nA special font, S, is also provided to accommodate roff documents that expect it to always be\navailable.\n" }, { "name": "Font description files", "content": "The font description files used with grohtml expose the same glyph repertoire in their\ncharset sections. See \u001b]8;;man:grofffont(5)\u001b\\grofffont(5)\u001b]8;;\u001b\\.\n" }, { "name": "Dependencies", "content": "pre-grohtml generates an image whenever an eqn equation, tbl table, or pic picture is encoun‐\ntered in the input. grohtml therefore may run several commands as part of its operation.\nThese include the Netpbm tools pnmcrop, pnmcut, and pnmtopng; Ghostscript (gs); and the\nPSUtils tool psselect.\n" } ] }, "Options": { "content": "--help displays a usage message, while -v and --version show version information; all exit\nafterward.\n", "subsections": [ { "name": "-a _", "content": "Number of bits of antialiasing information to be used by text when generating PNG im‐\nages. The default is 4 but 0, 1, and 2 are also valid. Your system's version of gs\nmust support the -dTextAlphaBits option in order to exploit antialiasing. A value\nof 0 stops grohtml from issuing antialiasing commands to gs.\n", "flag": "-a" }, { "name": "-b", "content": "", "flag": "-b" }, { "name": "-C", "content": "", "flag": "-C" }, { "name": "-D _", "content": "Instruct grohtml to place all image files into directory image-directory.\n", "flag": "-D" }, { "name": "-e", "content": "This option should not be manually specified; it is synthesized by groff depending on\nwhether it was given the -Thtml or -Txhtml option.\n", "flag": "-e" }, { "name": "-F _", "content": "Prepend directory font-directory/devname to the search path for font and device de‐\nscription files; name is the name of the device, usually html.\n", "flag": "-F" }, { "name": "-g _", "content": "Number of bits of antialiasing information to be used by graphics when generating PNG\nimages. The default is 4 but 0, 1, and 2 are also valid. Your system's version of gs\nmust support the -dGraphicAlphaBits option in order to exploit antialiasing. A value\nof 0 stops grohtml from issuing antialiasing commands to gs.\n", "flag": "-g" }, { "name": "-G", "content": "", "flag": "-G" }, { "name": "-h", "content": "rather than HTML H elements.\n", "flag": "-h" }, { "name": "-i _", "content": "Set the image resolution in pixels per inch; the default is 100.\n", "flag": "-i" }, { "name": "-I _", "content": "Determine the image file name stem. If omitted, grohtml uses grohtml-XXXXX (where\nXXXXX is the process ID). A dash is appended to the stem to separate it from the fol‐\nlowing image number.\n", "flag": "-I" }, { "name": "-j _", "content": "Instruct grohtml to split the HTML output into multiple files. Output is written to a\nnew file at each section heading (but see option -S below) named output-stem-n.html.\n", "flag": "-j" }, { "name": "-l", "content": "", "flag": "-l" }, { "name": "-n", "content": "the option the anchor value is the textual heading. This can cause problems when a\nheading contains a “?” on older versions of some browsers. This feature is automati‐\ncally enabled if a heading contains an image.\n", "flag": "-n" }, { "name": "-o _", "content": "Specify the vertical offset of images in points.\n", "flag": "-o" }, { "name": "-p", "content": "number only when an image is required.\n", "flag": "-p" }, { "name": "-r", "content": "", "flag": "-r" }, { "name": "-s _", "content": "Set the document's base type size in points. When this size is used in the source, it\ncorresponds to the HTML base type size. Every increase of two points in the source\nwill produce a “big” element, and conversely when a decrease of two points is seen, a\n“small” element is emitted.\n", "flag": "-s" }, { "name": "-S _", "content": "When splitting HTML output (see option -j above), split at each nested heading level\ndefined by heading-level, or higher). The default is 1.\n", "flag": "-S" }, { "name": "-V", "content": "", "flag": "-V" }, { "name": "-x _", "content": "Select HTML dialect. Currently, html-dialect should be either the digit 4 or the let‐\nter x, which indicates whether grohtml should generate HTML 4 or XHTML, respectively.\n\nThis option should not be manually specified; it is synthesized by groff depending on\nwhether it was given the -Thtml or -Txhtml option.\n", "flag": "-x" }, { "name": "-y -V", "content": "specified).\n", "flag": "-V" } ] }, "Environment": { "content": "GROFFFONTPATH\nlists directories in which to search for devhtml, grohtml's directory of device and\nfont description files. See \u001b]8;;man:troff(1)\u001b\\troff(1)\u001b]8;;\u001b\\ and \u001b]8;;man:grofffont(5)\u001b\\grofffont(5)\u001b]8;;\u001b\\.\n\nSOURCEDATEEPOCH\nA timestamp (expressed as seconds since the Unix epoch) to use as the output creation\ntimestamp in place of the current time. The time is converted to human-readable form\nusing \u001b]8;;man:gmtime(3)\u001b\\gmtime(3)\u001b]8;;\u001b\\ and \u001b]8;;man:asctime(3)\u001b\\asctime(3)\u001b]8;;\u001b\\, and recorded in an HTML comment.\n\nTZ The time zone to use when converting the current time to human-readable form; see\n\u001b]8;;man:tzset(3)\u001b\\tzset(3)\u001b]8;;\u001b\\. If SOURCEDATEEPOCH is used, it is always converted to human-readable form\nusing UTC.\n", "subsections": [] }, "Files": { "content": "/usr/share/groff/1.23.0/font/devhtml/DESC\ndescribes the html output device.\n\n/usr/share/groff/1.23.0/font/devhtml/F\ndescribes the font known as F on device html.\n\n/usr/share/groff/1.23.0/tmac/html.tmac\ndefines font mappings, special characters, and colors for use with the html output de‐\nvice. It is automatically loaded by troffrc when either of the html or xhtml output\ndevices is selected.\n\n/usr/share/groff/1.23.0/tmac/html-end.tmac\nfinalizes setup of the html output device. It is automatically loaded by troffrc-end\nwhen either of the html or xhtml output devices is selected.\n\ngrohtml uses temporary files. See \u001b]8;;man:groff(1)\u001b\\groff(1)\u001b]8;;\u001b\\ for details about where such files are created.\n", "subsections": [] }, "Bugs": { "content": "grohtml is still beta code.\n\ngrohtml does not truly support hyphenation, but you can fool it into hyphenating long input\nlines, which can appear in HTML output with a hyphenated word followed by a space but no line\nbreak.\n\nSee also\n\u001b]8;;man:groff(1)\u001b\\groff(1)\u001b]8;;\u001b\\, \u001b]8;;man:troff(1)\u001b\\troff(1)\u001b]8;;\u001b\\, \u001b]8;;man:grofffont(5)\u001b\\grofffont(5)\u001b]8;;\u001b\\\n\ngroff 1.23.0 31 March 2024 grohtml(1)", "subsections": [] } } } }