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

Revision: 9572
          http://sourceforge.net/p/docutils/code/9572
Author:   grubert
Date:     2024-03-16 15:59:22 +0000 (Sat, 16 Mar 2024)
Log Message:
-----------
Add rST sample to manpage.txt

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

Modified: trunk/docutils/docs/user/manpage.txt
===================================================================
--- trunk/docutils/docs/user/manpage.txt	2024-03-15 15:46:07 UTC (rev 9571)
+++ trunk/docutils/docs/user/manpage.txt	2024-03-16 15:59:22 UTC (rev 9572)
@@ -43,8 +43,10 @@
    SYNOPSIS
        man [-c|-w|-tZT device] [-adhu7V] [-m system[,...]] [-L locale]
 
-in roff formatting::
+in roff formatting
 
+.. code:: man
+
      .TH man 1 "14 May 2001" "2.3.19" "Manual pager utils"
      .SH NAME
      man \- an interface to the on-line reference manuals
@@ -54,6 +56,26 @@
      .RB [\| \-c \||\| \-w \||\| \-tZT
      .IR device \|]
 
+Then the rST input should be 
+
+.. code:: rst
+
+  =====
+   man
+  =====
+
+  ---------------------------------------------
+  an interface to the on-line reference manuals
+  ---------------------------------------------
+
+  :Manual section: 1
+  :Manual group: Man Pager Utils
+
+  SYNOPSIS
+  ========
+
+  ``man`` ``[-c|-w|-tZT device] [-adhu7V] [-m system[,...]] [-L locale]``
+
 This means we have
 
 * a title "man"
@@ -64,6 +86,7 @@
 * 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.
 
@@ -79,8 +102,8 @@
 References
 ''''''''''
 
-man pages from section 7, ``man`` and ``man-pages`` and ``groff_man`` and
-``groff_man_style``.
+man pages from section 7: *man* , *man-pages*, *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.