diff --git a/doc/sgml/backend.sgml b/doc/sgml/backend.sgml deleted file mode 100644 index 720787940..000000000 --- a/doc/sgml/backend.sgml +++ /dev/null @@ -1,11 +0,0 @@ - - Writing a backend for hamlib - - - - diff --git a/doc/sgml/genindex.sgml b/doc/sgml/genindex.sgml deleted file mode 100644 index 312584bf0..000000000 --- a/doc/sgml/genindex.sgml +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/doc/sgml/hamlib-doc.dsl b/doc/sgml/hamlib-doc.dsl deleted file mode 100644 index 4836a103c..000000000 --- a/doc/sgml/hamlib-doc.dsl +++ /dev/null @@ -1,150 +0,0 @@ - - - -]]> - - -]]> -]> - - - - - - -;; ============================== -;; customize the print stylesheet -;; ============================== - -(declare-characteristic preserve-sdata? - ;; this is necessary because right now jadetex does not understand - ;; symbolic entities, whereas things work well with numeric entities. - "UNREGISTERED::James Clark//Characteristic::preserve-sdata?" - #f) - -(define (toc-depth nd) - 2) - -(define %section-autolabel% - ;; Are sections enumerated? - #t) - -(define %body-start-indent% - ;; Default indent of body text - 0pi) - -(define %para-indent-firstpara% - ;; First line start-indent for the first paragraph - 12pt) - -(define %para-indent% - ;; First line start-indent for paragraphs (other than the first) - 0pt) - -(define %block-start-indent% - ;; Extra start-indent for block-elements - 0pt) - -(define formal-object-float - ;; Do formal objects float? - #t) - -(define %hyphenation% - ;; Allow automatic hyphenation? - #t) - -(define %admon-graphics% - ;; Use graphics in admonitions? - #f) - -(define %visual-acuity% - ;; General measure of document text size - ;; "normal" - ;; "presbyopic" - ;; "large-type" - "presbyopic") - - - - - - - - - - -(declare-characteristic preserve-sdata? - ;; this is necessary because right now jadetex does not understand - ;; symbolic entities, whereas things work well with numeric entities. - "UNREGISTERED::James Clark//Characteristic::preserve-sdata?" - #f) - -(define %generate-legalnotice-link% - ;; put the legal notice in a separate file - #t) - -(define %admon-graphics-path% - ;; use graphics in admonitions, set their - "../images/") - -(define %admon-graphics% - #f) - -(define %funcsynopsis-decoration% - ;; make funcsynopsis look pretty - #t) - -(define %html-ext% - ".html") - -(define %generate-article-toc% - ;; Should a Table of Contents be produced for Articles? - ;; If true, a Table of Contents will be generated for each 'Article'. - #t) - -(define %generate-part-toc% - #t) - -(define %generate-article-titlepage% - #t) - -(define (chunk-skip-first-element-list) - ;; forces the Table of Contents on separate page - '()) - -(define %root-filename% - ;; The filename of the root HTML document (e.g, "index"). - "hamlib-doc") - -(define %shade-verbatim% - #t) - -(define %use-id-as-filename% - ;; Use ID attributes as name for component HTML files? - #t) - -(define %graphic-default-extension% - "gif") - -(define %section-autolabel% - ;; For enumerated sections (1.1, 1.1.1, 1.2, etc.) - #t) - -(define (toc-depth nd) - ;; more depth, 2 levels, to toc, instead of flat hierarchy - 2) - - - - - - - diff --git a/doc/sgml/hamlib-doc.sgml b/doc/sgml/hamlib-doc.sgml deleted file mode 100644 index 2ebe692bd..000000000 --- a/doc/sgml/hamlib-doc.sgml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - -]> - - - Ham Radio Control Libraries - General manual for version &curver; - - Nathan - Bargmann - -
- n0nb@networksplus.net -
- 15 January, 2002 - - 2000 - 2001 - 2002 - Frank Singleton, VK3FCS & KM5WS; Stephane Fillod, F8CFE; - Nate Bargmann, N0NB - - - Hamlib-doc - Ham Radio Control Libraries Documentation - - Copyright (C) 2000-2002 Stephane Fillod, Frank Singleton, Nate - Bargmann. This documentation file is part of the Hamlib - package. - - Hamlib-doc is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License as - published by the Free Software Foundation; either version 2 of the - License, or (at your option) any later version. - - Hamlib-doc is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public - License along with Hamlib-doc; see the file COPYING. If not, write - to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, - MA 02139, USA. - - - Abstract - Demonstrate the need for Hamlib, document the Hamlib API, provide - an introduction to writing a program using Hamlib, and provide an - introduction to authoring a backend library to control a radio or other - device. - - - - 0.2.0 - 15 January 2002 - nfb - Update draft, convert 4.1 DTD, add Index framework, API - handled by Doxygen. - - - 0.1.1 - 23 September 2001 - nfb - Final final draft for 1.1.0 (ALPHA) - - - 0.1.0 - 24 February 2001 - nfb - Final draft for 1.1.0 (ALPHA) - - - 0.0.1 - 4 February 2001 - nfb - Rough draft of Preface and Chapter 1. Posted on the - Web for critique - - - - &preface; - &intro; - - - &reference; - - - &genindex; - - diff --git a/doc/sgml/internals.sgml b/doc/sgml/internals.sgml deleted file mode 100644 index 6d1124f6a..000000000 --- a/doc/sgml/internals.sgml +++ /dev/null @@ -1,11 +0,0 @@ - - A Tour of hamlib - - - - diff --git a/doc/sgml/intro.sgml b/doc/sgml/intro.sgml deleted file mode 100644 index 91359247b..000000000 --- a/doc/sgml/intro.sgml +++ /dev/null @@ -1,293 +0,0 @@ - - Introduction to Hamlib - When browsing through the owners manual of that new radio, the pages - devoted to the computer commands seem like an afterthought. While the - manufacturers are not interested in becoming software houses, they do - adequately document the computer control capabilities which allow - independent control software to be written. With the myriad possibilities - of radios and manufacturers available, writing that ultimate logging or - PSK31 application can be a daunting task if even basic - radio control support is desired. The Ham Radio Control Libraries project - aims to develop a solution to this problem. - -
- Overview of Hamlib - Hamlib itself is not an end-user application for radio - control. Rather, it is a collection of libraries, both shared, or - dynamic linked libraries, if you will, and static libraries that - provide end-user applications with - a common means of acessing and controlling radios (and perhaps other - ham radio related peripheral devices in the future) directly connected - to a computer or remotely over a network. Hamlib is currently being - developed on the Linux operating system, but plans include it being - usable on various flavors of UNIX and - Windows, or whatever platform GNU autoconf - will support. - - Hamlib consists of several parts. The application programming - interface, API, shared library is - libhamlib-&curver;.so which is installed in - /usr/local/lib by default. - For ease of use when linking, - libhamlib.so is provided as a - symbolic link to the latest version of Hamlib installed. Of course, - the installation directory may be changed by passing the proper - option to the configure script in the base - directory of the source distribution. While the static library is - libhamlib.a and installed in /usr/local/lib as well. - - The second main part of Hamlib consists of a number of - "backend" libraries each able to communicate to a specific radio. - For example, libhamlib-ft747.so is the shared - backend library that provides Hamlib access to the Yaesu FT-747 - radio. By default the backend libraries are also installed in - /usr/local/lib. Both shared - and static libraries are provided by the default - installation. -
- -
- Hamlib is Free Software - The Hamlib libraries are Free - Software licensed under the GNU Public License, GPL, - version 2. It is important to be aware that use of Hamlib in a - proprietary program has severe restrictions placed on it by the - GPL. As a result one must carefully consider - what kind of license to use for your program. Of course we - encourage using the GPL for your program as it - adds to the pool of available Free Software to the ham - community. - - The advantages of Free Software are multitude, but the primary ones - include accessability of your code to others who can fix problems or - add new functionality. Another advantage is that your code is - always available to be studied by other experimenters and your code - has a much lower chance of becoming dead bits that can't be used on - newer operating systems. For an experimenter's hobby like ham - radio, Free Software offers many more advantages than disadvantages - to you and the ham community. -
- -
- Hamlib development resources - If you are interested in working on Hamlib development itself, - there exist a few resources on the World Wide Web. The main project - page is at http://sourceforge.net/projects/hamlib/. - A homepage is currently in development at http://hamlib.sourceforge.net - A development mailing list is hosted by http://sourceforge.net. Subscription information and an archive - can be accessed through the Hamlib project main page. -
- -
- Getting Hamlib - At this time Hamlib is not included as a binary package in any - major distribution that we're aware of (hopefully this will change - soon). Until then you may retrieve the source from the Hamlib project - page at http://sourceforge.net/projects/hamlib/. - -
- Latest stable version - The latest stable version is &curver;. Currently the project is - in its early stages and only a few backend libraries are included. - Hamlib is currently in heavy development. -
- -
- Latest development version - The latest development code is available via anonymous - CVS through the - project - page. - -
- Accessing anonymous CVS - The following instructions are copied from the - Sourceforge website - (modified with hamlib in the right places) and did work for me. - -
- Anonymous CVS instructions - Hamlib's SourceForge CVS repository can be checked out through - anonymous (pserver) CVS with the following instruction set. When - prompted for a password for anonymous, simply - press the Enter key. - - - myhost:~/src $ cvs -d:pserver:anonymous@cvs.hamlib.\ - > sourceforge.net:/cvsroot/hamlib login - myhost:~/src $ cvs -z3 -d:pserver:anonymous@cvs.hamlib.\ - > sourceforge.net:/cvsroot/hamlib co hamlib - - - Working with long commandlines - Long commands like those above are difficult to work with - because once the line wraps the bash(1) shell - seems to start doing weird things. The trick is breaking the line - into two (or more) parts with the \ character. - When the right edge of the screen is reached simply add - \ to the end of the text you are typing and - then press - Enter. You will receive a > - from bash(1) 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 \ - 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 \ or at the beginning of the next line. - bash(1) will splice the lines together to form one - command once it receives a Enter character not - preceded by a \. - - - Updates from within the hamlib directory do not need the - -d parameter. - - If you get the following error: - cvs login: failed to open /home/user/.cvspass for reading: - No such file or directory - cvs [login aborted]: fatal error: exiting - - You can probably solve this by using the touch - command to create the file .cvspass in your home - directory: - - - myhost:~ $ touch .cvspass - - -
-
-
-
- -
- Building Hamlib - Building Hamlib from source isn't as daunting as it may seem - at first, thanks to GNU autoconf, a tool used by - the developers that generates the configure - script found in the base directory of the source distribution. - Running configure will test your system to be - sure that any required packages for building Hamlib are present. - While configure checks for many components, the - only critical dependency is that the C library development header - files are installed. Of course, you'll need a C compiler and its - associated libraries. - -
- Unpacking the source archive - While my favorite method of unpacking - .tar.gz files is to use the Linux version of - the Swiss Army Knife, Midnight Commander, the instructions - provided are for using tar at the command - prompt. - -
- Using <command>tar</command> to extract the archive - The first order of business is choosing a location for the - source distribution. Some may choose to place the archive under - /usr/local/src, or may - prefer to work within their home directory. The disadvantage of - working in /usr/local/src - is that one must either be logged in as root or - be a member of a group such as staff that has - write permissions on the directory. The advantage of working in - one's home directory is that writing and deleting files can be - done with much lower risk of damage to the system areas of the - filesystem. Either way, you will need to be logged in as - root to install the libraries after compiling. - On with unpacking the archive. - - For this example I will make a few assumptions, the archive - is downloaded and stored in ~/Download - and the source distribution will be installed in ~/src. - - - Interpreting <filename class="directory">~</filename> - If you are new to UNIX type - systems, you may be puzzled just what ~ - prepended to a path name means. It is simply a short hand for - your home directory. If your user name is - fred, then ~ refers to - /home/fred on most - systems, of course there are exceptions. If you are logged in - as root then ~ refers to - /root. - - - The following sequence of commands will get the Hamlib - archive to the right place (substitute your paths in the - examples). First we'll move the archive into the directory where - it will be extracted then use the tar command to extract the - archive into its own directory. - - - myhost:~ $ mv Download/hamlib-&curver;.tar.gz src - myhost:~ $ cd src - myhost:~/src $ tar xvfz hamlib-&curver;.tar.gz - - - Now you should have a directory called hamlib-&curver; - in the directory you executed the tar command. - This would be a good time to familiarize yourself with the files in - the archive. -
-
- -
- Compiling Hamlib - Thanks to the clever design of GNU autoconf - compiling Hamlib is as easy as running: - - - myhost:~/src/hamlib-&curver; $ ./configure - - - The configure script checks for the presence of - the proper development files required to build Hamlib. After the checks - configure then creates the Makefiles from the - included templates in the archive. The next step is to compile - Hamlib: - - - myhost:~/src/hamlib-&curver; $ make - - - Now there should be considerable output to the screen during - the compile process. The main thing here is to make sure that - gcc doesn't fail while reporting an error. The most - common failure is a message saying that a certain file cannot be - found. Most likely the named file will have a .h - extension which means the development files of a required library - aren't installed on your system. As of this writing only the glibc - development files are required. -
-
- -
- Summary - Hamlib is a tool for software authors wishing to take advantage of - the computer control capabilities of modern transceivers and other - devices used around the radio shack. When Hamlib reaches maturity - it will likely be available in your favorite packaging format and - manually compiling it won't be necessary unless you wish to customize - Hamlib itself. - - The remainder of this manual assumes a working knowledge of - UNIX type systems. If you are new to Linux, - I suggest getting a copy of Running Linux by O'Reilly and Associates - from your local bookstore. You can preview this excellent reference - on the Web at http://www.oreilly.com/catalog/runux3/. -
- - - - - - diff --git a/doc/sgml/preface.sgml b/doc/sgml/preface.sgml deleted file mode 100644 index e18ec2a0f..000000000 --- a/doc/sgml/preface.sgml +++ /dev/null @@ -1,64 +0,0 @@ - - Preface - The Personal Computer has arguably become as prominent of a fixture - in the modern hamshack as HF transceivers and handheld radios. The first - PCs hams used combined with an interface also known as a terminal unit, - TU, replaced the noisy mechanical radio teletype, - RTTY, machines. Gradually, other uses became apparent - for the hamshack PC such as logging contact information, operating newer - digital modes such as AMTOR, a forward error correcting - (FEC) mode of RTTY, and packet, an - error checked way of transfering binary data between computers. - - In the mid to late 1980s radio manufacturers began to offer computer - control capability to their offerings. Now the shack PC had one more duty - added to its repertoire. However, the amount of control over a given - radio's capability by computer control was often much less than from the - front panel. In large part was due to many analog controls on the front - panel that weren't under control of the radio's CPU. - Thus most radio control has been limited to control of frequency values - of the variable frequency - oscillators, VFO, and recalling and setting the radio's - memory channels. - - More recent models have more of the front panel controls under the - supervision of the radio's CPU, consequently - manufacturers have enabled more control of the radio's functions through - the computer interface. This has created an explosion of command functions - not just between the different manufacturers, but also among a given - manufacturer's product line. There may also exist subtle differences in - later versions of a given model. - - For the software author wishing to incorporate even the most basic of - radio control functions, the task is daunting. Even the long lived logging - program CT by Ken Wolff, K1EA has reports of subtle - bugs in one radio model or another (this is not intended as a knock of Ken - or his effort, rather it is an observation of the complexity of supporting - a multitude of radios in a monolithic program by one or a few authors). Is - every programmer doomed to recreate radio control themselves with varying - degrees of success? The answer is, no! - - Enter the Hamlib project. Hamlib aims to provide application authors - with a single application programming interface, API, - regardless of the actual radio in use. Thus Hamlib is not an end user - application, but is a middle software layer that acts as a translator - between the API and the specific radio commands. - - This manual will attempt to explain in detail the Hamlib API - , how to use Hamlib for writing radio control software, how to - write a radio backend library, and an overview of Hamlib's structure and - design. - - Finally, Hamlib is Free Software licensed under the GNU Public - License, GPL, version 2. This will have certain - implications if you are a software author considering using Hamlib as a - part of your project. Consult the COPYING file in the base directory of - the Hamlib source distribution for more details. - - - diff --git a/doc/sgml/reference.sgml b/doc/sgml/reference.sgml deleted file mode 100644 index dd7597348..000000000 --- a/doc/sgml/reference.sgml +++ /dev/null @@ -1,16 +0,0 @@ - - hamlib API Reference - The Hamlib API for &curver; is now in its own manual generated by the - Doxygen package using a special - markup in rig.c. The latest API Reference Manual can be - found at the Hamlib - manuals page. - - - - diff --git a/doc/sgml/using.sgml b/doc/sgml/using.sgml deleted file mode 100644 index 48240d801..000000000 --- a/doc/sgml/using.sgml +++ /dev/null @@ -1,19 +0,0 @@ - - Using the hamlib API - -
- Using Hamlib in your project - Currently Hamlib only provides a C language interface, - however, wrappers are planned for popular languages like C++, Perl, - and Python in the future. - -
- - - -