Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
BUILD.MAN.MK(5)		      File Formats Manual	       BUILD.MAN.MK(5)

NAME
       build.man.mk -- bsdbuild	- compilation of UNIX manual pages

SYNOPSIS
       .include	<bsd.man.mk>

DESCRIPTION
       The  build.man.mk module	processes UNIX manual pages files in mandoc(1)
       format into presentation-ready documents	in ASCII, PostScript,  PDF  or
       HTML format.

TARGETS
       all-catman	  Produce preformatted manual pages from the specified
			  mandoc source	files.	Fail silently on systems where
			  mandoc/nroff	are unavailable, or where preformatted
			  manual pages are not preferred.

       clean-man	  Clean	up output files.

       install-man-dirs	  Create empty section directories in ${MANDIR}.

       install-man	  Install the manpages into ${MANDIR}.

       install-manlinks	  Install the manpage symlinks into ${MANDIR}.

       man		  Display a manpage (passed via	the MAN	argument),  by
			  feeding its ASCII formatted version to ${PAGER}.

       manlinks		  Scan	 the   ${MAN*}	sources	 and  auto-generate  a
			  .manlinks.mk file defining links for function	 names
			  (i.e., where .Fn appears in a	SYNOPSIS or ".nr nS 1"
			  block),   or	 where	the  special  directive	 "MAN-
			  LINK(name)" appears in a comment.

       lint		  Parse	only,  produce	no  output.   Display  verbose
			  warnings.

VARIABLES
       MAN[1-9]	  List	of  mandoc  input source files (with the .[1-9]	exten-
		  sion).

       MANDOC	  Mandoc processor (usually "mandoc" or	"nroff -Tmandoc",  de-
		  pending  on platform).  This is typically set	by a ./config-
		  ure script (the needed test is included by  default  in  all
		  configure scripts by mkconfigure(1)).

       MANLINKS	  A  list  of  symbolic	 links	that  should be	created	by the
		  install target.  The elements	of this	list are of  the  form
		  "Foo.1:Bar.1",  where	 "Bar.1"  is  the  symbolic  link, and
		  "Foo.1" is the destination manpage.  Typically, MANLINKS  is
		  defined  in  the .manlinks.mk	files which are	auto-generated
		  by the manlinks target.

SEE ALSO
       build.common.mk(5), build.lib.mk(5)

HISTORY
       build.man.mk first appeared in BSDBuild 1.0.

       BSDBuild	is based on the	4.4BSD build system.

FreeBSD	ports 15.0		 July 14, 2015		       BUILD.MAN.MK(5)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=build.man.mk&sektion=5&manpath=FreeBSD+Ports+15.0>

home | help