ProFTPD Developer's Guide: Obtaining Copies

ProFTPD Version 1.2

Obtaining the ProFTPD Developer's Guide
This guide is distributed in two parts: the descriptive pages, and the source code pages. This is a necessary arrangement.

The descriptive pages, including the API indices, are available via CVS from SourceForge.net. When prompted for a password for anonymous, simply press the Enter key:

  cvs -d:pserver:anonymous@pdd.cvs.sourceforge.net:2401/cvsroot/pdd login 
                      
  cvs -z3 -d:pserver:anonymous@pdd.cvs.sourceforge.net:2401/cvsroot/pdd co devel-guide

Updates from within the module's directory do not need the -d parameter.

To obtain the source code pages, obtain the latest source code tarball from the www.proftpd.org site, and use my c2html Perl script (c2html -h for usage):

Create a directory outside the source code directory for the generated HTML pages:
```
    mkdir /tmp/proftpd
```

Unpack the source code tarball, and cd into that directory:

    tar zxvf proftpd-release.tar.gz
    cd proftpd-release

Use the ctags program to generate the information needed by c2html:
```
    ctags -R -x --sort=no > tags
```
Invoke c2html to generate the HTML pages:
```
    c2html -r -v -d /tmp/proftpd
```
Once the HTML has been generated, move the created directory under the devel-guide directory as src/:
```
    mv /tmp/proftpd devel-guide/src
```

You should now have a complete local copy of the ProFTPD Developer's Guide.

Table of Contents

Author: $Author: castaglia $
Last Updated: $Date: 2007/10/11 21:35:58 $