mirror of https://github.com/mkerrisk/man-pages
man-pages.7: Paragraphs should not be separated by blank lines
Reported-by: Paul Wise <pabs3@bonedaddy.net> Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
parent
344bbbd16a
commit
724ca69c82
|
@ -528,6 +528,15 @@ The preferred way to write this in the source file is:
|
||||||
makes it easier to write tools that parse man page source files.)
|
makes it easier to write tools that parse man page source files.)
|
||||||
.\"
|
.\"
|
||||||
.SS Formatting conventions (general)
|
.SS Formatting conventions (general)
|
||||||
|
Paragraphs should be separated by suitable markers (usually either
|
||||||
|
.I .PP
|
||||||
|
or
|
||||||
|
.IR .IP ).
|
||||||
|
Do
|
||||||
|
.I not
|
||||||
|
separate paragraphs using blank lines, as this results in poor rendering
|
||||||
|
in some output formats (such as PostScript and PDF).
|
||||||
|
.PP
|
||||||
Filenames (whether pathnames, or references to header files)
|
Filenames (whether pathnames, or references to header files)
|
||||||
are always in italics (e.g.,
|
are always in italics (e.g.,
|
||||||
.IR <stdio.h> ),
|
.IR <stdio.h> ),
|
||||||
|
|
Loading…
Reference in New Issue