gnu/usr.bin/man/lib/config.h

   1 /*
   2  * config.h
   3  *
   4  * If you haven't read the README file, now might be a good time.
   5  *
   6  * Sorry it's so long, but there are lots of things you might want to
   7  * customize for your site.
   8  *
   9  * Copyright (c) 1990, 1991, John W. Eaton.
  10  *
  11  * You may distribute under the terms of the GNU General Public
  12  * License as specified in the file COPYING that comes with the man
  13  * distribution.
  14  *
  15  * John W. Eaton
  16  * jwe@che.utexas.edu
  17  * Department of Chemical Engineering
  18  * The University of Texas at Austin
  19  * Austin, Texas  78712
  20  */
  21
  22 /*
  23  * This should be at least the size of the longest path.
  24  */
  25 #ifndef MAXPATHLEN
  26 #define MAXPATHLEN 1024
  27 #endif
  28
  29 /*
  30  * This is the maximum number of directories expected in the manpath.
  31  */
  32 #ifndef MAXDIRS
  33 #define MAXDIRS 64
  34 #endif
  35
  36 /*
  37  * It's probably best to define absolute paths to all of these.  If
  38  * you don't, you'll be depending on the user's path to be correct
  39  * when system () is called.  This can result in weird behavior that's
  40  * hard to track down, especially after you forget how this program
  41  * works...  If you don't have some of these programs, simply define
  42  * them to be empty strings (i.e. "").  As a minimum, you must have
  43  * nroff installed.
  44  */
  45 #ifndef APROPOS
  46 #define APROPOS "/usr/bin/apropos"
  47 #endif
  48
  49 #ifndef WHATIS
  50 #define WHATIS "/usr/bin/whatis"
  51 #endif
  52
  53 #ifndef PAGER
  54 #define PAGER "more -s"
  55 #endif
  56
  57 #ifndef TROFF
  58 #define TROFF "/usr/bin/groff -S -man"
  59 #endif
  60
  61 #ifndef NROFF
  62 #define NROFF "/usr/bin/groff -S -Wall -mtty-char -man"
  63 #endif
  64
  65 #ifndef EQN
  66 #define EQN "/usr/bin/eqn"
  67 #endif
  68
  69 #ifndef NEQN
  70 #define NEQN "/usr/bin/eqn"
  71 #endif
  72
  73 #ifndef TBL
  74 #define TBL "/usr/bin/tbl"
  75 #endif
  76
  77 #ifndef COL
  78 #define COL "/usr/bin/col"
  79 #endif
  80
  81 #ifndef VGRIND
  82 #define VGRIND "/usr/bin/vgrind"
  83 #endif
  84
  85 #ifndef REFER
  86 #define REFER "/usr/bin/refer"
  87 #endif
  88
  89 #ifndef GRAP
  90 #define GRAP ""
  91 #endif
  92
  93 #ifndef PIC
  94 #define PIC "/usr/bin/pic"
  95 #endif
  96
  97 /*
  98  * Define the absolute path to the configuration file.
  99  */
 100 #ifndef MAN_MAIN
 101   static char config_file[] = "/etc/manpath.config" ;
 102 #endif
 103
 104 /*
 105  * Define the uncompression program(s) to use for those preformatted
 106  * pages that end in the given character.  If you add extras here, you
 107  * may need to change man.c.  [I have no idea what FCAT and YCAT files
 108  * are! - I will leave them in for now.. -jkh]
 109  */
 110 /* .F files */
 111 #define FCAT ""
 112 /* .Y files */
 113 #define YCAT ""
 114 /* .Z files */
 115 #define ZCAT "/usr/bin/zcat -q"
 116
 117 /*
 118  * This is the standard program to use on this system for compressing
 119  * pages once they have been formatted, and the character to tack on
 120  * to the end of those files.  The program listed is expected to read
 121  * from the standard input and write compressed output to the standard
 122  * output.  These won't actually be used unless compression is enabled.
 123  */
 124 #define COMPRESSOR "/usr/bin/gzip -c"
 125 #define COMPRESS_EXT ".gz"
 126
 127 /*
 128  * Define the standard manual sections.  For example, if your man
 129  * directory tree has subdirectories man1, man2, man3, mann,
 130  * and man3foo, std_sections[] would have "1", "2", "3", "n", and
 131  * "3foo".  Directories are searched in the order they appear.  Having
 132  * extras isn't fatal, it just slows things down a bit.
 133  *
 134  * Note that this is just for directories to search.  If you have
 135  * files like .../man3/foobar.3Xtc, you don't need to have "3Xtc" in
 136  * the list below -- this is handled separately, so that `man 3Xtc foobar',
 137  * `man 3 foobar', and `man foobar' should find the file .../man3/foo.3Xtc,
 138  * (assuming, of course, that there isn't a .../man1/foo.1 or somesuch
 139  * that we would find first).
 140  *
 141  * Note that this list should be in the order that you want the
 142  * directories to be searched.  Is there a standard for this?  What is
 143  * the normal order?  If anyone knows, please tell me!
 144  */
 145 #ifndef MANPATH_MAIN
 146   static const char *std_sections[] =
 147     {
 148        "1", "1aout", "8", "2", "3", "n", "4", "5", "6", "7", "9", "l", NULL
 149     };
 150 #endif
 151
 152 /*
 153  * Not all systems define these in stat.h.
 154  */
 155 #ifndef S_IRUSR
 156 #define S_IRUSR 00400           /*  read permission: owner */
 157 #endif
 158 #ifndef S_IWUSR
 159 #define S_IWUSR 00200           /*  write permission: owner */
 160 #endif
 161 #ifndef S_IRGRP
 162 #define S_IRGRP 00040           /*  read permission: group */
 163 #endif
 164 #ifndef S_IWGRP
 165 #define S_IWGRP 00020           /*  write permission: group */
 166 #endif
 167 #ifndef S_IROTH
 168 #define S_IROTH 00004           /*  read permission: other */
 169 #endif
 170 #ifndef S_IWOTH
 171 #define S_IWOTH 00002           /*  write permission: other */
 172 #endif
 173
 174 /*
 175  * This is the mode used for formatted pages that we create.  If you
 176  * are using the setgid option, you should use 664.  If you are not,
 177  * you should use 666 and make the cat* directories mode 777.
 178  */
 179 #ifndef CATMODE
 180 #define CATMODE S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH
 181 #endif