]> git.cameronkatri.com Git - mandoc.git/blobdiff - Makefile
Implement the obsolete macros .En .Es .Fr .Ot for backward compatibility,
[mandoc.git] / Makefile
index 9c17d40090ebcde0e0582db5aa8825ed51912f7f..b6a1dc9bfcd494a7755c8a55cca4742a91bb626e 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,21 +1,54 @@
-.PHONY:         clean install installwww
-.SUFFIXES:      .sgml .html .md5 .h .h.html
-.SUFFIXES:      .1       .3       .7
-.SUFFIXES:      .1.txt   .3.txt   .7.txt
-.SUFFIXES:      .1.pdf   .3.pdf   .7.pdf
-.SUFFIXES:      .1.ps    .3.ps    .7.ps
-.SUFFIXES:      .1.html  .3.html  .7.html 
-.SUFFIXES:      .1.xhtml .3.xhtml .7.xhtml 
+# $Id: Makefile,v 1.420 2014/06/20 02:55:49 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
+
+# === USER SETTINGS ====================================================
 
 # 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 4.5\""
+#
+# 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
+# UCS-4 value) should you define USE_WCHAR.  If you define it and your
+# system DOESN'T support this, -Tlocale will produce garbage.
+# If you don't define it, -Tlocale is a synonym for -Tacsii.
+#
+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
+# makewhatis(8) will use manpath(1) to get the MANPATH variable.
+#CFLAGS                += -DUSE_MANPATH
 
-VERSION                 = 1.10.10
-VDATE           = 20 March 2011
-CFLAGS         += -g -DHAVE_CONFIG_H -DVERSION="\"$(VERSION)\""
+# If your system does not support static binaries, comment this,
+# for example on Mac OS X.
+STATIC          = -static
+# Linux requires -pthread to statically link with libdb.
+#STATIC                += -pthread
+
+CFLAGS         += -I/usr/local/include -g -DHAVE_CONFIG_H
 CFLAGS         += -W -Wall -Wstrict-prototypes -Wno-unused-parameter -Wwrite-strings
 PREFIX          = /usr/local
+WWWPREFIX       = /var/www
+HTDOCDIR        = $(WWWPREFIX)/htdocs
+CGIBINDIR       = $(WWWPREFIX)/cgi-bin
 BINDIR          = $(PREFIX)/bin
 INCLUDEDIR      = $(PREFIX)/include/mandoc
 LIBDIR          = $(PREFIX)/lib/mandoc
@@ -25,28 +58,70 @@ INSTALL              = install
 INSTALL_PROGRAM         = $(INSTALL) -m 0755
 INSTALL_DATA    = $(INSTALL) -m 0444
 INSTALL_LIB     = $(INSTALL) -m 0644
+INSTALL_SOURCE  = $(INSTALL) -m 0644
 INSTALL_MAN     = $(INSTALL_DATA)
 
-all: mandoc
+# 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           = makewhatis manpage apropos
+
+# OpenBSD has the ohash functions in libutil.
+# Comment the following line if your system doesn't.
+DBLIB          += -lutil
+
+# === END OF USER SETTINGS =============================================
 
-SRCS            = Makefile \
+ALLBIN          = mandoc preconv demandoc $(DBBIN)
+
+all: $(ALLBIN)
+
+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            = LICENSE \
+                  Makefile \
+                  NEWS \
+                  TODO \
+                  apropos.1 \
+                  apropos.c \
                   arch.c \
                   arch.in \
                   att.c \
                   att.in \
+                  cgi.c \
                   chars.c \
                   chars.in \
-                  compat.c \
+                  compat_fgetln.c \
+                  compat_getsubopt.c \
+                  compat_ohash.c \
+                  compat_ohash.h \
+                  compat_reallocarray.c \
+                  compat_strcasestr.c \
+                  compat_strlcat.c \
+                  compat_strlcpy.c \
+                  compat_strnlen.c \
+                  compat_strsep.c \
                   config.h.post \
                   config.h.pre \
+                  configure \
+                  demandoc.1 \
+                  demandoc.c \
                   eqn.7 \
                   eqn.c \
+                  eqn_html.c \
+                  eqn_term.c \
                   example.style.css \
-                  external.png \
+                  gmdiff \
                   html.c \
                   html.h \
-                  index.css \
-                  index.sgml \
                   lib.c \
                   lib.in \
                   libman.h \
@@ -55,8 +130,11 @@ SRCS                 = Makefile \
                   libroff.h \
                   main.c \
                   main.h \
+                  makewhatis.8 \
                   man.7 \
                   man.c \
