source@mandoc.bsd.lv
 help / color / mirror / Atom feed
* mandoc: Include .EX/.EE in the MACRO OVERVIEW and improve its
@ 2023-10-07 21:28 schwarze
  0 siblings, 0 replies; only message in thread
From: schwarze @ 2023-10-07 21:28 UTC (permalink / raw)
  To: source

Log Message:
-----------
Include .EX/.EE in the MACRO OVERVIEW and improve its description.

It is supported by all major man(7) implementations that G. Branden
Robinson and myself are aware of, so calling it "non-portable" can
no longer be justified.  Using it becomes increasingly more common,
so calling it "non-standard" is now misleading.  It is certainly
useful and not deprecated.

While here, also remove the word "non-standard" from the descriptions
of several other macros because it is slightly confusing.  A formal
standard for the man(7) language does not exist.  Arguably, Version 7
AT&T UNIX used to be a de-facto standard, but its influence has been
waning for 40 years, and various features that Version 7 did not
support are now widely used.

Modified Files:
--------------
    mandoc:
        man.7

Revision Data
-------------
Index: man.7
===================================================================
RCS file: /home/cvs/mandoc/mandoc/man.7,v
retrieving revision 1.148
retrieving revision 1.149
diff -Lman.7 -Lman.7 -u -p -r1.148 -r1.149
--- man.7
+++ man.7
@@ -97,10 +97,11 @@ but can be found in the alphabetical ref
 .It Ic SH Ta section header (one line)
 .It Ic SS Ta subsection header (one line)
 .It Ic PP Ta start an undecorated paragraph (no arguments)
-.It Ic RS , RE Ta reset the left margin: Op Ar width
 .It Ic IP Ta indented paragraph: Op Ar head Op Ar width
 .It Ic TP Ta tagged paragraph: Op Ar width
 .It Ic PD Ta set vertical paragraph distance: Op Ar height
+.It Ic EX , EE Ta display an example (no arguments)
+.It Ic RS , RE Ta reset the left margin: Op Ar width
 .It Ic in Ta additional indent: Op Ar width
 .El
 .Ss Physical markup
@@ -162,7 +163,9 @@ This has no effect unless the tabulator 
 .Ic ta
 request.
 .It Ic EE
-This is a non-standard Version 9
+End an example block started with
+.Ic EX .
+This is a Version 9
 .At
 extension later adopted by GNU.
 In
@@ -172,7 +175,8 @@ it does the same as the
 .Ic fi
 request (switch to fill mode).
 .It Ic EX
-This is a non-standard Version 9
+Begin a block to display an example.
+This is a Version 9
 .At
 extension later adopted by GNU.
 In
@@ -234,10 +238,10 @@ A synonym for
 .It Ic ME
 End a mailto block started with
 .Ic MT .
-This is a non-standard GNU extension.
+This is a GNU extension.
 .It Ic MT
 Begin a mailto block.
-This is a non-standard GNU extension.
+This is a GNU extension.
 It has the following syntax:
 .Bd -unfilled -offset indent
 .Pf . Ic MT Ar address
@@ -246,7 +250,7 @@ link description to be shown
 .Ed
 .It Ic OP
 Optional command-line argument.
-This is a non-standard DWB extension.
+This is a rarely used DWB extension.
 It has the following syntax:
 .Pp
 .D1 Pf . Ic OP Ar key Op Ar value
@@ -373,8 +377,7 @@ Begin a synopsis block with the followin
 .Pf . Ic YS
 .Ed
 .Pp
-This is a non-standard GNU extension
-and very rarely used even in GNU manual pages.
+This is a GNU extension and rarely used even in GNU manual pages.
 Formatting is similar to
 .Ic IP .
 .It Ic TH
@@ -437,8 +440,7 @@ unspecified, the saved or default width 
 Like
 .Ic TP ,
 except that no vertical spacing is inserted before the paragraph.
-This is a non-standard GNU extension
-and very rarely used even in GNU manual pages.
+This is a GNU extension and rarely used even in GNU manual pages.
 .It Ic UC
 Sets the volume for the footer for compatibility with man pages from
 .Bx
@@ -449,10 +451,10 @@ This macro is an extension that first ap
 .It Ic UE
 End a uniform resource identifier block started with
 .Ic UR .
-This is a non-standard GNU extension.
+This is a GNU extension.
 .It Ic UR
 Begin a uniform resource identifier block.
-This is a non-standard GNU extension.
+This is a GNU extension.
 It has the following syntax:
 .Bd -unfilled -offset indent
 .Pf . Ic UR Ar uri
@@ -462,7 +464,7 @@ link description to be shown
 .It Ic YS
 End a synopsis block started with
 .Ic SY .
-This is a non-standard GNU extension.
+This is a GNU extension.
 .It Ic in
 Indent relative to the current indentation:
 .Pp
--
 To unsubscribe send an email to source+unsubscribe@mandoc.bsd.lv


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2023-10-07 21:28 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-10-07 21:28 mandoc: Include .EX/.EE in the MACRO OVERVIEW and improve its schwarze

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).