[Python-checkins] r82020 - in python/branches/release26-maint: Doc/library/simplehttpserver.rst

[senthil.kumaran]

Author: senthil.kumaran
Date: Wed Jun 16 18:17:33 2010
New Revision: 82020

Log:
Merged revisions 82018 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r82018 | senthil.kumaran | 2010-06-16 20:25:31 +0530 (Wed, 16 Jun 2010) | 3 lines
  
  Fix Issue8937 - SimpleHTTPServer should contain usage example
........


Modified:
   python/branches/release26-maint/   (props changed)
   python/branches/release26-maint/Doc/library/simplehttpserver.rst

Modified: python/branches/release26-maint/Doc/library/simplehttpserver.rst
==============================================================================
--- python/branches/release26-maint/Doc/library/simplehttpserver.rst	(original)
+++ python/branches/release26-maint/Doc/library/simplehttpserver.rst	Wed Jun 16 18:17:33 2010
@@ -81,12 +81,34 @@
       contents of the file are output. If the file's MIME type starts with
       ``text/`` the file is opened in text mode; otherwise binary mode is used.
 
-      For example usage, see the implementation of the :func:`test` function.
+      The :func:`test` function in the :mod:`SimpleHTTPServer` module is an
+      example which interfaces the :class:`SimpleHTTPRequestHandler` as a
+      Handler to the :mod:`BaseHTTPServer` module.
 
       .. versionadded:: 2.5
          The ``'Last-Modified'`` header.
 
 
+The :mod:`SimpleHTTPServer` module can be used the following manner in order to
+setup a very basic web server serving files relative to the current directory.::
+
+        import SimpleHTTPServer
+        import SocketServer
+
+        PORT = 8000
+
+        Handler = SimpleHTTPServer.SimpleHTTPRequestHandler
+
+        httpd = SocketServer.TCPServer(("", PORT), Handler)
+
+        print "serving at port", PORT
+        httpd.serve_forever()
+
+It can also be invoked directly using the ``-m`` switch of interpreter a with
+``port number`` argument.::
+
+        python -m SimpleHTTPServer 8000
+
 .. seealso::
 
    Module :mod:`BaseHTTPServer`