src/tests/OpenAFS/config.pm

   1 # CMUCS AFStools
   2 # Copyright (c) 1996, Carnegie Mellon University
   3 # All rights reserved.
   4 #
   5 # See CMU_copyright.pm for use and distribution information
   6
   7 package OpenAFS::config;
   8
   9 =head1 NAME
  10
  11 OpenAFS::config - AFStools configuration
  12
  13 =head1 SYNOPSIS
  14
  15   use OpenAFS::config;
  16
  17 =head1 DESCRIPTION
  18
  19 This module contains various AFStools configuration variables which are used
  20 by the other AFStools modules.  These describe how AFStools should act in a
  21 particular installation, and are mostly pretty mundane.  All of the defaults
  22 here are pretty reasonable, so you shouldn't have to change anything unless
  23 your site is particularly exotic.
  24
  25 Note that this file only describes how a particular B<installation> of AFStools
  26 should act, not how it should act upon a particular B<cell>.  Since the cell
  27 AFStools is running in is not necessarily the same as the cell on which it
  28 is acting, most configuration that is really per-cell should be located in a
  29 cell-specific module.
  30
  31 This module should only be used by other parts of AFStools.  As such, the
  32 variables described here are not normally visible to user programs, and this
  33 file is mostly of interest to administrators who are installing AFStools.
  34
  35 =over 4
  36
  37 =cut
  38
  39 use OpenAFS::CMU_copyright;
  40 use OpenAFS::Dirpath;
  41 use Exporter;
  42
  43 $VERSION   = '';
  44 $VERSION   = '1.00';
  45 @ISA       = qw(Exporter);
  46 @EXPORT    = qw($def_ConfDir
  47                 @CmdList
  48                 @CmdPath
  49                 $err_table_dir
  50                );
  51
  52 # The following configuration variables are defined here.  Mention them
  53 # all an extra time, to suppress annoying warnings.  Doesn't perl have
  54 # a way of doing this???
  55 @x = ();
  56 @x = ($def_ConfDir, @CmdList, @CmdPath);
  57
  58 =item $def_ConfDir - Default configuration directory
  59
  60 This is the default AFS configuration directory, where files like ThisCell,
  61 CellServDB, and so on are found.  If the AFStools parameter I<confdir> is
  62 set, it will generally be searched before this directory.  Normally, this
  63 should be set to F</usr/vice/etc> and not changed, as that path is hardwired
  64 into AFS.  However, it might be necessary to modify this if your site uses
  65 an exotic locally-compiled version of AFS.
  66
  67 =cut
  68
  69 $def_ConfDir = "$openafsdirpath->{'viceetcdir'}";
  70 #$def_ConfDir = "/usr/vice/etc";
  71
  72
  73 =item @CmdList - List of AFS commands
  74
  75 This is a list of AFS commands that the AFStools package might want to invoke
  76 using B<OpenAFS::wrapper::wrapper>.  Don't remove anything from this list if you
  77 know what's good for you.  It's OK to add things, though, if you think you
  78 might use the wrapper features for something.
  79
  80 =cut
  81
  82 @CmdList = ('fs', 'pts', 'vos', 'bos', 'kas', 'krbkas', 'sys');
  83
  84
  85 =item @CmdPath - Path to search for AFS commands
  86
  87 This is the list of directories where B<OpenAFS::wrapper::wrapper> will look for
  88 AFS commands.  For AFStools to work properly, every command listed in
  89 I<@OpenAFS::config::CmdList> must appear in one of these directories.  The default
  90 should be sufficient for most sites; we deal with Transarc's reccommendations
  91 as well as common practice.  Note that on machines for which /usr/afs/bin
  92 exists (typically, AFS fileservers), that directory is first.  This is probably
  93 what you want...
  94
  95 =cut
  96
  97 @CmdPath = (split(/:/, $ENV{PATH}),
  98             "$openafsdirpath->{'afssrvbindir'}",        # For servers
  99             '/usr/local/bin',      # Many sites put AFS in /usr/local
 100             '/usr/local/etc',
 101             '/usr/afsws/bin',      # For people who use Transarc's
 102             '/usr/afsws/etc');     # silly reccommendations
 103
 104 =item $err_table_dir - Error table directory
 105
 106 This is the location of error tables used by the errcode and errstr
 107 routines in OpenAFS::errtrans.  Each file in this directory should be a
 108 com_err error table (in source form), and should be named the same
 109 as the com_err error package contained within.
 110
 111 =cut
 112
 113 $err_table_dir = '/usr/local/lib/errtbl';
 114
 115 1;
 116
 117 =back
 118
 119 =head1 COPYRIGHT
 120
 121 The CMUCS AFStools, including this module are
 122 Copyright (c) 1996, Carnegie Mellon University.  All rights reserved.
 123 For use and redistribution information, see CMUCS/CMU_copyright.pm
 124
 125 =cut