.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "wml::mod::MakeMaker 3" .TH wml::mod::MakeMaker 3 "2020-11-29" "EN Tools" "EN Tools" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" wml::mod::MakeMaker \- A Makefile generator .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& #!wml \-o Makefile \& #use wml::mod::MakeMaker \& \& .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This include file provides an easy way to write a Makefile to distribute your own \s-1WML\s0 modules. It is inspired by the \f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR Perl module. .SS "Default targets" .IX Subsection "Default targets" .IP "\fBmake all\fR" 4 .IX Item "make all" This is the default target. It will build all include files and their documentation. .IP "\fBmake install\fR" 4 .IX Item "make install" Install include files and documentation in the locations given by ``wml \-V2''. .IP "\fBmake clean\fR" 4 .IX Item "make clean" Remove files generated by \fBmake\fR. .IP "\fBmake distclean\fR" 4 .IX Item "make distclean" Like \fBmake clean\fR, plus remove the \fIMakefile\fR too. .IP "\fBmake dist\fR" 4 .IX Item "make dist" Build a distribution. Should only be used by the module maintainer. If there is a \fI\s-1MANIFEST\s0\fR file, then the list of files to include is taken from this file. Otherwise the tarball contains all source files, plus \fIMakeMaker.wml\fR, \fIMakefile.wml\fR, \fIshtool\fR and \fI\s-1README\s0\fR if these files exist. .SS "Overriding default targets" .IX Subsection "Overriding default targets" To build the \fIMakefile\fR, all targets are put in separate buffers during pass 3, and those buffers are diverted by pass 5. You can override this defaukt target by redefining buffer contents. Buffer names are explicit: .PP .Vb 1 \& MK_ALL MK_INSTALL MK_CLEAN MK_DISTCLEAN MK_CONFIG MK_RELEASE .Ve .SS "Defining new targets" .IX Subsection "Defining new targets" The \fB\s-1MK_USER\s0\fR is empty and devoted to this task. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" The first three attributes are mandatory. .IP "\fBpackage\fR" 4 .IX Item "package" The name of the package .IP "\fBversion\fR" 4 .IX Item "version" Its version number .IP "\fBmodules\fR" 4 .IX Item "modules" List of modules to build and install. This is a space separated list of filenames. Modules should reside in a sub-directory to be compliant with actual file hierarchy. For instance, the declaration .Sp .Vb 1 \& modules="math/log.tmpl math/exp.tmpl" .Ve .Sp tells that after compilation, there are two modules which are \&\f(CW\*(C`math/log.tmpl\*(C'\fR and \f(CW\*(C`math/exp.tmpl\*(C'\fR. This modules will be installed to \&\f(CW\*(C`LibDir/include/math/log.tmpl\*(C'\fR and \f(CW\*(C`LibDir/include/math/exp.tmpl\*(C'\fR. .Sp These modules will then be called in a \s-1WML\s0 file by .Sp .Vb 2 \& #use tmpl::math::log \& #use tmpl::math::exp .Ve .Sp Source files for these modules are obtained by replacing the suffix by \&\fI.src\fR. .IP "\fBsrc-ext\fR" 4 .IX Item "src-ext" Defines an alternate suffix for the source files. .IP "\fBman-ext\fR" 4 .IX Item "man-ext" Section number of the manual in which man files are put. Default is 3. .IP "\fBextradistfiles\fR" 4 .IX Item "extradistfiles" Space separated list of files to include in a distribution. By default, all source files plus \fIMakeMaker.wml\fR, \fIMakefile.wml\fR, \fI\s-1README\s0\fR and \&\fIshtool\fR are included in a distribution. .SH "EXAMPLE" .IX Header "EXAMPLE" .Vb 6 \& .Ve .PP This will build the \fBtmpl::math::log\fR include module from the \&\fImath/log.exp\fR source file. This source file will also produce the \&\fB\fBtmpl::math::log\fB\|(3)\fR manpage. .SH "NOTES" .IX Header "NOTES" Please do _not_ use a \f(CW\*(C`.wml\*(C'\fR suffix for your modules, they should be reserved for official \s-1WML\s0 modules shipped with \s-1WML.\s0 You may instead put your initials or anything else. .SH "AUTHOR" .IX Header "AUTHOR" .Vb 2 \& Denis Barbier \& barbier@engelschall.com .Ve .SH "REQUIRES" .IX Header "REQUIRES" .Vb 2 \& Internal: P1, P2, P3, P5 \& External: \-\- .Ve