mirror
/
sane-project-website
kopia lustrzana https://gitlab.com/sane-project/website
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Added information on how to contribute to SANE (from man sane and 

meier-geinitz.de).
merge-requests/1/head
Henning Geinitz 2003-09-23 19:44:12 +00:00
rodzic 8404165c93
commit 32e9d7c837
4 zmienionych plików z 258 dodań i 12 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

151
contrib.html 100644
Wyświetl plik

@ -0,0 +1,151 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>SANE - Contributing</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="author" content="Henning Meier-Geinitz">
<meta name="keywords" content="sane, scanner, help, helping, contributing, contribution">
<meta name="description" content="Contributing to SANE">
<link href="mailto:hmg-guest@users.alioth.debian.org" rev="made">
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<center>
<a href="http://www.sane-project.org"><img src="images/sane.png"
alt="SANE" height="117" width="346" border="0"></a>
</center>
<center>
<h1>SANE - Contributing or: How Can You Help SANE?</h1>
</center>
<hr>
<p>
We appreciate any help we can get. Here are some topics on which you can work:
</p>
<h2><a href="manufacturers.html">Information for Manufacturers</a></h2>
<p>
Are you a manufacturer or vendor of scanners and one of your scanners is not supported by SANE
yet? In this case please have a look at our <a
href="manufacturers.html">information for manufacturers</a>.
</p>
<h2>Reporting Unsupported Scanners and Adding more information</h2>
<p>
If you can provide more information for one of the scanners that's listed as "unsupported" in
our <a href="lists/sane-backends-cvs.html#UNSUPPORTED">current list of unsupported
scanners</a> or even want to add a new scanner, please send all information you have to us.
If you own an unsupported scanner, please send as much information as possible. Especially the
output of <em>sane-find-scanner -v -v</em> and/or <em>cat /proc/scsi/scsi</em> (for SCSI
scanners) or <em>cat /proc/bus/usb/devices</em> (for USB scanners) can help. If you dare to
open the scanner, have a look at the text that's printed on the chips. That may help to
identify the chipset. If you know that the scanner is similar to another one (e.g. supported
by the same Windows driver), please also mention this fact. Contact us by using using <a
href="http://www.meier-geinitz.de:80/tinc?key=rDoQ7lrj&#38;formname=adddev">the form for
adding an unsupported device</a> or by sending mail to the <a
href="mailing-lists.html">sane-devel mailing list</a>. If you think anything in the list or
on this web page is wrong, please also contact us or <a href="bugs.html">file a bug
report</a>.
</p>
<h2>Writing a Backend (Driver)</h2>
<p>
If your scanner is unsupported by SANE, please consider writing a
backend for it. As scanners are very different to each other, you can't
expect the SANE developers to write the backend for you. If your scanner
is similar to one that already works, it may be easy to add support. But
if it's necessary to write a completely new backend, it's up to you.
</p>
<p>
The time and skills needed for writing a backend depends on the
"intelligence" of the scanner. If it's rather high-level,
i.e. understand commands like "scan-at-600-dpi", it may be possible to
write a basic driver in 10-20 hours. If the protocol is more low-level
(e.g. move-motor-one-step), it can take much longer.
</p>
<p>
You don't need to be an experienced programmer. Backends are usually
written in C, so some basic knowledge of this language helps. You need a
lot of patience, however, especially if you can't get programmer's
documentation from your scanner's manufacturer.
</p>
<p>
If you intend to write a backend: contact the <a href="mailing-lists.html">sane-devel mailing
list</a> and let us know. Get all the information about your scanner that's available: chipset
application manual (sometimes it's on the web), Windows drivers used (sometimes they tell
which chipset is used), programmer's information (if the manufacturer provides those). If you
don't have enough information about the protocol used by the scanner, <a
href="http://www.meier-Geinitz.de/sane/misc/develop.html">try to find out what the MS Windows
driver does</a>. For basic information about how SANE works, get the latest <a
href="cvs.html">development version of SANE</a>, read man sane and
doc/backend-writing.txt. Also have a look at existing backends, e.g. one of the USB backends,
if you want to support a USB scanner.
</p>
<h2>Writing a Frontend</h2>
<p>
There are already <a href="sane-frontends.html">some very capable frontends</a>. So helping
with improving the existing frontends may make more sense than to write yet another one. On
the other hand there may be reasons to start writing a completely new frontend, like support
for a specific widget set, a programming language or a special type of devices (e.g. cameras,
slide scanners). In any case, keep the <a href="mailing-lists.html">sane-devel mailing
list</a> informed of your plans.
</p>
<h2>Reporting Bugs and Missing Features</h2>
<p>
If you think something in SANE isn't working as it should, please don't hesitate to <a
href="bugs.html">file a bug report</a> Please provide as many details as possible. Describe
which software you are using (operating system + version, distribution, version of
sane-backends and of the frontend you use). Explain exactly what doesn't work, is wrong or
missing.
</p>
<h2>Adding and fixing documentation</h2>
<p>
If you found a bug in any documentation (man pages, web site, READMEs), please contact us
using the <a href="mailing-lists.html">sane-devel mailing list</a> or <a href="bugs.html">file
a bug report</a>. Also write us if you think some documentation is missing. Please include a
patch in this case, if possible. Don't hesitate to send spelling and grammar mistakes. Most of
us are not native English speakers.
</p>
<h2>Translations</h2>
<p>
The options of the backends can be translated. For some languages, the translations are almost
complete, but some are lacking a lot of words and for most languages there is no translation
at all. If you want to help to translate the options to your native language (or a language
you speak fluently), contact the <a href="mailing-lists.html">sane-devel mailing list</a> and
have a look at the po/ directory in the <a href="cvs.html">source code</a>.
</p>
<h2>Success reports</h2>
<p>
If you had success using SANE we want to know about that, too. Especially if your scanner is
not in the lists yet or is marked "untested". Please send an email to the <a
href="mailing-lists.html">sane-devel mailing list</a> or <a href="bugs.html">file a bug
report</a>.
</p>
<hr>
<p>
<a href="/">SANE homepage</a><br>
<a href="imprint.html">Contact</a>
</p>
<p>
<font size="-1">$Date$ $Author$</font>
</p>
</body>
</html>

