SF.net SVN: docutils:[9569 ] trunk/docutils/docs/user/ manpage.txt

Revision: 9569
          http://sourceforge.net/p/docutils/code/9569
Author:   grubert
Date:     2024-03-15 14:59:59 +0000 (Fri, 15 Mar 2024)
Log Message:
-----------
remind of troff line break rules in manpage user documentation

Modified Paths:
--------------
    trunk/docutils/docs/user/manpage.txt

Modified: trunk/docutils/docs/user/manpage.txt
===================================================================
--- trunk/docutils/docs/user/manpage.txt	2024-03-15 14:48:35 UTC (rev 9568)
+++ trunk/docutils/docs/user/manpage.txt	2024-03-15 14:59:59 UTC (rev 9569)
@@ -12,8 +12,11 @@
 
 This writer explores the possibilities to generate man-pages from
 reStructuredText. Man pages are the way for Unix systems to provide
-help to the user. GNU does this with (TeX)info-pages.
+help to the user. GNU does this with (TeX)info-pages. 
 
+BSD uses mandoc. But mandoc supports a subset of man syntax and the
+manpage-writer tries to support this too.
+
 .. contents::
 
 
@@ -60,10 +63,24 @@
 * a date "14 May 2001"
 * a version "2.3.19"
 
+
+One should try to comply with the `troff line break rules`__ after punctuation
+signs in the rST source.  Use a new line or two spaces to start a new sentence.
+
+Avoid linebreaks after punctuation signs that do not end a sentence.
+A linebreak can be escaped with a backslash.  In rST, escaped whitespace
+is removed, so precede the backslash by a space::
+
+  We recommend the works of E. T. A. \
+  Hoffman.
+
+__ https://www.gnu.org/software/groff/manual/groff.html#Sentences
+
 References
 ''''''''''
 
-man pages from section 7, ``man`` and ``man-pages`` and ``groff_man``.
+man pages from section 7, ``man`` and ``man-pages`` and ``groff_man`` and
+``groff_man_style``.
 
 .. [LMHT] `Linux Man Page Howto <https://tldp.org/HOWTO/Man-Page/>`__.
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.