aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/man.7
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2018-08-18 02:08:27 +0000
committerIngo Schwarze <schwarze@openbsd.org>2018-08-18 02:08:27 +0000
commit0528debcf5b631def54405f2a163df53d1a9d2c8 (patch)
tree9e033e7adce6bb4a111338f24a7d72d46a7fae5b /man.7
parentde2a1122a661dd4bd4004854891d44e87d63c6c2 (diff)
downloadmandoc-0528debcf5b631def54405f2a163df53d1a9d2c8.tar.gz
mandoc-0528debcf5b631def54405f2a163df53d1a9d2c8.tar.zst
mandoc-0528debcf5b631def54405f2a163df53d1a9d2c8.zip
implement the GNU man-ext .SY/.YS (synopsis block) macro in man(7),
used in most manual pages of the groff package
Diffstat (limited to 'man.7')
-rw-r--r--man.723
1 files changed, 20 insertions, 3 deletions
diff --git a/man.7 b/man.7
index 5e302513..d4ef5e48 100644
--- a/man.7
+++ b/man.7
@@ -1,7 +1,8 @@
-.\" $Id: man.7,v 1.138 2018/08/16 23:43:37 schwarze Exp $
+.\" $Id: man.7,v 1.139 2018/08/18 02:08:27 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2011-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2017 Anthony Bentley <bentley@openbsd.org>
.\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
@@ -16,7 +17,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: August 16 2018 $
+.Dd $Mdocdate: August 18 2018 $
.Dt MAN 7
.Os
.Sh NAME
@@ -630,6 +631,18 @@ Begin a sub-section.
The scope of a sub-section is closed by a subsequent sub-section,
section, or end of file.
The paragraph left-margin width is reset to the default.
+.Ss \&SY
+Begin a synopsis block with the following syntax:
+.Bd -unfilled -offset indent
+.Pf \. Sx \&SY Ar command
+.Ar arguments
+.Pf \. Sx \&YS
+.Ed
+.Pp
+This is a non-standard GNU extension
+and very rarely used even in GNU manual pages.
+Formatting is similar to
+.Sx \&IP .
.Ss \&TH
Sets the title of the manual page for use in the page header
and footer with the following syntax:
@@ -718,6 +731,10 @@ It has the following syntax:
link description to be shown
.Pf \. Sx UE
.Ed
+.Ss \&YS
+End a synopsis block started by
+.Pf \. Sx SY .
+This is a non-standard GNU extension.
.Ss \&fi
End literal mode begun by
.Sx \&nf .