+                  man-cgi.css \
+                  man.h \
                   man_hash.c \
                   man_html.c \
                   man_macro.c \
@@ -65,26 +143,43 @@ SRCS                = Makefile \
                   mandoc.1 \
                   mandoc.3 \
                   mandoc.c \
+                  mandoc.db.5 \
                   mandoc.h \
+                  mandoc_aux.c \
+                  mandoc_aux.h \
                   mandoc_char.7 \
+                  mandocdb.c \
+                  manpage.c \
+                  manpath.c \
+                  manpath.h \
+                  mansearch.3 \
+                  mansearch.c \
+                  mansearch.h \
+                  mansearch_const.c \
                   mdoc.7 \
                   mdoc.c \
+                  mdoc.h \
                   mdoc_argv.c \
                   mdoc_hash.c \
                   mdoc_html.c \
                   mdoc_macro.c \
+                  mdoc_man.c \
                   mdoc_term.c \
                   mdoc_validate.c \
                   msec.c \
                   msec.in \
                   out.c \
                   out.h \
+                  preconv.1 \
+                  preconv.c \
+                  predefs.in \
                   read.c \
                   roff.7 \
                   roff.c \
                   st.c \
                   st.in \
                   style.css \
+                  tbl.3 \
                   tbl.7 \
                   tbl.c \
                   tbl_data.c \
@@ -96,16 +191,16 @@ SRCS                = Makefile \
                   term.h \
                   term_ascii.c \
                   term_ps.c \
-                  test-strlcat.c \
-                  test-strlcpy.c \
                   tree.c \
                   vol.c \
-                  vol.in
+                  vol.in \
+                  $(TESTSRCS)
 
 LIBMAN_OBJS     = man.o \
                   man_hash.o \
                   man_macro.o \
                   man_validate.o
+
 LIBMDOC_OBJS    = arch.o \
                   att.o \
                   lib.o \
@@ -114,191 +209,212 @@ LIBMDOC_OBJS     = arch.o \
                   mdoc_hash.o \
                   mdoc_macro.o \
                   mdoc_validate.o \
-                  msec.o \
                   st.o \
                   vol.o
+
 LIBROFF_OBJS    = eqn.o \
                   roff.o \
                   tbl.o \
                   tbl_data.o \
                   tbl_layout.o \
                   tbl_opts.o
