Support nesting of elements with next-line scope.

[mandoc.git] / configure.local.example

diff --git a/configure.local.example b/configure.local.example
index 493c88d17be6968ca8c632a5ae211af4bb11be02..82fc2a2c28e58199d250c2d28c3c0656e0f005ba 100644 (file)
--- a/configure.local.example
+++ b/configure.local.example
@@ -1,6 +1,6 @@
-# $Id: configure.local.example,v 1.4 2015/01/23 21:59:31 schwarze Exp $
+# $Id: configure.local.example,v 1.34 2018/07/31 15:34:00 schwarze Exp $

 #
 #

-# Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
+# Copyright (c) 2014,2015,2016,2017,2018 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
 #
 # Permission to use, copy, modify, and distribute this software for any
 # purpose with or without fee is hereby granted, provided that the above


@@ -20,7 +20,7 @@
 # and put any of these settings into it if ./configure autodetection
 # fails or if you want to make different choices for other reasons.
 
 # and put any of these settings into it if ./configure autodetection
 # fails or if you want to make different choices for other reasons.
 

-# If autodetection fails, please tell <tech@mdocml.bsd.lv>.
+# If autodetection fails, please tell <tech@mandoc.bsd.lv>.

 
 # We recommend that you write ./configure.local from scratch and
 # only put the lines there you need.  This file contains examples.
 
 # We recommend that you write ./configure.local from scratch and
 # only put the lines there you need.  This file contains examples.


@@ -48,6 +48,25 @@ HAVE_WCHAR=1
 
 HAVE_WCHAR=0
 
 
 HAVE_WCHAR=0
 

+# For -Tutf8 mode, mandoc needs to set an arbitrary locale having
+# a UTF-8 character set.  If autodetection of a suitable locale
+# fails or selects an undesirable locale, you can manually choose
+# the locale for -Tutf8 mode:
+
+UTF8_LOCALE=en_US.UTF-8
+
+# When man(1) or apropos(1) is called without -m and -M options,
+# MANPATH is not set in the environment, and man.conf(5) is not
+# available, manuals are searched for in the following directory
+# trees by default.
+
+MANPATH_DEFAULT="/usr/share/man:/usr/X11R6/man:/usr/local/man"
+
+# Validation of cross references with mandoc -Tlint only looks
+# for manual pages in the following directories:
+
+MANPATH_BASE="/usr/share/man:/usr/X11R6/man"
+

 # In manual pages written in the mdoc(7) language, the operating system
 # version is displayed in the page footer line.  If an operating system
 # is specified as an argument to the .Os macro, that is always used.
 # In manual pages written in the mdoc(7) language, the operating system
 # version is displayed in the page footer line.  If an operating system
 # is specified as an argument to the .Os macro, that is always used.


@@ -58,7 +77,7 @@ HAVE_WCHAR=0
 # If you do not want uname(3) to be called but instead want a fixed
 # string to be used, use the following line:
 
 # 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.6"
+OSNAME="OpenBSD 6.3"

 
 # The following installation directories are used.
 # It is possible to set only one or a few of these variables,
 
 # The following installation directories are used.
 # It is possible to set only one or a few of these variables,


@@ -69,10 +88,20 @@ OSNAME="OpenBSD 5.6"
 PREFIX="/usr/local"
 BINDIR="${PREFIX}/bin"
 SBINDIR="${PREFIX}/sbin"
 PREFIX="/usr/local"
 BINDIR="${PREFIX}/bin"
 SBINDIR="${PREFIX}/sbin"

-INCLUDEDIR="${PREFIX}/include/mandoc"
-LIBDIR="${PREFIX}/lib/mandoc"

 MANDIR="${PREFIX}/man"
 MANDIR="${PREFIX}/man"

-EXAMPLEDIR="${PREFIX}/share/examples/mandoc"
+
+# If BINDIR and SBINDIR are not subdirectories of the same parent
+# directory or if the basename(1) of BINDIR differs from "bin",
+# the relative path from SBINDIR to BINDIR is also needed.
+# The default is:
+
+BIN_FROM_SBIN="../bin"
+
+# Some distributions may want to avoid naming conflicts
+# with the configuration files of other man(1) implementations.
+# This changes the name of the installed section 5 manual page as well.
+
+MANM_MANCONF="mandoc.conf"     # default is "man.conf"

 
 # Some distributions may want to avoid naming conflicts among manuals.
 # If you want to change the names of installed section 7 manual pages,
 
 # Some distributions may want to avoid naming conflicts among manuals.
 # If you want to change the names of installed section 7 manual pages,


