configure.local.example revision 279527
1# $Id: configure.local.example,v 1.6 2015/02/16 14:56:22 schwarze Exp $
2#
3# Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
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
44HAVE_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
49HAVE_WCHAR=0
50
51# In manual pages written in the mdoc(7) language, the operating system
52# version is displayed in the page footer line.  If an operating system
53# is specified as an argument to the .Os macro, that is always used.
54# If the .Os macro has no argument and an operation system is specified
55# with the mandoc(1) -Ios= command line option, that is used.
56# Otherwise, the uname(3) library function is called at runtime to find
57# the name of the operating system.
58# If you do not want uname(3) to be called but instead want a fixed
59# string to be used, use the following line:
60
61OSNAME="OpenBSD 5.6"
62
63# The following installation directories are used.
64# It is possible to set only one or a few of these variables,
65# there is no need to copy the whole block.
66# Even if you set PREFIX to something else, the other variables
67# pick it up without copying them all over.
68
69PREFIX="/usr/local"
70BINDIR="${PREFIX}/bin"
71SBINDIR="${PREFIX}/sbin"
72INCLUDEDIR="${PREFIX}/include/mandoc"
73LIBDIR="${PREFIX}/lib/mandoc"
74MANDIR="${PREFIX}/man"
75EXAMPLEDIR="${PREFIX}/share/examples/mandoc"
76
77# The man(1) utility needs to know where the manuals reside.
78# We know of two ways to tell it: via manpath(1) or man.conf(5).
79# The latter is used by OpenBSD and NetBSD, the former by most
80# other systems.
81
82# Force usage of manpath(1).
83# If it is not installed or not operational,
84# man(1), makewhatis(8), and apropos(1) will not work properly.
85HAVE_MANPATH=1
86
87# Force usage of man.conf(5).
88# If it does not exist or contains no valid configuration,
89# man(1), makewhatis(8), and apropos(1) will not work properly.
90HAVE_MANPATH=0
91
92# Some distributions may want to avoid naming conflicts among manuals.
93# If you want to change the names of installed section 7 manual pages,
94# the following alternative names are suggested.
95# The suffix ".7" will automatically be appended.
96# It is possible to set only one or a few of these variables,
97# there is no need to copy the whole block.
98
99MANM_MAN="mandoc_man"		# default is "man"
100MANM_MDOC="mandoc_mdoc"		# default is "mdoc"
101MANM_ROFF="mandoc_roff"		# default is "roff"
102MANM_EQN="mandoc_eqn"		# default is "eqn"
103MANM_TBL="mandoc_tbl"		# default is "tbl"
104
105# Some distributions may want to avoid naming conflicts
106# with another man(1) utility.
107# If you want to change the name of the binary program,
108# the following alternative name is suggested.
109# Using a different name is possible as well.
110# This changes the name of the installed section 1 manual page as well.
111
112BINM_MAN=mman			# default is "man"
113
114# It is possible to change the utility program used for installation
115# and the modes files are installed with.  The defaults are:
116
117INSTALL="install"
118INSTALL_PROGRAM="${INSTALL} -m 0555"
119INSTALL_LIB="${INSTALL} -m 0444"
120INSTALL_MAN="${INSTALL} -m 0444"
121INSTALL_DATA="${INSTALL} -m 0444"
122
123# --- user settings related to database support ------------------------
124
125# By default, building makewhatis(8) and apropos(1) is enabled.
126# To disable it, for example to avoid the dependency on SQLite3,
127# use the following line.  It that case, the remaining settings
128# in this section are irrelevant.
129
130BUILD_DB=0
131
132# Two libraries are needed: SQLite3 and ohash(3).
133# Autoconfiguration tries the following linker flags to find them.
134# If none of these work, add a working DBLIB line to configure.local,
135# disabling autodetection for library directories.
136
137DBLIB="-lsqlite3"
138DBLIB="-lsqlite3 -lutil"
139DBLIB="-L/usr/local/lib -lsqlite3"
140
141# When library autodetection decides to use -L/usr/local/lib,
142# -I/usr/local/include is automatically added to CFLAGS.
143# If you manually set DBLIB to something including -L/usr/local/lib,
144# chances are you will also need the following line:
145
146CFLAGS="${CFLAGS} -I/usr/local/include"
147
148# Some distributions may want to avoid naming conflicts
149# with another implementation of apropos(1) and makewhatis(8).
150# If you want to change the names of the binary programs,
151# the following alternative names are suggested.
152# Using other names is possible as well.
153# This changes the names of the installed section 1 and section 8
154# manual pages as well.
155# It is possible to set only one or two of these variables,
156# there is no need to copy the whole block.
157
158BINM_APROPOS=mapropos		# default is "apropos"
159BINM_WHATIS=mwhatis		# default is "whatis"
160BINM_MAKEWHATIS=mandocdb	# default is "makewhatis"
161
162# When using the "homebrew" package manager on Mac OS X, the actual
163# manuals are located in a so-called "cellar" and only symlinked
164# into the manual trees.  To allow mandoc to follow such symlinks,
165# you have to specify the physical location of the cellar as returned
166# by realpath(3), for example:
167
168PREFIX="/usr/local"
169HOMEBREWDIR="${PREFIX}/Cellar"
170
171# --- user settings related man.cgi ------------------------------------
172
173# By default, building man.cgi(8) is disabled.  To enable it, copy
174# cgi.h.example to cgi.h, edit it, and use the following line.
175# Obviously, this requires that BUILD_DB is enabled, too.
176
177BUILD_CGI=1
178
179# The remaining settings in this section are only relevant if BUILD_CGI
180# is enabled.  Otherwise, they have no effect either way.
181
182# By default, man.cgi(8) is linked statically.
183# Some systems do not support static linking, for example Mac OS X.
184# In that case, use the following line:
185
186STATIC=
187
188# Some systems, for example Linux, require -pthread for static linking:
189
190STATIC="-static -pthread"
191
192# Some directories.
193# This works just like PREFIX, see above.
194
195WWWPREFIX="/var/www"
196HTDOCDIR="${WWWPREFIX}/htdocs"
197CGIBINDIR="${WWWPREFIX}/cgi-bin"
198
199# --- settings that rarely need to be touched --------------------------
200
201# Do not set these variables unless you really need to.
202
203# You can manually override the compiler to be used.
204# But that's rarely useful because ./configure asks your make(1)
205# which compiler to use, and that answer will hardly be wrong.
206
207CC=cc
208
209# The default compiler flags are:
210
211CFLAGS="-g -W -Wall -Wstrict-prototypes -Wno-unused-parameter -Wwrite-strings"
212
213# In rare cases, it may be required to skip individual automatic tests.
214# Each of the following variables can be set to 0 (test will not be run
215# and will be regarded as failed) or 1 (test will not be run and will
216# be regarded as successful).
217
218HAVE_DIRENT_NAMLEN=0
219HAVE_FGETLN=0
220HAVE_FTS=0
221HAVE_GETSUBOPT=0
222HAVE_MMAP=0
223HAVE_REALLOCARRAY=0
224HAVE_STRCASESTR=0
225HAVE_STRLCAT=0
226HAVE_STRLCPY=0
227HAVE_STRPTIME=0
228HAVE_STRSEP=0
229HAVE_STRTONUM=0
230
231HAVE_SQLITE3=0
232HAVE_SQLITE3_ERRSTR=0
233HAVE_OHASH=0
234