diff --git a/apps/sam/python/doc/guide/wiki/eeproxy.txt b/apps/sam/python/doc/guide/wiki/eeproxy.txt new file mode 100644 index 000000000..c6434903d --- /dev/null +++ b/apps/sam/python/doc/guide/wiki/eeproxy.txt @@ -0,0 +1,5 @@ +Title: Eeproxy + +The '''Eeproxy''' is run by the I2P router. The proxy is normally used for web browsers, as a means of accessing eepsites. + +The eeproxy is usually available at http://127.0.0.1:4444/. diff --git a/apps/sam/python/doc/guide/wiki/i2p.eep.txt b/apps/sam/python/doc/guide/wiki/i2p.eep.txt new file mode 100644 index 000000000..b6cbdcf89 --- /dev/null +++ b/apps/sam/python/doc/guide/wiki/i2p.eep.txt @@ -0,0 +1,18 @@ +Title: User's Guide:i2p.eep + +Module i2p.eep allows Python programs to access the [[Eeproxy]]. + +With this module, a program can easily download eepsites. + +== Functions == + +'''urlopen'''(url, eepaddr='127.0.0.1:4444') + +'''urlget'''(url, eepaddr='127.0.0.1:4444') + diff --git a/apps/sam/python/doc/guide/wiki/i2p.router.txt b/apps/sam/python/doc/guide/wiki/i2p.router.txt new file mode 100644 index 000000000..c1bd36e90 --- /dev/null +++ b/apps/sam/python/doc/guide/wiki/i2p.router.txt @@ -0,0 +1,51 @@ +Title: User's Guide:i2p.router + +Module i2p.router allows Python programs to control the I2P router. + +== Functions == + +'''check'''(dir=None) + +'''find'''(dir=None) + +'''start'''(dir=None, hidden=False) + +'''stop'''(dir=None, force=False) + diff --git a/apps/sam/python/doc/guide/wiki/i2p.sam.txt b/apps/sam/python/doc/guide/wiki/i2p.sam.txt new file mode 100644 index 000000000..0fcaaaaf1 --- /dev/null +++ b/apps/sam/python/doc/guide/wiki/i2p.sam.txt @@ -0,0 +1,202 @@ +Title: User's Guide:i2p.sam + +Module i2p.sam allows Python programs to access the [[SAM proxy]]. + +With this module, a program can send stream data, datagrams, and raw packets across the I2P network. + +== Sockets == + +'''socket'''(session, type, samaddr='127.0.0.1:7656', **kwargs) + +'''socket()''' object properties: + +'''poll'''() + + +'''resolve'''(host, samaddr='127.0.0.1:7656') + + +'''select'''(readlist, writelist, errlist, timeout=None) + + +== Tunnels == + +Tunnels allow stream sockets to be joined, so that connections to a listening socket are relayed to one or more sending sockets. This allows an ordinary web server to be exposed as an I2P Destination, or an I2P Destination to be bound as a local port, and so on. + +class '''Tunnel'''(self, receive, make_send, nconnect=-1, timeout=60.0) + + +'''close'''() + + +=== Tunnel Server === + +class '''TunnelServer'''(session, port, samaddr='127.0.0.1:7656', nconnect=-1, timeout=None, **kwargs) + + +'''TunnelServer''' properties: + + +=== Tunnel Client === + +class '''TunnelClient'''(session, port, dest, samaddr='127.0.0.1:7656', nconnect=-1, timeout=None, **kwargs) + + +'''TunnelClient''' properties: + + +== Errors == + +class '''Error'''(i2p.Error) + +class '''BlockError'''(Error) + +class '''ClosedError'''(Error) + +class '''NetworkError'''(Error) + + +== Constants == + +'''Socket types''' + +'''Packet sizes''' + +'''Flags for recv()''' + +'''Polling flags''' + diff --git a/apps/sam/python/doc/guide/wiki/i2p.txt b/apps/sam/python/doc/guide/wiki/i2p.txt new file mode 100644 index 000000000..2f69348f8 --- /dev/null +++ b/apps/sam/python/doc/guide/wiki/i2p.txt @@ -0,0 +1,22 @@ +Title: User's Guide:i2p + +Package i2p is a container package for more specific modules. + +It exports the following names: + + +class '''Error'''(Exception): + + +class '''RouterError'''(Error): + diff --git a/apps/sam/python/doc/guide/wiki/index.txt b/apps/sam/python/doc/guide/wiki/index.txt new file mode 100644 index 000000000..6bcfa254c --- /dev/null +++ b/apps/sam/python/doc/guide/wiki/index.txt @@ -0,0 +1,33 @@ +Title: Main Page + +'''Python-I2P''' is a Python interface to [http://www.i2p.net I2P]. + +== Quick Start == + +Install: + + + +Use: + + + +== User's Guide == + +The following modules are available: + + diff --git a/apps/sam/python/doc/guide/wiki/readme.txt b/apps/sam/python/doc/guide/wiki/readme.txt new file mode 100644 index 000000000..c836781fc --- /dev/null +++ b/apps/sam/python/doc/guide/wiki/readme.txt @@ -0,0 +1,18 @@ + +The documentation was created by using MediaWiki software. + +This directory houses the wiki text sources. + +Feel free to move to any other documentation system, if +it is efficient and easy to maintain. + +Ideally, one could patch pydoc to export only certain +names, in a certain order, like so: + +__pydoc__ = ['f', 'g'] # f() and g() documented in order + +This could proceed recursively for all namespaces. + +Combine this with a second patch to make pydoc create +nice CSS, and this whole guide could be generated +directly from the sources. diff --git a/apps/sam/python/doc/guide/wiki/samproxy.txt b/apps/sam/python/doc/guide/wiki/samproxy.txt new file mode 100644 index 000000000..8cda1c6d4 --- /dev/null +++ b/apps/sam/python/doc/guide/wiki/samproxy.txt @@ -0,0 +1,7 @@ +Title: SAM proxy + +A '''SAM proxy''' is run by the I2P router. The proxy allows streams, datagrams, and raw packets to be sent through the I2P network. A client application uses a telnet-like session to communicate with the proxy. In this way, the core features of the I2P library can be used by any language. + +The protocol used for SAM is described in [http://dev.i2p.net/pipermail/i2p/2004-July/000353.html SAM 1.0]. + +In practice, a ''SAM library'' is usually written, so that client applications do not need to use the low-level SAM commands.