Explain how to transform markup for the terminal when not using a

[mandoc.git] / configure.local.example

diff --git a/configure.local.example b/configure.local.example
index 18a84fbdea09b15a1197ad47c5c2286c351a3b4f..4a583ad0bab24e64f5ba450eb644fdae2f5eeb91 100644 (file)
--- a/configure.local.example
+++ b/configure.local.example
@@ -1,6 +1,6 @@
-# $Id: configure.local.example,v 1.17 2016/07/20 14:03:06 schwarze Exp $
+# $Id: configure.local.example,v 1.33 2017/07/20 16:24:53 schwarze Exp $

 #
 #

-# Copyright (c) 2014, 2015, 2016 Ingo Schwarze <schwarze@openbsd.org>
+# Copyright (c) 2014, 2015, 2016, 2017 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,13 @@ 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
 # 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


@@ -55,6 +62,11 @@ HAVE_WCHAR=0
 
 MANPATH_DEFAULT="/usr/share/man:/usr/X11R6/man:/usr/local/man"
 
 
 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.


@@ -76,10 +88,15 @@ OSNAME="OpenBSD 6.0"
 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"
 

+# 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.
 # 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.


@@ -114,6 +131,15 @@ BINM_WHATIS=mwhatis                # default is "whatis"
 BINM_MAKEWHATIS=mandocdb       # default is "makewhatis"
 BINM_SOELIM=msoelim            # default is "soelim"
 
 BINM_MAKEWHATIS=mandocdb       # default is "makewhatis"
 BINM_SOELIM=msoelim            # default is "soelim"
 

+# 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.
+
+LN="ln -sf"                    # default is "ln -f"
+

 # 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
 # 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


@@ -135,6 +161,12 @@ CFLAGS="${CFLAGS} -I/usr/local/include"
 
 LD_NANOSLEEP="-lrt"
 
 
 LD_NANOSLEEP="-lrt"
 

+# 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.
+
+LD_RECVMSG="-lsocket"
+

 # Some platforms might need additional linker flags to link against
 # libmandoc that are not autodetected, though no such cases are
 # currently known.
 # Some platforms might need additional linker flags to link against
 # libmandoc that are not autodetected, though no such cases are
 # currently known.


@@ -165,6 +197,21 @@ INSTALL_DATA="${INSTALL} -m 0444"
 PREFIX="/usr/local"
 HOMEBREWDIR="${PREFIX}/Cellar"
 
 PREFIX="/usr/local"
 HOMEBREWDIR="${PREFIX}/Cellar"
 

+# --- 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
 # --- user settings related to man.cgi ---------------------------------
 
 # By default, building man.cgi(8) is disabled.  To enable it, copy


@@ -192,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.


@@ -220,16 +281,23 @@ CFLAGS="-g"
 # be regarded as successful).
 
 HAVE_DIRENT_NAMLEN=0
 # be regarded as successful).
 
 HAVE_DIRENT_NAMLEN=0

+HAVE_ENDIAN=0
+HAVE_EFTYPE=0

 HAVE_ERR=0
 HAVE_ERR=0

-HAVE_FTS=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_ISBLANK=0
 HAVE_MKDTEMP=0
 HAVE_GETLINE=0
 HAVE_GETSUBOPT=0
 HAVE_ISBLANK=0
 HAVE_MKDTEMP=0

+HAVE_NTOHL=0
+HAVE_O_DIRECTORY=0

 HAVE_OHASH=0
 HAVE_OHASH=0

+HAVE_PATH_MAX=0

 HAVE_PLEDGE=0
 HAVE_PROGNAME=0
 HAVE_REALLOCARRAY=0
 HAVE_PLEDGE=0
 HAVE_PROGNAME=0
 HAVE_REALLOCARRAY=0

+HAVE_RECALLOCARRAY=0

 HAVE_REWB_BSD=0
 HAVE_REWB_SYSV=0
 HAVE_STRCASESTR=0
 HAVE_REWB_BSD=0
 HAVE_REWB_SYSV=0
 HAVE_STRCASESTR=0


@@ -239,5 +307,6 @@ HAVE_STRLCPY=0
 HAVE_STRPTIME=0
 HAVE_STRSEP=0
 HAVE_STRTONUM=0
 HAVE_STRPTIME=0
 HAVE_STRSEP=0
 HAVE_STRTONUM=0

+HAVE_SYS_ENDIAN=0

 HAVE_VASPRINTF=0
 HAVE_WCHAR=0
 HAVE_VASPRINTF=0
 HAVE_WCHAR=0