sane-project-website/old-archive/1998-06/0201.html

<!-- received="Tue Jun 23 23:40:11 1998 PDT" -->
<!-- sent="Wed, 24 Jun 1998 02:39:26 -0400 (EDT)" -->
<!-- name="Matto Marjanovic" -->
<!-- email="maddog@mir.com" -->
<!-- subject="Send in your .desc files..." -->
<!-- id="m0yojDK-000J3mC@yoo-hoo.ai.mit.edu" -->
<!-- inreplyto="" -->
<title>sane-devel: Send in your .desc files...</title>
<h1>Send in your .desc files...</h1>
<b>Matto Marjanovic</b> (<a href="mailto:maddog@mir.com"><i>maddog@mir.com</i></a>)<br>
<i>Wed, 24 Jun 1998 02:39:26 -0400 (EDT)</i>
<p>
<ul>
<li> <b>Messages sorted by:</b> <a href="date.html#201">[ date ]</a><a href="index.html#201">[ thread ]</a><a href="subject.html#201">[ subject ]</a><a href="author.html#201">[ author ]</a>
<!-- next="start" -->
<li> <b>Next message:</b> <a href="0202.html">Mathias Koerber: "Re: Send in your .desc files..."</a>
<li> <b>Previous message:</b> <a href="0200.html">charter@cs.ualberta.ca: "Re: General backend information"</a>
<!-- nextthread="start" -->
<li> <b>Next in thread:</b> <a href="0202.html">Mathias Koerber: "Re: Send in your .desc files..."</a>
<li> <b>Reply:</b> <a href="0202.html">Mathias Koerber: "Re: Send in your .desc files..."</a>
<!-- reply="end" -->
</ul>
<!-- body="start" -->
Hi, all,<br>
<p>
The winning extender goes to David, for its obviousness:  .desc<br>
<p>
With that settled, will all backend authors please write up a .desc<br>
 file and e-mail it to me (<a href="mailto:maddog@mir.com">maddog@mir.com</a>)?  I will collect them and<br>
 forward to David.<br>
<p>
A .desc template is included at the end of this message.  What you<br>
 send me should reflect the backend included in the current release of<br>
 SANE (0.73).  The idea is that when you send patch files in to update<br>
 the backend and its man-page, you should update the .desc file, too.<br>
 Then, the web page will always reflect the latest release, when it<br>
 becomes available.  <br>
<p>
The .desc file shouldn't be overloaded --- it should just contain the<br>
 most important cursory information about the status and performance<br>
 of the backend.  All the gory details should go in the man-page<br>
 and/or another web page.<br>
<p>
For an example of what the resulting web page will look like, check out:<br>
   <a href="http://www.mir.com/mtek/backends.html">http://www.mir.com/mtek/backends.html</a><br>
<p>
If you'd like to get the code that produced that (it's emacs-lisp):<br>
   <a href="http://www.mir.com/mtek/sane-desc.tgz">http://www.mir.com/mtek/sane-desc.tgz</a><br>
<p>
And, of course, if the .desc format/script is missing anything obvious, <br>
 send your suggestions/corrections my way....<br>
<p>
-matt m.<br>
<p>
-----------------cut here--------------------------------<br>
<p>
;<br>
; SANE Backend specification file<br>
;<br>
; It's basically emacs-lisp --- so ";" indicates comment to end of line.<br>
; All syntactic elements are keyword tokens, followed by a string or<br>
;  keyword argument, as specified.<br>
;<br>
; ":backend" *must* be specified.<br>
; All other information is optional (but what good is the file without it?).<br>
;<br>
<p>
:backend "template"               ; name of backend<br>
:version "0.n"                    ; version of backend<br>
:status :alpha                    ; :alpha, :beta, :stable, :new<br>
:manpage "sane-template"          ; name of manpage (if it exists)<br>
:url "<a href="http://www.luser.com/temp/">http://www.luser.com/temp/</a>" ; backend's web page<br>
<p>
:devicetype :scanner              ; start of a list of devices....<br>
                                  ; other types:  :stillcam, :vidcam,<br>
                                  ;               :meta, :api<br>
<p>
:mfg "TemPlate"                   ; name a manufacturer<br>
:url "<a href="http://www.template.com/">http://www.template.com/</a>"<br>
:model "Templ Z"                  ; name models for above-specified mfg.<br>
:model "Templ ZS"<br>
:model "Templ ZQ"<br>
<p>
:mfg "ArmorPlate"                 ; another manufacturer...<br>
:url "<a href="http://www.armorplate.com/">http://www.armorplate.com/</a>"<br>
:model "AmplScan II"<br>
:comment "AmplScan *II*, not AmplScan!"<br>
<p>
:devicetype :api                  ; specify a different type<br>
:desc "Interface to FrObYz API"   ; describe a non-hardware device<br>
<p>
; :comment and :url specifiers are optional after :mfg, :model, :desc,<br>
;  and at the top-level.<br>
<p>
<p>
<p>
<p>
<p>
<pre>
--
Source code, list archive, and docs: <a href="http://www.mostang.com/sane/">http://www.mostang.com/sane/</a>
To unsubscribe: echo unsubscribe sane-devel | mail <a href="mailto:majordomo@mostang.com">majordomo@mostang.com</a>
</pre>
<!-- body="end" -->
<p>
<ul>
<!-- next="start" -->
<li> <b>Next message:</b> <a href="0202.html">Mathias Koerber: "Re: Send in your .desc files..."</a>
<li> <b>Previous message:</b> <a href="0200.html">charter@cs.ualberta.ca: "Re: General backend information"</a>
<!-- nextthread="start" -->
<li> <b>Next in thread:</b> <a href="0202.html">Mathias Koerber: "Re: Send in your .desc files..."</a>
<li> <b>Reply:</b> <a href="0202.html">Mathias Koerber: "Re: Send in your .desc files..."</a>
<!-- reply="end" -->
</ul>