Commits

Armin Rigo committed a73e3a8

Change instructions to point to sshgraphserver instead
of graphserver.

  • Participants
  • Parent commits b7b0a7a

Comments (0)

Files changed (3)

dotviewer/dotviewer.py

 
     dotviewer.py filename.dot
     dotviewer.py filename.plain
-    dotviewer.py --server [interface:]port
 
 In the first form, show the graph contained in a .dot file.
 In the second form, the graph was already compiled to a .plain file.
-In the third form, listen for connexion on the given port and display
-the graphs sent by the remote side.  On the remote site, set the
-GRAPHSERVER environment variable to HOST:PORT.  See graphserver.py
-for more instructions.
 """
 
 import sys
         if option in ('-h', '--help'):
             print >> sys.stderr, __doc__
             sys.exit(2)
-        if option in ('-s', '--server'):
+        if option in ('-s', '--server'):      # deprecated
             server_addr = value
     if not args and server_addr is None:
         print >> sys.stderr, __doc__

dotviewer/graphclient.py

         pass
 
 def spawn_handler():
-    gsvar = os.environ.get('GRAPHSERVER')
+    gsvar = os.environ.get('GRAPHSERVER')      # deprecated
     if not gsvar:
         try:
             return spawn_sshgraphserver_handler()

dotviewer/graphserver.py

 #! /usr/bin/env python
-"""
-Usage:
-    graphserver.py [interface:]port
-    dotviewer.py --server [interface:]port
+"""Graph server.
 
-Start a server listening for connexions on the given port.  The two ways
-to start a server are equivalent.  The server displays the graphs sent
-by a remote process.  On the remote process' side, set the GRAPHSERVER
-environment variable to HOST:PORT.
-
-Here is a step-by-step example on how to use it in combination with ssh
-port forwarding (replace 9999 with a random port number of your choice,
-e.g. between 8000 and 20000):
-
-  - on your local machine, run:
-        graphserver.py localhost:9999
-
-  - connect to a remote machine, allowing the remote side to contact
-    your local dotviewer:
-        ssh -R9999:localhost:9999 machinename
-
-  - set the $GRAPHSERVER env var on the remote machine to point to the
-    redirected port (in bash):
-        export GRAPHSERVER=:9999
-
-  - then any graph-viewing command you execute while $GRAPHSERVER is set
-    will reach your local dotviewer and basically appear to work
-    completely transparently.
-
-  - to automate steps 2 and 3, I've put the following entry in my local
-    .ssh/config:
-                    Host machinename
-                        RemoteForward 9999 127.0.0.1:9999
-
-    and I've added the 'export GRAPHSERVER=:9999' line to my .bashrc on
-    the remote machine.
+From the command-line it's easier to use sshgraphserver.py instead of this.
 """
 
 import sys
             traceback.print_exc(file=f)
             # try to add some explanations
             help = (" | if you want to debug on a remote machine, see\n"
-                    " | instructions in dotviewer/graphserver.py\n")
+                    " | instructions in dotviewer/sshgraphserver.py\n")
             try:
                 import pygame
             except ImportError: