[src/trunk]: src/usr.bin/man Document the reality that the _build and _crunch...

[apb <apb%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/f269499240b8
branches:  trunk
changeset: 772273:f269499240b8
user:      apb <apb%NetBSD.org@localhost>
date:      Tue Dec 27 13:15:55 2011 +0000

description:
Document the reality that the _build and _crunch commands should each
contain exactly one "%s".  The previous description allowed any number
of "%s" in the _build command, but that does not match the actual
behaviour of either man(1) or catman(8).

diffstat:

 usr.bin/man/man.conf.5 |  12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

diffs (41 lines):

diff -r 4ac7ae64fd77 -r f269499240b8 usr.bin/man/man.conf.5
--- a/usr.bin/man/man.conf.5    Tue Dec 27 11:48:01 2011 +0000
+++ b/usr.bin/man/man.conf.5    Tue Dec 27 13:15:55 2011 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: man.conf.5,v 1.20 2007/02/10 19:27:39 reed Exp $
+.\"    $NetBSD: man.conf.5,v 1.21 2011/12/27 13:15:55 apb Exp $
 .\"
 .\" Copyright (c) 1989, 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -29,7 +29,7 @@
 .\"
 .\"    @(#)man.conf.5  8.5 (Berkeley) 1/2/94
 .\"
-.Dd April 10, 2006
+.Dd December 27, 2011
 .Dt MAN.CONF 5
 .Os
 .Sh NAME
@@ -98,9 +98,9 @@
 The rest of the _build line is a shell command line whose standard
 output is a formatted manual page that can be directly displayed to
 the user.
-Any occurrences of the string
+There should be exactly one occurrence of the string
 .Dq %s
-in the shell command line will
+in the shell command line, and it will
 be replaced by the name of the file which is being formatted.
 .It _crunch
 used by
@@ -110,6 +110,10 @@
 which indicates what kind of compression were used to compress the man page.
 The rest of the line must be a shell command line, used to compress the
 formatted pages.
+There should be exactly one occurrence of the string
+.Dq %s
+in the shell command line, and it will
+be replaced by the name of the output file.
 .It _default
 contains the system-wide default man path used to search for man pages.
 .It _subdir