kopia lustrzana https://github.com/Hamlib/Hamlib
16 January 2002:
Modified: hamlib-doc.dsl -- tweaked print output hamlib-doc.sgml -- minor title and revremarks edit intro.sgml -- minor edits to track hamlib versions better Removed: README.txt -- will return as README.docbook - N0NB git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@883 7ae35d74-ebe9-4afe-98af-79ac388436b8Hamlib-1.1.3
Nate Bargmann, N0NB
rodzic
2c26e5b213
commit
c111531102
|
|
@ -1,88 +0,0 @@
|
|||
README.txt - the companion answer file for the Hamlib SGML source
|
||||
distribution. Copyright (C) 2001 by Nathan Bargmann n0nb@arrl.net
|
||||
under the terms of the GNU General Public License version 2.0.
|
||||
|
||||
Notes for hamlib-doc for version 1.1.0 (ALPHA)
|
||||
|
||||
GENERAL:
|
||||
|
||||
This is the initial release of hamlib-doc, version 0.1.1. Covered
|
||||
topics include licensing of Hamlib, where and how to get the latest
|
||||
stable and CVS versions, introductory material on building, and
|
||||
API reference.
|
||||
|
||||
Generated formats are HTML, PS and PDF at this time.
|
||||
|
||||
BUILDING:
|
||||
|
||||
The source files are SGML marked up text that validates against the
|
||||
Docbook 3.1 DTD. Build environment is Debian GNU/Linux Woody a.ka.
|
||||
3.0 and required tools are Jade and nsgmls and the Cynus stylesheets.
|
||||
If you plan to use a Debian system I strongly recommend doing it on
|
||||
a Woody box as I had a number of issues with the output generated
|
||||
by the tools in the Potato release.
|
||||
|
||||
The proper DTD is required. Installing the sgml-tools task from
|
||||
dselect or apt-get will get all the DTDs and catalogs you'd ever
|
||||
need installed.
|
||||
|
||||
PDF:
|
||||
The PDF is built with the Cygnus db2pdf script, however, there is an
|
||||
included Docbook stylesheet, hamlib-doc.dsl. Invoke the db2pdf script
|
||||
in the same directory as the .sgml files with -d option:
|
||||
|
||||
db2pdf -d hamlib-doc hamlib-doc.sgml
|
||||
|
||||
and you'll wind up with a nice .pdf file.
|
||||
|
||||
HTML:
|
||||
To generate the HTML files I use a similar script called db2html that
|
||||
is invoked as above. The script will create and place the HTML and
|
||||
other files in a subdirectory.
|
||||
|
||||
PS:
|
||||
Same as above except the script in Woody won't accept the -d option for
|
||||
a custom DSSSL file.
|
||||
|
||||
SGML:
|
||||
Any editor may be used to edit the SGML source files. After editing,
|
||||
the SGML needs to be validated to ensure proper element placement and
|
||||
typos in the SGML structure. An excellent tool to do this is nsgmls.
|
||||
You can validate the files from the directory where the files are
|
||||
stored:
|
||||
|
||||
nsgmls -sv hamlib.sgml # validates the sgml
|
||||
|
||||
If there are no validation issues, nsgmls will return a prompt with
|
||||
no output except its version.
|
||||
|
||||
BUGS:
|
||||
|
||||
Bugs? What bugs? All bugs were taken out and shot!
|
||||
|
||||
I wish...
|
||||
|
||||
To enable links in the reference section I used brute force and
|
||||
marked up hyperlinks into the text flow. The .pdf has the hyperlinks
|
||||
in the text, but they're not annotated in any special way except
|
||||
beginning with http:.
|
||||
|
||||
Probably more as I'm too tired to look for them...
|
||||
|
||||
TODO:
|
||||
|
||||
Sections covering Hamlib usage in a program, writing a backend,
|
||||
and Hamlib internals.
|
||||
|
||||
Document top-level structures used by the API.
|
||||
|
||||
Sync with CVS version.
|
||||
|
||||
MISC:
|
||||
|
||||
I appreciate all feedback. Assistance won't be ignored either!
|
||||
Write me at n0nb@arrl.net
|
||||
|
||||
73, de Nate >>
|
||||
|
||||
|
||||
|
|
@ -25,29 +25,13 @@
|
|||
"UNREGISTERED::James Clark//Characteristic::preserve-sdata?"
|
||||
#f)
|
||||
|
||||
;(define %generate-article-toc%
|
||||
; ;; Should a Table of Contents be produced for Articles?
|
||||
; #t)
|
||||
|
||||
(define (toc-depth nd)
|
||||
2)
|
||||
|
||||
;(define %generate-article-titlepage-on-separate-page%
|
||||
; ;; Should the article title page be on a separate page?
|
||||
; #t)
|
||||
|
||||
(define %section-autolabel%
|
||||
;; Are sections enumerated?
|
||||
#t)
|
||||
|
||||
;(define %footnote-ulinks%
|
||||
; ;; Generate footnotes for ULinks?
|
||||
; #f)
|
||||
|
||||
;(define %bop-footnotes%
|
||||
; ;; Make "bottom-of-page" footnotes?
|
||||
; #f)
|
||||
|
||||
(define %body-start-indent%
|
||||
;; Default indent of body text
|
||||
0pi)
|
||||
|
|
@ -74,15 +58,14 @@
|
|||
|
||||
(define %admon-graphics%
|
||||
;; Use graphics in admonitions?
|
||||
#t)
|
||||
#f)
|
||||
|
||||
(define %admon-graphics-path%
|
||||
;; Path to admonition grpahics
|
||||
"./images/")
|
||||
|
||||
(define admon-graphic-default-extension
|
||||
;; Admonition graphic file extension
|
||||
".pdf")
|
||||
(define %visual-acuity%
|
||||
;; General measure of document text size
|
||||
;; "normal"
|
||||
;; "presbyopic"
|
||||
;; "large-type"
|
||||
"presbyopic")
|
||||
|
||||
</style-specification-body>
|
||||
</style-specification>
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
<book>
|
||||
<bookinfo>
|
||||
<title>Ham Radio Control Libraries</title>
|
||||
<subtitle>API Reference for Version &curver;</subtitle>
|
||||
<subtitle>General manual for version &curver;</subtitle>
|
||||
<author>
|
||||
<firstname>Nathan</firstname>
|
||||
<surname>Bargmann</surname>
|
||||
|
|
@ -61,9 +61,8 @@
|
|||
<revnumber>0.2.0</revnumber>
|
||||
<date>15 January 2002</date>
|
||||
<authorinitials>nfb</authorinitials>
|
||||
<revremark>Update draft for 1.1.3 and converted to Docbook Version
|
||||
4.1 DTD. Cut down reference.sgml as this is handled by
|
||||
Doxygen. Added framework for Index.</revremark>
|
||||
<revremark>Update draft, convert 4.1 DTD, add Index framework, API
|
||||
handled by Doxygen.</revremark>
|
||||
</revision>
|
||||
<revision>
|
||||
<revnumber>0.1.1</revnumber>
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
|
||||
<para>Hamlib consists of several parts. The application programming
|
||||
interface, <acronym>API</acronym>, shared library is
|
||||
<filename>libhamlib-1.1.0.so</filename> which is installed in
|
||||
<filename>libhamlib-&curver;.so</filename> which is installed in
|
||||
<filename class="directory">/usr/local/lib</filename> by default.
|
||||
For ease of use when linking,
|
||||
<filename class="symlink">libhamlib.so</filename> is provided as a
|
||||
|
|
@ -123,20 +123,20 @@
|
|||
|
||||
<note><title>Working with long commandlines</title>
|
||||
<para>Long commands like those above are difficult to work with
|
||||
because once the line wraps the <literal>Bash(1)</literal> shell
|
||||
because once the line wraps the <literal>bash(1)</literal> shell
|
||||
seems to start doing weird things. The trick is breaking the line
|
||||
into two (or more) parts with the <quote>\</quote> character.
|
||||
When the right edge of the screen is reached simply add
|
||||
<literal>\</literal> to the end of the text you are typing and
|
||||
then press
|
||||
<keycap>Enter</keycap>. You will receive a <prompt>></prompt>
|
||||
from <literal>Bash(1)</literal> and you may continue typing the
|
||||
from <literal>bash(1)</literal> and you may continue typing the
|
||||
command. If there is no space character in the command you are
|
||||
typing, be sure you don't add a space before the <literal>\</literal>
|
||||
or at the beginning of the next line. If you break the line where
|
||||
a space would exist in the command, either putting the space before
|
||||
the <literal>\</literal> or at the beginning of the next line.
|
||||
<literal>Bash(1)</literal> will splice the lines together to form one
|
||||
<literal>bash(1)</literal> will splice the lines together to form one
|
||||
command once it receives a <keycap>Enter</keycap> character not
|
||||
preceded by a <literal>\</literal>.
|
||||
</note>
|
||||
|
|
@ -223,12 +223,12 @@
|
|||
archive into its own directory.</para>
|
||||
|
||||
<screen format="linespecific">
|
||||
<prompt>myhost:~ $</prompt> <command>mv Download/hamlib-1.1.0.tar.gz src</command>
|
||||
<prompt>myhost:~ $</prompt> <command>mv Download/hamlib-&curver;.tar.gz src</command>
|
||||
<prompt>myhost:~ $</prompt> <command>cd src</command>
|
||||
<prompt>myhost:~/src $</prompt> <command>tar xvfz hamlib-1.1.0.tar.gz</command>
|
||||
<prompt>myhost:~/src $</prompt> <command>tar xvfz hamlib-&curver;.tar.gz</command>
|
||||
</screen>
|
||||
|
||||
<para>Now you should have a directory called <filename class="directory">hamlib-1.1.0</filename>
|
||||
<para>Now you should have a directory called <filename class="directory">hamlib-&curver;</filename>
|
||||
in the directory you executed the <command>tar</command> command.
|
||||
This would be a good time to familiarize yourself with the files in
|
||||
the archive.</para>
|
||||
|
|
@ -241,7 +241,7 @@
|
|||
compiling Hamlib is as easy as running:</para>
|
||||
|
||||
<screen format="linespecific">
|
||||
<prompt>myhost:~/src/hamlib-1.1.0 $</prompt> <command>./configure</command>
|
||||
<prompt>myhost:~/src/hamlib-&curver; $</prompt> <command>./configure</command>
|
||||
</screen>
|
||||
|
||||
<para>The <literal>configure</literal> script checks for the presence of
|
||||
|
|
@ -251,7 +251,7 @@
|
|||
Hamlib:</para>
|
||||
|
||||
<screen format="linespecific">
|
||||
<prompt>myhost:~/src/hamlib-1.1.0 $</prompt> <command>make</command>
|
||||
<prompt>myhost:~/src/hamlib-&curver; $</prompt> <command>make</command>
|
||||
</screen>
|
||||
|
||||
<para>Now there should be considerable output to the screen during
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue