]> git.cameronkatri.com Git - mandoc.git/blobdiff - Makefile
Make the calltree a bit easier to understand by giving the
[mandoc.git] / Makefile
index e29946e67ba11d0605f01f5c15ec89256abce444..6e5238d57631b67c52f97e5c9b86bfb1e401641d 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,19 @@
-.PHONY:         clean install installcgi installwww
-.SUFFIXES:      .md5 .h .h.html
-.SUFFIXES:      .1       .3       .7       .8
-.SUFFIXES:      .1.html  .3.html  .7.html  .8.html
+# $Id: Makefile,v 1.424 2014/07/13 09:39:32 schwarze Exp $
+#
+# Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+# Copyright (c) 2011, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 VERSION                 = 1.13.0
 
@@ -10,7 +22,7 @@ VERSION                = 1.13.0
 # Specify this if you want to hard-code the operating system to appear
 # in the lower-left hand corner of -mdoc manuals.
 #
-# CFLAGS       += -DOSNAME="\"OpenBSD 5.4\""
+# CFLAGS       += -DOSNAME="\"OpenBSD 5.5\""
 
 # IFF your system supports multi-byte functions (setlocale(), wcwidth(),
 # putwchar()) AND has __STDC_ISO_10646__ (that is, wchar_t is simply a
@@ -22,7 +34,7 @@ CFLAGS                += -DUSE_WCHAR
 
 # If your system has manpath(1), uncomment this.  This is most any
 # system that's not OpenBSD or NetBSD.  If uncommented, manpage(1) and
-# mandocdb(8) will use manpath(1) to get the MANPATH variable.
+# makewhatis(8) will use manpath(1) to get the MANPATH variable.
 #CFLAGS                += -DUSE_MANPATH
 
 # If your system does not support static binaries, comment this,
@@ -52,7 +64,15 @@ INSTALL_MAN   = $(INSTALL_DATA)
 # If you want to build without database support, for example to avoid
 # the dependency on SQLite3, comment the following two lines.
 DBLIB           = -L/usr/local/lib -lsqlite3
-DBBIN           = mandocdb manpage apropos
+DBBIN           = makewhatis manpage apropos
+
+# To build man.cgi, copy cgi.h.example to cgi.h, edit it, and
+# either enable the following line or run "make man.cgi" by hand.
+#DBBIN         += man.cgi
+
+# OpenBSD has the ohash functions in libutil.
+# Comment the following line if your system doesn't.
+DBLIB          += -lutil
 
 # === END OF USER SETTINGS =============================================
 
@@ -64,12 +84,14 @@ TESTSRCS     = test-fgetln.c \
                   test-getsubopt.c \
                   test-mmap.c \
                   test-ohash.c \
+                  test-reallocarray.c \
                   test-strlcat.c \
                   test-strlcpy.c \
                   test-strnlen.c \
                   test-strptime.c
 
-SRCS            = Makefile \
+SRCS            = LICENSE \
+                  Makefile \
                   NEWS \
                   TODO \
                   apropos.1 \
@@ -85,6 +107,7 @@ SRCS          = Makefile \
                   compat_getsubopt.c \
                   compat_ohash.c \
                   compat_ohash.h \
+                  compat_reallocarray.c \
                   compat_strcasestr.c \
                   compat_strlcat.c \
                   compat_strlcpy.c \
@@ -111,8 +134,10 @@ SRCS                = Makefile \
                   libroff.h \
                   main.c \
                   main.h \
+                  makewhatis.8 \
                   man.7 \
                   man.c \
+                  man.cgi.8 \
                   man-cgi.css \
                   man.h \
                   man_hash.c \
@@ -123,13 +148,16 @@ SRCS               = Makefile \
                   mandoc.1 \
                   mandoc.3 \
                   mandoc.c \
+                  mandoc.db.5 \
                   mandoc.h \
+                  mandoc_aux.c \
+                  mandoc_aux.h \
                   mandoc_char.7 \
-                  mandocdb.8 \
                   mandocdb.c \
                   manpage.c \
                   manpath.c \
                   manpath.h \
