258 lines
9.1 KiB
Plaintext
258 lines
9.1 KiB
Plaintext
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
|
|
<!-- define some ENTITYs -->
|
|
<!ENTITY fsp "File Service Protocol">
|
|
]>
|
|
<article id="fsp-faq" lang="en">
|
|
<articleinfo>
|
|
<title>FSP - &fsp; FAQ</title>
|
|
<author>
|
|
<firstname>Sven</firstname>
|
|
<othername>"Hoaxter"</othername>
|
|
<surname>Hoexter</surname>
|
|
</author>
|
|
<!-- I'll call it 0.1 later
|
|
<revhistory>
|
|
<revision>
|
|
<revnumber>0.1</revnumber>
|
|
<date>2003.09.10</date>
|
|
</revision>
|
|
</revhistory>
|
|
-->
|
|
<!-- starting with some general stuff -->
|
|
<abstract>
|
|
<para>
|
|
This document is a major rewrite of the old
|
|
<ulink url="http://fsp.sourceforge.net/doc/faq.html">FSP FAQ</ulink>.
|
|
I started with this FAQ from scratch cause nearly all parts of the old FAQ where outdated. This new FAQ is maintained
|
|
in DocBook SGML. Send patches to the fsp-devel Mailinglist (FIXME link to id gethelpml) or directly to me
|
|
<email>sven@du-gehoerst-mir.de-nospam</email>. You should be able to find the latest SGML version of this FAQ in the
|
|
<ulink url="http://sourceforge.net/cvs/?group_id=93841">fsp CVS at sf.net</ulink> or here
|
|
<ulink url="http://sven.stormbind.net/fsp/fsp-doc/fsp-faq.sgml">http://sven.stormbind.net/fsp/fsp-doc/fsp-faq.sgml</ulink>
|
|
(be aware the sf.net public CVS is often about a week behind the "real" CVS :( )
|
|
</para>
|
|
</abstract>
|
|
</articleinfo>
|
|
<!-- end of the general stuff -->
|
|
|
|
<!-- starting with the main document -->
|
|
|
|
<!-- starting with the introduction -->
|
|
<sect1 id="introduction">
|
|
<title>Introduction</title>
|
|
|
|
<sect2 id="whatisfsp">
|
|
<title>What is FSP?</title>
|
|
<para>
|
|
FSP stands for &fsp;. In general FSP is what anonymous ftp should be, a fast and bandwith friendly
|
|
way to access publicly avaible data. FSP is UDP based so it doesn't have all the protocol overhead you've with TCP
|
|
based transfer protocols. You can find the latest protocol definition right here
|
|
<ulink url="http://fsp.sourceforge.net/doc/PROTOCOL.txt">http://fsp.sourceforge.net/doc/PROTOCOL.txt</ulink>
|
|
or in the source distribution in the "doc" subdirectory.
|
|
</para>
|
|
|
|
<para>
|
|
In the past various people maintained the FSP code base. At the moment Radim Kolar <email>hsn@cybermail.net-nospam</email>
|
|
is maintaining FSP. If you like to get involved take a look at the FSP
|
|
<ulink url="http://fsp.sourceforge.net">Homepage</ulink> and the
|
|
<ulink url="http://www.sourceforge.net/projects/fsp/">FSP project page</ulink>.
|
|
</para>
|
|
</sect2>
|
|
|
|
<sect2 id="whatisitfor">
|
|
<title>Why and for what should I use FSP?</title>
|
|
<para>
|
|
The &fsp; has its strengths on slow lines and connections with a high package lose like a Wireless LAN. In general the &fsp; is
|
|
what anonymous FTP should be - a fast and bandwith friendly way for anonymous file access.
|
|
</para>
|
|
</sect2>
|
|
|
|
<sect2 id="wherecanifind">
|
|
<title>Where can I download FSP?</title>
|
|
<para>
|
|
You can Download the FSP source Distribtuion from the
|
|
<ulink url="http://sourceforge.net/project/showfiles.php?group_id=93841">sf.net mirror network</ulink>
|
|
or from
|
|
<ulink url="http://ibiblio.org/pub/linux/system/network/file-transfer/">ibblio</ulink>.
|
|
If you have the FSP tools already you can access the latest FSP release
|
|
via fsp on hxt.homelinux.org port 2221.
|
|
</para>
|
|
<para>
|
|
When you're interesseted in the latest, and of course greates,
|
|
development done in FSP please try a CVS checkout.
|
|
Explanation and all needed information to do this can be found
|
|
on the
|
|
<ulink url="http://sourceforge.net/cvs/?group_id=93841">sf.net CVS page</ulink>.
|
|
</sect2>
|
|
|
|
<sect2 id="gethelp">
|
|
<title>Where can I find help?</title>
|
|
<para>
|
|
First of all various people took the time to write nice documentation on FSP including the fspd Server
|
|
and the client tools. Please read those fine documents bevor you start writing to the mailinglists.
|
|
</para>
|
|
<sect3 id="gethelpdocs">
|
|
<title>RTFM - Read the fine Manuals</title>
|
|
<para>
|
|
<ulink url="http://fsp.sourceforge.net/doc/PROTOCOL.txt">The &fsp; definition</ulink>
|
|
The latest version of the FAQ
|
|
The old FAQ
|
|
</para>
|
|
</sect3>
|
|
<sect3 id="gethelpml">
|
|
<title>The Mailinglists</title>
|
|
<para>
|
|
For developing issue writte to the fsp-dev mainlinglist. For end-user questions
|
|
and questions on how to configure your server/client write to the fsp-user Mailinglist.
|
|
You can find more information on how to subscribe/unsubscribe to the mailinglist and
|
|
the archiv on the
|
|
<ulink url="http://sourceforge.net/mail/?group_id=93841">FSP mailinglist page</ulink>
|
|
on sf.net.
|
|
Please bevor you write to one of the provided mailinglists read and understand
|
|
<ulink url="http://www.catb.org/~esr/faqs/smart-questions.html">ESRs HowTo ask smart questions</ulink>
|
|
and
|
|
<ulink url="http://www.netmeister.org/news/learn2quote.html">learn.to/quote</ulink>
|
|
</para>
|
|
</sect3>
|
|
</sect2>
|
|
|
|
<sect2 id="licence">
|
|
<title>Licence, copyright and redistribution of FSP</title>
|
|
<para>
|
|
Most parts of the &fsp; distribution are free and licenced under a
|
|
BSD/MIT/X licence.
|
|
</para>
|
|
<para>
|
|
From the COPYRIGHT file in the source distribution (e-mail addresses removed):
|
|
<programlisting>
|
|
Authors:
|
|
Radim Kolar (Current FSP maintainer)
|
|
Andrew Doherty
|
|
Michael Fischbein
|
|
Cimarron D. Taylor
|
|
Guido van Rossum
|
|
Wen-King Su
|
|
Philip G. Richards
|
|
Michael Meskes
|
|
Rich $alz
|
|
gjc@mitech.com
|
|
Joseph_Traub
|
|
Sven (VMS port maintainer)
|
|
Very Mad Students, University of Karlsruhe, FRG (VMS port)
|
|
|
|
Copyright:
|
|
All of the FSP code is free software. Most of fsp falls under two
|
|
copyrights, the 2-point BSD copyright and one by Wen-King Su:
|
|
|
|
Copyright (c) 1991 by Wen-King Su (wen-king@vlsi.cs.caltech.edu)
|
|
You may copy or modify this file in any manner you wish, provided
|
|
that this notice is always included, and that you hold the author
|
|
harmless for any loss or damage resulting from the installation or
|
|
use of this software.
|
|
|
|
Other contributions to fsp fall under different copyrights:
|
|
|
|
This file is Copyright 1992 by Philip G. Richards. All Rights Reserved.
|
|
See the file README that came with this distribution for permissions on
|
|
code usage, copying, and distribution. It comes with absolutely no warranty.
|
|
|
|
Copyright (c) 1993 by Michael Meskes
|
|
You may copy or modify this file in any manner you wish, provided
|
|
that this notice is always included, and that you hold the author
|
|
harmless for any loss or damage resulting from the installation or
|
|
use of this software.
|
|
</programlisting>
|
|
</para>
|
|
</sect2>
|
|
|
|
<sect2 id="projecthistory">
|
|
<title>Project history</title>
|
|
<para>
|
|
This should give you a short overview over the development of the &fsp;
|
|
in the past and today.
|
|
</para>
|
|
<sect3 id="histpast">
|
|
<title>The past</title>
|
|
<para>
|
|
In the past various people worked on the &fsp;, see
|
|
<xref linkend="licence">
|
|
</para>
|
|
</sect3>
|
|
<sect3 id="histtoday">
|
|
<title>Today</title>
|
|
<para>
|
|
Radim Kolar started to work on the &fsp; again in June 2003. Since
|
|
that time he's maintaining the source distribution. You can reach him
|
|
on the mailinglists or via e-mail <email>hsn@cybermail.net-nospam</email>.
|
|
</para>
|
|
<para>
|
|
Since September 2003 Sven Hoexter is working on parts of the documentation.
|
|
You can reach him on the mailinglists or via e-mail
|
|
<email>sven@du-gehoerst-mir.de-nospam</email>.
|
|
</sect2>
|
|
|
|
<sect2 id="credits">
|
|
<title>Developers and contributors</title>
|
|
<para>
|
|
See <xref linkend="licence">
|
|
</para>
|
|
</sect2>
|
|
|
|
</sect1>
|
|
<!-- end of the introduction -->
|
|
|
|
<!-- start with the installation instructions-->
|
|
<sect1 id="installation">
|
|
<title>Installation instructions</title>
|
|
<sect2 id="getfsp">
|
|
<title>How to get FSP</title>
|
|
<sect3 id="getsource">
|
|
<title>How to obtain the source distribution</title>
|
|
<para>
|
|
FIXME
|
|
Link back to the id whrecanifind and tell how to download a tar.gz file ;)
|
|
</para>
|
|
</sect3>
|
|
<sect3 id="getbinary">
|
|
<title>How to obtain a binary copy</title>
|
|
<para>
|
|
FIXME
|
|
Well maybe we can provide binary builds some time in the future
|
|
I startet a spec file for RH 7.3 (should be generic cause fsp is nearly dependencie free)
|
|
some time ago but never finished it
|
|
</para>
|
|
</sect3>
|
|
</sect2>
|
|
|
|
<sect2 id="compilesource">
|
|
<title>How to compile the source code</title>
|
|
<para>
|
|
FIXME
|
|
Tell the normal shit again, tar zxf, ./configure make make install
|
|
</para>
|
|
</sect2>
|
|
</sect1>
|
|
<!-- end of the installation instructions -->
|
|
|
|
<!-- start how to use on the server side -->
|
|
<sect1 id="serverside">
|
|
<title>How to set up your FSP server</title>
|
|
<para>
|
|
FIXME
|
|
Information about the fspd
|
|
</para>
|
|
</sect1>
|
|
<!-- end how to use the server -->
|
|
|
|
<!-- start how to use on the client side -->
|
|
<sect1 id="clientside">
|
|
<title>How to use the fsp client tools</title>
|
|
<para>
|
|
FIXME
|
|
Explain client tools and those f*cking shell script wrappers *hrhr*
|
|
Check the X based fsp tools, maybe they'll compile ...
|
|
</para>
|
|
</sect1>
|
|
<!-- end how to use the client -->
|
|
|
|
|
|
</article> |