{ "content": [ { "type": "text", "text": "# html2textrc(5) (man)\n\n## NAME\n\nhtml2textrc - formatting properties file for html2text(1)\n\n## SYNOPSIS\n\nKey [ = | : ] Value\n\n## DESCRIPTION\n\nThe html2textrc(5) file defines a set of formatting properties used by the html2text(1) util‐\nity, that overrides the program's built-in formatting defaults. Each line of the html2tex‐‐\ntrc(5) file is either a formatting property or a comment.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION** (1 subsections)\n- **OPTIONS** (17 subsections)\n- **AUTHOR**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "html2textrc", "section": "5", "mode": "man", "summary": "html2textrc - formatting properties file for html2text(1)", "synopsis": "Key [ = | : ] Value", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [ { "name": "html2text", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/html2text/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 11, "subsections": [ { "name": "A property definition line consists of:", "lines": 16 } ] }, { "name": "OPTIONS", "lines": 5, "subsections": [ { "name": "DOCUMENT.{vspace.{before after} indent.{left right}} = 0", "lines": 3 }, { "name": "BODY.{vspace.{before after} indent.{left right}} = 0", "lines": 4 }, { "name": "{OL UL DIR MENU DL}.vspace.{before between after} = 0", "lines": 3 }, { "name": "{OL UL DIR MENU}.indents = 6", "lines": 19 }, { "name": "{DT DD}.{vspace.{before after} indent.{left right}} = 0", "lines": 4 }, { "name": "HR.marker = =", "lines": 2 }, { "name": "HR.{vspace.{before after} indent.{left right}} = 0", "lines": 11 }, { "name": "{H1 H2 H3 H4 H5 H6}.vspace.{before after} = 0", "lines": 2 }, { "name": "{PRE P}.{vspace.{before after} indent.{left right}} = 0", "lines": 3 }, { "name": "{BLOCKQUOTE ADDRESS}.{vspace.{before after} indent.{left right}} = {0 0 5 5}", "lines": 3 }, { "name": "TABLE.vspace.{before after} = 0", "lines": 2 }, { "name": "{H1 H2 H3 H4 H5 H6}.attributes = BOLD", "lines": 3 }, { "name": "{TT I BIG SMALL SUB SUP DFN CODE SAMP KBD CITE}.attributes = NONE", "lines": 3 }, { "name": "U.attributes = UNDERLINE", "lines": 2 }, { "name": "{B EM STRONG}.attributes = BOLD", "lines": 2 }, { "name": "STRIKE.attributes = STRIKETHROUGH", "lines": 12 }, { "name": "IMG.alt.{prefix suffix} = {[ ]}", "lines": 3 } ] }, { "name": "AUTHOR", "lines": 4, "subsections": [] }, { "name": "SEE ALSO", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "html2textrc - formatting properties file for html2text(1)\n", "subsections": [] }, "SYNOPSIS": { "content": "Key [ = | : ] Value\n", "subsections": [] }, "DESCRIPTION": { "content": "The html2textrc(5) file defines a set of formatting properties used by the html2text(1) util‐\nity, that overrides the program's built-in formatting defaults. Each line of the html2tex‐‐\ntrc(5) file is either a formatting property or a comment.\n\nLines with a leading \"#\" or \"!\" (i.e. the first non-space character is a \"#\" or a \"!\") and\nblank lines (i.e. a line consisting only of white-space characters), are considered comments\nand ignored. Everything else is literary interpreted by the parser as a formatting property,\nwhere a string-type property value may also be empty (unsets default value). Both, the prop‐\nerty key and the property value, may contain C-style escape sequences to mask meta charac‐\nters.\n", "subsections": [ { "name": "A property definition line consists of:", "content": "(1) Optional leading space,\n\n(2) the property key (a sequence of non-space characters except \"=\" and \":\") as described\nbelow,\n\n(3) an optional space,\n\n(4) an optional \"=\" or \":\",\n\n(5) optional space,\n\n(6) the property value as described below.\nEverything up to the next newline is interpreted literary as the value of the speci‐\nfied element. Literary meant leading white-space must be quoted with backslashes (i.e.\n\"\\ \"). Be aware not to include unwanted trailing white-space characters.\n" } ] }, "OPTIONS": { "content": "The following is the list of valid formatting properties, together with their default values.\nIf the -style command line option of html2text(1) is used, different default values apply.\n\nCurly braces indicate alternatives, e.g. {A B}C stands for AC or BC.\n", "subsections": [ { "name": "DOCUMENT.{vspace.{before after} indent.{left right}} = 0", "content": "Specifies how many blank lines are inserted before and after, and how many blank col‐\numns are inserted to the left and to the right of the formatted document. (Numeric.)\n" }, { "name": "BODY.{vspace.{before after} indent.{left right}} = 0", "content": "Same for the document body. (Since the document body is currently the only document\npart that is rendered, it is virtually the same whether you specify DOCUMENT or BODY).\n(Numeric.)\n" }, { "name": "{OL UL DIR MENU DL}.vspace.{before between after} = 0", "content": "Specifies how many blank lines are inserted before a list, between the individual list\nitems, and after the list. (Numeric.)\n" }, { "name": "{OL UL DIR MENU}.indents = 6", "content": "Specifies by how deep list items are indented. If an item bullet would not fit into\nthe space created by the indentation, then the indentation is automatically increased\nsuch that the bullet fits in (relevant for relatively wide bullets, e.g. roman num‐\nbers). If N blank-separated integers are specified instead of one, then the first\nN-1 integers specify indentation for the first N-1 list nesting levels, while the last\ninteger specifies the indentation for nesting levels N and higher. (Numeric.)\n\n{UL DIR}.defaulttypes = DISC CIRCLE SQUARE\nSpecifies the default list type (i.e. the bullet style), if the HTML list tag does not\nspecify an explicit type. Legal values are NOBULLET, DISC, SQUARE, CIRCLE, CUSTOM1,\nCUSTOM2 and CUSTOM3. If more than one value is specified, then the values apply for\nthe respective list nesting levels (see indents). (Option.)\n\nMENU.defaulttypes = NOBULLET\nSame for , but here the default is NOBULLET. (Option.)\n\nLI.{disc square circle custom1 custom2 custom3}bullet = {* # o + - ~}\nSpecifies the strings used as list item bullets. (String.)\n" }, { "name": "{DT DD}.{vspace.{before after} indent.{left right}} = 0", "content": "Specifies how many blank lines are inserted before and after, and how many blank col‐\numns are inserted to the left and to the right of each
or
element. (Nu‐\nmeric.)\n" }, { "name": "HR.marker = =", "content": "Specifies the character to use for horizontal rules. (String.)\n" }, { "name": "HR.{vspace.{before after} indent.{left right}} = 0", "content": "Specifies how many blank lines are inserted before and after, and how many blank col‐\numns are inserted to the left and to the right of the horizontal rule. (Numeric.)\n\n{H1 H2 H3 H4 H5 H6}.prefix = { * * *}\nSpecifies how headings are decorated with a prefix. (The default values have a trail‐\ning blank, e.g. \" \".) (String.)\n\n{H1 H2 H3 H4 H5 H6}.suffix = { * * *}\nSpecifies how headings are decorated with a suffix. (The default values have a leading\nblank, e.g. \"\\ \".) (String.)\n" }, { "name": "{H1 H2 H3 H4 H5 H6}.vspace.{before after} = 0", "content": "Specifies how many blank lines are inserted before and after headings. (Numeric.)\n" }, { "name": "{PRE P}.{vspace.{before after} indent.{left right}} = 0", "content": "Specifies how many blank lines are inserted before and after, and how many blank col‐\numns are inserted to the left and to the right of these items. (Numeric.)\n" }, { "name": "{BLOCKQUOTE ADDRESS}.{vspace.{before after} indent.{left right}} = {0 0 5 5}", "content": "Specifies how many blank lines are inserted before and after, and how many blank col‐\numns are inserted to the left and to the right of these items. (Numeric.)\n" }, { "name": "TABLE.vspace.{before after} = 0", "content": "Specifies how many blank lines are inserted before and after tables. (Numeric.)\n" }, { "name": "{H1 H2 H3 H4 H5 H6}.attributes = BOLD", "content": "Specifies the cell attributes for headings. The value is a sequence of NONE, BOLD, UN‐‐\nDERLINE and STRIKETHROUGH. (Option.)\n" }, { "name": "{TT I BIG SMALL SUB SUP DFN CODE SAMP KBD CITE}.attributes = NONE", "content": "Specifies the cell attributes for these text items. Legal values are: NONE, BOLD, UN‐‐\nDERLINE or STRIKETHROUGH. (Option.)\n" }, { "name": "U.attributes = UNDERLINE", "content": "Same for elements, but with a different default value. (Option.)\n" }, { "name": "{B EM STRONG}.attributes = BOLD", "content": "Same for these elements, but with a different default value. (Option.)\n" }, { "name": "STRIKE.attributes = STRIKETHROUGH", "content": "Same for elements, but with a different default value. (Option.)\n\nA.attributes.{internallink externallink} = UNDERLINE\nSpecifies the cell attributes for links. A link is an element that has an \"HREF\"\nattribute. An internal link is a link whose \"HREF\" attribute starts with a hash char‐\nacter (e.g. \"\"). Legal values are again NONE, BOLD, UNDERLINE and\nSTRIKETHROUGH. (Option.)\n\nIMG.replace.{all noalt} = unset\nSpecifies the string used to replace all elements, or those without an \"ALT\" at‐\ntribute set. (String.)\n" }, { "name": "IMG.alt.{prefix suffix} = {[ ]}", "content": "Specifies how the values (if any) of IMG elements' \"ALT\" attributes are marked.\n(String.)\n" } ] }, "AUTHOR": { "content": "Current maintainer and primary download location for html2text is:\nMartin Bayer \nhttp://userpage.fu-berlin.de/~mbayer/tools/ ⟨⟩\n", "subsections": [] }, "SEE ALSO": { "content": "html2text(1)\n\n\n\n2001-06-11 html2textrc(5)", "subsections": [] } } } }