@@ -87,71 +116,71 @@ MANM_ROFF="mandoc_roff"            # default is "roff"
 MANM_EQN="mandoc_eqn"          # default is "eqn"
 MANM_TBL="mandoc_tbl"          # default is "tbl"
 
 MANM_EQN="mandoc_eqn"          # default is "eqn"
 MANM_TBL="mandoc_tbl"          # default is "tbl"
 

-# It is possible to change the utility program used for installation
-# and the modes files are installed with.  The defaults are:
+# Some distributions may want to avoid naming conflicts with
+# other man(1), apropos(1), makewhatis(8), or soelim(1) utilities.
+# If you want to change the names of binary programs,
+# the following alternative names are suggested.
+# Using different names is possible as well.
+# This changes the names of the installed section 1 and section 8
+# manual pages as well.
+# It is possible to set only one or two of these variables,
+# there is no need to copy the whole block.

 
 

-INSTALL="install"
-INSTALL_PROGRAM="${INSTALL} -m 0555"
-INSTALL_LIB="${INSTALL} -m 0444"
-INSTALL_MAN="${INSTALL} -m 0444"
-INSTALL_DATA="${INSTALL} -m 0444"
+BINM_MAN=mman                  # default is "man"
+BINM_APROPOS=mapropos          # default is "apropos"
+BINM_WHATIS=mwhatis            # default is "whatis"
+BINM_MAKEWHATIS=mandocdb       # default is "makewhatis"
+BINM_SOELIM=msoelim            # default is "soelim"

 
 

-# --- user settings related to database support ------------------------
+# Some distributions do not want hardlinks
+# between installed binary programs.
+# Set the following variable to use symbolic links instead.
+# It is also used for links between manual pages.
+# It is only used by the install* targets.
+# When using this, DESTDIR must be empty or an absolute path.

 
 

-# By default, building makewhatis(8) and apropos(1) is enabled.
-# To disable it, for example to avoid the dependency on SQLite3,
-# use the following line.  It that case, the remaining settings
-# in this section are irrelevant.
+LN="ln -sf"                    # default is "ln -f"

 
 

-BUILD_DB=0
+# Before falling back to the bundled version of the ohash(3) hashing
+# library, autoconfiguration tries the following linker flag to
+# link against your system version.  If you do have ohash(3) on
+# your system but it needs different linker flags, set the following
+# variable to specify the required linker flags.

 
 

-# Two libraries are needed: SQLite3 and ohash(3).
-# Autoconfiguration tries the following linker flags to find them.
-# If none of these work, add a working DBLIB line to configure.local,
-# disabling autodetection for library directories.
+LD_OHASH="-lutil"

 
 

-DBLIB="-lsqlite3"
-DBLIB="-lsqlite3 -lutil"
-DBLIB="-L/usr/local/lib -lsqlite3"
+# Some platforms may need an additional linker flag for nanosleep(2).
+# If none is needed or it is -lrt, it is autodetected.
+# Otherwise, set the following variable.

 
 

-# When library autodetection decides to use -L/usr/local/lib,
-# -I/usr/local/include is automatically added to CFLAGS.
-# If you manually set DBLIB to something including -L/usr/local/lib,
-# chances are you will also need the following line:
+LD_NANOSLEEP="-lrt"

 
 

-CFLAGS="${CFLAGS} -I/usr/local/include"
+# Some platforms may need an additional linker flag for recvmsg(2).
+# If none is needed or it is -lsocket, it is autodetected.
+# Otherwise, set the following variable.

 
 

-# The man(1) utility needs to know where the manuals reside.
-# We know of two ways to tell it: via manpath(1) or man.conf(5).
-# The latter is used by OpenBSD and NetBSD, the former by most
-# other systems.
+LD_RECVMSG="-lsocket"

 
 

-# Force usage of manpath(1).
-# If it is not installed or not operational,
-# makewhatis(8) and apropos(1) will not work properly.
+# Some platforms might need additional linker flags to link against
+# libmandoc that are not autodetected, though no such cases are
+# currently known.

 
 

