Loading...
Searching...
No Matches
Hamlib API Reference

# Preface

This document describes the Hamlib library Application Programming Interface (API) for this distribution.

We attempt to document the complete API of the core modules of Hamlib, i.e. the API seen by end-user application developers. You may navigate the documentation through the tabs at the top of this page.

Note
  This documentation is a work in progress.

Please report any problems to hamli.nosp@m.b-de.nosp@m.velop.nosp@m.er@l.nosp@m.ists..nosp@m.sour.nosp@m.cefor.nosp@m.ge.n.nosp@m.et.

# Typographic conventions

While Doxygen applies its own typographic conventions to the document based on its own stylesheets, this section details Hamlib specific conventions.

## Key words

Key words used in program source such as TRUE or FALSE are shown in a constant width font.

## Manual pages

References to Unix style manual pages are shown as man(1). The manual page entry is in a constant width font immediately followed by parentheses containing a numeral denoting the section of the manual the key word can be found. For example, to view printf(3) use:

man 3 printf

at a terminal prompt and the man(1) program will display the C library manual page for the printf() function. On most Unix type systems there are two printf manual pages, one in section 1 (user commands) and the other in section 3 (library calls).

To learn more about manual pages:

man man-pages

is a good starting point.

If you are using a system that does not have manual pages, many HTML formatted pages are available on the World Wide Web. The Linux man-pages project has many manual pages online and is the source for most system and library call documentation found in every Linux distribution. The Debian project also hosts a large collection of manual pages drawn from the packages in its distributions.

## Program names and options

Program names and options to programs such as the Hamlib utilities are shown in a constant width font, e.g. rigctl -v the verbose option to the rigctl(1) Hamlib utility.

# Distributed information files

These text files are distributed with the Hamlib package.

- Readme files: General; Beta Tester; Developer; MS Windows; Mac OS X; Frequency range changes; Multicast support;

- Other files: INSTALL; AUTHORS; COPYING; COPYING.LIB; LICENSE; NEWS; PLAN; THANKS;

# Internet links

- http://hamlib.org — Main project with links to releases, Wiki, and documentation including list of supported equipment.
- https://github.com/Hamlib/Hamlib — GitHub repository via Web interface.
- https://sourceforge.net/projects/hamlib/ — SourceForge.net project page.
- https://sourceforge.net/p/hamlib/code/ — SourceForge Git repository via Web interface.

# Documentation License

- License for Documentation

# Authors

- Stéphane Fillod, F8CFE, and Frank Singleton, VK3FCS and the Hamlib Group
- Documentation revisions by Martin Ewing, AA6E, Nate Bargmann, N0NB, Michael Black, W9MDB and many others.