[doc] add documentation of FTPServer constructor to help(pyftpdlib)

[GoogleCodeExporter]

help(pyftpdlib) doesn't contain any information about the handling of address 
parameter passed to the constructor, futhermore I experienced the following 
inconsistence between my version 1.2.0 (running on Ubuntu 14.04 with both 
python 2.7.6 and 3.4.0) and the wiki:
<code>
python -m pyftpdlib -i 127.0.0.1 -p 8021
</code>
returns
<output>
[I 14-05-11 01:31:48] >>> starting FTP server on 127.0.0.1:8021, pid=21752 <<<
[I 14-05-11 01:31:48] poller: <class 'pyftpdlib.ioloop.Epoll'>
[I 14-05-11 01:31:48] masquerade (NAT) address: None
[I 14-05-11 01:31:48] passive ports: None
[I 14-05-11 01:31:48] use sendfile(2): True
</output>
instead of 
<output>
[I 13-02-20 14:16:36] >>> starting FTP server on 0.0.0.0:21 <<<
[I 13-02-20 14:16:36] poller: <class 'pyftpdlib.ioloop.Epoll'>
[I 13-02-20 14:16:36] masquerade (NAT) address: None
[I 13-02-20 14:16:36] passive ports: None
[I 13-02-20 14:16:36] use sendfile(2): True
</output>
as shown in the wiki https://code.google.com/p/pyftpdlib/wiki/FAQ. 

Besides a general need for this improvement of the docs, I need clearification 
in order to investigate further and file a bug report if necessary.

Original issue reported on code.google.com by karl.ric...@gmail.com on 10 May 2014 at 11:40

[GoogleCodeExporter]

port in the second output should be 8021 instead of 21 (can't edit :( )

Original comment by karl.ric...@gmail.com on 10 May 2014 at 11:42

[GoogleCodeExporter]

> help(pyftpdlib) doesn't contain any information about the handling of address 
parameter passed to the constructor, 

What do you mean? The "address" parameter is already explained in the doc. 
help(pyftpdlib) is not meant to provide an extended set of information, just a 
brief description of the lib and a quick & dirty example usage.

As for the "port 8021" issue: I just edited the doc (thanks for signaling).

Original comment by g.rodola on 12 May 2014 at 7:12

[GoogleCodeExporter]

It is not clear whether the address is the address where pyftpdlib listens (I 
assumed this from 0.0.0.0) or the address where the socket is created.

Original comment by karl.ric...@gmail.com on 15 May 2014 at 6:21

[GoogleCodeExporter]

> [...] or the address where the socket is created.

This doesn't make sense.
The ip:port pair is the address where the socket *listens*, and it should be 
clear if you're used to network/socket programming.

Original comment by g.rodola on 15 May 2014 at 6:48

[GoogleCodeExporter]

OK, I thought it might be some sort of access restriction for client (as I 
partly pointed out initially, I needed clearification to check whether access 
works). It should be clearer with the correction of the example :)

Original comment by karl.ric...@gmail.com on 15 May 2014 at 7:19

[GoogleCodeExporter]

Original comment by g.rodola on 16 May 2014 at 2:37

• Changed state: Invalid