www-apps/phpSANE-0.8.0
[anomen-overlay.git] / www-apps / phpSANE / dev / help / help_1.php
blob39f411c5ad38a5d48025371ae026cbe834dc05e7
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <head>
4 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
5 <meta name="author" content="root">
6 <meta name="robots" content="noindex">
7 <link rel="stylesheet" type="text/css" href="css/style.css">
8 <title>phpSANE: help</title>
9 </head>
10 <body>
12 <?PHP
14 // English Help
15 // ============
17 $SCANIMAGE = "/usr/bin/scanimage";
18 $cmd = $SCANIMAGE . " -h";
19 $sane_help = `$cmd`;
20 unset($cmd);
22 $start = strpos($sane_help, "\nOptions specific to device") + 1;
23 if ($start !== FALSE)
25 $sane_help = substr($sane_help, $start);
28 $start = strpos($sane_help, "\nType ``scanimage --help");
29 if ($start !== FALSE)
31 $sane_help = substr($sane_help, 0, $start);
34 echo <<<EOT
36 <h1>
37 phpSANE: Help
38 </h1>
40 <h3>
41 Scan Area
42 </h3>
44 <p>
45 Choosing a page size will set the required page dimensions.
46 </p>
48 <p>
49 Clicking on the 'preview image' area will set the appropriate
50 corner (top left or bottom right) to the mouse position.
51 </p>
54 <h3>
55 Scan Options
56 </h3>
58 <p>
59 Only the most basic options are supported directly,
60 that give you control over the image quality
61 (--mode and --resolution)
62 and the file format type to save the image as.
63 </p>
65 <h4>
66 Extra :-
67 </h4>
69 <p>
70 For your scanner,
71 the full list of options (from: scanimage -h) is :-
72 </p>
74 <p>
75 <pre>
76 {$sane_help}
77 </pre>
78 </p>
81 <p>
82 Any extra options you want to add to the scan command,
83 you can add them in this 'extra' field.
84 </p>
86 <p>
87 NB. Invalid characters are replaced with an 'X'.
88 </p>
90 <p>
91 eg. To control the brightness :-
92 </p>
94 <p>
95 The value is not stanard across all scanners,
96 so you need to see what options your scanner takes.
97 It may be a percentage,
98 or a number in a range (eg. -4..3).
99 </p>
102 eg.<br>
103 --brightness=50%<br>
104 --brightness 2<br>
105 </p>
108 <h3>
109 Action Buttons
110 </h3>
112 <h4>
113 Preview :-
114 </h4>
117 Does a scan of the whole area,
118 at a low resolution and displays it,
119 so you can view your document and select areas from it.
120 </p>
123 <h4>
124 Scan :-
125 </h4>
128 Does a scan of the area selected and lets you save the
129 output file (image or text).
130 </p>
133 <h4>
134 OCR :- (only available if 'gocr' is installed)
135 </h4>
138 Does a scan and uses OCR to convert the contents into an ASCII text file.
139 </p>
142 Recommend using Grayscale at 300dpi or above.
143 </p>
146 <h4>
147 Reset :-
148 </h4>
151 Re-loads the page,
152 but does nothing else.
153 </p>
156 <h4>
157 Clean :-
158 </h4>
161 Resets all parameters to their default values and clears the preview.
162 </p>
165 <h3>
166 Scan Command
167 </h3>
170 At the bottom of the page,
171 the command line used to perform the scan is displayed.
172 This allows you to manually check the format of the command
173 in case of errors.
174 </p>
176 EOT;
180 </body>
181 </html>