Add manpage for mllp_send via Sphinx.

johnpaulett · Dec 14, 2011 · b2afedd · b2afedd
1 parent ca0eccd
commit b2afedd
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -212,7 +212,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'python-hl7', u'python-hl7 Documentation',
+    ('mllp_send', 'mllp_send', 'MLLP network client',
      [u'John Paulett'], 1)
 ]
 

diff --git a/docs/contribute.rst b/docs/contribute.rst
@@ -22,7 +22,7 @@ The test suite is located in :file:`tests/` and can be run via :file:`setup.py`:
 
 Make sure the documentation is still valid::
 
-   $ pushd docs && make html && make doctest && popd
+   $ pushd docs && make html man doctest && popd
    ...
    Doctest summary
    ===============

diff --git a/docs/index.rst b/docs/index.rst
@@ -132,7 +132,7 @@ MLLP network client - ``mllp_send``
 
 python-hl7 features a simple network client, ``mllp_send``, which reads HL7
 messages from a file or ``sys.stdin`` and posts them to an MLLP server.
-``mllp_send`` is a command-line wrapper around 
+``mllp_send`` is a command-line wrapper around
 :py:class:`hl7.client.MLLPClient`.
 
 ::
@@ -144,7 +144,9 @@ messages from a file or ``sys.stdin`` and posts them to an MLLP server.
       -p PORT, --port=PORT  port to connect to
       -f FILE, --file=FILE  read from FILE instead of stdin
       -q, --quiet           do not print status messages to stdout
-
+      --loose               allow file to be a HL7-like object (\r\n instead of
+                            \r). Can ONLY send 1 message. Requires --file option
+                            (no stdin)
 
 Contents
 --------
@@ -153,6 +155,7 @@ Contents
    :maxdepth: 1
 
    api
+   mllp_send man page <mllp_send>
    contribute
    changelog
    authors

diff --git a/docs/mllp_send.rst b/docs/mllp_send.rst
@@ -0,0 +1,23 @@
+===================================
+``mllp_send`` - MLLP network client
+===================================
+
+python-hl7 features a simple network client, ``mllp_send``, which reads HL7
+messages from a file or ``sys.stdin`` and posts them to an MLLP server.
+``mllp_send`` is a command-line wrapper around
+:py:class:`hl7.client.MLLPClient`.
+
+::
+
+    Usage: mllp_send [options] <server>
+
+    Options:
+      -h, --help            show this help message and exit
+      -p PORT, --port=PORT  port to connect to
+      -f FILE, --file=FILE  read from FILE instead of stdin
+      -q, --quiet           do not print status messages to stdout
+      --loose               allow file to be a HL7-like object (\r\n instead of
+                            \r). Can ONLY send 1 message. Requires --file option
+                            (no stdin)
+
+For more details, visit http://python-hl7.readthedocs.org