www-apps/phpSANE-0.8.0
[anomen-overlay.git] / www-apps / phpSANE / dev / help / help_7.php
blob2ce6b89323834a6d12ba987b5cd055aa43b61877
1 <?php
3 echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4 <html>
5 <head>
6 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
7 <meta name="author" content="root">
8 <meta name="robots" content="noindex">
9 <link rel="stylesheet" type="text/css" href="css/style.css">
10 <title>phpSANE: help</title>
11 </head>
12 <body>';
15 // Polish Help
16 // ============
18 $SCANIMAGE = "/usr/bin/scanimage";
19 $cmd = $SCANIMAGE . " -h";
20 $sane_help = `$cmd`;
21 unset($cmd);
23 $start = strpos($sane_help, "\nOptions specific to device") + 1;
24 if ($start !== FALSE)
26 $sane_help = substr($sane_help, $start);
29 $start = strpos($sane_help, "\nType ``scanimage --help");
30 if ($start !== FALSE)
32 $sane_help = substr($sane_help, 0, $start);
35 echo <<<EOT
37 <h1>
38 phpSANE: Help
39 </h1>
41 <h3>
42 Scan Area
43 </h3>
45 <p>
46 Choosing a page size will set the required page dimensions.
47 </p>
49 <p>
50 Clicking on the 'preview image' area will set the appropriate
51 corner (top left or bottom right) to the mouse position.
52 </p>
55 <h3>
56 Scan Options
57 </h3>
59 <p>
60 Only the most basic options are supported directly,
61 that give you control over the image quality
62 (--mode and --resolution)
63 and the file format type to save the image as.
64 </p>
66 <h4>
67 Extra :-
68 </h4>
70 <p>
71 For your scanner,
72 the full list of options (from: scanimage -h) is :-
73 </p>
75 <p>
76 <pre>
77 {$sane_help}
78 </pre>
79 </p>
82 <p>
83 Any extra options you want to add to the scan command,
84 you can add them in this 'extra' field.
85 </p>
87 <p>
88 NB. Invalid characters are replaced with an 'X'.
89 </p>
91 <p>
92 eg. To control the brightness :-
93 </p>
95 <p>
96 The value is not stanard across all scanners,
97 so you need to see what options your scanner takes.
98 It may be a percentage,
99 or a number in a range (eg. -4..3).
100 </p>
103 eg.<br>
104 --brightness=50%<br>
105 --brightness 2<br>
106 </p>
109 <h3>
110 Action Buttons
111 </h3>
113 <h4>
114 Preview :-
115 </h4>
118 Does a scan of the whole area,
119 at a low resolution and displays it,
120 so you can view your document and select areas from it.
121 </p>
124 <h4>
125 Scan :-
126 </h4>
129 Does a scan of the area selected and lets you save the
130 output file (image or text).
131 </p>
134 <h4>
135 OCR :- (only available if 'gocr' is installed)
136 </h4>
139 Does a scan and uses OCR to convert the contents into an ASCII text file.
140 </p>
143 Recommend using Grayscale at 300dpi or above.
144 </p>
147 <h4>
148 Reset :-
149 </h4>
152 Re-loads the page,
153 but does nothing else.
154 </p>
157 <h4>
158 Clean :-
159 </h4>
162 Resets all parameters to their default values and clears the preview.
163 </p>
166 <h3>
167 Scan Command
168 </h3>
171 At the bottom of the page,
172 the command line used to perform the scan is displayed.
173 This allows you to manually check the format of the command
174 in case of errors.
175 </p>
177 EOT;
181 </body>
182 </html>