Index of /sandbox/manpage-writer

[ICO]NameLast modifiedSizeDescription

[PARENTDIR]Parent Directory   -  
[TXT]COPYRIGHT.txt 2023-07-07 10:40 316  
[TXT]TODO.html 2024-08-14 19:11 12K 
[TXT]TODO.rst 2024-08-14 19:11 10K 
[TXT]URUE-problem.txt 2024-03-26 23:15 3.1K 
[TXT]check 2021-09-23 18:00 837  
[DIR]expected-mandoc/ 2024-08-11 11:07 -  
[DIR]expected/ 2024-08-02 00:19 -  
[DIR]input/ 2024-08-02 00:19 -  
[   ]lexgrog-test.sh 2020-06-15 09:57 394  
[TXT]multiple_definition_..>2024-06-12 15:12 4.5K 
[TXT]ref-breakpoints.py 2024-08-02 00:19 3.2K 
[TXT]rst2man.txt 2018-06-17 08:52 2.1K 
[TXT]runtest 2024-08-14 10:21 2.5K 
[TXT]runtest-man 2024-03-26 23:15 1.7K 
[TXT]runtest-mandoc 2024-08-14 10:21 2.8K 
[TXT]using-list.txt 2023-09-26 19:17 1.0K 

Manpage test area

Manpage test area

Additionally to standard testing, here we try to include tests that process the generated man pages and verify the output.

The tests either require man or roff/nroff/... to verify the produced layout.

From the groff-manual at gnu.org

5.1.6 Input Conventions

Since gtroff does filling automatically, it is traditional in groff not to try and type things in as nicely formatted paragraphs.

: this conflicts with reST because a reST-document is nicely formatted WYSIWYH.

These are some conventions commonly used when typing gtroff text:

5.1.3 Sentences

Although it is often debated, some typesetting rules say there should be different amounts of space after various punctuation marks. For example, the Chicago typesetting manual says that a period at the end of a sentence should have twice as much space following it as would a comma or a period as part of an abbreviation.

gtroff does this by flagging certain characters (normally ‘!’, ‘?’, and ‘.’) as end-of-sentence characters. When gtroff encounters one of these characters at the end of a line, it appends a normal space followed by a sentence space in the formatted output. (This justifies one of the conventions mentioned in Input Conventions.)

In addition, the following characters and symbols are treated transparently while handling end-of-sentence characters: ‘"’, ‘'’, ‘)’, ‘]’, ‘*’, [dg], [rq], and [cq].

See the cflags request in Using Symbols, for more details.

To prevent the insertion of extra space after an end-of-sentence character (at the end of a line), append &.