-HAVE_MANPATH=1
+LDADD="-lm"

 
 

-# Force usage of man.conf(5).
-# If it does not exist or contains no valid configuration,
-# makewhatis(8) and apropos(1) will not work properly.
+# Some systems may want to set additional linker flags for all the
+# binaries, not only for those using libmandoc, for example for
+# hardening options.

 
 

-HAVE_MANPATH=0
+LDFLAGS="-Wl,-z,relro"

 
 

-# Some distributions may want to avoid naming conflicts
-# with groff, man-db, or other tools.
-# If you want to change the names of binary programs,
-# the following alternative names are suggested.
-# Using other names is possible as well.
-# This changes the names of the installed section 1 and section 8
-# manual pages as well.
-# It is possible to set only one or a few of these variables,
-# there is no need to copy the whole block.
+# It is possible to change the utility program used for installation
+# and the modes files are installed with.  The defaults are:

 
 

-BINM_APROPOS=mapropos          # default is "apropos"
-BINM_MAN=mman                  # default is "man"
-BINM_WHATIS=mwhatis            # default is "whatis"
-BINM_MAKEWHATIS=mandocdb       # default is "makewhatis"
+INSTALL="install"
+INSTALL_PROGRAM="${INSTALL} -m 0555"
+INSTALL_LIB="${INSTALL} -m 0444"
+INSTALL_MAN="${INSTALL} -m 0444"
+INSTALL_DATA="${INSTALL} -m 0444"

 
 # When using the "homebrew" package manager on Mac OS X, the actual
 # manuals are located in a so-called "cellar" and only symlinked
 
 # When using the "homebrew" package manager on Mac OS X, the actual
 # manuals are located in a so-called "cellar" and only symlinked


@@ -162,27 +191,47 @@ BINM_MAKEWHATIS=mandocdb  # default is "makewhatis"
 PREFIX="/usr/local"
 HOMEBREWDIR="${PREFIX}/Cellar"
 
 PREFIX="/usr/local"
 HOMEBREWDIR="${PREFIX}/Cellar"
 

-# --- user settings related man.cgi ------------------------------------
+# --- user settings for the mandoc(3) library --------------------------
+
+# By default, libmandoc.a is not installed.  It is almost never needed
+# because there is almost no non-mandoc software out there using this
+# library.  The one notable exception is NetBSD apropos(1).
+# So, when building for the NetBSD base system - but not for NetBSD
+# ports nor for pkgsrc! - you may want the following:
+
+INSTALL_LIBMANDOC=1
+
+# The following settings are only used when INSTALL_LIBMANDOC is set.
+
+INCLUDEDIR="${PREFIX}/include/mandoc"
+LIBDIR="${PREFIX}/lib/mandoc"
+
+# --- user settings related to man.cgi ---------------------------------

 
 # By default, building man.cgi(8) is disabled.  To enable it, copy
 # cgi.h.example to cgi.h, edit it, and use the following line.
 
 # By default, building man.cgi(8) is disabled.  To enable it, copy
 # cgi.h.example to cgi.h, edit it, and use the following line.

-# Obviously, this requires that BUILD_DB is enabled, too.

 
 BUILD_CGI=1
 
 # The remaining settings in this section are only relevant if BUILD_CGI
 # is enabled.  Otherwise, they have no effect either way.
 
 
 BUILD_CGI=1
 
 # The remaining settings in this section are only relevant if BUILD_CGI
 # is enabled.  Otherwise, they have no effect either way.
 

-# By default, man.cgi(8) is linked statically.
-# Some systems do not support static linking, for example Mac OS X.
-# In that case, use the following line:
+# By default, man.cgi(8) is linked statically if the compiler supports
+# the -static option.  If automatic detection fails, you can force
+# static linking of man.cgi(8).

 
 

-STATIC=
+STATIC="-static"

 
 

-# Some systems, for example Linux, require -pthread for static linking:
+# Some systems may require -pthread for static linking:

 
 STATIC="-static -pthread"
 
 
 STATIC="-static -pthread"
 

+# If static linking works in general but not with additional libraries
+# like -lrt or -lz, you can force dynamic linking.  This may for
+# example be required on SunOS 5.9.
+
+STATIC=" "
+

 # Some directories.
 # This works just like PREFIX, see above.
 
 # Some directories.
 # This works just like PREFIX, see above.
 


