usr.bin/man/manconf.h

   1 /*      $NetBSD: manconf.h,v 1.3 2006/04/10 14:39:06 chuck Exp $        */
   2
   3 /*-
   4  * Copyright (c) 1993
   5  *      The Regents of the University of California.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)config.h    8.4 (Berkeley) 12/18/93
  33  */
  34
  35 /*
  36  * manconf.h: common data structures and APIs shared across all programs
  37  * that access man.conf (currently: apropos, catman, makewhatis, man, and
  38  * whatis).
  39  */
  40
  41 /* TAG: top-level structure (one per section/reserved word) */
  42 typedef struct _tag {
  43         TAILQ_ENTRY(_tag) q;                    /* Queue of tags */
  44
  45         TAILQ_HEAD(tqh, _entry) entrylist;      /* Queue of entries */
  46         char *s;                                /* Associated string */
  47         size_t len;                             /* Length of 's' */
  48 } TAG;
  49
  50 /* ENTRY: each TAG has one or more ENTRY strings linked off of it */
  51 typedef struct _entry {
  52         TAILQ_ENTRY(_entry) q;                  /* Queue of entries */
  53
  54         char *s;                                /* Associated string */
  55         size_t len;                             /* Length of 's' */
  56 } ENTRY;
  57
  58 int      addentry(TAG *, const char *, int);
  59 void     config(const char *);
  60 TAG     *gettag(const char *, int);