[Hamlib-commits] Hamlib -- Ham radio control libraries branch master updated. 4b8a12a8c53bd2c94f1f7
Library to control radio transceivers and receivers
Brought to you by:
n0nb
Menu
▾
▴
[Hamlib-commits] Hamlib -- Ham radio control libraries branch master updated. 4b8a12a8c53bd2c94f1f77655b1760669c9bc299
|
From: Nate B. <n0...@us...> - 2021-05-18 16:28:40
|
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Hamlib -- Ham radio control libraries".
The branch, master has been updated
via 4b8a12a8c53bd2c94f1f77655b1760669c9bc299 (commit)
via 394c61fa442da425ed916e326d1dd2e7bc8d9ae5 (commit)
via 225ab6f85d63011c67f0e5df0d2cdf7d7f5a921b (commit)
from e8c7a198ea93a6ec5208d76494d85b56c5b9f1b9 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 4b8a12a8c53bd2c94f1f77655b1760669c9bc299
Merge: 225ab6f8 394c61fa
Author: Nate Bargmann <n0...@n0...>
Date: Tue May 18 11:26:04 2021 -0500
Merge pull request #705 from N0NB/doxygen_work
Enable optional generation of the PDF manual
commit 394c61fa442da425ed916e326d1dd2e7bc8d9ae5
Author: Nate Bargmann <n0...@n0...>
Date: Tue May 18 11:16:15 2021 -0500
Enable optional generation of the PDF manual
In the event anyone wants a PDF version of the reference manual, it can
be generated now.
diff --git a/README.developer b/README.developer
index 0c441692..e49ccda3 100644
--- a/README.developer
+++ b/README.developer
@@ -267,10 +267,6 @@ Optional, but highly recommended:
N.B.: The libusb-1.0 package is required for building most of the 'kit'
backend. The older version of libusb 0.1.x is no longer supported.
-Documentation:
-* Doxygen
-* GNU Source-highlight
-
N.B.: Some systems can have several versions of the autotools installed. In
that case, autoconf may be called "autoconf2.59", autoheader
"autoheader2.59", and automake "automake-1.9", aclocal "aclocal-1.9" or a
@@ -376,6 +372,44 @@ then 'ldconfig' will need to be run as the root user so that applications
using the Hamlib libraries can find them.
+1.3.1 Doxygen generated reference manual
+
+The following packages need to be installed:
+* Doxygen
+* GNU Source-highlight
+
+1.3.1.1 HTML manual
+
+In the top level of the build directory:
+
+ cd doc
+ make doc
+
+will build the HTML manual. The resulting 'doc/html' directory contains all
+of the files needed for the HTML manual. The 'index.html' file is the entry
+point to the manual.
+
+1.3.1.2 PDF manual
+
+To generate the PDF version of the reference manual the following texlive
+packages are required (Debian package names shown):
+* texlive-latex-base
+* texlive-latex-recommended
+* texlive-latex-extra
+
+Set GENERATE_LATEX in 'doc/hamlib.cfg.in' to 'YES' which will enable the LaTEX
+build. Then run:
+
+ make doc
+
+as above and once the run is complete:
+
+ cd latex
+ make
+
+The resulting generated document in the 'latex' directory is 'refman.pdf'.
+
+
1.4. Feedback
The Hamlib team is very interested to hear from you, how Hamlib builds and
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 72de81e7..79cdfe15 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -14,10 +14,12 @@ SCRIPTSLST = build-w32.sh build-w64.sh
# Use GNU source-highlight to generate highlighted shell scripts for the
# Doxygen manual.
doc: hamlib.cfg $(SRCDOCLST)
- for script in $(SCRIPTSLST) ; do \
- source-highlight -n -i $(top_srcdir)/scripts/$${script} -o $(top_builddir)/scripts/$${script}.html ; \
- done ; \
+ for script in $(SCRIPTSLST) ; \
+ do \
+ source-highlight -n -f html -i $(top_srcdir)/scripts/$${script} -o $(top_builddir)/scripts/$${script}.html ; \
+ source-highlight -n -f latex -i $(top_srcdir)/scripts/$${script} -o $(top_builddir)/scripts/$${script}.tex ; \
+ done
doxygen hamlib.cfg
clean-local:
- -rm -rf $(top_builddir)/doc/html $(top_builddir)/scripts/build-w*.sh.html
+ -rm -rf $(top_builddir)/doc/html $(top_builddir)/doc/latex $(top_builddir)/scripts/build-w*
diff --git a/doc/hamlib.cfg.in b/doc/hamlib.cfg.in
index 310330e5..569c6c14 100644
--- a/doc/hamlib.cfg.in
+++ b/doc/hamlib.cfg.in
@@ -14,6 +14,15 @@ GENERATE_RTF = NO
GENERATE_MAN = NO # User can set to YES for local man pages
MAN_EXTENSION = .3
+# Set GENERATE_LATEX to YES to generate the needed files for the PDF manual
+# and run 'make doc'. Then 'cd latex ; make' to generate the PDF manual.
+#
+# See section 1.3.1.2 in @top_srcdir@/README.developer for the needed LaTEX
+# packages.
+USE_PDFLATEX = YES
+PDF_HYPERLINKS = YES
+EXTRA_PACKAGES = pmboxdraw
+
# Input
CASE_SENSE_NAMES = YES
FULL_PATH_NAMES = NO
@@ -29,9 +38,8 @@ INCLUDE_PATH = @top_srcdir@/include
EXAMPLE_PATH = @top_srcdir@/tests/testrig.c \
@top_srcdir@ \
- @top_srcdir@/scripts/README.build-Windows \
- @top_builddir@/scripts/build-w32.sh.html \
- @top_builddir@/scripts/build-w64.sh.html
+ @top_srcdir@/scripts \
+ @top_builddir@/scripts
QUIET = YES
diff --git a/doc/index.doxygen b/doc/index.doxygen
index c1740079..58ebc9cf 100644
--- a/doc/index.doxygen
+++ b/doc/index.doxygen
@@ -87,8 +87,10 @@ GNU/Linux.
\verbinclude README.build-Windows
\subsection W32 The build-w32.sh script
\htmlinclude build-w32.sh.html
+\latexinclude build-w32.sh.tex
\subsection W64 The build-w64.sh script
\htmlinclude build-w64.sh.html
+\latexinclude build-w64.sh.tex
*/
/*! \page Rdmeosx README.osx
commit 225ab6f85d63011c67f0e5df0d2cdf7d7f5a921b
Author: Mike Black W9MDB <mdb...@ya...>
Date: Tue May 18 08:58:21 2021 -0500
Update multicast draft protocol
diff --git a/README.multicast b/README.multicast
index 150788d1..d1249604 100644
--- a/README.multicast
+++ b/README.multicast
@@ -25,30 +25,35 @@ CRC=0xf49f4708 (this is just an example CRC and not accurate for this example)
Example JSON
{
- "VFO1": { // unlimited number of VFOs possible
+ "__comment1__": "customizable rig identification -- will allow multiple rigs to be on the multicast",
+ "ID": "Rig#1",
+ "vfos": [
+ {
"VFO": "VFOA",
- "Freq": 14074000, // Hz
+ "Freq": 14074000,
"Mode": "USB",
- "Width": 5000, .. // Hz
- "RX": 0, // boolean values 0 = off, 1 = on
- "TX": 0,
+ "Width": 5000,
+ "RX": 0,
+ "TX": 0
},
- "VFO2": {
+ {
"VFO": "VFOB",
"Freq": 14076000,
"Mode": "USB",
"Width": 5000,
"RX": 0,
- "TX": 0,
- },
+ "TX": 0
+ }],
"Split": 0,
- "SatMode": 0
- "ID": "Rig#1", // customizable rig identification
+ "SatMode": 0,
"Rig": "Dummy",
"App": "Hamlib",
- "Version": "20210429", // protocol version date YYYYMMDD
- "Seq": 1, // 1-up sequence number 32-bit -- wraps around to 1 from 2^32-1
- "CRC": "0xf49f4708" // 32-bit CRC of all data replacing the CRC value with 0x00000000
+ "__comment_version__": "protocol version date YYYYMMDD",
+ "Version": "20210518",
+ "__comment_seq__": "Seq is 1-up sequence number 32-bit -- wraps around to 1 from 2^32-1",
+ "Seq": 1,
+ "__comment_crc__": "32-bit CRC of all data replacing the CRC value with 0x00000000",
+ "CRC": "0xf49f4708"
}
Will be able to set freq, mode, width, ptt
-----------------------------------------------------------------------
Summary of changes:
README.developer | 42 ++++++++++++++++++++++++++++++++++++++----
README.multicast | 31 ++++++++++++++++++-------------
doc/Makefile.am | 10 ++++++----
doc/hamlib.cfg.in | 14 +++++++++++---
doc/index.doxygen | 2 ++
5 files changed, 75 insertions(+), 24 deletions(-)
hooks/post-receive
--
Hamlib -- Ham radio control libraries
|
