| 1 |
/*! \mainpage Hamlib API Reference |
| 2 |
|
| 3 |
\section s1 Preface |
| 4 |
|
| 5 |
This document describes the Hamlib library Application Programming Interface |
| 6 |
(API) for this distribution. |
| 7 |
|
| 8 |
We attempt to document the complete API of the core modules of Hamlib, i.e. |
| 9 |
the API seen by end-user application developers. You may navigate the |
| 10 |
documentation through the tabs at the top of this page. |
| 11 |
|
| 12 |
\note This documentation is a work in progress. |
| 13 |
|
| 14 |
Please report any problems to [email protected]. |
| 15 |
|
| 16 |
\section s2 Typographic conventions |
| 17 |
|
| 18 |
While Doxygen applies its own typographic conventions to the document based on |
| 19 |
its own stylesheets, this section details Hamlib specific conventions. |
| 20 |
|
| 21 |
\subsection sub1 Key words |
| 22 |
|
| 23 |
Key words used in program source such as `TRUE` or `FALSE` are shown in a |
| 24 |
constant width font. |
| 25 |
|
| 26 |
\subsection sub2 Manual pages |
| 27 |
|
| 28 |
References to Unix style manual pages are shown as `man`(1). The manual page |
| 29 |
entry is in a constant width font immediately followed by parentheses |
| 30 |
containing a numeral denoting the section of the manual the key word can be |
| 31 |
found. For example, to view `printf`(3) use: |
| 32 |
|
| 33 |
``` |
| 34 |
man 3 printf |
| 35 |
``` |
| 36 |
|
| 37 |
at a terminal prompt and the `man`(1) program will display the C library |
| 38 |
manual page for the `printf()` function. On most Unix type systems there are |
| 39 |
two `printf` manual pages, one in section 1 (user commands) and the other in |
| 40 |
section 3 (library calls). |
| 41 |
|
| 42 |
To learn more about manual pages: |
| 43 |
|
| 44 |
``` |
| 45 |
man man-pages |
| 46 |
``` |
| 47 |
|
| 48 |
is a good starting point. |
| 49 |
|
| 50 |
If you are using a system that does not have manual pages, many HTML formatted |
| 51 |
pages are available on the World Wide Web. |
| 52 |
[The Linux man-pages project](https://www.kernel.org/doc/man-pages/) |
| 53 |
has many manual pages online and is the source for most system and library call |
| 54 |
documentation found in every Linux distribution. The |
| 55 |
[Debian project also hosts a large collection of manual pages](https://manpages.debian.org/) |
| 56 |
drawn from the packages in its distributions. |
| 57 |
|
| 58 |
\subsection sub3 Program names and options |
| 59 |
|
| 60 |
Program names and options to programs such as the Hamlib utilities are shown |
| 61 |
in a constant width font, e.g. `rigctl -v` the *verbose* option to the `rigctl`(1) |
| 62 |
Hamlib utility. |
| 63 |
|
| 64 |
\section txtfil Distributed information files |
| 65 |
|
| 66 |
These text files are distributed with the Hamlib package. |
| 67 |
|
| 68 |
\li Readme files: \subpage Rdme "General"; |
| 69 |
\subpage Rdmebeta "Beta Tester"; |
| 70 |
\subpage Rdmedevel "Developer"; |
| 71 |
\subpage Rdmewin "MS Windows"; |
| 72 |
\subpage Rdmeosx "Mac OS X"; |
| 73 |
\subpage Rdmefrq "Frequency range changes"; |
| 74 |
\subpage Rdmemulti "Multicast support"; |
| 75 |
|
| 76 |
\li Other files: \subpage INSTALL; |
| 77 |
\subpage AUTHORS; |
| 78 |
\subpage COPYING; |
| 79 |
\subpage COPYING.LIB; |
| 80 |
\subpage LICENSE; |
| 81 |
\subpage NEWS; |
| 82 |
\subpage PLAN; |
| 83 |
\subpage THANKS; |
| 84 |
|
| 85 |
\section lnks Internet links |
| 86 |
|
| 87 |
\li http://hamlib.org — Main project with links to releases, Wiki, and documentation including list of supported equipment. |
| 88 |
\li https://github.com/Hamlib/Hamlib — GitHub repository via Web interface. |
| 89 |
\li https://sourceforge.net/projects/hamlib/ — SourceForge.net project page. |
| 90 |
\li https://sourceforge.net/p/hamlib/code/ — SourceForge Git repository via Web interface. |
| 91 |
|
| 92 |
\section slic Documentation License |
| 93 |
|
| 94 |
\li \subpage doclicense |
| 95 |
|
| 96 |
\section auth Authors |
| 97 |
|
| 98 |
\li Stéphane Fillod, F8CFE, and Frank Singleton, VK3FCS and the Hamlib Group |
| 99 |
\li Documentation revisions by Martin Ewing, AA6E, Nate Bargmann, N0NB, |
| 100 |
Michael Black, W9MDB and many others. |
| 101 |
*/ |
| 102 |
|
| 103 |
|
| 104 |
/* Subpage definitions follow. */ |
| 105 |
|
| 106 |
/*! \page doclicense License for Documentation |
| 107 |
This documentation is free; you can redistribute it without |
| 108 |
any restrictions. The modification or derived work must retain |
| 109 |
copyright and list all authors. |
| 110 |
|
| 111 |
This documentation is distributed in the hope that it will be |
| 112 |
useful, but WITHOUT ANY WARRANTY; without even the implied warranty |
| 113 |
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| 114 |
*/ |
| 115 |
|
| 116 |
/*! \page Rdme README (general) |
| 117 |
\verbinclude README.md |
| 118 |
*/ |
| 119 |
|
| 120 |
/*! \page Rdmebeta README.betatester |
| 121 |
\verbinclude README.betatester |
| 122 |
*/ |
| 123 |
|
| 124 |
/*! \page Rdmedevel README.developer |
| 125 |
\verbinclude README.developer |
| 126 |
*/ |
| 127 |
|
| 128 |
/*! \page Rdmewin Cross-compiling Hamlib on Linux for MS Windows |
| 129 |
This page contains the `scripts/README.build-Windows` instructions and the |
| 130 |
`scripts/build-w32.sh` and `scripts/build-w64.h` files that describe |
| 131 |
cross-compiling Hamlib for MS Windows 32 and 64 bit versions on Debian |
| 132 |
GNU/Linux. |
| 133 |
\tableofcontents |
| 134 |
\section Build README.build-Windows |
| 135 |
\verbinclude README.build-Windows |
| 136 |
\subsection W32 The build-w32.sh script |
| 137 |
\htmlinclude build-w32.sh.html |
| 138 |
\latexinclude build-w32.sh.tex |
| 139 |
\subsection W64 The build-w64.sh script |
| 140 |
\htmlinclude build-w64.sh.html |
| 141 |
\latexinclude build-w64.sh.tex |
| 142 |
*/ |
| 143 |
|
| 144 |
/*! \page Rdmeosx README.macos |
| 145 |
\verbinclude README.macos |
| 146 |
*/ |
| 147 |
|
| 148 |
/*! \page Rdmefrq README.freqranges |
| 149 |
\verbinclude README.freqranges |
| 150 |
*/ |
| 151 |
|
| 152 |
/*! \page Rdmemulti README.multicast |
| 153 |
\verbinclude README.multicast |
| 154 |
*/ |
| 155 |
|
| 156 |
/*! \page INSTALL INSTALL |
| 157 |
\verbinclude INSTALL |
| 158 |
*/ |
| 159 |
|
| 160 |
/*! \page AUTHORS AUTHORS |
| 161 |
\verbinclude AUTHORS |
| 162 |
*/ |
| 163 |
|
| 164 |
/*! \page COPYING COPYING |
| 165 |
\verbinclude COPYING |
| 166 |
*/ |
| 167 |
|
| 168 |
/*! \page COPYING.LIB COPYING.LIB |
| 169 |
\verbinclude COPYING.LIB |
| 170 |
*/ |
| 171 |
|
| 172 |
/*! \page LICENSE LICENSE |
| 173 |
\verbinclude LICENSE |
| 174 |
*/ |
| 175 |
|
| 176 |
/*! \page NEWS NEWS |
| 177 |
\verbinclude NEWS |
| 178 |
*/ |
| 179 |
|
| 180 |
/*! \page PLAN PLAN |
| 181 |
\verbinclude PLAN |
| 182 |
*/ |
| 183 |
|
| 184 |
/*! \page THANKS THANKS |
| 185 |
\verbinclude THANKS |
| 186 |
*/ |
| 187 |
|
| 188 |
|
| 189 |
/* Defined API groups--sections included with addtogroup in sources. */ |
| 190 |
|
| 191 |
/*! Define groups for Doxygen |
| 192 |
* \defgroup rig Rig (transceiver) API |
| 193 |
* \defgroup riglist Rig (radio) Model List |
| 194 |
* \defgroup rig_internal Rig (transceiver) Internal API |
| 195 |
* \defgroup rotator Rotator API |
| 196 |
* \defgroup rotlist Rotator Model List |
| 197 |
* \defgroup rot_internal Rotator Internal API |
| 198 |
* \defgroup amplifier Amplifier API |
| 199 |
* \defgroup amplist Amplifier Model list |
| 200 |
* \defgroup amp_internal Amplifier Internal API |
| 201 |
* \defgroup port Port data structure for accessing devices |
| 202 |
* \defgroup utilities Utility Routines API |
| 203 |
* \defgroup lib_internal Hamlib internals |
| 204 |
*/ |