Send in your .desc files...

Matto Marjanovic (maddog@mir.com)
Wed, 24 Jun 1998 02:39:26 -0400 (EDT)

Hi, all,

The winning extender goes to David, for its obviousness: .desc

With that settled, will all backend authors please write up a .desc
file and e-mail it to me (maddog@mir.com)? I will collect them and
forward to David.

A .desc template is included at the end of this message. What you
send me should reflect the backend included in the current release of
SANE (0.73). The idea is that when you send patch files in to update
the backend and its man-page, you should update the .desc file, too.
Then, the web page will always reflect the latest release, when it
becomes available.

The .desc file shouldn't be overloaded --- it should just contain the
most important cursory information about the status and performance
of the backend. All the gory details should go in the man-page
and/or another web page.

For an example of what the resulting web page will look like, check out:
http://www.mir.com/mtek/backends.html

If you'd like to get the code that produced that (it's emacs-lisp):
http://www.mir.com/mtek/sane-desc.tgz

And, of course, if the .desc format/script is missing anything obvious,
send your suggestions/corrections my way....

-matt m.

-----------------cut here--------------------------------

;
; SANE Backend specification file
;
; It's basically emacs-lisp --- so ";" indicates comment to end of line.
; All syntactic elements are keyword tokens, followed by a string or
; keyword argument, as specified.
;
; ":backend" *must* be specified.
; All other information is optional (but what good is the file without it?).
;

:backend "template" ; name of backend
:version "0.n" ; version of backend
:status :alpha ; :alpha, :beta, :stable, :new
:manpage "sane-template" ; name of manpage (if it exists)
:url "http://www.luser.com/temp/" ; backend's web page

:devicetype :scanner ; start of a list of devices....
; other types: :stillcam, :vidcam,
; :meta, :api

:mfg "TemPlate" ; name a manufacturer
:url "http://www.template.com/"
:model "Templ Z" ; name models for above-specified mfg.
:model "Templ ZS"
:model "Templ ZQ"

:mfg "ArmorPlate" ; another manufacturer...
:url "http://www.armorplate.com/"
:model "AmplScan II"
:comment "AmplScan *II*, not AmplScan!"

:devicetype :api ; specify a different type
:desc "Interface to FrObYz API" ; describe a non-hardware device

; :comment and :url specifiers are optional after :mfg, :model, :desc,
; and at the top-level.

--
Source code, list archive, and docs: http://www.mostang.com/sane/
To unsubscribe: echo unsubscribe sane-devel | mail majordomo@mostang.com