3
index.html
Wyświetl plik

@ -99,9 +99,10 @@
<h2> <a href="sane-supported-devices.html">Supported devices</a></h2>
<h2> <a href="sane-frontends.html">Applications (frontends)</a></h2>
<h2> <a href="docs.html">Documentation</a></h2>
<h2> <a href="source.html">Download</a></h2>
<h2> <a href="mailing-lists.html">Mailing Lists and IRC Channel</a></h2>
<h2> <a href="bugs.html">Reporting Bugs</a></h2>
<h2> <a href="source.html">Download</a></h2>
<h2> <a href="contrib.html">Contributing</a></h2>
<h2> <a href="related.html">Related Projects</a></h2>
</blockquote>
</td>

20
intro.html
Wyświetl plik

@ -26,17 +26,15 @@
<hr>
<p>
<em>SANE</em> stands for "Scanner Access Now Easy" and is an application
programming interface (API) that provides standardized access to any
raster image scanner hardware (flatbed scanner, hand-held scanner,
video- and still-cameras, frame-grabbers, etc.). The <a
href="html/">SANE API</a> is public domain and its discussion and
development is open to everybody. The current source code is written
for UNIX (including GNU/Linux) and is available under the GNU General
Public License (the <em>SANE</em> API is available to proprietary
applications and backends as well, however). <a
href="sane-support.html">Ports to MacOS X, OS/2 and Microsoft
Windows</a> are either already done or in progress.
<em>SANE</em> stands for "Scanner Access Now Easy" and is an application programming interface
(API) that provides standardized access to any raster image scanner hardware (flatbed scanner,
hand-held scanner, video- and still-cameras, frame-grabbers, etc.). The <a href="html/">SANE
API</a> is public domain and its discussion and development is open to everybody. The current
source code is written for UNIX (including GNU/Linux) and is available under the GNU General
Public License (the <em>SANE</em> API is available to proprietary applications and backends as
well, however). More details about the license can be found on <a href="license.html>our
license page</a>. <a href="sane-support.html">Ports to MacOS X, OS/2 and Microsoft Windows</a>
are either already done or in progress.
</p>
<p>

