From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from localhost (fantadrom.bsd.lv [local])
	by fantadrom.bsd.lv (OpenSMTPD) with ESMTPA id 302726dd
	for <source@mandoc.bsd.lv>;
	Fri, 23 Feb 2018 13:54:32 -0500 (EST)
Date: Fri, 23 Feb 2018 13:54:32 -0500 (EST)
X-Mailinglist: mandoc-source
Reply-To: source@mandoc.bsd.lv
MIME-Version: 1.0
From: schwarze@mandoc.bsd.lv
To: source@mandoc.bsd.lv
Subject: mandoc: clarify documentation of macro keys
X-Mailer: activitymail 1.26, http://search.cpan.org/dist/activitymail/
Content-Type: text/plain; charset=utf-8
Message-Id: <84f4c4c49cef551b@fantadrom.bsd.lv>

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