contrib/bind/man/Makefile

   1 #
   2 # Makefile to install the BIND 4.9 manual entries.
   3 #
   4 # Default Configuration:
   5 #       There are a set of default assignments immediately following this
   6 #       note. These defaults are for BSD4.4, BSD/386, other net2-alikes,
   7 #       and will install manual entries with following characteristics:
   8 #       o  They will be catable (i.e., passed through nroff)
   9 #       o  They will be installed in the directories
  10 #               /usr/share/man/catN, where N is 1, 3, 5, 7, 8
  11 #       o  They will have an extension of `.0'
  12 #
  13 # Don't change these defaults. Instead, following the default configuration
  14 # are sets of commented values for particular systems that can be used
  15 # to override the default values.
  16 #
  17
  18 #
  19 # Target directory for the manual directory tree. Eg., may be used to
  20 # specify the path of an NFS-mounted directory for common files.
  21 #
  22 DESTDIR=
  23
  24 #
  25 # Default location for manual section directories.
  26 #
  27 DESTMAN= /usr/share/man
  28
  29 #
  30 # Install manuals in ${MANDIR}N. For systems that generate catable manual
  31 # entries on the fly, use
  32 #       MANDIR = man
  33 #
  34 MANDIR = cat
  35
  36 #
  37 # Default extension for manual entries. To install the manual entries under
  38 # their `real' extensions use
  39 #       CATEXT = $$N
  40 #
  41 CATEXT = 0
  42
  43 #
  44 # Command to install manual entries
  45 #
  46 INSTALL= install
  47
  48 #
  49 # `install' options to set Owner and Group for manual entries. Eg. for
  50 # BSD `install' use
  51 #       MAN_OWNER = -o bin
  52 #       MAN_GROUP = -g bin
  53 #
  54 MAN_OWNER =
  55 MAN_GROUP =
  56
  57 SHELL= /bin/sh
  58
  59 INDOT=
  60 XFER_INDOT=
  61 #
  62 # Uppercase versions of the above variables (`INDOT_U' and `XFER_INDOT_U')
  63 # are defined for use in `.TH' lines.
  64 #
  65
  66 #
  67 # Command used to generate a manual entry. By default this produces catable
  68 # manual entries.
  69 #
  70 # For systems that store manuals in source form (eg SunOS 4.x and SunOS 5.x)
  71 # and generate catable manual entries on the fly the following assignment
  72 # can be used.
  73 #       MANROFF = cat
  74 #
  75 MANROFF = ( tbl | nroff -man )
  76
  77 #
  78 # Default extensions for installed manual entries. The following variables
  79 # have been defined to allow BIND's manual entries to be installed in the
  80 # right place for a given platform.
  81 #
  82 #       CMD_EXT = extension for user commands (eg, dig)
  83 #       LIB_NETWORK_EXT = extension for network library routines (eg,
  84 #                       gethostbyname)
  85 #       FORMAT_EXT = extension for files describing file formats
  86 #                       (eg, resolver)
  87 #       DESC_EXT = extension for descriptive files (eg, mailaddr)
  88 #       SYS_OPS_EXT =  extension system operation and maintenance commands
  89 #                       and applications. (eg, named, named-xfer, syslog)
  90 #
  91 # Associated with each variable is an additional variable with the suffix
  92 # `_DIR' that specifies the suffix to ${MANDIR}. It's needed because on
  93 # some systems, eg., Ultrix, multiple subsections (eg 3x, 3m 3n) are
  94 # stored in generic manual section directories (eg., man3).
  95 #
  96 # Associated with each variable is an additional variable with the suffix
  97 # `_U' which gives the upper case form of the variable for use in `.TH'
  98 # commands. Useful for platforms (such as Solaris 2) that include letters
  99 # in manual sections.
 100 #
 101 CMD_EXT = 1
 102 CMD_EXT_DIR = ${CMD_EXT}
 103 LIB_NETWORK_EXT = 3
 104 LIB_NETWORK_EXT_DIR = ${LIB_NETWORK_EXT}
 105 FORMAT_EXT = 5
 106 FORMAT_EXT_DIR = ${FORMAT_EXT}
 107 DESC_EXT = 7
 108 DESC_EXT_DIR = ${DESC_EXT}
 109 SYS_OPS_EXT = 8
 110 SYS_OPS_EXT_DIR = ${SYS_OPS_EXT}
 111
 112 #
 113 # Additional variables are defined for cross-references within manual
 114 # entries:
 115 #       SYSCALL_EXT = extension for system calls
 116 #       BSD_SYSCALL_EXT = extension for BSD-specifc system calls. On some
 117 #                       systems (eg Ultrix) these appear in section 2.
 118 #                       On other system (eg SunOS 5) these are implemented
 119 #                       via a BSD-compatibility library and appear in
 120 #                       section 3.
 121 #       LIB_C_EXT = extension for C library routines (eg, signal)
 122 #
 123 SYSCALL_EXT = 2
 124 SYSCALL_EXT_DIR = ${SYSCALL_EXT}
 125 BSD_SYSCALL_EXT = 2
 126 BSD_SYSCALL_EXT_DIR = ${BSD_SYSCALL_EXT}
 127 LIB_C_EXT = 3
 128 LIB_C_EXT_DIR = ${LIB_C_EXT}
 129
 130 #
 131 # Platform specific assignments start here:
 132 #
 133
 134 #
 135 # (CRAY)
 136 #
 137
 138 #
 139 # (DEC AXP OSF/1)
 140 #
 141 #DESTMAN= /usr/share/man
 142 #MANDIR = man
 143 #CATEXT = $$N
 144 #MAN_OWNER = -o root
 145 #MAN_GROUP = -g root
 146 #INSTALL = installbsd
 147 #MANROFF = cat
 148 ## Extensions for DEC AXP OSF/1 manual entries
 149 #CMD_EXT = 1
 150 #SYS_OPS_EXT = 8
 151 #LIB_NETWORK_EXT = 3
 152 #FORMAT_EXT = 4
 153 #DESC_EXT = 5
 154 #
 155 #SYSCALL_EXT = 2
 156 #BSD_SYSCALL_EXT = 2
 157 #LIB_C_EXT = 3
 158
 159 #
 160 # (irix4)
 161 #
 162
 163 #
 164 # (irix5)
 165 #
 166
 167 #
 168 # (sunos4.x)
 169 #
 170
 171 #
 172 # (ULTRIX, sunos, other 4.[23]bsd-alikes)
 173 #
 174 #DESTMAN= /usr/man
 175 #MANDIR = man
 176 #CATEXT = $$N
 177 #MAN_OWNER = -o root
 178 #MAN_GROUP = -g root
 179 #INSTALL = install
 180 #MANROFF = cat
 181 ## Extensions for ULTRIX, sunos, other 4.[23]bsd-alikes manual entries
 182 #CMD_EXT = 1
 183 #SYS_OPS_EXT = 8
 184 #LIB_NETWORK_EXT = 3n
 185 #LIB_NETWORK_EXT_DIR = 3
 186 #FORMAT_EXT = 5
 187 #DESC_EXT = 7
 188 #
 189 #SYSCALL_EXT = 2
 190 #BSD_SYSCALL_EXT = 2
 191 #LIB_C_EXT = 3
 192
 193 #
 194 # SunOS 5.x (Solaris 2.x)
 195 #
 196 #DESTMAN= /usr/share/man
 197 #MANDIR = man
 198 #CATEXT = $$N
 199 #MAN_OWNER = -o bin
 200 #MAN_GROUP = -g bin
 201 #INSTALL = /usr/ucb/install
 202 #MANROFF = cat
 203 #INDOT = in.
 204 #XFER_INDOT =
 205 ## Extensions for Solaris 2.x manual entries
 206 #CMD_EXT = 1
 207 #SYS_OPS_EXT = 1m
 208 #LIB_NETWORK_EXT = 3n
 209 #FORMAT_EXT = 4
 210 #DESC_EXT = 5
 211 #
 212 #SYSCALL_EXT = 2
 213 #BSD_SYSCALL_EXT = 3b
 214 #LIB_C_EXT = 3c
 215
 216 #
 217 # (hpux9.0)
 218 #
 219
 220 #
 221 # (apollo domainos)
 222 #
 223
 224 #
 225 # (AIX3)
 226 #
 227
 228 #
 229 # (ConvexOS-10.x)
 230 #
 231
 232 #
 233 # (NEC EWS4800 EWS-UX/V Rel4.0/Rel4.2)
 234 #
 235
 236 #
 237 # SCO Unix 3.4.2 / ODT 3.0
 238 #
 239
 240 #
 241 # (NeXTstep 2.1 and 3.0)
 242 #
 243
 244 #
 245 # (Sequent Dynix/PTX)
 246 #
 247
 248 ######################################################################
 249 #
 250 # No user changes needed past this point.
 251 #
 252 ######################################################################
 253 #
 254 # This sed command is used to update the manual entries so they refer to
 255 # the appropriate section of the manual for a given platform.
 256 #
 257 EXT_SED_CMD =   INDOT_U=`echo "${INDOT}"|tr "[a-z]" "[A-Z]"`; \
 258                 export INDOT_U; \
 259                 XFER_INDOT_U=`echo "${XFER_INDOT}"|tr "[a-z]" "[A-Z]"`; \
 260                 export XFER_INDOT_U; \
 261                 CMD_EXT_U=`echo "${CMD_EXT}"|tr "[a-z]" "[A-Z]"`; \
 262                 export CMD_EXT_U; \
 263                 SYS_OPS_EXT_U=`echo "${SYS_OPS_EXT}"|tr "[a-z]" "[A-Z]"`; \
 264                 export SYS_OPS_EXT_U; \
 265                 LIB_NETWORK_EXT_U=`echo "${LIB_NETWORK_EXT}"|tr "[a-z]" "[A-Z]"`; \
 266                 export LIB_NETWORK_EXT_U; \
 267                 FORMAT_EXT_U=`echo "${FORMAT_EXT}"|tr "[a-z]" "[A-Z]"`; \
 268                 export FORMAT_EXT_U; \
 269                 DESC_EXT_U=`echo "${DESC_EXT}"|tr "[a-z]" "[A-Z]"`; \
 270                 export DESC_EXT_U; \
 271                 SYSCALL_EXT_U=`echo "${SYSCALL_EXT}"|tr "[a-z]" "[A-Z]"`; \
 272                 export SYSCALL_EXT_U; \
 273                 BSD_SYSCALL_EXT_U=`echo "${BSD_SYSCALL_EXT}"|tr "[a-z]" "[A-Z]"`; \
 274                 export BSD_SYSCALL_EXT_U; \
 275                 LIB_C_EXT_U=`echo "${LIB_C_EXT}"|tr "[a-z]" "[A-Z]"`; \
 276                 export LIB_C_EXT_U; \
 277                 sed -e "s/@INDOT@/${INDOT}/g" \
 278                 -e "s/@INDOT_U@/$${INDOT_U}/g" \
 279                 -e "s/@XFER_INDOT@/${XFER_INDOT}/g" \
 280                 -e "s/@XFER_INDOT_U@/$${XFER_INDOT_U}/g" \
 281                 -e "s/@CMD_EXT@/${CMD_EXT}/g" \
 282                 -e "s/@CMD_EXT_U@/$${CMD_EXT_U}/g" \
 283                 -e "s/@LIB_NETWORK_EXT@/${LIB_NETWORK_EXT}/g" \
 284                 -e "s/@LIB_NETWORK_EXT_U@/$${LIB_NETWORK_EXT_U}/g" \
 285                 -e "s/@FORMAT_EXT@/${FORMAT_EXT}/g" \
 286                 -e "s/@FORMAT_EXT_U@/$${FORMAT_EXT_U}/g" \
 287                 -e "s/@DESC_EXT@/${DESC_EXT}/g" \
 288                 -e "s/@DESC_EXT_U@/$${DESC_EXT_U}/g" \
 289                 -e "s/@SYS_OPS_EXT@/${SYS_OPS_EXT}/g" \
 290                 -e "s/@SYS_OPS_EXT_U@/$${SYS_OPS_EXT_U}/g" \
 291                 -e "s/@SYSCALL_EXT@/${SYSCALL_EXT}/g" \
 292                 -e "s/@SYSCALL_EXT_U@/$${SYSCALL_EXT_U}/g" \
 293                 -e "s/@BSD_SYSCALL_EXT@/${BSD_SYSCALL_EXT}/g" \
 294                 -e "s/@BSD_SYSCALL_EXT_U@/$${BSD_SYSCALL_EXT_U}/g" \
 295                 -e "s/@LIB_C_EXT@/${LIB_C_EXT}/g" \
 296                 -e "s/@LIB_C_EXT_U@/$${LIB_C_EXT_U}/g"
 297
 298 #
 299 # Command used to produce manual entries
 300 #
 301 MK_MANFILE = ( ${EXT_SED_CMD} | ${MANROFF} )
 302
 303 #
 304 # Extensions for the generated manual entries
 305 #
 306 CMD_OUT_EXT = out${CMD_EXT}
 307 LIB_NETWORK_OUT_EXT = out${LIB_NETWORK_EXT}
 308 FORMAT_OUT_EXT = out${FORMAT_EXT}
 309 DESC_OUT_EXT = out${DESC_EXT}
 310 SYS_OPS_OUT_EXT = out${SYS_OPS_EXT}
 311
 312 #
 313 # User command manual entries
 314 #
 315 CMD_BASE =      dig host dnsquery
 316 CMD_SRC_EXT =   1
 317 CMD_SRC =       dig.${CMD_SRC_EXT} host.${CMD_SRC_EXT} dnsquery.${CMD_SRC_EXT}
 318 CMD_OUT =       dig.${CMD_OUT_EXT} host.${CMD_OUT_EXT} dnsquery.${CMD_OUT_EXT}
 319
 320 #
 321 # named manual entries
 322 #
 323 NAMED_BASE =    named named.reload named.restart ndc
 324 SYS_OPS_SRC_EXT = 8
 325 NAMED_SRC =     named.${SYS_OPS_SRC_EXT} named.reload.${SYS_OPS_SRC_EXT} \
 326                 named.restart.${SYS_OPS_SRC_EXT} ndc.${SYS_OPS_SRC_EXT}
 327 NAMED_OUT =     named.${SYS_OPS_OUT_EXT} named.reload.${SYS_OPS_OUT_EXT} \
 328                 named.restart.${SYS_OPS_OUT_EXT} ndc.${SYS_OPS_OUT_EXT}
 329
 330 #
 331 # named-xfer manual entry
 332 #
 333 NAMED_XFER_BASE = named-xfer
 334 NAMED_XFER_SRC = named-xfer.${SYS_OPS_SRC_EXT}
 335 NAMED_XFER_OUT = named-xfer.${SYS_OPS_OUT_EXT}
 336
 337 #
 338 # nslookup manual entry
 339 #
 340 NSLOOKUP_BASE = nslookup
 341 NSLOOKUP_SRC =  nslookup.${SYS_OPS_SRC_EXT}
 342 NSLOOKUP_OUT =  nslookup.${SYS_OPS_OUT_EXT}
 343
 344 #
 345 # Network library routines manual entries
 346 #
 347 LIB_NETWORK_BASE =      gethostbyname resolver getnetent
 348 LIB_NETWORK_SRC_EXT =   3
 349 LIB_NETWORK_SRC =       gethostbyname.${LIB_NETWORK_SRC_EXT} \
 350                         resolver.${LIB_NETWORK_SRC_EXT} \
 351                         getnetent.${LIB_NETWORK_SRC_EXT}
 352 LIB_NETWORK_OUT =       gethostbyname.${LIB_NETWORK_OUT_EXT} \
 353                         resolver.${LIB_NETWORK_OUT_EXT} \
 354                         getnetent.${LIB_NETWORK_OUT_EXT}
 355
 356 #
 357 # File format manual entries
 358 #
 359 FORMAT_BASE =   resolver
 360 FORMAT_SRC_EXT = 5
 361 FORMAT_SRC =    resolver.${FORMAT_SRC_EXT}
 362 FORMAT_OUT =    resolver.${FORMAT_OUT_EXT}
 363
 364 #
 365 # Feature Description manual entries
 366 #
 367 DESC_BASE =     hostname mailaddr
 368 DESC_SRC_EXT =  7
 369 DESC_SRC =      hostname.${DESC_SRC_EXT} mailaddr.${DESC_SRC_EXT}
 370 DESC_OUT =      hostname.${DESC_OUT_EXT} mailaddr.${DESC_OUT_EXT}
 371
 372 .SUFFIXES:      .${CMD_SRC_EXT} .${CMD_OUT_EXT} \
 373                 .${SYS_OPS_SRC_EXT} .${SYS_OPS_OUT_EXT} \
 374                 .${LIB_NETWORK_SRC_EXT} .${LIB_NETWORK_OUT_EXT} \
 375                 .${FORMAT_SRC_EXT} .${FORMAT_OUT_EXT} \
 376                 .${DESC_SRC_EXT} .${DESC_OUT_EXT}
 377
 378 .${CMD_SRC_EXT}.${CMD_OUT_EXT}:
 379         ${MK_MANFILE} <$*.${CMD_SRC_EXT} >$*.${CMD_OUT_EXT}
 380
 381 .${SYS_OPS_SRC_EXT}.${SYS_OPS_OUT_EXT}:
 382         ${MK_MANFILE} <$*.${SYS_OPS_SRC_EXT} >$*.${SYS_OPS_OUT_EXT}
 383
 384 .${LIB_NETWORK_SRC_EXT}.${LIB_NETWORK_OUT_EXT}:
 385         ${MK_MANFILE} <$*.${LIB_NETWORK_SRC_EXT} >$*.${LIB_NETWORK_OUT_EXT}
 386
 387 .${FORMAT_SRC_EXT}.${FORMAT_OUT_EXT}:
 388         ${MK_MANFILE} <$*.${FORMAT_SRC_EXT} >$*.${FORMAT_OUT_EXT}
 389
 390 .${DESC_SRC_EXT}.${DESC_OUT_EXT}:
 391         ${MK_MANFILE} <$*.${DESC_SRC_EXT} >$*.${DESC_OUT_EXT}
 392
 393 OUTFILES =      ${CMD_OUT} ${NAMED_OUT} ${NAMED_XFER_OUT} ${NSLOOKUP_OUT} \
 394                 ${LIB_NETWORK_OUT} ${FORMAT_OUT} ${DESC_OUT}
 395
 396 all:    ${OUTFILES}
 397
 398 install:        ${OUTFILES} \
 399                 ${DESTDIR}${DESTMAN}/${MANDIR}${CMD_EXT_DIR} \
 400                 ${DESTDIR}${DESTMAN}/${MANDIR}${SYS_OPS_EXT_DIR} \
 401                 ${DESTDIR}${DESTMAN}/${MANDIR}${LIB_NETWORK_EXT_DIR} \
 402                 ${DESTDIR}${DESTMAN}/${MANDIR}${FORMAT_EXT_DIR} \
 403                 ${DESTDIR}${DESTMAN}/${MANDIR}${DESC_EXT_DIR}
 404         @set -x; N=${CMD_EXT}; for f in ${CMD_BASE}; do \
 405                 ${INSTALL} -c -m 444 ${MAN_OWNER} ${MAN_GROUP} \
 406                 $${f}.${CMD_OUT_EXT} \
 407                 ${DESTDIR}${DESTMAN}/${MANDIR}${CMD_EXT_DIR}/$${f}.${CATEXT}; \
 408         done
 409         @set -x; N=${SYS_OPS_EXT}; for f in ${NAMED_BASE}; do \
 410                 ${INSTALL} -c -m 444 ${MAN_OWNER} ${MAN_GROUP} \
 411                 $${f}.${SYS_OPS_OUT_EXT} \
 412                 ${DESTDIR}${DESTMAN}/${MANDIR}${SYS_OPS_EXT_DIR}/${INDOT}$${f}.${CATEXT}; \
 413         done
 414         @set -x; N=${SYS_OPS_EXT}; for f in ${NAMED_XFER_BASE}; do \
 415                 ${INSTALL} -c -m 444 ${MAN_OWNER} ${MAN_GROUP} \
 416                 $${f}.${SYS_OPS_OUT_EXT} \
 417                 ${DESTDIR}${DESTMAN}/${MANDIR}${SYS_OPS_EXT_DIR}/${XFER_INDOT}$${f}.${CATEXT}; \
 418         done
 419         @set -x; N=${SYS_OPS_EXT}; for f in ${NSLOOKUP_BASE}; do \
 420                 ${INSTALL} -c -m 444 ${MAN_OWNER} ${MAN_GROUP} \
 421                 $${f}.${SYS_OPS_OUT_EXT} \
 422                 ${DESTDIR}${DESTMAN}/${MANDIR}${SYS_OPS_EXT_DIR}/$${f}.${CATEXT}; \
 423         done
 424         @set -x; N=${LIB_NETWORK_EXT}; for f in ${LIB_NETWORK_BASE}; do \
 425                 ${INSTALL} -c -m 444 ${MAN_OWNER} ${MAN_GROUP} \
 426                 $${f}.${LIB_NETWORK_OUT_EXT} \
 427                 ${DESTDIR}${DESTMAN}/${MANDIR}${LIB_NETWORK_EXT_DIR}/$${f}.${CATEXT}; \
 428         done
 429         @set -x; N=${FORMAT_EXT}; for f in ${FORMAT_BASE}; do \
 430                 ${INSTALL} -c -m 444 ${MAN_OWNER} ${MAN_GROUP} \
 431                 $${f}.${FORMAT_OUT_EXT} \
 432                 ${DESTDIR}${DESTMAN}/${MANDIR}${FORMAT_EXT_DIR}/$${f}.${CATEXT}; \
 433         done
 434         @set -x; N=${DESC_EXT}; for f in ${DESC_BASE}; do \
 435                 ${INSTALL} -c -m 444 ${MAN_OWNER} ${MAN_GROUP} \
 436                 $${f}.${DESC_OUT_EXT} \
 437                 ${DESTDIR}${DESTMAN}/${MANDIR}${DESC_EXT_DIR}/$${f}.${CATEXT}; \
 438         done
 439
 440 ${DESTDIR}${DESTMAN}/${MANDIR}${CMD_EXT_DIR} \
 441 ${DESTDIR}${DESTMAN}/${MANDIR}${SYS_OPS_EXT_DIR} \
 442 ${DESTDIR}${DESTMAN}/${MANDIR}${LIB_NETWORK_EXT_DIR} \
 443 ${DESTDIR}${DESTMAN}/${MANDIR}${FORMAT_EXT_DIR} \
 444 ${DESTDIR}${DESTMAN}/${MANDIR}${DESC_EXT_DIR}:
 445         mkdir $@
 446
 447 depend:
 448
 449 clean:
 450         rm -f *~ *.BAK *.CKP *.orig
 451         rm -f ${OUTFILES}