Debian Codegraph @

README

raw
1 AFS::PAG 1.02
2 (Perl bindings for AFS PAG manipulation)
3
4 Written by Russ Allbery <[email protected]>
5
6 Copyright 2013, 2014 The Board of Trustees of the Leland Stanford Junior
7 University. This software is distributed under a BSD-style license.
8 Please see the section LICENSE below for more information.
9
10 BLURB
11
12 AFS::PAG provides the standard PAG and token manipulation functions
13 setpag and unlog to Perl programs as a native module. It also provides
14 the hasafs and haspag functions to detect whether AFS is running and
15 whether the current process is in a PAG. Unlike the more general AFS
16 module, it will build with any recent OpenAFS, Heimdal's libkafs, or on
17 Linux without any AFS libraries at all.
18
19 DESCRIPTION
20
21 AFS is a distributed file system allowing cross-platform sharing of
22 files among multiple computers. It associates client credentials
23 (called AFS tokens) with a Process Authentication Group, or PAG.
24 AFS::PAG makes available in Perl the PAG manipulation functions provided
25 by the libkafs or libkopenafs libraries.
26
27 With the functions provided by this module, a Perl program can detect
28 whether AFS is available on the local system and whether it is currently
29 running inside a PAG. It can also create a new PAG and put the current
30 process in it, and remove any AFS tokens in the current PAG.
31
32 This module doesn't provide a direct way to obtain new AFS tokens, only
33 to create a new PAG so that any obtained tokens are isolated from other
34 processes on the system and can be inherited by child processes.
35
36 REQUIREMENTS
37
38 Perl 5.10.1 or later, the Config::AutoConf module, and a C compiler are
39 required to build this module. On any platform other than Linux, either
40 the kafs library (from Heimdal) or the kopenafs library (from recent
41 versions of OpenAFS) are also required.
42
43 The following additional Perl modules will be used by the test suite if
44 present:
45
46 IPC::System::Simple
47 Test::MinimumVersion
48 Test::Perl::Critic
49 Test::Pod
50 Test::Pod::Coverage
51 Test::Spelling
52 Test::Strict
53 Test::Synopsis
54
55 All are available on CPAN. Those tests will be skipped if the modules
56 are not available.
57
58 To enable tests that may be sensitive to the local environment or that
59 produce a lot of false positives without uncovering many problems, set
60 RRA_MAINTAINER_TESTS to a true value.
61
62 BUILDING AND INSTALLATION
63
64 AFS::PAG uses Module::Build and can be installed using the same process
65 as any other Module::Build module:
66
67 perl Build.PL
68 ./Build
69 ./Build test
70 ./Build install
71
72 If your libkafs or libkopenafs libraries are in a path that's not
73 searched by your linker by default, pass them to Build.PL using the
74 --extra-linker-flags option, as in:
75
76 perl Build.PL --extra-linker-flags '-L/opt/openafs/lib'
77
78 You will have to run the last command as root unless you're installing
79 into a local Perl module tree in your home directory.
80
81 SUPPORT
82
83 The AFS::PAG web page at:
84
85 http://www.eyrie.org/~eagle/software/afs-pag/
86
87 will always have the current version of this package, the current
88 documentation, and pointers to any additional resources.
89
90 For bug tracking, this package uses the CPAN bug tracker at:
91
92 https://rt.cpan.org/Public/Dist/Display.html?Name=AFS-PAG
93
94 I welcome bug reports and patches for this package at [email protected] or
95 via the CPAN bug tracker. However, please be aware that I tend to be
96 extremely busy and work projects often take priority. I'll save your
97 mail and get to it as soon as I can, but it may take me a couple of
98 months.
99
100 SOURCE REPOSITORY
101
102 AFS::PAG is maintained using Git. You can access the current source by
103 cloning the repository at:
104
105 git://git.eyrie.org/afs/afs-pag.git
106
107 or view the repository via the web at:
108
109 http://git.eyrie.org/?p=afs/afs-pag.git
110
111 When contributing modifications, either patches (possibly generated by
112 git format-patch) or Git pull requests are welcome.
113
114 LICENSE
115
116 The AFS::PAG package as a whole is covered by the following copyright
117 statement and license:
118
119 Copyright 2013, 2014
120 The Board of Trustees of the Leland Stanford Junior University
121
122 Permission is hereby granted, free of charge, to any person obtaining
123 a copy of this software and associated documentation files (the
124 "Software"), to deal in the Software without restriction, including
125 without limitation the rights to use, copy, modify, merge, publish,
126 distribute, sublicense, and/or sell copies of the Software, and to
127 permit persons to whom the Software is furnished to do so, subject to
128 the following conditions:
129
130 The above copyright notice and this permission notice shall be
131 included in all copies or substantial portions of the Software.
132
133 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
134 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
135 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
136 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
137 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
138 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
139 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
140
141 All individual files without an explicit exception below are released
142 under this license. Some files may have additional copyright holders as
143 noted in those files. There is detailed information about the licensing
144 of each file in the LICENSE file in this distribution.
145
146 Some files in this distribution are individually released under
147 different licenses, all of which are compatible with the above general
148 package license but which may require preservation of additional
149 notices. All required notices are preserved in the LICENSE file.