+                  mansearch.3 \
                   mansearch.c \
                   mansearch.h \
                   mansearch_const.c \
@@ -201,18 +229,22 @@ LIBMANDOC_OBJS     = $(LIBMAN_OBJS) \
                   $(LIBROFF_OBJS) \
                   chars.o \
                   mandoc.o \
+                  mandoc_aux.o \
                   msec.o \
                   read.o
 
 COMPAT_OBJS     = compat_fgetln.o \
                   compat_getsubopt.o \
                   compat_ohash.o \
+                  compat_reallocarray.o \
                   compat_strcasestr.o \
                   compat_strlcat.o \
                   compat_strlcpy.o \
                   compat_strnlen.o \
                   compat_strsep.o
 
+# === DEPENDENCY HANDLING ==============================================
+
 arch.o: arch.in
 att.o: att.in
 chars.o: chars.in
@@ -221,11 +253,12 @@ msec.o: msec.in
 roff.o: predefs.in
 st.o: st.in
 vol.o: vol.in
+cgi.o: cgi.h
 
 $(LIBMAN_OBJS): libman.h
 $(LIBMDOC_OBJS): libmdoc.h
 $(LIBROFF_OBJS): libroff.h
-$(LIBMANDOC_OBJS): mandoc.h mdoc.h man.h libmandoc.h config.h
+$(LIBMANDOC_OBJS): mandoc.h mandoc_aux.h mdoc.h man.h libmandoc.h config.h
 $(COMPAT_OBJS): config.h compat_ohash.h
 
 MANDOC_HTML_OBJS = eqn_html.o \
@@ -252,50 +285,68 @@ MANDOC_OBJS        = $(MANDOC_HTML_OBJS) \
                   main.o \
                   out.o \
                   tree.o
-$(MANDOC_OBJS): main.h mandoc.h mdoc.h man.h config.h out.h
+$(MANDOC_OBJS): main.h mandoc.h mandoc_aux.h mdoc.h man.h config.h out.h
 
-MANDOCDB_OBJS   = mandocdb.o mansearch_const.o manpath.o
-$(MANDOCDB_OBJS): mansearch.h mandoc.h mdoc.h man.h config.h manpath.h
+MAKEWHATIS_OBJS         = mandocdb.o mansearch_const.o manpath.o
+$(MAKEWHATIS_OBJS): mansearch.h mandoc.h mandoc_aux.h \
+                 mdoc.h man.h config.h manpath.h
 
 PRECONV_OBJS    = preconv.o
 $(PRECONV_OBJS): config.h
 
 APROPOS_OBJS    = apropos.o mansearch.o mansearch_const.o manpath.o
-$(APROPOS_OBJS): config.h manpath.h mansearch.h
+$(APROPOS_OBJS): config.h mandoc.h mandoc_aux.h manpath.h mansearch.h
+
+CGI_OBJS        = $(MANDOC_HTML_OBJS) \
+                  cgi.o \
+                  mansearch.o \
+                  mansearch_const.o \
+                  out.o
+$(CGI_OBJS): main.h out.h config.h mandoc.h mandoc_aux.h \
+            manpath.h mansearch.h
 
 MANPAGE_OBJS    = manpage.o mansearch.o mansearch_const.o manpath.o
-$(MANPAGE_OBJS): config.h manpath.h mansearch.h
+$(MANPAGE_OBJS): config.h mandoc.h mandoc_aux.h manpath.h mansearch.h
 
 DEMANDOC_OBJS   = demandoc.o
-$(DEMANDOC_OBJS): config.h
+$(DEMANDOC_OBJS): config.h mandoc.h man.h mdoc.h
 
 WWW_MANS        = apropos.1.html \
                   demandoc.1.html \
                   mandoc.1.html \
                   preconv.1.html \
                   mandoc.3.html \
+                  mansearch.3.html \
                   tbl.3.html \
+                  mandoc.db.5.html \
                   eqn.7.html \
                   man.7.html \
                   mandoc_char.7.html \
                   mdoc.7.html \
                   roff.7.html \
                   tbl.7.html \
