mangavalk/lcdproc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Starting the developers docs in docbook.

Browse Source
This commit is contained in:
gfk
2002-10-01 18:40:21 +00:00
parent 71389edb05
commit 46f930bf98
10 changed files with 1163 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-dev/Makefile.am
+1
View File
@@ -0,0 +1 @@
EXTRA_DIST = lcdproc-dev.docbook bookinfo.docbook introduction.docbook shared-files.docbook make-driver.docbook add-your-driver.docbook license.docbook
docs/lcdproc-dev/README.docbook
+14
View File
@@ -0,0 +1,14 @@
README.docbook
You can generate the documentation of LCDproc using
the Docbook utilities.
$ docbook2html lcdproc-user.docbook
should generate ist as HTML.
On my box (Mdk 8.1) I have to run
$ docbook2html -c /etc/sgml/catalog lcdproc-user.docbook
(-c defines the location of the SGML catalog)
docs/lcdproc-dev/add-your-driver.docbook
+171
View File
@@ -0,0 +1,171 @@
<chapter id="add-your-driver">
<title>Adding your driver to LCDproc</title>
<sect1 id="add-your-driver-intro">
<title>Introduction</title>
<para>
LCDproc is meant to be modular, it is relatively easy to add new input and output drivers to LCDproc.
</para>
<para>
This chapter will explain you the major steps and few gotchas of adding your own driver to LCDproc. Enjoy!
</para>
</sect1>
<sect1 id="autoconfautomake">
<title>Autoconf, automake, b&ouml;rk b&ouml;rk b&ouml;rk!</title>
<para>How I Learned to Stop Worrying and Love the Configure Script</para>
<para>
It was decided pretty early in LCDproc's life to use GNU autoconf and GNU automake. This allows LCDproc to be ported to several platforms with much less effort. It can be quite daunting to understand how autoconf & automake interact with each others and with your code, but don't be discouraged. We have taken great care in making this as simple as possible for programers to add their own driver to LCDproc. Hopefully, you'll only have to modify two files, one for autoconf and one for automake.
</para>
<para>
The first thing you need to do is to find a name for your driver, it should be as descriptive as possible; most drivers are named after their respective chipset, for example hd44780, mtc_s16209x, sed1330 and stv5730, others are named after the company that makes that particular LCD display, for example CFontz and MtxOrb. Remember that these names are case sensitive. In this chapter, we'll use myDriver (which is an absolute non-descriptive name).
</para>
<sect2 id="autoconf">
<title>Autoconf and its friend, acinclude.m4</title>
<para>
You need to add your driver to function LCD_DRIVERS_SELECT of file acinclude.m4. This can be done in three steps.
</para>
<sect3 id="autoconf-step1">
<title>Step 1</title>
<para>
First you need to add your driver name to the list of possible choices in the help screen.
</para>
<para>This:</para>
<screen>
AC_ARG_ENABLE(drivers,
[ --enable-drivers=&lt;list&gt; compile driver for LCDs in &lt;list&gt;.]
[ drivers may be separated with commas.]
[ Possible choices are:]
[ mtxorb,cfontz,cfontz633,curses,text,lb216,]
[ hd44780,joy,irman,lirc,bayrad,glk,,mtc_s16209x]
[ stv5730,sed1330,sed1520,svga,lcdm001,t6963]
[ lcterm,icp_a106]
[ \"all\" compiles all drivers],
drivers="$enableval",
</screen>
<para>becomes:</para>
<screen>
AC_ARG_ENABLE(drivers,
[ --enable-drivers=&lt;list&gt; compile driver for LCDs in &lt;list&gt;.]
[ drivers may be separated with commas.]
[ Possible choices are:]
[ mtxorb,cfontz,cfontz633,curses,text,lb216,]
[ hd44780,joy,irman,lirc,bayrad,glk,,mtc_s16209x]
[ stv5730,sed1330,sed1520,svga,lcdm001,t6963]
[ lcterm,icp_a106,<emphasis>myDriver</emphasis>]
[ \"all\" compiles all drivers],
drivers="$enableval",
</screen>
</sect3>
<sect3 id="autoconf-step2">
<title>Step 2</title>
<para>Second, you need to add your driver to the list of all drivers.</para>
<para>This:</para>
<screen>
if test "$drivers" = "all"; then
drivers=[mtxorb,cfontz,...biglist...,lcterm,icp_a106]
fi
</screen>
<para>becomes:</para>
<screen>
if test "$drivers" = "all"; then
drivers=[mtxorb,cfontz,...biglist...,lcterm,icp_a106,<emphasis>myDriver</emphasis>]
fi
</screen>
</sect3>
<sect3 id="autoconf-step3">
<title>Step 3</title>
<para>Then last, you need to add your driver to be big switch-case in this function, see below.</para>
<screen>
myDriver)
DRIVERS="$DRIVERS myDriver${SO}"
actdrivers=["$actdrivers myDriver"]
;;
</screen>
<para>
If your driver only works in some platform or requires a particular library or header, you can add your autoconf test here. You can see how other drivers do it, but if you're not sure on how to do this, just send an email to the mailing list and we'll make it for you.
</para>
</sect3>
</sect2>
<sect2 id="automake">
<title>Automake and its friend, Makefile.am</title>
<para>Allready half of the job is done! Not to bad, wasn't it? The rest should be just as easy. In this section, you'll be adding your driver to the file server/drivers/Makefile.am. As you can guess, it's the Makefile for the drivers. This can be done in three (or two) simple steps.</para>
<sect3 id="automake-step1">
<title>Step 1</title>
<para>First, you need to add your driver to the list of drivers in this file, this list is called EXTRA_PROGRAMS.</para>
<para>This</para>
<screen>
EXTRA_PROGRAMS = bayrad CFontz ...biglist... text wirz_sli
</screen>
<para>becomes</para>
<screen>
EXTRA_PROGRAMS = bayrad CFontz ...biglist... text wirz_sli <emphasis>myDriver</emphasis>
</screen>
</sect3>
<sect3 id="automake-step2">
<title>Step 2</title>
<para>This second step is only needed if your driver needs a particular library. If it doesn't, you can skip to step 3.</para>
<para>You basically need to put you driver name followed by _LDADD and egal this to the name of the library that you need. Usually, these library are substituted by a autoconf variable, if you're not comfortable with this, you send an email to the mailing list and we'll set this up for you.</para>
<para>For example, we would put this for our fictional driver</para>
<screen>
myDriver_LDADD = @SOMESTRANGELIB@
</screen>
</sect3>
<sect3 id="automake-step3">
<title>Step 3</title>
<para>Last but not least, you need to specify which source files should be associated with your driver. You put your driver name followed by _SOURCES and egal this to a space separated list of the source and header files. See below for an example.</para>
<screen>
myDriver_SOURCES = lcd.h myDriver.c myDriver.h report.h
</screen>
</sect3>
</sect2>
<sect2 id="autoconfautomake-test">
<title>Test your setup</title>
<para>You're almost done! You only need to check out if you didn't made any mistake. Just run sh autogen.sh to regenerate the configure script and Makefiles, then run ./configure --enable-driver=myDriver and type make. If your driver compiles without error, then congratulations, you've just added your driver to LCDproc! Remember to submit a patch to the mailing list so that we can add it to the standard distribution.</para>
<para>If you had an error, just send us an email describing it to the mailing list and we'll try to help you.</para>
</sect2>
</sect1>
</chapter>
docs/lcdproc-dev/bookinfo.docbook
+48
View File
@@ -0,0 +1,48 @@
<bookinfo>
<title>LCDproc Developer's Guide</title>
<subtitle>The Hitchhicker's Guide to LCDproc 0.5</subtitle>
<authorgroup>
<author>
<firstname>Guillaume</firstname>
<surname>Filion</surname>
<affiliation><address><email>gfk@logidac.com</email></address></affiliation>
</author>
</authorgroup>
<date>2002-10-01</date>
<releaseinfo>0.0.1</releaseinfo>
<abstract>
<para>
This document is a guide to LCDproc written for developers. It covers LCDproc 0.5. Users should read the user guide.
</para>
</abstract>
<copyright>
<year>2002</year>
<holder>Guillaume Filion</holder>
</copyright>
<legalnotice>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version
1.1 or any later version published by the Free Software Foundation; with
no Invariant Sections, with no Front-Cover texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled "GNU
Free Documentation License".
</para>
</legalnotice>
<keywordset>
<keyword>documentation</keyword>
<keyword>LCDproc</keyword>
<keyword>0.5</keyword>
<keyword>developer guide</keyword>
</keywordset>
</bookinfo>
docs/lcdproc-dev/introduction.docbook
+35
View File
@@ -0,0 +1,35 @@
<chapter id="introduction">
<title>Introduction</title>
<sect1 id="what-is-this">
<title>About this Document</title>
<para>
This document is meant to be a reference for LCDproc developers. It tries to indicate you
where to find the relevant information about LCDproc's inner workings.
</para>
<note><para>
Please note that this document is still "under construction".
If you run into any trouble feel free to write to the LCDproc mailing list.
See <ulink url="http://lcdproc.org/mail.php3">http://lcdproc.org/mail.php3</ulink>
for details on how to subscribe to the list.
</para>
<para>
Therefore you might want to have a look at <ulink url="http://lcdproc.sf.net/docs/">http://lcdproc.sf.net/docs/</ulink>,
to get the latest version of this document, unless you want to generate it yourself from the
docbook files in the CVS).
</para></note>
<para>
This document was written for LCDproc 0.5.
</para>
<para>
In several other places e-mails and other documents have been included in this
document. The authors of those are listed below every such document.
</para>
</sect1>
</chapter>
docs/lcdproc-dev/lcdproc-dev.docbook
+20
View File
@@ -0,0 +1,20 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY bookinfo SYSTEM "bookinfo.docbook">
<!ENTITY introduction SYSTEM "introduction.docbook">
<!ENTITY shared-files SYSTEM "shared-files.docbook">
<!ENTITY make-driver SYSTEM "make-driver.docbook">
<!ENTITY add-your-driver SYSTEM "add-your-driver.docbook">
<!ENTITY license SYSTEM "license.docbook">
]>
<book id="lcdproc-dev" lang="en">
&bookinfo;
&introduction;
&shared-files;
&make-driver;
&add-your-driver;
&license;
</book>
docs/lcdproc-dev/license.docbook
+464
View File
@@ -0,0 +1,464 @@
<appendix id="gfdl">
<title>GNU Free Documentation License</title>
<!-- - GNU Project - Free Software Foundation (FSF) -->
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
<!-- sect1>
<title>GNU Free Documentation License</title -->
<para>Version 1.1, March 2000</para>
<blockquote>
<para>Copyright (C) 2000 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.</para>
</blockquote>
<sect1 id="gfdl-0">
<title>PREAMBLE</title>
<para>The purpose of this License is to make a manual, textbook,
or other written document "free" in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or
noncommercially. Secondarily, this License preserves for the
author and publisher a way to get credit for their work, while not
being considered responsible for modifications made by
others.</para>
<para>This License is a kind of "copyleft", which means that
derivative works of the document must themselves be free in the
same sense. It complements the GNU General Public License, which
is a copyleft license designed for free software.</para>
<para>We have designed this License in order to use it for manuals
for free software, because free software needs free documentation:
a free program should come with manuals providing the same
freedoms that the software does. But this License is not limited
to software manuals; it can be used for any textual work,
regardless of subject matter or whether it is published as a
printed book. We recommend this License principally for works
whose purpose is instruction or reference.</para>
</sect1>
<sect1 id="gfdl-1">
<title>APPLICABILITY AND DEFINITIONS</title>
<para>This License applies to any manual or other work that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. The "Document",
below, refers to any such manual or work. Any member of the
public is a licensee, and is addressed as "you".</para>
<para>A "Modified Version" of the Document means any work
containing the Document or a portion of it, either copied
verbatim, or with modifications and/or translated into another
language.</para>
<para>A "Secondary Section" is a named appendix or a front-matter
section of the Document that deals exclusively with the
relationship of the publishers or authors of the Document to the
Document's overall subject (or to related matters) and contains
nothing that could fall directly within that overall subject.
(For example, if the Document is in part a textbook of
mathematics, a Secondary Section may not explain any mathematics.)
The relationship could be a matter of historical connection with
the subject or with related matters, or of legal, commercial,
philosophical, ethical or political position regarding
them.</para>
<para>The "Invariant Sections" are certain Secondary Sections
whose titles are designated, as being those of Invariant Sections,
in the notice that says that the Document is released under this
License.</para>
<para>The "Cover Texts" are certain short passages of text that
are listed, as Front-Cover Texts or Back-Cover Texts, in the
notice that says that the Document is released under this
License.</para>
<para>A "Transparent" copy of the Document means a
machine-readable copy, represented in a format whose specification
is available to the general public, whose contents can be viewed
and edited directly and straightforwardly with generic text
editors or (for images composed of pixels) generic paint programs
or (for drawings) some widely available drawing editor, and that
is suitable for input to text formatters or for automatic
translation to a variety of formats suitable for input to text
formatters. A copy made in an otherwise Transparent file format
whose markup has been designed to thwart or discourage subsequent
modification by readers is not Transparent. A copy that is not
"Transparent" is called "Opaque".</para>
<para>Examples of suitable formats for Transparent copies include
plain ASCII without markup, Texinfo input format, LaTeX input
format, SGML or XML using a publicly available DTD, and
standard-conforming simple HTML designed for human modification.
Opaque formats include PostScript, PDF, proprietary formats that
can be read and edited only by proprietary word processors, SGML
or XML for which the DTD and/or processing tools are not generally
available, and the machine-generated HTML produced by some word
processors for output purposes only.</para>
<para>The "Title Page" means, for a printed book, the title page
itself, plus such following pages as are needed to hold, legibly,
the material this License requires to appear in the title page.
For works in formats which do not have any title page as such,
"Title Page" means the text near the most prominent appearance of
the work's title, preceding the beginning of the body of the
text.</para>
</sect1>
<sect1 id="gfdl-2">
<title>VERBATIM COPYING</title>
<para>You may copy and distribute the Document in any medium,
either commercially or noncommercially, provided that this
License, the copyright notices, and the license notice saying this
License applies to the Document are reproduced in all copies, and
that you add no other conditions whatsoever to those of this
License. You may not use technical measures to obstruct or
control the reading or further copying of the copies you make or
distribute. However, you may accept compensation in exchange for
copies. If you distribute a large enough number of copies you
must also follow the conditions in section 3.</para>
<para>You may also lend copies, under the same conditions stated
above, and you may publicly display copies.</para>
</sect1>
<sect1 id="gfdl-3">
<title>COPYING IN QUANTITY</title>
<para>If you publish printed copies of the Document numbering more
than 100, and the Document's license notice requires Cover Texts,
you must enclose the copies in covers that carry, clearly and
legibly, all these Cover Texts: Front-Cover Texts on the front
cover, and Back-Cover Texts on the back cover. Both covers must
also clearly and legibly identify you as the publisher of these
copies. The front cover must present the full title with all
words of the title equally prominent and visible. You may add
other material on the covers in addition. Copying with changes
limited to the covers, as long as they preserve the title of the
Document and satisfy these conditions, can be treated as verbatim
copying in other respects.</para>
<para>If the required texts for either cover are too voluminous to
fit legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto
adjacent pages.</para>
<para>If you publish or distribute Opaque copies of the Document
numbering more than 100, you must either include a
machine-readable Transparent copy along with each Opaque copy, or
state in or with each Opaque copy a publicly-accessible
computer-network location containing a complete Transparent copy
of the Document, free of added material, which the general
network-using public has access to download anonymously at no
charge using public-standard network protocols. If you use the
latter option, you must take reasonably prudent steps, when you
begin distribution of Opaque copies in quantity, to ensure that
this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you
distribute an Opaque copy (directly or through your agents or
retailers) of that edition to the public.</para>
<para>It is requested, but not required, that you contact the
authors of the Document well before redistributing any large
number of copies, to give them a chance to provide you with an
updated version of the Document.</para>
</sect1>
<sect1 id="gfdl-4">
<title>MODIFICATIONS</title>
<para>You may copy and distribute a Modified Version of the
Document under the conditions of sections 2 and 3 above, provided
that you release the Modified Version under precisely this
License, with the Modified Version filling the role of the
Document, thus licensing distribution and modification of the
Modified Version to whoever possesses a copy of it. In addition,
you must do these things in the Modified Version:</para>
<orderedlist numeration="upperalpha">
<listitem><para>Use in the Title Page
(and on the covers, if any) a title distinct from that of the
Document, and from those of previous versions (which should, if
there were any, be listed in the History section of the
Document). You may use the same title as a previous version if
the original publisher of that version gives permission.</para>
</listitem>
<listitem><para>List on the Title Page,
as authors, one or more persons or entities responsible for
authorship of the modifications in the Modified Version,
together with at least five of the principal authors of the
Document (all of its principal authors, if it has less than
five).</para>
</listitem>
<listitem><para>State on the Title page
the name of the publisher of the Modified Version, as the
publisher.</para>
</listitem>
<listitem><para>Preserve all the
copyright notices of the Document.</para>
</listitem>
<listitem><para>Add an appropriate
copyright notice for your modifications adjacent to the other
copyright notices.</para>
</listitem>
<listitem><para>Include, immediately
after the copyright notices, a license notice giving the public
permission to use the Modified Version under the terms of this
License, in the form shown in the Addendum below.</para>
</listitem>
<listitem><para>Preserve in that license
notice the full lists of Invariant Sections and required Cover
Texts given in the Document's license notice.</para>
</listitem>
<listitem><para>Include an unaltered
copy of this License.</para>
</listitem>
<listitem><para>Preserve the section
entitled "History", and its title, and add to it an item stating
at least the title, year, new authors, and publisher of the
Modified Version as given on the Title Page. If there is no
section entitled "History" in the Document, create one stating
the title, year, authors, and publisher of the Document as given
on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.</para>
</listitem>
<listitem><para>Preserve the network
location, if any, given in the Document for public access to a
Transparent copy of the Document, and likewise the network
locations given in the Document for previous versions it was
based on. These may be placed in the "History" section. You
may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.</para>
</listitem>
<listitem><para>In any section entitled
"Acknowledgements" or "Dedications", preserve the section's
title, and preserve in the section all the substance and tone of
each of the contributor acknowledgements and/or dedications
given therein.</para>
</listitem>
<listitem><para>Preserve all the
Invariant Sections of the Document, unaltered in their text and
in their titles. Section numbers or the equivalent are not
considered part of the section titles.</para>
</listitem>
<listitem><para>Delete any section
entitled "Endorsements". Such a section may not be included in
the Modified Version.</para>
</listitem>
<listitem><para>Do not retitle any
existing section as "Endorsements" or to conflict in title with
any Invariant Section.</para>
</listitem>
</orderedlist>
<para>If the Modified Version includes new front-matter sections
or appendices that qualify as Secondary Sections and contain no
material copied from the Document, you may at your option
designate some or all of these sections as invariant. To do this,
add their titles to the list of Invariant Sections in the Modified
Version's license notice. These titles must be distinct from any
other section titles.</para>
<para>You may add a section entitled "Endorsements", provided it
contains nothing but endorsements of your Modified Version by
various parties--for example, statements of peer review or that
the text has been approved by an organization as the authoritative
definition of a standard.</para>
<para>You may add a passage of up to five words as a Front-Cover
Text, and a passage of up to 25 words as a Back-Cover Text, to the
end of the list of Cover Texts in the Modified Version. Only one
passage of Front-Cover Text and one of Back-Cover Text may be
added by (or through arrangements made by) any one entity. If the
Document already includes a cover text for the same cover,
previously added by you or by arrangement made by the same entity
you are acting on behalf of, you may not add another; but you may
replace the old one, on explicit permission from the previous
publisher that added the old one.</para>
<para>The author(s) and publisher(s) of the Document do not by
this License give permission to use their names for publicity for
or to assert or imply endorsement of any Modified Version.</para>
</sect1>
<sect1 id="gfdl-5">
<title>COMBINING DOCUMENTS</title>
<para>You may combine the Document with other documents released
under this License, under the terms defined in section 4 above for
modified versions, provided that you include in the combination
all of the Invariant Sections of all of the original documents,
unmodified, and list them all as Invariant Sections of your
combined work in its license notice.</para>
<para>The combined work need only contain one copy of this
License, and multiple identical Invariant Sections may be replaced
with a single copy. If there are multiple Invariant Sections with
the same name but different contents, make the title of each such
section unique by adding at the end of it, in parentheses, the
name of the original author or publisher of that section if known,
or else a unique number. Make the same adjustment to the section
titles in the list of Invariant Sections in the license notice of
the combined work.</para>
<para>In the combination, you must combine any sections entitled
"History" in the various original documents, forming one section
entitled "History"; likewise combine any sections entitled
"Acknowledgements", and any sections entitled "Dedications". You
must delete all sections entitled "Endorsements."</para>
</sect1>
<sect1 id="gfdl-6">
<title>COLLECTIONS OF DOCUMENTS</title>
<para>You may make a collection consisting of the Document and
other documents released under this License, and replace the
individual copies of this License in the various documents with a
single copy that is included in the collection, provided that you
follow the rules of this License for verbatim copying of each of
the documents in all other respects.</para>
<para>You may extract a single document from such a collection,
and distribute it individually under this License, provided you
insert a copy of this License into the extracted document, and
follow this License in all other respects regarding verbatim
copying of that document.</para>
</sect1>
<sect1 id="gfdl-7">
<title>AGGREGATION WITH INDEPENDENT WORKS</title>
<para>A compilation of the Document or its derivatives with other
separate and independent documents or works, in or on a volume of
a storage or distribution medium, does not as a whole count as a
Modified Version of the Document, provided no compilation
copyright is claimed for the compilation. Such a compilation is
called an "aggregate", and this License does not apply to the
other self-contained works thus compiled with the Document, on
account of their being thus compiled, if they are not themselves
derivative works of the Document.</para>
<para>If the Cover Text requirement of section 3 is applicable to
these copies of the Document, then if the Document is less than
one quarter of the entire aggregate, the Document's Cover Texts
may be placed on covers that surround only the Document within the
aggregate. Otherwise they must appear on covers around the whole
aggregate.</para>
</sect1>
<sect1 id="gfdl-8">
<title>TRANSLATION</title>
<para>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section
4. Replacing Invariant Sections with translations requires
special permission from their copyright holders, but you may
include translations of some or all Invariant Sections in addition
to the original versions of these Invariant Sections. You may
include a translation of this License provided that you also
include the original English version of this License. In case of
a disagreement between the translation and the original English
version of this License, the original English version will
prevail.</para>
</sect1>
<sect1 id="gfdl-9">
<title>TERMINATION</title>
<para>You may not copy, modify, sublicense, or distribute the
Document except as expressly provided for under this License. Any
other attempt to copy, modify, sublicense or distribute the
Document is void, and will automatically terminate your rights
under this License. However, parties who have received copies, or
rights, from you under this License will not have their licenses
terminated so long as such parties remain in full
compliance.</para>
</sect1>
<sect1 id="gfdl-10">
<title>FUTURE REVISIONS OF THIS LICENSE</title>
<para>The Free Software Foundation may publish new, revised
versions of the GNU Free Documentation License from time to time.
Such new versions will be similar in spirit to the present
version, but may differ in detail to address new problems or
concerns. See <ulink
url="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</ulink>.</para>
<para>Each version of the License is given a distinguishing
version number. If the Document specifies that a particular
numbered version of this License "or any later version" applies to
it, you have the option of following the terms and conditions
either of that specified version or of any later version that has
been published (not as a draft) by the Free Software Foundation.
If the Document does not specify a version number of this License,
you may choose any version ever published (not as a draft) by the
Free Software Foundation.</para>
</sect1>
<sect1 id="gfdl-11">
<title>How to use this License for your documents</title>
<para>To use this License in a document you have written, include
a copy of the License in the document and put the following
copyright and license notices just after the title page:</para>
<blockquote><para>
Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
</para></blockquote>
<para>If you have no Invariant Sections, write "with no Invariant
Sections" instead of saying which ones are invariant. If you have
no Front-Cover Texts, write "no Front-Cover Texts" instead of
"Front-Cover Texts being LIST"; likewise for Back-Cover
Texts.</para>
<para>If your document contains nontrivial examples of program
code, we recommend releasing these examples in parallel under your
choice of free software license, such as the GNU General Public
License, to permit their use in free software.</para>
</sect1>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-parent-document: ("referenz.sgml" "appendix")
sgml-exposed-tags:nil
sgml-local-ecat-files:nil
sgml-local-catalogs: CATALOG
sgml-validate-command: "nsgmls -s referenz.sgml"
ispell-skip-sgml: t
End:
-->
docs/lcdproc-dev/make-driver.docbook
+146
View File
@@ -0,0 +1,146 @@
<chapter id="make-driver">
<title>Making a LCDproc driver</title>
<sect1 id="make-driver-intro">
<title>Introduction</title>
<para>
LCDproc is meant to be modular, it is relatively easy to add new input and output drivers to LCDproc. Actually, there are a few things that you can do to make your life easier, they are listed here.
</para>
<para>
This chapter will explain you the major steps and few gotchas of adding your own driver to LCDproc. Enjoy!
</para>
</sect1>
<sect1 id="driver-shared-files">
<title>Shared files specific for drivers</title>
<para>
Driving an LCD display is not easy; you need to address ports, to send bytes in a certain order, to respect timing, and unfortunaly no two operating system let you do this in the same way. But don't dispair! There's hope! Someone in a galaxy far far away, has allready done the dirty job for you! This dirty job has been put in shared files. These shared files are full cross platform and are automagically configured by the configure script. You only need to include them and use their functions to benefit from them.
</para>
<para>
These files are provided only for drivers, others are provided for all of LCDproc. These files are located in the shared directory, they have a dedicated chapter in this book.
</para>
<sect2 id="port.h">
<title>port.h : Parallel port I/O</title>
<para>The file port.h, located in the server/drivers/ directory provide Input/Output and port permissions for the PC compatible parallel port, also known as the LPT port.</para>
<para>
Of course, these functions will only work if the computer where LCDproc runs has parallel port! In these situations, the configure script will see this and disable drivers that need a parallel port.
</para>
<para>port.h file defines 6 static inline functions for port I/O:</para>
<sect3 id="port_in">
<title>Read a byte from port</title>
<funcsynopsis>
<funcprototype>
<funcdef>static inline int <function>port_in</function></funcdef>
<paramdef>unsigned short int <parameter>port</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>Returns the content of the byte.</para>
</sect3>
<sect3 id="port_out">
<title>Write a char(byte) 'val' to port</title>
<funcsynopsis>
<funcprototype>
<funcdef>static inline void <function>port_out</function></funcdef>
<paramdef>unsigned short int <parameter>port</parameter></paramdef>
<paramdef>unsigned char <parameter>val</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>Returns nothing (void).</para>
</sect3>
<sect3 id="port_access">
<title>Get access to a specific port</title>
<funcsynopsis>
<funcprototype>
<funcdef>static inline int <function>port_access</function></funcdef>
<paramdef>unsigned short int <parameter>port</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>Returns 0 if successful, -1 if failed.</para>
</sect3>
<sect3 id="port_deny">
<title>Close access to a specific port</title>
<funcsynopsis>
<funcprototype>
<funcdef>static inline int <function>port_deny</function></funcdef>
<paramdef>unsigned short int <parameter>port</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>Returns 0 if successful, -1 if failed.</para>
</sect3>
<sect3 id="port_access_full">
<title>Get access to three sequential ports</title>
<funcsynopsis>
<funcsynopsisinfo>/* port (CONTROL), port+1 (STATUS) and port+2 (DATA) */ </funcsynopsisinfo>
<funcprototype>
<funcdef>static inline int <function>port_access_full</function></funcdef>
<paramdef>unsigned short int <parameter>port</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>Returns 0 if successful, -1 if failed.</para>
</sect3>
<sect3 id="port_deny_full">
<title>Close access to three sequential ports</title>
<funcsynopsis>
<funcprototype>
<funcdef>static inline int <function>port_deny_full</function></funcdef>
<paramdef>unsigned short int <parameter>port</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>Returns 0 if successful, -1 if failed.</para>
</sect3>
<sect3 id="port.h-example">
<title>Example use</title>
<screen>
#include "port.h"
/* Get access to these 3 ports:
0x378 (CONTROL),
0x379 (STATUS) and
0x37A (DATA)
*/
if ( -1 == port_access_full(0x378) ) {
/* Access denied, do something */
}
/* Write a 'A' to the control port */
ort_out(0x378, 'A');
/* Read from the status port */
char status = port_in(0x379);
/* Close the 3 ports */
port_deny_full(0x378);
</screen>
</sect3>
</sect2>
</sect1>
</chapter>
docs/lcdproc-dev/shared-files.docbook
+263
View File
@@ -0,0 +1,263 @@
<chapter id="shared-files">
<title>Shared files</title>
<sect1 id="shared-files-intro">
<title>Introduction</title>
<para>
Here we provide functions that should be used by all parts of the program.
</para>
</sect1>
<sect1 id="debug.h">
<title>report.h : Debugging and reporting</title>
<para>To enable the debug() function on all of the software, just type:
./configure --enable-debug and recompile with 'make'.</para>
<para>To enable the debug() function only in specific files:
1) Configure without enabling debug (that is without --enable-debug)
2) Edit the source file that you want to debug and put the following
line at the top, before the #include "report.h" line:
#define DEBUG
3) Then recompile with 'make'
This way, the global DEBUG macro is off but is locally enabled in
certains parts of the software.</para>
<para>The reporting levels have the following meaning.</para>
<variablelist><title>Reporting Levels</title>
<varlistentry><term>0 RPT_CRIT</term>
<listitem><para>
Critical conditions: the program stops right after
this. Only use this if the program is actually exited
from the current function.
</para></listitem>
</varlistentry>
<varlistentry><term>1 RPT_ERR</term>
<listitem><para>
Error conditions: serious problem, program continues.
Use this just before you return -1 from a function.
</para></listitem>
</varlistentry>
<varlistentry><term>2 RPT_WARNING</term>
<listitem><para>
Warning conditions: Something that the user should
fix, but the program can continue without a real
problem. Ex: Protocol errors from a client.
</para></listitem>
</varlistentry>
<varlistentry><term>3 RPT_NOTICE</term>
<listitem><para>
Major event in the program: (un)loading of driver, client (dis)connect.
</para></listitem>
</varlistentry>
<varlistentry><term>4 RPT_INFO</term>
<listitem><para>
Minor event in the program: the activation of a
setting, details of a loaded driver, a key
reservation, a keypress, a screen switch.
</para></listitem>
</varlistentry>
<varlistentry><term>5 RPT_DEBUG</term>
<listitem><para>
Insignificant event: What function has been called, what subpart of a
function is being executed, what was received and sent
over the socket, etc.
</para></listitem>
</varlistentry>
</variablelist>
<para>Levels 4 (maybe) and 5 (certainly) should be reported using the debug
function. The code that this function generates will not be in the executable when
compiled without debugging. This way memory and CPU cycles are saved.</para>
<para>report.h file defines 3 functions for debugging and reporting:</para>
<sect2 id="set_reporting">
<title>Sets reporting level and message destination</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>set_reporting</function></funcdef>
<paramdef>char * <parameter>application_name</parameter></paramdef>
<paramdef>int <parameter>new_level</parameter></paramdef>
<paramdef>int <parameter>new_dest</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>Returns the content of the byte.</para>
</sect2>
<sect2 id="report">
<title>Report the message to the selected destination if important enough</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>report</function></funcdef>
<paramdef>const int <parameter>level</parameter></paramdef>
<paramdef>const char *<parameter>format</parameter></paramdef>
<paramdef>...</paramdef>
</funcprototype>
</funcsynopsis>
<para>Returns nothing (void).</para>
<para>The format parameter is the same as the one used by printf.</para>
</sect2>
<sect2 id="debug">
<title>Send debugging information if important enough</title>
<para>Consider the debug function to be exactly the same as the report function. The only difference is that it is only compiled in if DEBUG is defined.</para>
</sect2>
</sect1>
<sect1 id="LL.h">
<title>LL.h : Linked Lists (Doubly-Linked Lists)</title>
<sect2 id="LL.h-new">
<title>Creating a list</title>
<para>To create a list, do the following:</para>
<screen>
LinkedList *list;
list = LL_new();
if(!list) handle_an_error();
</screen>
<para>The list can hold any type of data. You will need to typecast your datatype to a "void *", though. So, to add something to the list, the following would be a good way to start:</para>
<screen>
typedef struct my_data {
char string[16];
int number;
} my_data;
my_data *thingie;
for(something to something else) {
thingie = malloc(sizeof(my_data));
LL_AddNode(list, (void *)thingie); // typecast it to a "void *"
}
</screen>
<para>For errors, the general convention is that "0" means success, and a negative number means failure. Check LL.c to be sure, though.</para>
</sect2>
<sect2 id="LL.h-edit">
<title>Changing data</title>
<para>To change the data, try this:</para>
<screen>
thingie = (my_data *)LL_Get(list); // typecast it back to "my_data"
thingie->number = another_number;
</screen>
<para>You don't need to "Put" the data back, but it doesn't hurt anything.</para>
<screen>
LL_Put(list, (void *)thingie);
</screen>
<para>However, if you want to point the node's data somewhere else, you'll need to get the current data first, keep track of it, then set the data to a new location:</para>
<screen>
my_data * old_thingie, new_thingie;
old_thingie = (my_data *)LL_Get(list);
LL_Put(list, (void *)new_thingie);
// Now, do something with old_thingie. (maybe, free it?)
</screen>
<para>Or, you could just delete the node entirely and then add a new one:</para>
<screen>
my_data * thingie;
thingie = (my_data *)LL_DeleteNode(list);
free(thingie);
thingie->number = 666;
LL_InsertNode(list, (void *)thingie);
</screen>
</sect2>
<sect2 id="LL.h-iterate">
<title>Iterations throught the list</title>
<para>To iterate on each list item, try this:</para>
<screen>
LL_Rewind(list);
do {
my_data = (my_data *)LL_Get(list);
/* ... do something to it ... */
} while(LL_Next(list) == 0);
</screen>
</sect2>
<sect2 id="LL.h-stack">
<title>Using the list as a stack or a queue</title>
<para>You can also treat the list like a stack, or a queue. Just use the following functions:</para>
<screen>
LL_Push() // Regular stack stuff: add, remove, peek, rotate
LL_Pop()
LL_Top()
LL_Roll()
LL_Shift() // Other end of the stack (like in perl)
LL_Unshift()
LL_Look()
LL_UnRoll()
LL_Enqueue() // Standard queue operations
LL_Dequeue()
</screen>
<para>There are also other goodies, like sorting and searching.</para>
</sect2>
<sect2 id="LL.h-future">
<title>Future</title>
<para>Array-like operations will come later, to allow numerical indexing:</para>
<screen>
LL_nGet(list, 3);
LL_nSwap(list, 6, 13);
LL_nPut(list, -4, data); // Puts item at 4th place from the end..
</screen>
<para>More ideas for later:</para>
<screen>
LL_MoveNode(list, amount); // Slides a node to another spot in the list
-- LL_MoveNode(list, -1); // moves a node back one toward the head
</screen>
<para>That's about it, for now... Be sure to free the list when you're done!</para>
<para>See LL.c for more detailed descriptions of these functions.</para>
</sect2>
</sect1>
</chapter>