96
manufacturers.html 100644
Wyświetl plik

@ -0,0 +1,96 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>SANE - Information for Manufacturers</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="author" content="Henning Meier-Geinitz">
<meta name="keywords" content="sane, scanner, manufacturers, programming, vendor, driver, backend">
<meta name="description" content="Information for Manufacturers">
<link href="mailto:hmg-guest@users.alioth.debian.org" rev="made">
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<center>
<a href="http://www.sane-project.org"><img src="images/sane.png"
alt="SANE" height="117" width="346" border="0"></a>
</center>
<center>
<h1>Information for Manufacturers</h1>
</center>
<hr>
<p>
Are you a manufacturer or vendor of scanners and one of your scanners is not supported by <a
href="/">SANE</a> yet? As Linux and other Unix systems become more and more popular, many
people check for SANE support when buying scanners. A logo "Supported by SANE" or "Runs on
Linux" or similar would be nice, wouldn't it? Also an existing SANE backend would mean that
your scanner is no longer listed as <a
href="lists/sane-backends-cvs.html#UNSUPPORTED">unsupported</a> in our lists and you could add
"Linux support" to the list of features on your website.
</p>
<p>
As you are the manufacturer of the device, you have all the information necessary to write a
SANE backend (driver). That makes it much easier for you to do it than for any other
person. Most probably you only need to port your MS Windows code to SANE. You can ignore all
the graphical interface code as SANE already provides a variety of <a
href="sane-frontends.html">frontends</a> (scanning applications). You only need the code for
accessing the scanner. For details on how to write a driver see our <a
href="contrib.html">contributing page</a>.
</p>
<p>
I recommend to use the <a href="license.html">GPL + SANE exception</a> license for your
code. So it can be included in the SANE distribution and your driver will come with most Linux
distributions. Furthermore you can use the existing code for USB and SCSI access and many
helper functions so you don't need to think about the low level details. And your scanner will
be supported not just on one operating system and platform but on everything SANE runs on (see
our <a href="sane-support.html">platforms page</a>). Providing source code makes it easier for
other developers to give feedback and send patches for bugs.
</p>
<p>
If you can only release binary SANE backends that's better than nothing but still not
recommended. The SANE standard itself is public domain, so you are free to use it. But keep
in mind that you must adhere to our <a href="license.html">license</a> if you use parts of the
SANE code. Binary-only drivers mean you can't get help from us or any SANE users because
nobody can debug your code. Binary-only drivers can not be included in the official SANE
releases.
</p>
<p>
Yet another option is to publish complete programming information or the source code of the
scanner drivers for MS Windows. With this information it's much easier for a free software
developer to create a backend. Some manufacturers don't like to publish this information but
give it to selected developers only. That's possible, but the backend code will be GPL most
likely so at least part of the information will be public anyway. If you intend to publish
programming information, you may want to ask on the <a
href="mailing-lists.html">sane-devel mailing list</a> if anyone is
interested in programming a driver. But keep in mind that providing programming information is
not a guarantee that a driver will ever be written.
</p>
<p>
The most important part is communication: Please tell us what you intend to do. We are also
interested in partial information, e.g. if some scanners use the same chipset as others. That
may help to write backends for a variety of devices. Also tell us if any of the information in
our lists is missing or wrong. So please contact the <a href="mailing-lists.html">sane-devel
mailing list</a> with your information and ideas. If you don't want to subscribe to this list,
please write to Henning Meier-Geinitz (<a
href="mailto:henning@meier-geinitz.de">henning@meier-geinitz.de</a>).
</p>
<hr>
<p>
<a href="/">SANE homepage</a><br>
<a href="imprint.html">Contact</a>
</p>
<p>
<font size="-1">$Date$ $Author$</font>
</p>
</body>
</html>