changeset 16:3cad40fda053

Updated README
author Ben Croston <ben@croston.org>
date Mon, 15 Aug 2011 19:25:52 +0100
parents cc41931a7ded
children a9dacd180597
files README
diffstat 1 files changed, 17 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/README	Mon Aug 15 18:38:59 2011 +0100
+++ b/README	Mon Aug 15 19:25:52 2011 +0100
@@ -12,20 +12,28 @@
 
     from zebra import zebra
 
-    z = zebra( [printerqueue] )
-      - Constructor with optional printerqueue
+    z = zebra( [queue] )
+      - Constructor with optional printer queue
 
     z.getqueues()
-      - Return a list containing a list of printer queues
+      - Return a list containing available printer queues
 
-    z.setqueue( printerqueue )
+    z.setqueue( queue )
       - Set the printer queue
 
-    z.setup(direct_thermal=None, label_height=None, label_width=None)
-      - Set up the printer
+    z.setup( direct_thermal=None, label_height=None, label_width=None )
+      Set up the label printer. Parameters are not set if they are None.
+
+        direct_thermal - True if using direct thermal labels
+        label_height   - tuple (label height, label gap) in dots
+        label_width    - in dots
 
-    z.store_graphic(name, filename)
-       - Store a graphics .PCX file on printer
+    z.store_graphic( name, filename )
+       Store a .PCX file on the label printer
 
-    z.output(commands)
+        name     - name to be used on printer
+        filename - local filename
+
+    z.output( commands )
        - Output EPL2 commands to the printer
+