Annotation of mandoc/configure.local.example, Revision 1.30
1.30 ! schwarze 1: # $Id: configure.local.example,v 1.29 2017/02/18 12:24:24 schwarze Exp $
1.1 schwarze 2: #
1.28 schwarze 3: # Copyright (c) 2014, 2015, 2016, 2017 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 4: #
5: # Permission to use, copy, modify, and distribute this software for any
6: # purpose with or without fee is hereby granted, provided that the above
7: # copyright notice and this permission notice appear in all copies.
8: #
9: # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16:
17: # For all settings documented in this file, there are reasonable
18: # defaults and/or the ./configure script attempts autodetection.
19: # Consequently, you only need to create a file ./configure.local
20: # and put any of these settings into it if ./configure autodetection
21: # fails or if you want to make different choices for other reasons.
22:
23: # If autodetection fails, please tell <tech@mdocml.bsd.lv>.
24:
25: # We recommend that you write ./configure.local from scratch and
26: # only put the lines there you need. This file contains examples.
27: # It is not intended as a template to be copied as a whole.
28:
29: # --- user settings relevant for all builds ----------------------------
30:
31: # For -Tutf8 and -Tlocale operation, mandoc(1) requires <locale.h>
32: # providing setlocale(3) and <wchar.h> providing wcwidth(3) and
33: # putwchar(3) with a wchar_t storing UCS-4 values. Theoretically,
34: # the latter should be tested with the __STDC_ISO_10646__ feature
35: # macro. In practice, many <wchar.h> headers do not provide that
36: # macro even though they treat wchar_t as UCS-4. So the automatic
37: # test only checks that wchar_t is wide enough, that is, at least
38: # four bytes.
39:
40: # The following line forces multi-byte support.
41: # If your C library does not treat wchar_t as UCS-4, the UTF-8 output
42: # mode will print garbage.
43:
44: HAVE_WCHAR=1
45:
46: # The following line disables multi-byte support.
47: # The output modes -Tutf8 and -Tlocale will be the same as -Tascii.
48:
49: HAVE_WCHAR=0
1.18 schwarze 50:
51: # For -Tutf8 mode, mandoc needs to set an arbitrary locale having
52: # a UTF-8 character set. If autodetection of a suitable locale
53: # fails or selects an undesirable locale, you can manually choose
54: # the locale for -Tutf8 mode:
55:
56: UTF8_LOCALE=en_US.UTF-8
1.7 schwarze 57:
58: # When man(1) or apropos(1) is called without -m and -M options,
1.16 schwarze 59: # MANPATH is not set in the environment, and man.conf(5) is not
60: # available, manuals are searched for in the following directory
61: # trees by default.
1.7 schwarze 62:
63: MANPATH_DEFAULT="/usr/share/man:/usr/X11R6/man:/usr/local/man"
1.1 schwarze 64:
65: # In manual pages written in the mdoc(7) language, the operating system
66: # version is displayed in the page footer line. If an operating system
67: # is specified as an argument to the .Os macro, that is always used.
68: # If the .Os macro has no argument and an operation system is specified
69: # with the mandoc(1) -Ios= command line option, that is used.
70: # Otherwise, the uname(3) library function is called at runtime to find
71: # the name of the operating system.
72: # If you do not want uname(3) to be called but instead want a fixed
73: # string to be used, use the following line:
74:
1.15 schwarze 75: OSNAME="OpenBSD 6.0"
1.1 schwarze 76:
77: # The following installation directories are used.
78: # It is possible to set only one or a few of these variables,
79: # there is no need to copy the whole block.
80: # Even if you set PREFIX to something else, the other variables
81: # pick it up without copying them all over.
82:
83: PREFIX="/usr/local"
84: BINDIR="${PREFIX}/bin"
85: SBINDIR="${PREFIX}/sbin"
86: MANDIR="${PREFIX}/man"
1.30 ! schwarze 87:
! 88: # If BINDIR and SBINDIR are not subdirectories of the same parent
! 89: # directory or if the basename(1) of BINDIR differs from "bin",
! 90: # the relative path from SBINDIR to BINDIR is also needed.
! 91: # The default is:
! 92:
! 93: BIN_FROM_SBIN="../bin"
1.8 schwarze 94:
95: # Some distributions may want to avoid naming conflicts
96: # with the configuration files of other man(1) implementations.
97: # This changes the name of the installed section 5 manual page as well.
98: MANM_MANCONF="mandoc.conf" # default is "man.conf"
1.5 schwarze 99:
1.2 schwarze 100: # Some distributions may want to avoid naming conflicts among manuals.
101: # If you want to change the names of installed section 7 manual pages,
102: # the following alternative names are suggested.
103: # The suffix ".7" will automatically be appended.
104: # It is possible to set only one or a few of these variables,
105: # there is no need to copy the whole block.
106:
1.27 schwarze 107: MANM_MAN="mandoc_man" # default is "man"
1.2 schwarze 108: MANM_MDOC="mandoc_mdoc" # default is "mdoc"
109: MANM_ROFF="mandoc_roff" # default is "roff"
110: MANM_EQN="mandoc_eqn" # default is "eqn"
111: MANM_TBL="mandoc_tbl" # default is "tbl"
112:
1.15 schwarze 113: # Some distributions may want to avoid naming conflicts with
114: # other man(1), apropos(1), makewhatis(8), or soelim(1) utilities.
1.9 schwarze 115: # If you want to change the names of binary programs,
116: # the following alternative names are suggested.
117: # Using different names is possible as well.
1.15 schwarze 118: # This changes the names of the installed section 1 and section 8
119: # manual pages as well.
120: # It is possible to set only one or two of these variables,
121: # there is no need to copy the whole block.
1.5 schwarze 122:
123: BINM_MAN=mman # default is "man"
1.15 schwarze 124: BINM_APROPOS=mapropos # default is "apropos"
125: BINM_WHATIS=mwhatis # default is "whatis"
126: BINM_MAKEWHATIS=mandocdb # default is "makewhatis"
1.9 schwarze 127: BINM_SOELIM=msoelim # default is "soelim"
1.28 schwarze 128:
129: # Some distributions do not want hardlinks
130: # between installed binary programs.
131: # Set the following variable to use symbolic links instead.
132: # It is also used for links between manual pages.
133: # It is only used by the install* targets.
134: # When using this, DESTDIR must be empty or an absolute path.
135:
136: LN="ln -sf" # default is "ln -f"
1.5 schwarze 137:
1.11 schwarze 138: # Before falling back to the bundled version of the ohash(3) hashing
139: # library, autoconfiguration tries the following linker flag to
140: # link against your system version. If you do have ohash(3) on
141: # your system but it needs different linker flags, set the following
142: # variable to specify the required linker flags.
143:
144: LD_OHASH="-lutil"
145:
1.15 schwarze 146: # When library autodetection decides to use -L/usr/local/lib,
147: # -I/usr/local/include is automatically added to CFLAGS.
148: # If you manually set LD_OHASH to something including -L/usr/local/lib,
149: # chances are you will also need the following line:
150:
151: CFLAGS="${CFLAGS} -I/usr/local/include"
152:
1.17 schwarze 153: # Some platforms may need an additional linker flag for nanosleep(2).
154: # If none is needed or it is -lrt, it is autodetected.
155: # Otherwise, set the following variable.
1.11 schwarze 156:
1.17 schwarze 157: LD_NANOSLEEP="-lrt"
1.24 schwarze 158:
159: # Some platforms may need an additional linker flag for recvmsg(2).
160: # If none is needed or it is -lsocket, it is autodetected.
161: # Otherwise, set the following variable.
162:
163: LD_RECVMSG="-lsocket"
1.17 schwarze 164:
165: # Some platforms might need additional linker flags to link against
166: # libmandoc that are not autodetected, though no such cases are
167: # currently known.
168:
169: LDADD="-lm"
1.12 schwarze 170:
171: # Some systems may want to set additional linker flags for all the
172: # binaries, not only for those using libmandoc, for example for
173: # hardening options.
174:
175: LDFLAGS="-Wl,-z,relro"
1.11 schwarze 176:
1.1 schwarze 177: # It is possible to change the utility program used for installation
178: # and the modes files are installed with. The defaults are:
179:
180: INSTALL="install"
181: INSTALL_PROGRAM="${INSTALL} -m 0555"
182: INSTALL_LIB="${INSTALL} -m 0444"
183: INSTALL_MAN="${INSTALL} -m 0444"
184: INSTALL_DATA="${INSTALL} -m 0444"
185:
1.3 schwarze 186: # When using the "homebrew" package manager on Mac OS X, the actual
187: # manuals are located in a so-called "cellar" and only symlinked
188: # into the manual trees. To allow mandoc to follow such symlinks,
189: # you have to specify the physical location of the cellar as returned
190: # by realpath(3), for example:
191:
1.4 schwarze 192: PREFIX="/usr/local"
193: HOMEBREWDIR="${PREFIX}/Cellar"
1.22 schwarze 194:
195: # --- user settings for the mandoc(3) library --------------------------
196:
197: # By default, libmandoc.a is not installed. It is almost never needed
198: # because there is almost no non-mandoc software out there using this
199: # library. The one notable exception is NetBSD apropos(1).
200: # So, when building for the NetBSD base system - but not for NetBSD
201: # ports nor for pkgsrc! - you may want the following:
202:
203: INSTALL_LIBMANDOC=1
204:
205: # The following settings are only used when INSTALL_LIBMANDOC is set.
206:
207: INCLUDEDIR="${PREFIX}/include/mandoc"
208: LIBDIR="${PREFIX}/lib/mandoc"
1.1 schwarze 209:
1.14 schwarze 210: # --- user settings related to man.cgi ---------------------------------
1.1 schwarze 211:
212: # By default, building man.cgi(8) is disabled. To enable it, copy
213: # cgi.h.example to cgi.h, edit it, and use the following line.
214:
215: BUILD_CGI=1
216:
217: # The remaining settings in this section are only relevant if BUILD_CGI
218: # is enabled. Otherwise, they have no effect either way.
219:
220: # By default, man.cgi(8) is linked statically.
221: # Some systems do not support static linking, for example Mac OS X.
222: # In that case, use the following line:
223:
224: STATIC=
225:
226: # Some systems, for example Linux, require -pthread for static linking:
227:
228: STATIC="-static -pthread"
229:
230: # Some directories.
231: # This works just like PREFIX, see above.
232:
233: WWWPREFIX="/var/www"
234: HTDOCDIR="${WWWPREFIX}/htdocs"
235: CGIBINDIR="${WWWPREFIX}/cgi-bin"
1.23 schwarze 236:
237: # --- user settings related to catman ----------------------------------
238:
239: # By default, building mandocd(8) and catman(8) is disabled.
240: # To enable it, use the following line.
1.25 schwarze 241: # It does not work on SunOS 5.10 because there is no mkdirat(2)
242: # nor on SunOS 5.9 which also lacks CMSG_LEN(3) and CMSG_SPACE(3).
1.23 schwarze 243:
244: BUILD_CATMAN=1
1.26 schwarze 245:
246: # Install catman(8) with a different name.
247: # See BINM_MAN above for details of how this works.
248:
1.27 schwarze 249: BINM_CATMAN=mcatman # default is "catman"
1.1 schwarze 250:
251: # --- settings that rarely need to be touched --------------------------
252:
253: # Do not set these variables unless you really need to.
254:
255: # You can manually override the compiler to be used.
256: # But that's rarely useful because ./configure asks your make(1)
257: # which compiler to use, and that answer will hardly be wrong.
258:
259: CC=cc
260:
1.13 schwarze 261: # IBM AIX may need:
262:
263: CC=xlc
264:
1.1 schwarze 265: # The default compiler flags are:
266:
267: CFLAGS="-g -W -Wall -Wstrict-prototypes -Wno-unused-parameter -Wwrite-strings"
1.13 schwarze 268:
269: # IBM AIX xlc does not support -W; in that case, please use:
270:
271: CFLAGS="-g"
1.1 schwarze 272:
273: # In rare cases, it may be required to skip individual automatic tests.
274: # Each of the following variables can be set to 0 (test will not be run
275: # and will be regarded as failed) or 1 (test will not be run and will
276: # be regarded as successful).
277:
278: HAVE_DIRENT_NAMLEN=0
1.20 schwarze 279: HAVE_ENDIAN=0
1.19 schwarze 280: HAVE_EFTYPE=0
1.11 schwarze 281: HAVE_ERR=0
1.21 schwarze 282: HAVE_FTS=0 # Setting this implies HAVE_FTS_COMPARE_CONST=0.
283: HAVE_FTS_COMPARE_CONST=0 # Setting this implies HAVE_FTS=1.
1.11 schwarze 284: HAVE_GETLINE=0
1.1 schwarze 285: HAVE_GETSUBOPT=0
1.11 schwarze 286: HAVE_ISBLANK=0
287: HAVE_MKDTEMP=0
1.20 schwarze 288: HAVE_NTOHL=0
1.29 schwarze 289: HAVE_O_DIRECTORY=0
1.15 schwarze 290: HAVE_OHASH=0
1.19 schwarze 291: HAVE_PATH_MAX=0
1.11 schwarze 292: HAVE_PLEDGE=0
293: HAVE_PROGNAME=0
1.1 schwarze 294: HAVE_REALLOCARRAY=0
1.11 schwarze 295: HAVE_REWB_BSD=0
296: HAVE_REWB_SYSV=0
1.1 schwarze 297: HAVE_STRCASESTR=0
1.11 schwarze 298: HAVE_STRINGLIST=0
1.1 schwarze 299: HAVE_STRLCAT=0
300: HAVE_STRLCPY=0
301: HAVE_STRPTIME=0
302: HAVE_STRSEP=0
1.6 schwarze 303: HAVE_STRTONUM=0
1.20 schwarze 304: HAVE_SYS_ENDIAN=0
1.11 schwarze 305: HAVE_VASPRINTF=0
306: HAVE_WCHAR=0
CVSweb