www-apps/phpSANE/dev/doc/README_EN.txt

   1    phpSANE   (Version 0.6.0)
   2   ~~~~~~~~~
   3
   4 phpSANE is a web-based frontend for SANE written in PHP.
   5 Now you can scan with your web-browser, too.
   6
   7 Copyright (C) 2009  David Froehlich <dfroe@gmx.de>
   8                     and John Walsh <john.walsh@mini-net.co.uk>
   9                     and Wojciech Bronisz <wojtek@bronisz.eu>
  10
  11 This program is free software; you can redistribute it and/or modify it under
  12 the terms of the GNU General Public License as published by the Free Software
  13 Foundation; either version 2 of the License, or (at your option) any later
  14 version.
  15 This program is distributed in the hope that it will be useful, but
  16 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  17 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  18 details.
  19 You should have received a copy of the GNU General Public License along
  20 with this program; if not, write to the Free Software Foundation, Inc., 59
  21 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  22
  23
  24 ------------------------------------------------------------------------
  25
  26 Requirements:
  27 ^^^^^^^^^^^^^
  28 * SANE
  29 * netpbm
  30 * Apache web-server with PHP-support
  31 * gocr (optional)
  32
  33
  34 ------------------------------------------------------------------------
  35
  36 Installation:
  37 ^^^^^^^^^^^^^
  38 Just copy the phpSANE-directory into your www-root.
  39 Then you can scan by opening phpsane.php in your web-browser.
  40
  41
  42 ------------------------------------------------------------------------
  43
  44 FAQ:
  45 ^^^^
  46
  47 Q: How do I check if my scanner is working ?
  48
  49 A: Before trying phpSANE, it is a good idea to make sure that your
  50 scanner is detected and working from the local machine. To do this,
  51 just use one of the scanner applications :-
  52
  53 Application Menu->Graphics->Scanner Tool
  54 Application Menu->Graphics->The GIMP, File->Aquire->XSane: Device Dialog...
  55
  56 If your scanner does not work directly from your machine, then it will
  57 not work through phpSANE.
  58
  59 ----------
  60
  61 Q: My scanner isn't found by phpSANE ?
  62 Q: My scanner is detected, but when I preview or scan, the image file
  63 is empty ?
  64
  65 A: this is probably a permissions problem, try :-
  66
  67 chmod +s /usr/bin/scanimage
  68 chmod 775 WWW_PHPSANE_DIR/tmp
  69
  70 WWW_PHPSANE_DIR = the www file area you put phpSANE at.
  71
  72 ie. Make sure that your apache user is able to scan with scanimage,
  73 and your apache user must have write-access to the phpSANE tmp directory.
  74
  75 ----------
  76
  77 Q: phpSANE is showing my scanner by a different name/model ?
  78
  79 A: In different regions of the world, a scanner may be sold by different
  80 model names and numbers, but the internal hardware is exactly the same.
  81 So it may be that to the SANE project, the scanner is recognised by a
  82 different name to the one that you know your scanner as. For example,
  83 the Epson Perfection range of scanners are sold in Japan under the
  84 model names GT-****.
  85
  86 ----------
  87
  88 Q: phpSANE is working, but when I 'Scan', nothing happens ?
  89
  90 A: There could be two things wrong :-
  91
  92 a) the 'Scan Area' could be invalid,
  93 ie. you have not selected an area to scan.
  94
  95 b) when a scan completes, a new window is opened with the scan
  96 results to allow you to save it - this may be blocked by a
  97 'pop-up' blocker.
  98
  99 ----------
 100
 101 Q: phpSANE is working fine, but how do I restrict access to it to my
 102 internal network only ?
 103 A: in httpd.conf :-
 104
 105 <Directory "WWW_PHPSANE_DIR/">
 106     DirectoryIndex phpsane.php
 107     Order Deny,Allow
 108     Deny from all
 109     Allow from 127.0.0.0/8
 110     Allow from 192.168.1.0/24
 111 </Directory>
 112
 113 ------------------------------------------------------------------------