#lang scribble/doc
@(require
  scribble/manual
  (for-label racket "../main.rkt"))

@title{@bold{9P}: Plan9 Network Filesystem}

@table-of-contents[]

@defmodule[(planet "main.rkt" ("murphy" "9p.plt" 2 0))]{

  Allows you to access and provide 9P network filesystems over TCP
  through an object oriented interface. Depending on which side of
  the protocol you want to speak, you probably want to import
  the @racket["client.rkt"] or @racket["server.rkt"] modules instead
  of the @racket["main.rkt"] module. The main module only re-exports
  data structure definitions from @racket["data.rkt"], @racket["exception.rkt"]
  and common interfaces from @racket["interface.rkt"].
  
  For usage examples refer to the sources @racket["example/hello-server.rkt"]
  and @racket["example/hello-client.rkt"].

}

@include-section["data.scrbl"]
@include-section["exception.scrbl"]
@include-section["interface.scrbl"]
@include-section["client.scrbl"]
@include-section["server.scrbl"]
@include-section["network.scrbl"]

@section{License}

Copyright (c) 2010 by @link["mailto:chust@web.de"]{Thomas Chust @"<chust@web.de>"}.

This package is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You can find a copy of the GNU Lesser General Public License at
@link["http://www.gnu.org/licenses/lgpl-3.0.html"]{http://www.gnu.org/licenses/lgpl-3.0.html}.