-                  mandocdb.8.html \
+                  makewhatis.8.html \
+                  man.cgi.8.html \
                   man.h.html \
                   mandoc.h.html \
+                  mandoc_aux.h.html \
+                  manpath.h.html \
+                  mansearch.h.html \
                   mdoc.h.html
 
-$(WWW_MANS): mandoc
-
 WWW_OBJS        = mdocml.tar.gz \
-                  mdocml.md5
+                  mdocml.sha256
+
+www: $(WWW_OBJS) $(WWW_MANS)
+
+# === TARGETS CONTAINING SHELL COMMANDS ================================
 
 clean:
        rm -f libmandoc.a $(LIBMANDOC_OBJS)
        rm -f apropos $(APROPOS_OBJS)
-       rm -f mandocdb $(MANDOCDB_OBJS)
+       rm -f makewhatis $(MAKEWHATIS_OBJS)
        rm -f preconv $(PRECONV_OBJS)
+       rm -f man.cgi $(CGI_OBJS)
        rm -f manpage $(MANPAGE_OBJS)
        rm -f demandoc $(DEMANDOC_OBJS)
        rm -f mandoc $(MANDOC_OBJS)
@@ -310,30 +361,37 @@ install: all
        mkdir -p $(DESTDIR)$(INCLUDEDIR)
        mkdir -p $(DESTDIR)$(MANDIR)/man1
        mkdir -p $(DESTDIR)$(MANDIR)/man3
+       mkdir -p $(DESTDIR)$(MANDIR)/man5
        mkdir -p $(DESTDIR)$(MANDIR)/man7
        $(INSTALL_PROGRAM) $(ALLBIN) $(DESTDIR)$(BINDIR)
        $(INSTALL_LIB) libmandoc.a $(DESTDIR)$(LIBDIR)
        $(INSTALL_LIB) man.h mdoc.h mandoc.h $(DESTDIR)$(INCLUDEDIR)
        $(INSTALL_MAN) mandoc.1 preconv.1 demandoc.1 $(DESTDIR)$(MANDIR)/man1
-       $(INSTALL_MAN) mandoc.3 tbl.3 $(DESTDIR)$(MANDIR)/man3
-       $(INSTALL_MAN) man.7 mdoc.7 roff.7 eqn.7 tbl.7 mandoc_char.7 $(DESTDIR)$(MANDIR)/man7
+       $(INSTALL_MAN) mandoc.3 mansearch.3 tbl.3 $(DESTDIR)$(MANDIR)/man3
+       $(INSTALL_MAN) mandoc.db.5 $(DESTDIR)$(MANDIR)/man5
+       $(INSTALL_MAN) man.7 mdoc.7 roff.7 eqn.7 tbl.7 mandoc_char.7 \
+               $(DESTDIR)$(MANDIR)/man7
        $(INSTALL_DATA) example.style.css $(DESTDIR)$(EXAMPLEDIR)
 
 installcgi: all
        mkdir -p $(DESTDIR)$(CGIBINDIR)
        mkdir -p $(DESTDIR)$(HTDOCDIR)
-       #$(INSTALL_PROGRAM) man.cgi $(DESTDIR)$(CGIBINDIR)
+       mkdir -p $(DESTDIR)$(WWWPREFIX)/man/mandoc/man1
+       mkdir -p $(DESTDIR)$(WWWPREFIX)/man/mandoc/man8
+       $(INSTALL_PROGRAM) man.cgi $(DESTDIR)$(CGIBINDIR)
        $(INSTALL_DATA) example.style.css $(DESTDIR)$(HTDOCDIR)/man.css
        $(INSTALL_DATA) man-cgi.css $(DESTDIR)$(HTDOCDIR)
+       $(INSTALL_MAN) apropos.1 $(DESTDIR)$(WWWPREFIX)/man/mandoc/man1/
+       $(INSTALL_MAN) man.cgi.8 $(DESTDIR)$(WWWPREFIX)/man/mandoc/man8/
 
