{ "content": [ { "type": "text", "text": "# Pod::Text::Overstrike (perldoc)\n\n**Summary:** Pod::Text::Overstrike - Convert POD data to formatted overstrike text\n\n**Synopsis:** use Pod::Text::Overstrike;\nmy $parser = Pod::Text::Overstrike->new (sentence => 0, width => 78);\n# Read POD from STDIN and write to STDOUT.\n$parser->parsefromfilehandle;\n# Read POD from file.pod and write to file.txt.\n$parser->parsefromfile ('file.pod', 'file.txt');\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (9 lines)\n- **DESCRIPTION** (12 lines)\n- **BUGS** (3 lines)\n- **AUTHOR** (3 lines)\n- **COPYRIGHT AND LICENSE** (7 lines)\n- **SEE ALSO** (6 lines)\n\n## Full Content\n\n### NAME\n\nPod::Text::Overstrike - Convert POD data to formatted overstrike text\n\n### SYNOPSIS\n\nuse Pod::Text::Overstrike;\nmy $parser = Pod::Text::Overstrike->new (sentence => 0, width => 78);\n\n# Read POD from STDIN and write to STDOUT.\n$parser->parsefromfilehandle;\n\n# Read POD from file.pod and write to file.txt.\n$parser->parsefromfile ('file.pod', 'file.txt');\n\n### DESCRIPTION\n\nPod::Text::Overstrike is a simple subclass of Pod::Text that highlights output text using\noverstrike sequences, in a manner similar to nroff. Characters in bold text are overstruck\n(character, backspace, character) and characters in underlined text are converted to overstruck\nunderscores (underscore, backspace, character). This format was originally designed for\nhard-copy terminals and/or line printers, yet is readable on soft-copy (CRT) terminals.\n\nOverstruck text is best viewed by page-at-a-time programs that take advantage of the terminal's\nstand-out and *underline* capabilities, such as the less program on Unix.\n\nApart from the overstrike, it in all ways functions like Pod::Text. See Pod::Text for details\nand available options.\n\n### BUGS\n\nCurrently, the outermost formatting instruction wins, so for example underlined text inside a\nregion of bold text is displayed as simply bold. There may be some better approach possible.\n\n### AUTHOR\n\nOriginally written by Joe Smith , using the framework created by Russ\nAllbery . Subsequently updated by Russ Allbery.\n\n### COPYRIGHT AND LICENSE\n\nCopyright 2000 by Joe Smith \n\nCopyright 2001, 2004, 2008, 2014, 2018-2019 by Russ Allbery \n\nThis program is free software; you may redistribute it and/or modify it under the same terms as\nPerl itself.\n\n### SEE ALSO\n\nPod::Text, Pod::Simple\n\nThe current version of this module is always available from its web site at\n. It is also part of the Perl core\ndistribution as of 5.6.0.\n\n" } ], "structuredContent": { "command": "Pod::Text::Overstrike", "section": "", "mode": "perldoc", "summary": "Pod::Text::Overstrike - Convert POD data to formatted overstrike text", "synopsis": "use Pod::Text::Overstrike;\nmy $parser = Pod::Text::Overstrike->new (sentence => 0, width => 78);\n# Read POD from STDIN and write to STDOUT.\n$parser->parsefromfilehandle;\n# Read POD from file.pod and write to file.txt.\n$parser->parsefromfile ('file.pod', 'file.txt');", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 9, "subsections": [] }, { "name": "DESCRIPTION", "lines": 12, "subsections": [] }, { "name": "BUGS", "lines": 3, "subsections": [] }, { "name": "AUTHOR", "lines": 3, "subsections": [] }, { "name": "COPYRIGHT AND LICENSE", "lines": 7, "subsections": [] }, { "name": "SEE ALSO", "lines": 6, "subsections": [] } ], "sections": { "NAME": { "content": "Pod::Text::Overstrike - Convert POD data to formatted overstrike text\n", "subsections": [] }, "SYNOPSIS": { "content": "use Pod::Text::Overstrike;\nmy $parser = Pod::Text::Overstrike->new (sentence => 0, width => 78);\n\n# Read POD from STDIN and write to STDOUT.\n$parser->parsefromfilehandle;\n\n# Read POD from file.pod and write to file.txt.\n$parser->parsefromfile ('file.pod', 'file.txt');\n", "subsections": [] }, "DESCRIPTION": { "content": "Pod::Text::Overstrike is a simple subclass of Pod::Text that highlights output text using\noverstrike sequences, in a manner similar to nroff. Characters in bold text are overstruck\n(character, backspace, character) and characters in underlined text are converted to overstruck\nunderscores (underscore, backspace, character). This format was originally designed for\nhard-copy terminals and/or line printers, yet is readable on soft-copy (CRT) terminals.\n\nOverstruck text is best viewed by page-at-a-time programs that take advantage of the terminal's\nstand-out and *underline* capabilities, such as the less program on Unix.\n\nApart from the overstrike, it in all ways functions like Pod::Text. See Pod::Text for details\nand available options.\n", "subsections": [] }, "BUGS": { "content": "Currently, the outermost formatting instruction wins, so for example underlined text inside a\nregion of bold text is displayed as simply bold. There may be some better approach possible.\n", "subsections": [] }, "AUTHOR": { "content": "Originally written by Joe Smith , using the framework created by Russ\nAllbery . Subsequently updated by Russ Allbery.\n", "subsections": [] }, "COPYRIGHT AND LICENSE": { "content": "Copyright 2000 by Joe Smith \n\nCopyright 2001, 2004, 2008, 2014, 2018-2019 by Russ Allbery \n\nThis program is free software; you may redistribute it and/or modify it under the same terms as\nPerl itself.\n", "subsections": [] }, "SEE ALSO": { "content": "Pod::Text, Pod::Simple\n\nThe current version of this module is always available from its web site at\n. It is also part of the Perl core\ndistribution as of 5.6.0.\n", "subsections": [] } } } }