path: root/usr.sbin/afs/src/doc/arla.texi

\input texinfo @c -*- texinfo -*-
@c Copyright (c) 1998 - 2000 Kungliga Tekniska H�gskolan
@c (Royal Institute of Technology, Stockholm, Sweden).
@c All rights reserved.

@c %**start of header
@c $arla: arla.texi,v 1.53 2003/02/01 17:16:03 lha Exp $
@setfilename arla.info
@settitle ARLA
@iftex
@afourpaper
@end iftex
@c some sensible characters, please?
@tex
\input latin1.tex
@end tex
@setchapternewpage on
@syncodeindex pg cp
@c %**end of header

@ifinfo
@dircategory Arla
@direntry
* Arla: (arla).           Arla - A Free AFS Implementation
@end direntry
@end ifinfo

@c title page
@titlepage
@iftex
@image{arla-logo}
@sp 5
@end iftex

@ifnottex
@title Arla
@end ifnottex

@subtitle A Free AFS implementation from KTH
@subtitle Edition 0.3, for version 0.36
@subtitle 1999 - 2002

@author Love H�rnquist-�strand
@author Assar Westerlund
@author Harald Barth
@author last updated $arla: 2003/02/01 17:16:03 $

@comment This text will show up in the output of texi2html
@def@fnotsupported{THIS TEXT MAY CONTAIN GARBLED OUTPUT BECAUSE THIS VIEW FORMAT DOES NOT SUPPORT TEXI FUNCTIONS}

@def@copynext{@vskip 20pt plus 1fil@penalty-1000}
@def@copyrightstart{}
@def@copyrightend{}

@page
@copyrightstart
@example

Copyright (c) 1995 - 2002 Kungliga Tekniska H�gskolan 
(Royal Institute of Technology, Stockholm, Sweden).
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

3. Neither the name of the Institute nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

@end example

@copynext
@example
/*
 * Copyright (c) 2002, Stockholms Universitet
 * (Stockholm University, Stockholm Sweden)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the university nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
@end example

@copynext
@example

Copyright (c) 1988, 1990, 1993
     The Regents of the University of California.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

3. All advertising materials mentioning features or use of this software
   must display the following acknowledgement:
     This product includes software developed by the University of
     California, Berkeley and its contributors.

4. Neither the name of the University nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

@end example
@copynext
@example

Copyright 1992 Simmule Turner and Rich Salz.  All rights reserved. 

This software is not subject to any license of the American Telephone 
and Telegraph Company or of the Regents of the University of California. 

Permission is granted to anyone to use this software for any purpose on
any computer system, and to alter it and redistribute it freely, subject
to the following restrictions:

1. The authors are not responsible for the consequences of use of this
   software, no matter how awful, even if they arise from flaws in it.

2. The origin of this software must not be misrepresented, either by
   explicit claim or by omission.  Since few users ever read sources,
   credits must appear in the documentation.

3. Altered versions must be plainly marked as such, and must not be
   misrepresented as being the original software.  Since few users
   ever read sources, credits must appear in the documentation.

4. This notice may not be removed or altered.


@end example
@copynext
@example

COPYRIGHT  (C)  1998
THE REGENTS OF THE UNIVERSITY OF MICHIGAN
ALL RIGHTS RESERVED

PERMISSION IS GRANTED TO USE, COPY, CREATE DERIVATIVE WORKS 
AND REDISTRIBUTE THIS SOFTWARE AND SUCH DERIVATIVE WORKS 
FOR ANY PURPOSE, SO LONG AS THE NAME OF THE UNIVERSITY OF 
MICHIGAN IS NOT USED IN ANY ADVERTISING OR PUBLICITY 
PERTAINING TO THE USE OR DISTRIBUTION OF THIS SOFTWARE 
WITHOUT SPECIFIC, WRITTEN PRIOR AUTHORIZATION.  IF THE 
ABOVE COPYRIGHT NOTICE OR ANY OTHER IDENTIFICATION OF THE 
UNIVERSITY OF MICHIGAN IS INCLUDED IN ANY COPY OF ANY 
PORTION OF THIS SOFTWARE, THEN THE DISCLAIMER BELOW MUST 
ALSO BE INCLUDED.

THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION 
FROM THE UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY 
PURPOSE, AND WITHOUT WARRANTY BY THE UNIVERSITY OF 
MICHIGAN OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
WITHOUT LIMITATION THE IMPLIED WARRANTIES OF 
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE LIABLE 
FOR ANY DAMAGES, INCLUDING SPECIAL, INDIRECT, INCIDENTAL, OR 
CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM ARISING 
OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN 
IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF 
SUCH DAMAGES.

@end example
@copynext
@example

/*
****************************************************************************
*        Copyright IBM Corporation 1988, 1989 - All Rights Reserved        *
*                                                                          *
* Permission to use, copy, modify, and distribute this software and its    *
* documentation for any purpose and without fee is hereby granted,         *
* provided that the above copyright notice appear in all copies and        *
* that both that copyright notice and this permission notice appear in     *
* supporting documentation, and that the name of IBM not be used in        *
* advertising or publicity pertaining to distribution of the software      *
* without specific, written prior permission.                              *
*                                                                          *
* IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL *
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL IBM *
* BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY      *
* DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER  *
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING   *
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.    *
****************************************************************************
*/

