Nate Bargmann
fee7ea2425
Add typographic conventions section to the main page
2021-05-19 21:54:21 -05:00
Nate Bargmann
b1e84abded
Add most all files needed to SRCDOCLST
2021-05-18 18:59:09 -05:00
Nate Bargmann
394c61fa44
Enable optional generation of the PDF manual
...
In the event anyone wants a PDF version of the reference manual, it can
be generated now.
2021-05-18 11:16:15 -05:00
Nate Bargmann
1501ad78ea
Remove security page as it is for GitHub only
...
Distribute other files ommitted from the 4.2 release for documentation
generation. Caveat--don't rush!
2021-05-17 18:31:19 -05:00
Nate Bargmann
2a43303947
Use GNU Source-highlight for documentation build
...
Generate highlighted and line numbered files for the Windows build
scripts to be included in the generated documentation.
Add clean-local target to doc/Makefile.am to clean generated document
files.
Document requirement for GNU Source-highlight.
2021-05-17 17:35:27 -05:00
Nate Bargmann
aaee375d48
Distribute logo image file for the Doxygen manual
2021-05-17 15:15:17 -05:00
Nate Bargmann
0ed6b11088
Update Doxygen comments and main page
2021-05-16 21:10:31 -05:00
Mike Black W9MDB
906b6e62d8
Update man pages
2021-04-28 07:03:10 -05:00
Mike Black W9MDB
4501c1c97b
Remove generated files
2021-04-14 15:41:01 -05:00
Mike Black W9MDB
9d310062eb
More files for git clone configure to work
2021-04-14 09:19:27 -05:00
Nate Bargmann
132d896e89
Add amp_internal subgroup to Doxygen documentation
...
The amp_internal subgroup will document those items intended for Hamlib
interal use, i.e. not a part of the public API.
2021-02-20 07:13:55 -06:00
Michael Black W9MDB
5964e1de18
Improve FTDX3000 antenna handling
...
https://github.com/Hamlib/Hamlib/issues/510
2021-02-17 08:43:12 -06:00
Nate Bargmann
9dce43fc50
Update Docygen comments in rotator.c
...
Create new group for rot_internal that Doxygen shows under the Modules
tab.
2021-02-15 15:36:47 -06:00
Nate Bargmann
3602c326cd
Include Windows build info and scripts to Doxygen
...
Add these files as part of the Doxygen generated documentation.
2021-02-14 14:07:11 -06:00
Michael Black W9MDB
f81d0ca96e
Add info for set_ant
2021-02-14 07:37:02 -06:00
Nate Bargmann
d31f6ef441
Unify the amplifier API into a single group
2021-02-11 03:09:17 -06:00
Nate Bargmann
5503dddcdd
Exclude rotclass.h from Doxygen processing
...
Exclude rotclass.h from Doxygen processing for now.
2021-02-11 02:30:24 -06:00
Nate Bargmann
7b32e58a76
Exclude ampclass.h from Doxygen processing
...
Exclude ampclass.h from Doxygen processing for now.
2021-02-08 12:48:47 -06:00
Nate Bargmann
30c04fabd4
Exclude amp_conf.h from Doxygen processing
...
As amp_conf.h only contains private function declarations exclude it
from Doxygen processing for now.
2021-02-08 12:38:23 -06:00
Nate Bargmann
d4bc60be0b
Update Doxygen files
...
The latest Doxygen has changed the footer.html substantially from the
much older version we were using. Add some Hamlib project specific
information to it.
Align hamlib.cfg.in to the latest Doxygen.
Reduce hamlib.css to only those elements needed for Hamlib
customization.
Add hamlib.png as a project logo.
2021-02-05 20:36:49 -06:00
Michael Black W9MDB
0fe9b866d2
Update rigctl.1 man page for W command format
2021-01-19 11:18:38 -06:00
Michael Black W9MDB
2a0deb3415
Add RIG_LEVEL_RFPOWER_METER_WATTS
...
Old level of 0-1 just doesn't work well with the varying power levels in rigs now
2020-12-16 17:47:49 -06:00
Michael Black W9MDB
44baf44dcc
Update rigctl.1 man page
2020-12-11 17:20:34 -06:00
Mikael Nousiainen
bb315270bf
Merge branch 'master' into rotator-speed-control-and-status
2020-12-02 21:46:23 +02:00
Michael Black W9MDB
dd3ed134dd
Turns out M2 has two different protcols
...
So we now have RC2800, RC2800_EARLY_AZ, and RC2800_EARLY_AZEL
RC2800_EARLY_AZ is azimuth only
Update rotctl man page for move keywords
https://github.com/Hamlib/Hamlib/issues/451
2020-11-30 09:22:33 -08:00
Mikael Nousiainen
a48f149955
Implement funcs, levels and parms + the ext variants for rotators. Add option to not change rotator speed when using the move command. Add rotator status flags. Work in progress.
2020-11-24 21:51:10 +02:00
Michael Black W9MDB
bba86fb6a1
Update rigctl.1 man page
2020-11-21 08:25:13 -06:00
Michael Black W9MDB
131d45551c
Update rigctld.1 man page
...
https://github.com/Hamlib/Hamlib/issues/404
2020-10-23 11:52:00 -05:00
Michael Black W9MDB
d4e1e91272
Fix rigctl -W and --twiddle_timeout
2020-10-22 16:04:53 -05:00
Daniele Forsi
1e00e4e8db
Fix typos
...
Command line:
codespell --write-changes --summary --skip=*.m4 --ignore-words-list="develope,get's,quitt,setts,som,ue,vektor,objext,ans
2020-10-11 18:03:50 +02:00
Michael Black W9MDB
c500b342a5
Update man pages for get_chan
...
https://github.com/Hamlib/Hamlib/issues/370
2020-09-17 10:37:22 -05:00
Michael Black W9MDB
f107faf71e
Update man pages for set_ant
2020-09-17 08:20:51 -05:00
Michael Black W9MDB
975824c618
Update rigctl.1 set_ant
2020-09-11 08:40:07 -05:00
Nate Bargmann
e4727094ab
Update informational man pages for Hamlib 4.0
2020-09-10 08:40:04 -05:00
Nate Bargmann
42f4177306
Update utilities man pages for Hamlib 4.0
2020-09-10 08:36:57 -05:00
Nate Bargmann
516779cf03
Expand section on examples
...
Add note on testing output.
2020-09-10 08:34:31 -05:00
Daniele Forsi
d7b332c3f7
Fix spelling errors
...
Fixed using the following command:
codespell --write-changes --summary --skip=*.m4 --ignore-words-list="develope,get's,quitt,setts,som,ue,vektor"
codespell --write-changes --summary --skip=aclocal.m4,lib --ignore-words-list="develope,get's,quitt,setts,som,ue,vektor"
Codespell home page: https://github.com/codespell-project/codespell
2020-07-24 09:02:48 +02:00
Michael Black W9MDB
65d8ac8d95
Fix spelling error in rigctl.1
2020-07-14 12:56:09 -05:00
Michael Black W9MDB
e8bd6517af
Update rigctld.1 manpage with ip6 info and examples
2020-06-22 23:42:01 -05:00
Michael Black W9MDB
87a83ffbb1
rigctld now works with rigctl in vfo mode
...
https://github.com/Hamlib/Hamlib/issues/259
set_vfo_opt can now dynamically change vfo mode on rigctld
So this example now works...does some non-vfo stuff then switches to vfo mode
rigctl -m 2 F 14074000 V VFOB F 14076000 V VFOA f V VFOB f set_vfo_opt 1 f VFOA
rigctl commands v,V and S have been changed to not require VFO arguments
New API function rig_set_vfo_opt -- only implemented for Net rigctl as it doesn't apply to any other rigs
2020-05-27 12:21:41 -05:00
mdblack98
5eb5b6f3d8
https://github.com/Hamlib/Hamlib/issues/227
...
Added read_only flag everywhere
2020-04-26 14:37:03 -05:00
Michael Black
6fc7554443
Update rotctl.1 to add some description of azimuth and elevation
2020-04-09 15:36:07 -05:00
Michael Black
9a49167b69
Update long command for -Y rigctl option and man page
2020-04-05 23:35:20 -05:00
Michael Black
15f56aca22
Update H/h command to implemented...though not in many rigs
2020-04-05 23:23:11 -05:00
Michael Black
defe4e8f10
Update rigctl rigctld man pages for new f command that now returns the VFO too
2020-03-20 08:22:40 -05:00
Michael Black
086e3ae9da
Add dump_caps and dump_state info to man pages
2020-03-06 12:09:42 -06:00
Michael Black
f18b0ebb07
Add -X to rigctld.1
2020-03-01 22:48:46 -06:00
Michael Black
49aa7d00a7
Fix get_ant RIG_ANT_CURR logic
2020-02-12 07:20:34 -06:00
Michael Black
1463762ff0
Update rigctl.1 man page for new set_ant and get_ant
2020-02-10 15:48:00 -06:00
Michael Black
cab9cffdd8
Add CM108, GPIO, and GPION to rigctl.1 man page
2020-01-21 22:52:35 -06:00