updated README

Wed, 05 Aug 2009 17:32:05 +0100

author
Philip Pemberton <philpem@philpem.me.uk>
date
Wed, 05 Aug 2009 17:32:05 +0100
changeset 18
fd1c6f6066da
parent 17
cf9d239ac1c9
child 19
b7fe751ea60d

updated README

README file | annotate | diff | revisions
     1.1 --- a/README	Wed Aug 05 17:10:56 2009 +0100
     1.2 +++ b/README	Wed Aug 05 17:32:05 2009 +0100
     1.3 @@ -7,7 +7,7 @@
     1.4  =================
     1.5    1. What is libptouch?
     1.6    2. Supported printers
     1.7 -  3. Building and Using libptouch
     1.8 +  3. Building and Installing libptouch
     1.9    T. TODO, aka Things That Don't Work Yet.
    1.10    R. References
    1.11  
    1.12 @@ -73,12 +73,15 @@
    1.13  " " = No
    1.14  
    1.15  
    1.16 -3. Building and Using libptouch
    1.17 -===============================
    1.18 +3. Building and Installing libptouch
    1.19 +====================================
    1.20  To build libptouch, you will need:
    1.21    GNU gcc    version 3.1 or later  (libptouch is tested with gcc 4.3.3)
    1.22    GNU make   version 3.80 or later (libptouch is tested with make 3.81)
    1.23 -  libgd      version 2.0 or higher (libptouch is tested with libgd 2.0.36)
    1.24 +  libgd      version 2.0 or later  (libptouch is tested with libgd 2.0.36)
    1.25 +
    1.26 +To build the documentation, you will also need:
    1.27 +  doxygen    version 1.5 or later  (libptouch is tested with doxygen 1.5.8)
    1.28  
    1.29  Briefly, this means any common Linux distribution (Debian or RedHat based)
    1.30  released in 2006 or later should successfully build libptouch. As for other
    1.31 @@ -96,6 +99,33 @@
    1.32  
    1.33  This will build the libptouch library and documentation from the source code.
    1.34  
    1.35 +To install libptouch into /usr/local, type:
    1.36 +  $ make install
    1.37 +
    1.38 +To install libptouch into another directory, say /opt/libptouch, type:
    1.39 +  $ make install PREFIX=/opt/libptouch
    1.40 +
    1.41 +
    1.42 +4. Using libptouch
    1.43 +==================
    1.44 +[... TODO ...]
    1.45 +
    1.46 +
    1.47 +5. Using libptouch-based Applications Without Superuser Privileges
    1.48 +==================================================================
    1.49 +To use a libptouch-based application without superuser (root) privileges, you
    1.50 +must do one of two things:
    1.51 +
    1.52 +  1. Set the application's group ID to the user that normally owns printers
    1.53 +     (or serial ports) on your system, then chmod the application to "g+S"
    1.54 +     (turn the Set Group ID bit on). This will only work if all your printers
    1.55 +     use the same interface type, e.g. all serial or all USB.
    1.56 +
    1.57 +  2. Add the user who will be running the application to the 'lp' or 'dialout'
    1.58 +     group (for USB or serial printers respectively). Note that a user can be
    1.59 +     a member of more than one group -- see your system documentation for more
    1.60 +     information.
    1.61 +
    1.62  
    1.63  T. TODO, aka Things That Don't Work Yet.
    1.64  ========================================