@@ -190,6 +239,20 @@ WWWPREFIX="/var/www"
 HTDOCDIR="${WWWPREFIX}/htdocs"
 CGIBINDIR="${WWWPREFIX}/cgi-bin"
 
 HTDOCDIR="${WWWPREFIX}/htdocs"
 CGIBINDIR="${WWWPREFIX}/cgi-bin"
 

+# --- user settings related to catman ----------------------------------
+
+# By default, building mandocd(8) and catman(8) is disabled.
+# To enable it, use the following line.
+# It does not work on SunOS 5.10 because there is no mkdirat(2)
+# nor on SunOS 5.9 which also lacks CMSG_LEN(3) and CMSG_SPACE(3).
+
+BUILD_CATMAN=1
+
+# Install catman(8) with a different name.
+# See BINM_MAN above for details of how this works.
+
+BINM_CATMAN=mcatman            # default is "catman"
+

 # --- settings that rarely need to be touched --------------------------
 
 # Do not set these variables unless you really need to.
 # --- settings that rarely need to be touched --------------------------
 
 # Do not set these variables unless you really need to.


@@ -200,9 +263,21 @@ CGIBINDIR="${WWWPREFIX}/cgi-bin"
 
 CC=cc
 
 
 CC=cc
 

-# The default compiler flags are:
+# Because the system compiler may not provide <stdint.h>,
+# SunOS 5.9 may need:

 
 

-CFLAGS="-g -W -Wall -Wstrict-prototypes -Wno-unused-parameter -Wwrite-strings"
+CC=gcc
+
+# IBM AIX may need:
+
+CC=xlc
+
+# Normally, leave CFLAGS unset.  In that case, -g will automatically
+# be used, and various -W options will be added if the compiler
+# supports them.  If you define CFLAGS manually, it will be used
+# unchanged, and nothing will be added.
+
+CFLAGS="-g"

 
 # In rare cases, it may be required to skip individual automatic tests.
 # Each of the following variables can be set to 0 (test will not be run
 
 # In rare cases, it may be required to skip individual automatic tests.
 # Each of the following variables can be set to 0 (test will not be run


@@ -210,17 +285,32 @@ CFLAGS="-g -W -Wall -Wstrict-prototypes -Wno-unused-parameter -Wwrite-strings"
 # be regarded as successful).
 
 HAVE_DIRENT_NAMLEN=0
 # be regarded as successful).
 
 HAVE_DIRENT_NAMLEN=0

-HAVE_FGETLN=0
-HAVE_FTS=0
+HAVE_ENDIAN=0
+HAVE_EFTYPE=0
+HAVE_ERR=0
+HAVE_FTS=0  # Setting this implies HAVE_FTS_COMPARE_CONST=0.
+HAVE_FTS_COMPARE_CONST=0  # Setting this implies HAVE_FTS=1.
+HAVE_GETLINE=0

 HAVE_GETSUBOPT=0
 HAVE_GETSUBOPT=0

-HAVE_MMAP=0
+HAVE_ISBLANK=0
+HAVE_MKDTEMP=0
+HAVE_NTOHL=0
+HAVE_O_DIRECTORY=0
+HAVE_OHASH=0
+HAVE_PATH_MAX=0
+HAVE_PLEDGE=0
+HAVE_PROGNAME=0

 HAVE_REALLOCARRAY=0
 HAVE_REALLOCARRAY=0

+HAVE_RECALLOCARRAY=0
+HAVE_REWB_BSD=0
+HAVE_REWB_SYSV=0

 HAVE_STRCASESTR=0
 HAVE_STRCASESTR=0

+HAVE_STRINGLIST=0

 HAVE_STRLCAT=0
 HAVE_STRLCPY=0
 HAVE_STRPTIME=0
 HAVE_STRSEP=0
 HAVE_STRLCAT=0
 HAVE_STRLCPY=0
 HAVE_STRPTIME=0
 HAVE_STRSEP=0

-
-HAVE_SQLITE3=0
-HAVE_SQLITE3_ERRSTR=0
-HAVE_OHASH=0
+HAVE_STRTONUM=0
+HAVE_SYS_ENDIAN=0
+HAVE_VASPRINTF=0
+HAVE_WCHAR=0