summaryrefslogtreecommitdiff
path: root/debian/manpage/python-engineio.1
diff options
context:
space:
mode:
Diffstat (limited to 'debian/manpage/python-engineio.1')
-rw-r--r--debian/manpage/python-engineio.180
1 files changed, 48 insertions, 32 deletions
diff --git a/debian/manpage/python-engineio.1 b/debian/manpage/python-engineio.1
index 76f30d0..2951d7b 100644
--- a/debian/manpage/python-engineio.1
+++ b/debian/manpage/python-engineio.1
@@ -1,4 +1,5 @@
-.\" Man page generated from reStructuredText.
+.\" Man page generated from reStructuredText
+.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
@@ -27,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "PYTHON-ENGINEIO" "1" "May 19, 2025" "" "python-engineio"
+.TH "PYTHON-ENGINEIO" "1" "Dec 29, 2025" "" "python-engineio"
.SH NAME
python-engineio \- python-engineio Documentation
.sp
@@ -189,16 +190,16 @@ Two versions of the server, one for standard Python and another for \fBasyncio\f
Supports large number of clients even on modest hardware due to being
asynchronous.
.IP \(bu 2
-Can be hosted on any \X'tty: link https://wsgi.readthedocs.io/en/latest/index.html'\fI\%WSGI\fP\X'tty: link' and
-\X'tty: link https://asgi.readthedocs.io/en/latest/'\fI\%ASGI\fP\X'tty: link' web servers includind
-\X'tty: link https://gunicorn.org/'\fI\%Gunicorn\fP\X'tty: link', \X'tty: link https://github.com/encode/uvicorn'\fI\%Uvicorn\fP\X'tty: link',
-\X'tty: link http://eventlet.net/'\fI\%eventlet\fP\X'tty: link' and \X'tty: link http://gevent.org'\fI\%gevent\fP\X'tty: link'\&.
+Can be hosted on any WSGI \%<https://\:wsgi\:.readthedocs\:.io/\:en/\:latest/\:index\:.html> and
+ASGI \%<https://\:asgi\:.readthedocs\:.io/\:en/\:latest/> web servers includind
+Gunicorn \%<https://\:gunicorn\:.org/>, Uvicorn \%<https://\:github\:.com/\:encode/\:uvicorn>,
+eventlet \%<http://\:eventlet\:.net/> and gevent \%<http://\:gevent\:.org>\&.
.IP \(bu 2
Can be integrated with WSGI applications written in frameworks such as Flask, Django,
etc.
.IP \(bu 2
-Can be integrated with \X'tty: link http://aiohttp.readthedocs.io/'\fI\%aiohttp\fP\X'tty: link',
-\X'tty: link http://sanic.readthedocs.io/'\fI\%sanic\fP\X'tty: link' and \X'tty: link http://www.tornadoweb.org/'\fI\%tornado\fP\X'tty: link'
+Can be integrated with aiohttp \%<http://\:aiohttp\:.readthedocs\:.io/>,
+sanic \%<http://\:sanic\:.readthedocs\:.io/> and tornado \%<http://\:www\:.tornadoweb\:.org/>
\fBasyncio\fP applications.
.IP \(bu 2
Uses an event\-based architecture implemented with decorators that hides the
@@ -521,9 +522,17 @@ eio = engineio.AsyncClient(logger=True)
.UNINDENT
.UNINDENT
.sp
-The \fBlogger\fP argument can be set to \fBTrue\fP to output logs to \fBstderr\fP, or
-to an object compatible with Python\(aqs \fBlogging\fP package where the logs should
-be emitted to. A value of \fBFalse\fP disables logging.
+The \fBlogger\fP argument controls logging behavior:
+.INDENT 0.0
+.IP \(bu 2
+\fBTrue\fP: Enables log output to \fBstderr\fP at the \fBINFO\fP level.
+.IP \(bu 2
+\fBFalse\fP: Enables log output to \fBstderr\fP at the \fBERROR\fP level. This is
+the default.
+.IP \(bu 2
+A \fBlogging.Logger\fP instance: Uses the provided logger without additional
+configuration.
+.UNINDENT
.sp
Logging can help identify the cause of connection problems, unexpected
disconnections and other issues.
@@ -555,7 +564,7 @@ pip install \(dqpython\-engineio\(dq
.sp
In addition to the server, you will need to select an asynchronous framework
or server to use along with it. The list of supported packages is covered
-in the \fI\%Deployment Strategies\fP section.
+in the Deployment Strategies section.
.SS Creating a Server Instance
.sp
An Engine.IO server is an instance of class \fBengineio.Server\fP\&. This
@@ -1023,9 +1032,17 @@ eio = engineio.AsyncServer(logger=True)
.UNINDENT
.UNINDENT
.sp
-The \fBlogger\fP argument can be set to \fBTrue\fP to output logs to \fBstderr\fP, or
-to an object compatible with Python\(aqs \fBlogging\fP package where the logs should
-be emitted to. A value of \fBFalse\fP disables logging.
+The \fBlogger\fP argument controls logging behavior:
+.INDENT 0.0
+.IP \(bu 2
+\fBTrue\fP: Enables log output to \fBstderr\fP at the \fBINFO\fP level.
+.IP \(bu 2
+\fBFalse\fP: Enables log output to \fBstderr\fP at the \fBERROR\fP level. This is
+the default.
+.IP \(bu 2
+A \fBlogging.Logger\fP instance: Uses the provided logger without additional
+configuration.
+.UNINDENT
.sp
Logging can help identify the cause of connection problems, 400 responses,
bad performance and other issues.
@@ -1064,7 +1081,7 @@ The \fBASGIApp\fP instance is a fully complaint ASGI instance that can be
deployed with an ASGI compatible web server.
.SS Aiohttp
.sp
-\X'tty: link http://aiohttp.readthedocs.io/'\fI\%aiohttp\fP\X'tty: link' provides a framework with support
+aiohttp \%<http://\:aiohttp\:.readthedocs\:.io/> provides a framework with support
for HTTP and WebSocket, based on asyncio.
.sp
Instances of class \fBengineio.AsyncServer\fP will automatically use aiohttp
@@ -1106,7 +1123,7 @@ if __name__ == \(aq__main__\(aq:
.UNINDENT
.SS Tornado
.sp
-\X'tty: link http://www.tornadoweb.org//'\fI\%Tornado\fP\X'tty: link' is a web framework with support
+Tornado \%<http://\:www\:.tornadoweb\:.org//> is a web framework with support
for HTTP and WebSocket. Only Tornado version 5 and newer are supported, thanks
to its tight integration with asyncio.
.sp
@@ -1158,7 +1175,7 @@ Note: Due to some backward incompatible changes introduced in recent versions
of Sanic, it is currently recommended that a Sanic application is deployed with
the ASGI integration instead.
.sp
-\X'tty: link http://sanic.readthedocs.io/'\fI\%Sanic\fP\X'tty: link' is a very efficient asynchronous web
+Sanic \%<http://\:sanic\:.readthedocs\:.io/> is a very efficient asynchronous web
server for Python.
.sp
Instances of class \fBengineio.AsyncServer\fP will automatically use Sanic for
@@ -1200,7 +1217,7 @@ if __name__ == \(aq__main__\(aq:
.UNINDENT
.sp
It has been reported that the CORS support provided by the Sanic extension
-\X'tty: link https://github.com/ashleysommer/sanic-cors'\fI\%sanic\-cors\fP\X'tty: link' is incompatible with
+sanic\-cors \%<https://\:github\:.com/\:ashleysommer/\:sanic-cors> is incompatible with
this package\(aqs own support for this protocol. To disable CORS support in this
package and let Sanic take full control, initialize the server as follows:
.INDENT 0.0
@@ -1224,7 +1241,7 @@ app.config[\(aqCORS_SUPPORTS_CREDENTIALS\(aq] = True
.UNINDENT
.SS Eventlet
.sp
-\X'tty: link http://eventlet.net/'\fI\%Eventlet\fP\X'tty: link' is a high performance concurrent networking
+Eventlet \%<http://\:eventlet\:.net/> is a high performance concurrent networking
library for Python 2 and 3 that uses coroutines, enabling code to be written in
the same style used with the blocking standard library functions. An Engine.IO
server deployed with eventlet has access to the long\-polling and WebSocket
@@ -1257,7 +1274,7 @@ eventlet.wsgi.server(eventlet.listen((\(aq\(aq, 8000)), app)
.SS Eventlet with Gunicorn
.sp
An alternative to running the eventlet WSGI server as above is to use
-\fI\%gunicorn\fP, a fully featured pure Python web server. The
+gunicorn \%<gunicorn\:.org>, a fully featured pure Python web server. The
command to launch the application under gunicorn is shown below:
.INDENT 0.0
.INDENT 3.5
@@ -1281,7 +1298,7 @@ versions. While python\-engineio does not require monkey patching, other
libraries such as database drivers are likely to require it.
.SS Gevent
.sp
-\X'tty: link http://gevent.org'\fI\%Gevent\fP\X'tty: link' is another asynchronous framework based on
+Gevent \%<http://\:gevent\:.org> is another asynchronous framework based on
coroutines, very similar to eventlet. An Engine.IO server deployed with
gevent has access to the long\-polling and websocket transports.
.sp
@@ -1313,7 +1330,7 @@ pywsgi.WSGIServer((\(aq\(aq, 8000), app).serve_forever()
.SS Gevent with Gunicorn
.sp
An alternative to running the gevent WSGI server as above is to use
-\fI\%gunicorn\fP, a fully featured pure Python web server. The
+gunicorn \%<gunicorn\:.org>, a fully featured pure Python web server. The
command to launch the application under gunicorn is shown below:
.INDENT 0.0
.INDENT 3.5
@@ -1371,7 +1388,7 @@ $ uwsgi \-\-http :5000 \-\-gevent 1000 \-\-http\-websockets \-\-master \-\-wsgi\
While not comparable to eventlet and gevent in terms of performance,
the Engine.IO server can also be configured to work with multi\-threaded web
servers that use standard Python threads. This is an ideal setup to use with
-development servers such as \X'tty: link http://werkzeug.pocoo.org'\fI\%Werkzeug\fP\X'tty: link'\&.
+development servers such as Werkzeug \%<http://\:werkzeug\:.pocoo\:.org>\&.
.sp
Instances of class \fBengineio.Server\fP will automatically use the threading
mode if neither eventlet nor gevent are not installed. To request the
@@ -1421,7 +1438,7 @@ With the above configuration the server will be able to handle up to 100
concurrent clients.
.sp
When using standard threads, WebSocket is supported through the
-\X'tty: link https://github.com/miguelgrinberg/simple-websocket'\fI\%simple\-websocket\fP\X'tty: link'
+simple\-websocket \%<https://\:github\:.com/\:miguelgrinberg/\:simple-websocket>
package, which must be installed separately. This package provides a
multi\-threaded WebSocket server that is compatible with Werkzeug and Gunicorn\(aqs
threaded worker. Other multi\-threaded web servers are not supported and will
@@ -1466,15 +1483,14 @@ attacks.
.SH API REFERENCE
.INDENT 0.0
.IP \(bu 2
-\fI\%Index\fP
+Index \%<>
.IP \(bu 2
-\fI\%Module Index\fP
+Module Index \%<>
.IP \(bu 2
-\fI\%Search Page\fP
+Search Page \%<>
.UNINDENT
-.SH AUTHOR
+.SH Author
Miguel Grinberg
-.SH COPYRIGHT
+.SH Copyright
2018, Miguel Grinberg
-.\" Generated by docutils manpage writer.
-.
+.\" End of generated man page.