@end example
@copyrightend
@end titlepage

@c Less filling! Tastes great!
@iftex
@parindent=0pt
@global@parskip 6pt plus 1pt
@global@chapheadingskip = 15pt plus 4pt minus 2pt 
@global@secheadingskip = 12pt plus 3pt minus 2pt
@global@subsecheadingskip = 9pt plus 2pt minus 2pt
@end iftex
@ifinfo
@paragraphindent 0
@end ifinfo

@ifinfo
@node Top,  , (dir), (dir)
@comment  node-name,  next,  previous,  up
@top Arla

Arla is a free AFS implementation from KTH.

Please send comments (and fixes) on this manual and the arla programs to
@email{arla-drinkers@@stacken.kth.se}.

@end ifinfo

@menu
* Introduction::                Introduction to Arla.
* AFS infrastructure::		A description of the afs infrastructure.
* Organization of data::	How different data is organized in AFS.
* AFS and the real world::	Common problems and their solutions.
* Parts of Arla::		Description of different parts of arla.
* Debugging::			How to debug arla when its not working.
* Porting::			That you need to know to port arla.
* Programming::			Programming documentation of arla.
* Oddities::			Strange things that did happen to us.
* Arla timeline::		Short timeline of arla.
* Authors::			The authors of arla.
* Acknowledgments::             People that have helped us.
* Index::             		Index.
@c * Building and Installing::     
@c * Unreleased parts of the arla suite::

@detailmenu

 --- The Detailed Node Listing ---

* Introduction::
* AFS infrastructure::

How data and servers are organized in AFS.

* Requirements::
* Data organization::
* Callbacks::
* Volume management::
* Relationship between pts uid and unix uid::

How to cope with reality

* NAT::
* Samba::
* Integration with Kerberos::
* Kerberos tickets and AFS tokens::

The parts of arla

* How arla works::
* The relation between Arlad and NNPFS::
* The life of a file::
* Tools and libs::
* The files in arlad/::
* pioctl and kafs::

How to debug arla when its not working

* Arlad::
* Debugging LWP with GDB::
* nnpfs::
* nnpfs on linux::
* Debugging techniques::
* Kernel debuggers::
* Darwin/MacOS X::

Porting arla

* Porting::
* Porting user-space::
* Porting NNPFS::

Programming

* Programming::
* Disco with arla::
* afsUUID::
@c * NNPFS interface::

Odd stuff you find when looking around

* Oddities::

Miscellaneous

* Arla timeline::
* Authors::
* Acknowledgments::

* Index::

@end detailmenu
@end menu

@contents

@include intro.texi
@c @include install.texi
@include afs-basics.texi
@include storage.texi
@include real-world.texi
@include partsofarla.texi
@include debugging.texi
@include porting.texi
@include prog.texi
@include oddities.texi
@include timeline.texi
@include authors.texi
@include ack.texi
@include index.texi

@bye