Annotation of mandoc/configure.local.example, Revision 1.29
1.29 ! schwarze 1: # $Id: configure.local.example,v 1.28 2017/02/16 16:09:33 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.8 schwarze 87:
88: # Some distributions may want to avoid naming conflicts
89: # with the configuration files of other man(1) implementations.
90: # This changes the name of the installed section 5 manual page as well.
91: MANM_MANCONF="mandoc.conf" # default is "man.conf"
1.5 schwarze 92:
1.2 schwarze 93: # Some distributions may want to avoid naming conflicts among manuals.
94: # If you want to change the names of installed section 7 manual pages,
95: # the following alternative names are suggested.
96: # The suffix ".7" will automatically be appended.
97: # It is possible to set only one or a few of these variables,
98: # there is no need to copy the whole block.
99:
1.27 schwarze 100: MANM_MAN="mandoc_man" # default is "man"
1.2 schwarze 101: MANM_MDOC="mandoc_mdoc" # default is "mdoc"
102: MANM_ROFF="mandoc_roff" # default is "roff"
103: MANM_EQN="mandoc_eqn" # default is "eqn"
104: MANM_TBL="mandoc_tbl" # default is "tbl"
105:
1.15 schwarze 106: # Some distributions may want to avoid naming conflicts with
107: # other man(1), apropos(1), makewhatis(8), or soelim(1) utilities.
1.9 schwarze 108: # If you want to change the names of binary programs,
109: # the following alternative names are suggested.
110: # Using different names is possible as well.
1.15 schwarze 111: # This changes the names of the installed section 1 and section 8
112: # manual pages as well.
113: # It is possible to set only one or two of these variables,
114: # there is no need to copy the whole block.
1.5 schwarze 115:
116: BINM_MAN=mman # default is "man"
1.15 schwarze 117: BINM_APROPOS=mapropos # default is "apropos"
118: BINM_WHATIS=mwhatis # default is "whatis"
119: BINM_MAKEWHATIS=mandocdb # default is "makewhatis"
1.9 schwarze 120: BINM_SOELIM=msoelim # default is "soelim"
1.28 schwarze 121:
122: # Some distributions do not want hardlinks
123: # between installed binary programs.
124: # Set the following variable to use symbolic links instead.
125: # It is also used for links between manual pages.
126: # It is only used by the install* targets.
127: # When using this, DESTDIR must be empty or an absolute path.
128:
129: LN="ln -sf" # default is "ln -f"
1.5 schwarze 130:
1.11 schwarze 131: # Before falling back to the bundled version of the ohash(3) hashing
132: # library, autoconfiguration tries the following linker flag to
133: # link against your system version. If you do have ohash(3) on
134: # your system but it needs different linker flags, set the following
135: # variable to specify the required linker flags.
136:
137: LD_OHASH="-lutil"
138:
1.15 schwarze 139: # When library autodetection decides to use -L/usr/local/lib,
140: # -I/usr/local/include is automatically added to CFLAGS.
141: # If you manually set LD_OHASH to something including -L/usr/local/lib,
142: # chances are you will also need the following line:
143:
144: CFLAGS="${CFLAGS} -I/usr/local/include"
145:
1.17 schwarze 146: # Some platforms may need an additional linker flag for nanosleep(2).
147: # If none is needed or it is -lrt, it is autodetected.
148: # Otherwise, set the following variable.
1.11 schwarze 149:
1.17 schwarze 150: LD_NANOSLEEP="-lrt"
1.24 schwarze 151:
152: # Some platforms may need an additional linker flag for recvmsg(2).
153: # If none is needed or it is -lsocket, it is autodetected.
154: # Otherwise, set the following variable.
155:
156: LD_RECVMSG="-lsocket"
1.17 schwarze 157:
158: # Some platforms might need additional linker flags to link against
159: # libmandoc that are not autodetected, though no such cases are
160: # currently known.
161:
162: LDADD="-lm"
1.12 schwarze 163:
164: # Some systems may want to set additional linker flags for all the
165: # binaries, not only for those using libmandoc, for example for
166: # hardening options.
167:
168: LDFLAGS="-Wl,-z,relro"
1.11 schwarze 169:
1.1 schwarze 170: # It is possible to change the utility program used for installation
171: # and the modes files are installed with. The defaults are:
172:
173: INSTALL="install"
174: INSTALL_PROGRAM="${INSTALL} -m 0555"
175: INSTALL_LIB="${INSTALL} -m 0444"
176: INSTALL_MAN="${INSTALL} -m 0444"
177: INSTALL_DATA="${INSTALL} -m 0444"
178:
1.3 schwarze 179: # When using the "homebrew" package manager on Mac OS X, the actual
180: # manuals are located in a so-called "cellar" and only symlinked
181: # into the manual trees. To allow mandoc to follow such symlinks,
182: # you have to specify the physical location of the cellar as returned
183: # by realpath(3), for example:
184:
1.4 schwarze 185: PREFIX="/usr/local"
186: HOMEBREWDIR="${PREFIX}/Cellar"
1.22 schwarze 187:
188: # --- user settings for the mandoc(3) library --------------------------
189:
190: # By default, libmandoc.a is not installed. It is almost never needed
191: # because there is almost no non-mandoc software out there using this
192: # library. The one notable exception is NetBSD apropos(1).
193: # So, when building for the NetBSD base system - but not for NetBSD
194: # ports nor for pkgsrc! - you may want the following:
195:
196: INSTALL_LIBMANDOC=1
197:
198: # The following settings are only used when INSTALL_LIBMANDOC is set.
199:
200: INCLUDEDIR="${PREFIX}/include/mandoc"
201: LIBDIR="${PREFIX}/lib/mandoc"
1.1 schwarze 202:
1.14 schwarze 203: # --- user settings related to man.cgi ---------------------------------
1.1 schwarze 204:
205: # By default, building man.cgi(8) is disabled. To enable it, copy
206: # cgi.h.example to cgi.h, edit it, and use the following line.
207:
208: BUILD_CGI=1
209:
210: # The remaining settings in this section are only relevant if BUILD_CGI
211: # is enabled. Otherwise, they have no effect either way.
212:
213: # By default, man.cgi(8) is linked statically.
214: # Some systems do not support static linking, for example Mac OS X.
215: # In that case, use the following line:
216:
217: STATIC=
218:
219: # Some systems, for example Linux, require -pthread for static linking:
220:
221: STATIC="-static -pthread"
222:
223: # Some directories.
224: # This works just like PREFIX, see above.
225:
226: WWWPREFIX="/var/www"
227: HTDOCDIR="${WWWPREFIX}/htdocs"
228: CGIBINDIR="${WWWPREFIX}/cgi-bin"
1.23 schwarze 229:
230: # --- user settings related to catman ----------------------------------
231:
232: # By default, building mandocd(8) and catman(8) is disabled.
233: # To enable it, use the following line.
1.25 schwarze 234: # It does not work on SunOS 5.10 because there is no mkdirat(2)
235: # nor on SunOS 5.9 which also lacks CMSG_LEN(3) and CMSG_SPACE(3).
1.23 schwarze 236:
237: BUILD_CATMAN=1
1.26 schwarze 238:
239: # Install catman(8) with a different name.
240: # See BINM_MAN above for details of how this works.
241:
1.27 schwarze 242: BINM_CATMAN=mcatman # default is "catman"
1.1 schwarze 243:
244: # --- settings that rarely need to be touched --------------------------
245:
246: # Do not set these variables unless you really need to.
247:
248: # You can manually override the compiler to be used.
249: # But that's rarely useful because ./configure asks your make(1)
250: # which compiler to use, and that answer will hardly be wrong.
251:
252: CC=cc
253:
1.13 schwarze 254: # IBM AIX may need:
255:
256: CC=xlc
257:
1.1 schwarze 258: # The default compiler flags are:
259:
260: CFLAGS="-g -W -Wall -Wstrict-prototypes -Wno-unused-parameter -Wwrite-strings"
1.13 schwarze 261:
262: # IBM AIX xlc does not support -W; in that case, please use:
263:
264: CFLAGS="-g"
1.1 schwarze 265:
266: # In rare cases, it may be required to skip individual automatic tests.
267: # Each of the following variables can be set to 0 (test will not be run
268: # and will be regarded as failed) or 1 (test will not be run and will
269: # be regarded as successful).
270:
271: HAVE_DIRENT_NAMLEN=0
1.20 schwarze 272: HAVE_ENDIAN=0
1.19 schwarze 273: HAVE_EFTYPE=0
1.11 schwarze 274: HAVE_ERR=0
1.21 schwarze 275: HAVE_FTS=0 # Setting this implies HAVE_FTS_COMPARE_CONST=0.
276: HAVE_FTS_COMPARE_CONST=0 # Setting this implies HAVE_FTS=1.
1.11 schwarze 277: HAVE_GETLINE=0
1.1 schwarze 278: HAVE_GETSUBOPT=0
1.11 schwarze 279: HAVE_ISBLANK=0
280: HAVE_MKDTEMP=0
1.20 schwarze 281: HAVE_NTOHL=0
1.29 ! schwarze 282: HAVE_O_DIRECTORY=0
1.15 schwarze 283: HAVE_OHASH=0
1.19 schwarze 284: HAVE_PATH_MAX=0
1.11 schwarze 285: HAVE_PLEDGE=0
286: HAVE_PROGNAME=0
1.1 schwarze 287: HAVE_REALLOCARRAY=0
1.11 schwarze 288: HAVE_REWB_BSD=0
289: HAVE_REWB_SYSV=0
1.1 schwarze 290: HAVE_STRCASESTR=0
1.11 schwarze 291: HAVE_STRINGLIST=0
1.1 schwarze 292: HAVE_STRLCAT=0
293: HAVE_STRLCPY=0
294: HAVE_STRPTIME=0
295: HAVE_STRSEP=0
1.6 schwarze 296: HAVE_STRTONUM=0
1.20 schwarze 297: HAVE_SYS_ENDIAN=0
1.11 schwarze 298: HAVE_VASPRINTF=0
299: HAVE_WCHAR=0
CVSweb