summaryrefslogtreecommitdiffstats
path: root/apropos.1
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2018-02-23 18:54:02 +0000
committerIngo Schwarze <schwarze@openbsd.org>2018-02-23 18:54:02 +0000
commit26699c18e14752f8c5338bb28c64775184685f96 (patch)
tree41c380138d699095ed1328b57fdff59636bea925 /apropos.1
parentd32de303089b01e25effdb54cc92a00b71a3a986 (diff)
downloadmandoc-26699c18e14752f8c5338bb28c64775184685f96.tar.gz
clarify documentation of macro keys
Diffstat (limited to 'apropos.1')
-rw-r--r--apropos.123
1 files changed, 23 insertions, 0 deletions
diff --git a/apropos.1 b/apropos.1
index 12fb0b81..6786b56a 100644
--- a/apropos.1
+++ b/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