[prev in list] [next in list] [prev in thread] [next in thread] 

List:       mandoc-source
Subject:    mandoc: clarify documentation of macro keys
From:       schwarze () mandoc ! bsd ! lv
Date:       2018-02-23 18:54:32
Message-ID: 84f4c4c49cef551b () fantadrom ! bsd ! lv
[Download RAW message or body]

Log Message:
-----------
clarify documentation of macro keys

Modified Files:
--------------
    mandoc:
        apropos.1

Revision Data
-------------
Index: apropos.1
===================================================================
RCS file: /home/cvs/mandoc/mandoc/apropos.1,v
retrieving revision 1.46
retrieving revision 1.47
diff -Lapropos.1 -Lapropos.1 -u -p -r1.46 -r1.47
--- apropos.1
+++ apropos.1
@@ -328,6 +328,29 @@ Text production:
 .It Li \&Ox Ta Ox No version reference
 .It Li \&Dx Ta Dx No version reference
 .El
+.Pp
+In general, macro keys are supposed to yield complete results without
+expecting the user to consider actual macro usage.
+For example, results include:
+.Pp
+.Bl -tag -width 3n -offset 3n -compact
+.It Li \&Fa
+function arguments appearing on
+.Ic \&Fn
+lines
+.It Li \&Fn
+fuction names marked up with
+.Ic \&Fo
+macros
+.It Li \&In
+include file names marked up with
+.Ic \&Fd
+macros
+.It Li \&Vt
+types appearing as function return types and
+.It \&
+types appearing in function arguments in the SYNOPSIS
+.El
 .Sh ENVIRONMENT
 .Bl -tag -width MANPAGER
 .It Ev MANPAGER
--
 To unsubscribe send an email to source+unsubscribe@mandoc.bsd.lv

[prev in list] [next in list] [prev in thread] [next in thread]