diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2017-02-21 16:25:19 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2017-02-21 16:25:19 +0000 |
commit | 2e0f02657765c5e07ae5bc11a3a849f007ee4681 (patch) | |
tree | fc4df6850fb0a6de9518fa20b08d51f23db91c53 | |
parent | bef83d35531f40d5d067db7ed21d4a719f615cdc (diff) | |
download | mandoc-2e0f02657765c5e07ae5bc11a3a849f007ee4681.tar.gz mandoc-2e0f02657765c5e07ae5bc11a3a849f007ee4681.tar.zst mandoc-2e0f02657765c5e07ae5bc11a3a849f007ee4681.zip |
first step of 1.13.5 release preparations
-rw-r--r-- | INSTALL | 50 | ||||
-rw-r--r-- | LICENSE | 9 | ||||
-rw-r--r-- | Makefile | 16 | ||||
-rwxr-xr-x | configure | 6 | ||||
-rw-r--r-- | configure.local.example | 4 |
5 files changed, 48 insertions, 37 deletions
@@ -1,4 +1,4 @@ -$Id: INSTALL,v 1.17 2016/07/19 22:40:33 schwarze Exp $ +$Id: INSTALL,v 1.15.2.1 2017/02/21 16:25:19 schwarze Exp $ About mdocml, the portable mandoc distribution ---------------------------------------------- @@ -16,7 +16,7 @@ tech@ mailing list, too. Enjoy using the mandoc toolset! -Ingo Schwarze, Karlsruhe, July 2016 +Ingo Schwarze, Karlsruhe, February 2017 Installation @@ -31,15 +31,11 @@ Regarding how packages and ports are maintained for your operating system, please consult your operating system documentation. To install mandoc manually, the following steps are needed: -1. If you want to build the CGI program, man.cgi(8), too, run the -command "echo BUILD_CGI=1 > configure.local". Then run "cp -cgi.h.examples cgi.h" and edit cgi.h as desired. +1. If you want to build the CGI program, man.cgi(8), too, +run the command "echo BUILD_CGI=1 > configure.local". +Then run "cp cgi.h.examples cgi.h" and edit cgi.h as desired. -2. Define MANPATH_DEFAULT in configure.local -if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate -for your operating system. - -3. Run "./configure". +2. Run "./configure". This script attempts autoconfiguration of mandoc for your system. Read both its standard output and the file "Makefile.local" it generates. If anything looks wrong or different from what you @@ -49,21 +45,28 @@ result seems right to you. On Solaris 10 and earlier, you may have to run "ksh ./configure" because the native /bin/sh lacks some POSIX features. -4. Run "make". +3. Run "make". Any POSIX-compatible make, in particular both BSD make and GNU make, should work. If the build fails, look at "configure.local.example" and go back to step 2. -5. Run "make -n install" and check whether everything will be +4. Run "make -n install" and check whether everything will be installed to the intended places. Otherwise, put some *DIR or *NM* -variables into "configure.local" and go back to step 3. +variables into "configure.local" and go back to step 2. -6. Run "sudo make install". If you intend to build a binary +5. Run "sudo make install". If you intend to build a binary package using some kind of fake root mechanism, you may need a command like "make DESTDIR=... install". Read the *-install targets in the "Makefile" to understand how DESTDIR is used. -7. Run the command "sudo +6. If you want to use the integrated man(1) and your system uses +manpath(1), make sure it is configured correctly, in particular, +it returns all directory trees where manual pages are installed. +Otherwise, if your system uses man.conf(5), make sure it contains +a "manpath" line for each directory tree, and the order of these +lines meets your wishes. + +7. If you compiled with database support, run the command "sudo makewhatis" to build mandoc.db(5) databases in all the directory trees configured in step 6. Whenever installing new manual pages, re-run makewhatis(8) to update the databases, or apropos(1) will @@ -81,9 +84,20 @@ manual page source. Understanding mandoc dependencies --------------------------------- -The following libraries are required: - -1. zlib for decompressing gzipped manual pages. +The mandoc(1), man(1), and demandoc(1) utilities only depend +on the zlib library for decompressing gzipped manual pages, +but makewhatis(8) and apropos(1) depend on the following +additional software: + +1. The SQLite database system, see <http://sqlite.org/>. +The recommended version of SQLite is 3.8.4.3 or newer. The mandoc +toolset is known to work with version 3.7.5 or newer. Versions +older than 3.8.3 may not achieve full performance due to the +missing SQLITE_DETERMINISTIC optimization flag. Versions older +than 3.8.0 may not show full error information if opening a database +fails due to the missing sqlite3_errstr() API. Both are very minor +problems, apropos(1) is fully usable with SQLite 3.7.5. Versions +older than 3.7.5 may or may not work, they have not been tested. 2. The fts(3) directory traversion functions. If your system does not have them, the bundled compatibility version @@ -1,14 +1,15 @@ -$Id: LICENSE,v 1.12 2016/07/07 23:46:36 schwarze Exp $ +$Id: LICENSE,v 1.13.2.1 2017/02/21 16:25:19 schwarze Exp $ With the exceptions noted below, all code and documentation contained in the mdocml toolkit is protected by the Copyright of the following developers: Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv> -Copyright (c) 2010-2016 Ingo Schwarze <schwarze@openbsd.org> +Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org> Copyright (c) 2009, 2010, 2011, 2012 Joerg Sonnenberger <joerg@netbsd.org> Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de> -Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org> +Copyright (c) 2014 Baptiste Daroussin <bapt@freebsd.org> +Copyright (c) 2016 Ed Maste <emaste@freebsd.org> Copyright (c) 1999, 2004 Marc Espie <espie@openbsd.org> Copyright (c) 1998, 2004, 2010 Todd C. Miller <Todd.Miller@courtesan.com> Copyright (c) 2008 Otto Moerbeek <otto@drijf.net> @@ -41,7 +42,7 @@ other people's Copyright and are distributed under various 2-clause and 3-clause BSD licenses; see these individual files for details. soelim.c, soelim.1: -Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org> +Copyright (c) 2014 Baptiste Daroussin <bapt@freebsd.org> compat_err.c, compat_fts.c, compat_fts.h, compat_getsubopt.c, compat_strcasestr.c, compat_strsep.c, @@ -1,4 +1,4 @@ -# $Id: Makefile,v 1.488.2.6 2017/02/18 13:16:53 schwarze Exp $ +# $Id: Makefile,v 1.488.2.7 2017/02/21 16:25:19 schwarze Exp $ # # Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> # Copyright (c) 2011, 2013-2017 Ingo Schwarze <schwarze@openbsd.org> @@ -15,7 +15,7 @@ # 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.4 +VERSION = 1.13.5 # === LIST OF FILES ==================================================== @@ -321,11 +321,7 @@ include Makefile.local # === DEPENDENCY HANDLING ============================================== -all: base-build $(BUILD_TARGETS) Makefile.local - -base-build: mandoc demandoc soelim - -cgi-build: man.cgi +all: mandoc demandoc soelim $(BUILD_TARGETS) Makefile.local install: base-install $(INSTALL_TARGETS) @@ -353,7 +349,7 @@ clean: rm -f $(WWW_MANS) $(WWW_OBJS) rm -rf *.dSYM -base-install: base-build +base-install: mandoc demandoc soelim mkdir -p $(DESTDIR)$(BINDIR) mkdir -p $(DESTDIR)$(LIBDIR) mkdir -p $(DESTDIR)$(INCLUDEDIR) @@ -380,7 +376,7 @@ base-install: base-build $(INSTALL_MAN) tbl.7 $(DESTDIR)$(MANDIR)/man7/$(MANM_TBL).7 $(INSTALL_MAN) mandoc_char.7 $(DESTDIR)$(MANDIR)/man7 -db-install: base-build +db-install: mandoc demandoc soelim mkdir -p $(DESTDIR)$(BINDIR) mkdir -p $(DESTDIR)$(SBINDIR) mkdir -p $(DESTDIR)$(MANDIR)/man1 @@ -399,7 +395,7 @@ db-install: base-build $(INSTALL_MAN) makewhatis.8 \ $(DESTDIR)$(MANDIR)/man8/$(BINM_MAKEWHATIS).8 -cgi-install: cgi-build +cgi-install: man.cgi mkdir -p $(DESTDIR)$(CGIBINDIR) mkdir -p $(DESTDIR)$(HTDOCDIR) $(INSTALL_PROGRAM) man.cgi $(DESTDIR)$(CGIBINDIR) @@ -1,6 +1,6 @@ #!/bin/sh # -# $Id: configure,v 1.43.2.10 2017/02/17 14:50:13 schwarze Exp $ +# $Id: configure,v 1.43.2.11 2017/02/21 16:25:19 schwarze Exp $ # # Copyright (c) 2014, 2015, 2016, 2017 Ingo Schwarze <schwarze@openbsd.org> # @@ -483,8 +483,8 @@ if [ ${BUILD_DB} -eq 0 -a ${BUILD_CGI} -gt 0 ]; then BUILD_CGI=0 fi -BUILD_TARGETS="base-build" -[ ${BUILD_CGI} -gt 0 ] && BUILD_TARGETS="${BUILD_TARGETS} cgi-build" +BUILD_TARGETS="" +[ ${BUILD_CGI} -gt 0 ] && BUILD_TARGETS="${BUILD_TARGETS} man.cgi" INSTALL_TARGETS="base-install" [ ${BUILD_DB} -gt 0 ] && INSTALL_TARGETS="${INSTALL_TARGETS} db-install" [ ${BUILD_CGI} -gt 0 ] && INSTALL_TARGETS="${INSTALL_TARGETS} cgi-install" diff --git a/configure.local.example b/configure.local.example index 61b1874a..66450009 100644 --- a/configure.local.example +++ b/configure.local.example @@ -1,4 +1,4 @@ -# $Id: configure.local.example,v 1.14.2.6 2017/02/16 16:21:04 schwarze Exp $ +# $Id: configure.local.example,v 1.14.2.7 2017/02/21 16:25:19 schwarze Exp $ # # Copyright (c) 2014, 2015, 2016, 2017 Ingo Schwarze <schwarze@openbsd.org> # @@ -72,7 +72,7 @@ MANPATH_DEFAULT="/usr/share/man:/usr/X11R6/man:/usr/local/man" # If you do not want uname(3) to be called but instead want a fixed # string to be used, use the following line: -OSNAME="OpenBSD 5.9" +OSNAME="OpenBSD 6.0" # The following installation directories are used. # It is possible to set only one or a few of these variables, |