-installwww: $(WWW_MANS) $(WWW_OBJS)
+installwww: www
        mkdir -p $(DESTDIR)$(HTDOCDIR)/snapshots
        $(INSTALL_DATA) $(WWW_MANS) style.css $(DESTDIR)$(HTDOCDIR)
        $(INSTALL_DATA) $(WWW_OBJS) $(DESTDIR)$(HTDOCDIR)/snapshots
        $(INSTALL_DATA) mdocml.tar.gz \
                $(DESTDIR)$(HTDOCDIR)/snapshots/mdocml-$(VERSION).tar.gz
-       $(INSTALL_DATA) mdocml.md5 \
-               $(DESTDIR)$(HTDOCDIR)/snapshots/mdocml-$(VERSION).md5
+       $(INSTALL_DATA) mdocml.sha256 \
+               $(DESTDIR)$(HTDOCDIR)/snapshots/mdocml-$(VERSION).sha256
 
 libmandoc.a: $(COMPAT_OBJS) $(LIBMANDOC_OBJS)
        $(AR) rs $@ $(COMPAT_OBJS) $(LIBMANDOC_OBJS)
@@ -341,8 +399,8 @@ libmandoc.a: $(COMPAT_OBJS) $(LIBMANDOC_OBJS)
 mandoc: $(MANDOC_OBJS) libmandoc.a
        $(CC) $(LDFLAGS) -o $@ $(MANDOC_OBJS) libmandoc.a
 
-mandocdb: $(MANDOCDB_OBJS) libmandoc.a
-       $(CC) $(LDFLAGS) -o $@ $(MANDOCDB_OBJS) libmandoc.a $(DBLIB)
+makewhatis: $(MAKEWHATIS_OBJS) libmandoc.a
+       $(CC) $(LDFLAGS) -o $@ $(MAKEWHATIS_OBJS) libmandoc.a $(DBLIB)
 
 preconv: $(PRECONV_OBJS)
        $(CC) $(LDFLAGS) -o $@ $(PRECONV_OBJS)
@@ -353,11 +411,14 @@ manpage: $(MANPAGE_OBJS) libmandoc.a
 apropos: $(APROPOS_OBJS) libmandoc.a
        $(CC) $(LDFLAGS) -o $@ $(APROPOS_OBJS) libmandoc.a $(DBLIB)
 
+man.cgi: $(CGI_OBJS) libmandoc.a
+       $(CC) $(LDFLAGS) $(STATIC) -o $@ $(CGI_OBJS) libmandoc.a $(DBLIB)
+
 demandoc: $(DEMANDOC_OBJS) libmandoc.a
        $(CC) $(LDFLAGS) -o $@ $(DEMANDOC_OBJS) libmandoc.a
 
-mdocml.md5: mdocml.tar.gz
-       md5 mdocml.tar.gz >$@
+mdocml.sha256: mdocml.tar.gz
+       sha256 mdocml.tar.gz > $@
 
 mdocml.tar.gz: $(SRCS)
        mkdir -p .dist/mdocml-$(VERSION)/
@@ -370,8 +431,13 @@ config.h: configure config.h.pre config.h.post $(TESTSRCS)
        rm -f config.log
        CC="$(CC)" CFLAGS="$(CFLAGS)" VERSION="$(VERSION)" ./configure
 
+.PHONY:         clean install installcgi installwww
+.SUFFIXES:      .1       .3       .5       .7       .8       .h
+.SUFFIXES:      .1.html  .3.html  .5.html  .7.html  .8.html  .h.html
+
 .h.h.html:
-       highlight -I $< >$@
+       highlight -I $< > $@
 
-.1.1.html .3.3.html .7.7.html .8.8.html:
-       ./mandoc -Thtml -Wall,stop -Ostyle=style.css,man=%N.%S.html,includes=%I.html $< >$@
+.1.1.html .3.3.html .5.5.html .7.7.html .8.8.html: mandoc
+       ./mandoc -Thtml -Wall,stop \
+               -Ostyle=style.css,man=%N.%S.html,includes=%I.html $< > $@