This commit was manufactured by cvs2svn to create tag 'FreeBSD-release/1.0'.

[unix-history] / gnu / usr.bin / man / lib / config.h_dist

/*
 * config.h
 *
 * If you haven't read the README file, now might be a good time.
 *
 * This file is edited by configure, so you shouldn't have to.
 * If that doesn't work, edit this file to match your site.
 *
 * Sorry it's so long, but there are lots of things you might want to
 * customize for your site.
 *
 * Copyright (c) 1990, 1991, John W. Eaton.
 *
 * You may distribute under the terms of the GNU General Public
 * License as specified in the file COPYING that comes with the man
 * distribution.  
 *
 * John W. Eaton
 * jwe@che.utexas.edu
 * Department of Chemical Engineering
 * The University of Texas at Austin
 * Austin, Texas  78712
 */

#ifdef COMPRESS
#define DO_COMPRESS
#define DO_UNCOMPRESS
#endif

/*
 * This is the size of a number of internal buffers.  It should
 * probably not be less than 512.
 */
#ifndef BUFSIZ
#define BUFSIZ 1024
#endif

/*
 * This should be at least the size of the longest path.
 */
#ifndef MAXPATHLEN
#define MAXPATHLEN 1024
#endif

/*
 * This is the maximum number of directories expected in the manpath.
 */
#ifndef MAXDIRS
#define MAXDIRS 64
#endif

/*
 * This is the name of the group that owns the preformatted man pages.
 * If you are running man as a setgid program, you should make sure
 * that all of the preformatted man pages and the directories that
 * they live in are readable and writeable and owned by this group.
 */
#ifdef SECURE_MAN_UID
#define MAN_USER ""
#endif

/*
 * It's probably best to define absolute paths to all of these.  If
 * you don't, you'll be depending on the user's path to be correct
 * when system () is called.  This can result in weird behavior that's
 * hard to track down, especially after you forget how this program
 * works...  If you don't have some of these programs, simply define
 * them to be empty strings (i.e. "").  As a minimum, you must have
 * nroff installed.
 */
#ifndef APROPOS
#define APROPOS "%apropos%"
#endif

#ifndef WHATIS
#define WHATIS "%whatis%"
#endif

#ifndef PAGER
#define PAGER "%pager%"
#endif

#ifdef HAS_TROFF
#ifndef TROFF
#define TROFF "%troff%"
#endif
#endif

#ifndef NROFF
#define NROFF "%nroff%"
#endif

#ifndef EQN
#define EQN "%eqn%"
#endif

#ifndef NEQN
#define NEQN "%neqn%"
#endif

#ifndef TBL
#define TBL "%tbl%"
#endif

#ifndef COL
#define COL "%col%"
#endif

#ifndef VGRIND
#define VGRIND "%vgrind%"
#endif

#ifndef REFER
#define REFER "%refer%"
#endif

#ifndef GRAP
#define GRAP "%grap%"
#endif

#ifndef PIC
#define PIC "%pic%"
#endif

/*
 * Define the absolute path to the configuration file.
 */
#ifndef MAN_MAIN
  static char config_file[] = "%manpath_config_file%" ;
#endif

/*
 * Define the uncompression program(s) to use for those preformatted
 * pages that end in the given character.  If you add extras here, you
 * may need to change man.c.
 */
#ifdef DO_UNCOMPRESS
/* .F files */
#define FCAT ""
/* .Y files */
#define YCAT ""
/* .Z files */
#define ZCAT "%zcat%"
#endif

/*
 * This is the standard program to use on this system for compressing
 * pages once they have been formatted, and the character to tack on
 * to the end of those files.  The program listed is expected to read
 * from the standard input and write compressed output to the standard
 * output.
 */
#ifdef DO_COMPRESS
#define COMPRESSOR ""
#define COMPRESS_EXT ""
#endif

/*
 * Define the standard manual sections.  For example, if your man
 * directory tree has subdirectories man1, man2, man3, mann,
 * and man3foo, std_sections[] would have "1", "2", "3", "n", and
 * "3foo".  Directories are searched in the order they appear.  Having
 * extras isn't fatal, it just slows things down a bit.
 *
 * Note that this is just for directories to search.  If you have
 * files like .../man3/foobar.3Xtc, you don't need to have "3Xtc" in
 * the list below -- this is handled separately, so that `man 3Xtc foobar',
 * `man 3 foobar', and `man foobar' should find the file .../man3/foo.3Xtc,
 * (assuming, of course, that there isn't a .../man1/foo.1 or somesuch
 * that we would find first).
 *
 * Note that this list should be in the order that you want the
 * directories to be searched.  Is there a standard for this?  What is
 * the normal order?  If anyone knows, please tell me!
 */
#ifndef MANPATH_MAIN
  static char *std_sections[] = 
    {
       "1", "n", "l", "6", "8", "2", "3", "4", "5", "7", "p", "o", NULL
    };
#endif

/*
 * Not all systems define these in stat.h.
 */
#ifndef S_IRUSR
#define	S_IRUSR	00400		/*  read permission: owner */
#endif
#ifndef S_IWUSR
#define	S_IWUSR	00200		/*  write permission: owner */
#endif
#ifndef S_IRGRP
#define	S_IRGRP	00040		/*  read permission: group */
#endif
#ifndef S_IWGRP
#define	S_IWGRP	00020		/*  write permission: group */
#endif
#ifndef S_IROTH
#define	S_IROTH	00004		/*  read permission: other */
#endif
#ifndef S_IWOTH
#define	S_IWOTH	00002		/*  write permission: other */
#endif

/*
 * This is the mode used for formatted pages that we create.  If you
 * are using the setgid option, you should use 664.  If you are not,
 * you should use 666 and make the cat* directories mode 777.
 */
#ifndef CATMODE
#ifdef SECURE_MAN_UID
#define CATMODE S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH
#else
#define CATMODE S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH
#endif
#endif