+
 LIBMANDOC_OBJS  = $(LIBMAN_OBJS) \
                   $(LIBMDOC_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
 lib.o: lib.in
 msec.o: msec.in
+roff.o: predefs.in
 st.o: st.in
 vol.o: vol.in
 
 $(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 = html.o \
+MANDOC_HTML_OBJS = eqn_html.o \
+                  html.o \
                   man_html.o \
                   mdoc_html.o \
                   tbl_html.o
-MANDOC_TERM_OBJS = man_term.o \
+$(MANDOC_HTML_OBJS): html.h
+
+MANDOC_MAN_OBJS  = mdoc_man.o
+
+MANDOC_TERM_OBJS = eqn_term.o \
+                  man_term.o \
                   mdoc_term.o \
                   term.o \
                   term_ascii.o \
                   term_ps.o \
                   tbl_term.o
+$(MANDOC_TERM_OBJS): term.h
+
 MANDOC_OBJS     = $(MANDOC_HTML_OBJS) \
+                  $(MANDOC_MAN_OBJS) \
                   $(MANDOC_TERM_OBJS) \
-                  chars.o \
                   main.o \
                   out.o \
                   tree.o
+$(MANDOC_OBJS): main.h mandoc.h mandoc_aux.h mdoc.h man.h config.h out.h
 
-chars.o: chars.in
+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
 
-$(MANDOC_HTML_OBJS): html.h
-$(MANDOC_TERM_OBJS): term.h
-$(MANDOC_OBJS): main.h mandoc.h mdoc.h man.h config.h out.h
+PRECONV_OBJS    = preconv.o
+$(PRECONV_OBJS): config.h
 
-compat.o: config.h
+APROPOS_OBJS    = apropos.o mansearch.o mansearch_const.o manpath.o
+$(APROPOS_OBJS): config.h mandoc.h mandoc_aux.h manpath.h mansearch.h
 
-INDEX_MANS      = mandoc.1.html \
-                  mandoc.1.xhtml \
-                  mandoc.1.ps \
-                  mandoc.1.pdf \
-                  mandoc.1.txt \
+MANPAGE_OBJS    = manpage.o mansearch.o mansearch_const.o manpath.o
+$(MANPAGE_OBJS): config.h mandoc.h mandoc_aux.h manpath.h mansearch.h
+
+DEMANDOC_OBJS   = demandoc.o
+$(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 \
-                  mandoc.3.xhtml \
-                  mandoc.3.ps \
-                  mandoc.3.pdf \
-                  mandoc.3.txt \
+                  mansearch.3.html \
+                  tbl.3.html \
+                  mandoc.db.5.html \
                   eqn.7.html \
-                  eqn.7.xhtml \
-                  eqn.7.ps \
-                  eqn.7.pdf \
-                  eqn.7.txt \
                   man.7.html \
-                  man.7.xhtml \
-                  man.7.ps \
-                  man.7.pdf \
-                  man.7.txt \
                   mandoc_char.7.html \
-                  mandoc_char.7.xhtml \
-                  mandoc_char.7.ps \
-                  mandoc_char.7.pdf \
-                  mandoc_char.7.txt \
                   mdoc.7.html \
-                  mdoc.7.xhtml \
-                  mdoc.7.ps \
-                  mdoc.7.pdf \
-                  mdoc.7.txt \
                   roff.7.html \
-                  roff.7.xhtml \
-                  roff.7.ps \
-                  roff.7.pdf \
-                  roff.7.txt \
                   tbl.7.html \
-                  tbl.7.xhtml \
-                  tbl.7.ps \
-                  tbl.7.pdf \
-                  tbl.7.txt
-
-$(INDEX_MANS): mandoc
-
-INDEX_OBJS      = $(INDEX_MANS) \
+                  makewhatis.8.html \
                   man.h.html \
                   mandoc.h.html \
-                  mdoc.h.html \
-                  mdocml.tar.gz \
-                  mdocml.md5
+                  mandoc_aux.h.html \
+                  manpath.h.html \
+                  mansearch.h.html \
+                  mdoc.h.html
+
+WWW_OBJS        = mdocml.tar.gz \
+                  mdocml.sha256
+
+www: $(WWW_OBJS) $(WWW_MANS)
 
-www: index.html
+# === TARGETS CONTAINING SHELL COMMANDS ================================
 
 clean:
        rm -f libmandoc.a $(LIBMANDOC_OBJS)
+       rm -f apropos $(APROPOS_OBJS)
+       rm -f makewhatis $(MAKEWHATIS_OBJS)
+       rm -f preconv $(PRECONV_OBJS)
+       rm -f manpage $(MANPAGE_OBJS)
+       rm -f demandoc $(DEMANDOC_OBJS)
        rm -f mandoc $(MANDOC_OBJS)
-       rm -f config.h compat.o config.log
-       rm -f mdocml.tar.gz
-       rm -f index.html $(INDEX_OBJS)
+       rm -f config.h config.log $(COMPAT_OBJS)
+       rm -f $(WWW_MANS) $(WWW_OBJS)
+       rm -rf *.dSYM
 
 install: all
        mkdir -p $(DESTDIR)$(BINDIR)
        mkdir -p $(DESTDIR)$(EXAMPLEDIR)
+       mkdir -p $(DESTDIR)$(LIBDIR)
+       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) mandoc $(DESTDIR)$(BINDIR)
-       $(INSTALL_LIB) libmandoc.a $(DESTDIR)$(LIBDIR)/
-       $(INSTALL_MAN) mandoc.1 $(DESTDIR)$(MANDIR)/man1
-       $(INSTALL_MAN) mandoc.3 $(DESTDIR)$(MANDIR)/man3
-       $(INSTALL_MAN) man.7 mdoc.7 roff.7 eqn.7 tbl.7 mandoc_char.7 $(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 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)
+       $(INSTALL_DATA) example.style.css $(DESTDIR)$(HTDOCDIR)/man.css
+       $(INSTALL_DATA) man-cgi.css $(DESTDIR)$(HTDOCDIR)
+
 installwww: www
-       mkdir -p $(PREFIX)/snapshots
-       $(INSTALL_DATA) index.html external.png index.css $(PREFIX)
-       $(INSTALL_DATA) $(INDEX_MANS) style.css $(PREFIX)
-       $(INSTALL_DATA) mandoc.h.html man.h.html mdoc.h.html $(PREFIX)
-       $(INSTALL_DATA) mdocml.tar.gz $(PREFIX)/snapshots
-       $(INSTALL_DATA) mdocml.md5 $(PREFIX)/snapshots
-       $(INSTALL_DATA) mdocml.tar.gz $(PREFIX)/snapshots/mdocml-$(VERSION).tar.gz
-       $(INSTALL_DATA) mdocml.md5 $(PREFIX)/snapshots/mdocml-$(VERSION).md5
-
-libmandoc.a: compat.o $(LIBMANDOC_OBJS)
-       $(AR) rs $@ compat.o $(LIBMANDOC_OBJS)
+       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.sha256 \
+               $(DESTDIR)$(HTDOCDIR)/snapshots/mdocml-$(VERSION).sha256
+
+libmandoc.a: $(COMPAT_OBJS) $(LIBMANDOC_OBJS)
+       $(AR) rs $@ $(COMPAT_OBJS) $(LIBMANDOC_OBJS)
 
 mandoc: $(MANDOC_OBJS) libmandoc.a
-       $(CC) -o $@ $(MANDOC_OBJS) libmandoc.a
+       $(CC) $(LDFLAGS) -o $@ $(MANDOC_OBJS) libmandoc.a
 
-mdocml.md5: mdocml.tar.gz
-       md5 mdocml.tar.gz >$@
+makewhatis: $(MAKEWHATIS_OBJS) libmandoc.a
+       $(CC) $(LDFLAGS) -o $@ $(MAKEWHATIS_OBJS) libmandoc.a $(DBLIB)
 
-mdocml.tar.gz: $(SRCS)
-       mkdir -p .dist/mdocml-$(VERSION)/
-       $(INSTALL) -m 0444 $(SRCS) .dist/mdocml-$(VERSION)
-       ( cd .dist/ && tar zcf ../$@ ./ )
-       rm -rf .dist/
+preconv: $(PRECONV_OBJS)
+       $(CC) $(LDFLAGS) -o $@ $(PRECONV_OBJS)
 
-index.html: $(INDEX_OBJS)
+manpage: $(MANPAGE_OBJS) libmandoc.a
+       $(CC) $(LDFLAGS) -o $@ $(MANPAGE_OBJS) libmandoc.a $(DBLIB)
 
-config.h: config.h.pre config.h.post
-       rm -f config.log
-       ( cat config.h.pre; \
-         echo; \
-         if $(CC) $(CFLAGS) -Werror -o test-strlcat test-strlcat.c >> config.log 2>&1; then \
-               echo '#define HAVE_STRLCAT'; \
-               rm test-strlcat; \
-         fi; \
-         if $(CC) $(CFLAGS) -Werror -o test-strlcpy test-strlcpy.c >> config.log 2>&1; then \
-               echo '#define HAVE_STRLCPY'; \
-               rm test-strlcpy; \
-         fi; \
-         echo; \
-         cat config.h.post \
-       ) > $@
+apropos: $(APROPOS_OBJS) libmandoc.a
+       $(CC) $(LDFLAGS) -o $@ $(APROPOS_OBJS) libmandoc.a $(DBLIB)
 
-.h.h.html:
-       highlight -I $< >$@
+demandoc: $(DEMANDOC_OBJS) libmandoc.a
+       $(CC) $(LDFLAGS) -o $@ $(DEMANDOC_OBJS) libmandoc.a
 
-.1.1.txt .3.3.txt .7.7.txt:
-       ./mandoc -Tascii -Wall,stop $< | col -b >$@
+mdocml.sha256: mdocml.tar.gz
+       sha256 mdocml.tar.gz > $@
 
-.1.1.html .3.3.html .7.7.html:
-       ./mandoc -Thtml -Wall,stop -Ostyle=style.css,man=%N.%S.html,includes=%I.html $< >$@
+mdocml.tar.gz: $(SRCS)
+       mkdir -p .dist/mdocml-$(VERSION)/
+       $(INSTALL_SOURCE) $(SRCS) .dist/mdocml-$(VERSION)
+       chmod 755 .dist/mdocml-$(VERSION)/configure
+       ( cd .dist/ && tar zcf ../$@ mdocml-$(VERSION) )
+       rm -rf .dist/
 
-.1.1.ps .3.3.ps .7.7.ps:
-       ./mandoc -Tps -Wall,stop $< >$@
+config.h: configure config.h.pre config.h.post $(TESTSRCS)
+       rm -f config.log
+       CC="$(CC)" CFLAGS="$(CFLAGS)" VERSION="$(VERSION)" ./configure
 
-.1.1.xhtml .3.3.xhtml .7.7.xhtml:
-       ./mandoc -Txhtml -Wall,stop -Ostyle=style.css,man=%N.%S.xhtml,includes=%I.html $< >$@
+.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
 
-.1.1.pdf .3.3.pdf .7.7.pdf:
-       ./mandoc -Tpdf -Wall,stop $< >$@
+.h.h.html:
+       highlight -I $< > $@
 
-.sgml.html:
-       validate --warn $<
-       sed -e "s!@VERSION@!$(VERSION)!" -e "s!@VDATE@!$(VDATE)!" $< >$@
+.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 $< > $@