From: Tom Tromey Date: Mon, 15 Jan 2001 17:50:31 +0000 (+0000) Subject: * automake.texi (Man pages): Updated to account for man1_MANS, X-Git-Tag: Release-1-4d~114 X-Git-Url: https://sourceware.org/git/?a=commitdiff_plain;h=0fe00b8298730f40c792a78c3e3445d72832087a;p=automake.git * automake.texi (Man pages): Updated to account for man1_MANS, etc. --- diff --git a/ChangeLog b/ChangeLog index ad024663..c627ffb4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2001-01-15 Tom Tromey + + * automake.texi (Man pages): Updated to account for man1_MANS, + etc. + 2001-01-13 Steve Robbins Tom Tromey diff --git a/automake.texi b/automake.texi index 221199b4..383cc78f 100644 --- a/automake.texi +++ b/automake.texi @@ -52,7 +52,7 @@ by the Foundation. @page @vskip 0pt plus 1filll -Copyright @copyright{} 1995, 1996, 2000 Free Software Foundation, Inc. +Copyright @copyright{} 1995, 1996, 2000, 2001 Free Software Foundation, Inc. @sp 2 This is the first edition of the GNU Automake documentation,@* and is consistent with GNU Automake @value{VERSION}.@* @@ -2797,10 +2797,32 @@ matter, @ref{Man Pages, , , standards, The GNU Coding Standards}.) Man pages are declared using the @samp{MANS} primary. Generally the @code{man_MANS} macro is used. Man pages are automatically installed in the correct subdirectory of @code{mandir}, based on the file extension. -They are not automatically included in the distribution. @vindex MANS @vindex man_MANS +File extensions such as @samp{.1c} are handled by looking for the valid +part of the extension and using that to determine the correct +subdirectory of @code{mandir}. Valid section names are the digits +@samp{0} through @samp{9}, and the letters @samp{l} and @samp{n}. + +Sometimes developers prefer to name a man page something like +@file{foo.man} in the source, and then rename it to have the correct +suffix, e.g. @file{foo.1}, when installing the file. Automake also +supports this mode. For a valid section named @var{SECTION}, there is a +corresponding directory named @samp{man@var{SECTION}dir}, and a +corresponding @samp{_MANS} variable. Files listed in such a variable +are installed in the indicated section. If the file already has a +valid suffix, then it is installed as-is; otherwise the file suffix is +changed to match the section. + +For instance, consider this example: +@example +man1_MANS = rename.man thesame.1 alsothesame.1c +@end example + +In this case, @file{rename.man} will be renamed to @file{rename.1} when +installed, but the other files will keep their names. + @cindex Target, install-man @cindex Target, noinstall-man @cindex install-man target