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

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