share/man/man4/coda.4

   1 .\" Copyright (c) 2008 Robert N. M. Watson
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 21, 2008
  28 .Os
  29 .Dt CODA 4
  30 .Sh NAME
  31 .Nm coda
  32 .Nd Coda Distributed File System
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "options CODA"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 coda_load="YES"
  46 .Ed
  47 .Pp
  48 To load as a kernel loadable module after boot:
  49 .Pp
  50 .Dl "kldload coda"
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 kernel module allows the experimental, third-party Coda distributed file
  55 system client to be used with
  56 .Fx .
  57 The module allows the userspace Coda client daemon, Venus, to present the
  58 Coda distributed file system namespace via the local
  59 .Pa /coda
  60 file system mountpoint via the
  61 .Pa /dev/cfs0
  62 special device.
  63 .Pp
  64 To use Coda, the Coda client software package must also be installed; more
  65 information on Coda may be found in the Coda documentation distributed with
  66 that package.
  67 .Sh SEE ALSO
  68 .Xr loader.conf 5 ,
  69 .Xr kldload 8
  70 .Sh HISTORY
  71 Support for
  72 .Nm
  73 first appeared in
  74 .Fx 3.0 .
  75 .Sh AUTHORS
  76 This manual page was written by
  77 .An Robert Watson Aq rwatson@FreeBSD.org .
  78 .Sh BUGS
  79 The
  80 Coda distributed file system is considered experimental, and production
  81 deployment should occur only after careful consideration of the risks of
  82 deploying experimental software.