Created Documentation (markdown)

master
Nate Bargmann 2018-03-04 06:30:29 -06:00
rodzic 6d59e434bb
commit 64ff4bc8b4
1 zmienionych plików z 30 dodań i 0 usunięć

30
Documentation.md 100644

@ -0,0 +1,30 @@
# Hamlib Documentation
On this page are links to the generated Hamlib documentation and manual pages of the Hamlib utility programs converted to PDF.
[TOC]
## Hamlib manual
A new manual covering Hamlib is being written. It is planned to replaced the Doxygen generated API reference and the manual files in the sections below.
[Hamlib manual for 3.0.1](http://hamlib.sourceforge.net/manuals/hamlib.html)
## API reference
Beginning with version 1.1.2 the API Reference Manual is generated by [Doxygen](http://www.doxygen.org/), a sophisticated tool capable of generating nice output from marked up comments in the C source files.
[HTML API Reference (v 3.0.1)](http://hamlib.sourceforge.net/manuals/3.0.1/index.html)
[HTML API Reference (v 1.2.15)](http://hamlib.sourceforge.net/manuals/1.2.15/index.html)
## Hamlib utilities
These manual pages were created by groff(1) and ps2pdf(1) from the nroff man page files. These files are a reference for those whose systems do not have a manual page facility.
* [rigctl](http://hamlib.sourceforge.net/pdf/rigctl.1.pdf)
* [rigctld](http://hamlib.sourceforge.net/pdf/rigctld.8.pdf)
* [rotctl](http://hamlib.sourceforge.net/pdf/rotctl.1.pdf)
* [rotctld](http://hamlib.sourceforge.net/pdf/rotctld.8.pdf)
* [rigsmtr](http://hamlib.sourceforge.net/pdf/rigsmtr.1.pdf)
* [rigswr](http://hamlib.sourceforge.net/pdf/rigswr.1.pdf)
* [rigmem](http://hamlib.sourceforge.net/pdf/rigmem.1.pdf)