Commit graph

296 commits

Author SHA1 Message Date
Nate Bargmann
ecadd8dde8
Add manual pages for rigtestmcast and rigtestmcastrx
(cherry picked from commit 357bcf251f)
2026-02-14 21:16:12 -06:00
Nate Bargmann
6bc35d1e8c
Add manual page for rigtestlibusb
(cherry picked from commit 5f3d8c9f55)
2026-02-14 21:16:02 -06:00
Nate Bargmann
c33b05d9f7
Add rigctltcp manual page
Reorder rigctltcp usage output slightly.

(cherry picked from commit 3703191f67)
2026-02-14 21:15:37 -06:00
George Baltz N3GB
21ebcfbd99
Fix typos in man pages
(cherry picked from commit cda9d0bcc9)
2026-01-30 17:42:48 -06:00
Daniele Forsi IU5HKX
b350989609
Update date of man pages
(cherry picked from commit f794a6149c)
2026-01-21 10:11:30 -06:00
Daniele Forsi IU5HKX
f2aaa5d79f
Copy command descriptions form rigctl.1 to rigctld.1
(cherry picked from commit 02539995d6)
2026-01-21 10:11:18 -06:00
Daniele Forsi IU5HKX
b955643806
Make man pages of rigctl and rigctld more similar
(cherry picked from commit 3fc3c80b30)
2026-01-21 10:11:04 -06:00
Daniele Forsi IU5HKX
8bacb2c29a
Fix errors
Fixes:
* move the description of set_separator before get_separator
  for consistency with all other set/get pairs
* fix quotes and mandatory argument in "send_raw" example
* sort "scan" functions
* escape backslashes
* BUGS section: the "halt" command exits the daemon
* "rigctl --show-conf" does not exit
* "rigctld --show-conf" does exit if -r is not given.
* be explicit that "send_raw" gives a special meaning to "0 bytes"
* add missing parameter to description of "get_channel"

(cherry picked from commit ed3551f9b9)
2026-01-21 10:10:39 -06:00
Daniele Forsi IU5HKX
5ac89bf67a
Add missing commands
Adds:
dump_conf
get_cache / set_cache
get_conf / set_conf
get_mode_bandwidths
get_modes
get_split_freq_mode / set_split_freq_mode
get_twiddle / set_twiddle
get_vfo_list
halt
uplink

(cherry picked from commit 82d53cb322)
2026-01-21 10:10:24 -06:00
Daniele Forsi IU5HKX
8a27cbcd1f
Fix typos
(cherry picked from commit ee42a8c120)
2025-12-26 10:52:31 -06:00
George Baltz N3GB
b707b52481 Oops. Fix extra "s. 2025-11-19 06:23:31 -05:00
George Baltz N3GB
4f14c2db8b Add missing 'stop_voice_mem' to man pages. 2025-11-18 14:14:45 -05:00
Nate Bargmann
1ecf721714
Update URL for daily snapshots
Per a message received from SourceForge, the user Web space is being
shut down around 10 Oct 2025.  The message can be read from:

https://sourceforge.net/p/hamlib/mailman/message/59235022/
2025-09-23 12:49:58 -05:00
Nate Bargmann
0f871a5a3e
Update Doxygen comments for rigerror() and rigerror2()
Add a new topic of "Hamlib internals" with the group of lib_internal.

Address GitHub issue #1881.
2025-09-06 18:13:12 -05:00
Nate Bargmann
a35365d155
Merge GitHub PR #1886 2025-09-05 07:20:11 -05:00
Daniele Forsi IU5HKX
d8565776c2 Add a short description of INDI (Instrument Neutral Distributed Interface) 2025-09-04 22:43:38 +02:00
Daniele Forsi IU5HKX
8d5e602229 Add missing configuration parameter freq_skip 2025-09-04 21:38:03 +02:00
Daniele Forsi IU5HKX
c4d524e379 Fix typo 2025-09-04 21:37:55 +02:00
Daniele Forsi IU5HKX
6b4c6200d0 Add examples of using INDI rotators 2025-09-02 21:38:29 +02:00
Nate Bargmann
d596581ece
Rename README.osx to README.macos
Conform the file name to current system marketing name.
2025-09-01 17:13:19 -05:00
Nate Bargmann
c4aad6e0ec
Merge GitHub PR #1854 2025-08-19 13:18:47 -05:00
Daniele Forsi IU5HKX
6a83b0d054
[doc] Split and sort the list of EXTRA_DIST files 2025-08-18 08:07:16 -05:00
Daniele Forsi IU5HKX
a8a53124df freq_skip is a configuration parameter, not a command 2025-08-18 12:21:11 +02:00
Daniele Forsi IU5HKX
c5668bf75a Add value 0/1 to description of set_gpio 2025-08-18 12:11:13 +02:00
Daniele Forsi IU5HKX
caf7346fc0 Fix typos 2025-08-16 11:52:55 +02:00
Nate Bargmann
7cceee9aba
Complete Doxygen comments for rotlist.h
Add new topic for rotator model list.
2025-07-26 18:34:31 -05:00
Nate Bargmann
4d6a3ed582
Fully document amplist.h
Create a new topic group of 'amplist' to separate the list of amplifier
models from the main Amplifier API group.
2025-07-26 18:34:30 -05:00
Nate Bargmann
f67a3cfe47
Update Doxygen comments in riglist.h
Create a new topic group of 'riglist' to separate the long list of radio
models from the main Rig API group.
2025-07-26 18:34:30 -05:00
Nate Bargmann
d2025477be
Add some tips on formatting with Doxygen 2025-07-26 18:34:30 -05:00
Nate Bargmann
82feea990e
Add Doxygen config statements for newer versions
Newer versions of Doxygen (1.14 in Arch Linux) default HAVE_DOT and
CALL_GRAPH to NO, although older versions also default the latter to NO
as well.

Document why DISTRIBUTE_GROUP_DOC was added.  Removes a bit of
redundancy.
2025-07-23 14:34:14 -05:00
Nate Bargmann
98cc0b688e
Update Doxygen comments for rot_state.h 2025-07-22 22:27:59 -05:00
Nate Bargmann
1eb645004a
Ignore additional files from Doxygen processing 2025-07-22 22:27:59 -05:00
Nate Bargmann
c49cd2312c
Add Doxygen support to port.h 2025-07-22 22:27:58 -05:00
Nate Bargmann
9ede33de4f
Exclude multicast.[ch] from Doxygen docs 2025-07-22 22:27:57 -05:00
Nate Bargmann
6cfaf03edd
Add amp_state.h to Doxygen docs 2025-07-22 22:27:57 -05:00
Daniele Forsi IU5HKX
976bfb4276 Remove the executable bit from data files 2025-07-06 19:45:43 +02:00
George Baltz N3GB
65d922ce53 Add -S to rigctld man page 2025-06-21 04:39:11 -04:00
Daniele Forsi IU5HKX
0123cce135 Fix typo
Do the same change as in commit 42f41773
2025-06-06 23:52:13 +02:00
Daniele Forsi IU5HKX
2967945e32 Fix syntax error
Fixes an error that happens when trying to run the example:
$ nc -w 1 localhost 4532P
nc: port number invalid: 4532P
2025-06-06 23:52:13 +02:00
Daniele Forsi IU5HKX
43017b38f0 Fix typo
Add closing tag for example text.
2025-05-26 08:31:39 +02:00
Daniele Forsi IU5HKX
7f717d520d Add that passwords aren't implemented 2025-04-21 20:25:09 +02:00
Daniele Forsi IU5HKX
0323d3a06a Add description for -w/--twiddle_rit 2025-04-21 20:25:09 +02:00
Daniele Forsi IU5HKX
735d54e318 Sync text between man rigctl and man rigctld 2025-04-21 20:25:09 +02:00
Daniele Forsi IU5HKX
576cfb66b1 Fix typos 2025-04-21 20:25:09 +02:00
Daniele Forsi IU5HKX
69f2c60939 Add missing diagram 2025-04-21 20:25:09 +02:00
Daniele Forsi IU5HKX
19de592d3c Fix list of parameters for get_parm/set_parm
Fixes: AFIF_ACC, AFIF_LAN, AFIF_WLAN were missing.
Uses the list returned by \get_parm ? sorted alphabetically
to be more user friendly and to easily spot any missing item in
future.
2025-04-21 20:25:09 +02:00
Daniele Forsi IU5HKX
f9deb43e80 Fix list of parameters for get_level/set_level
Fixes: BAND_SELECT and COMP_METER were spelled wrong, NB was
spelled NQ, USB_AF_INPUT, AGC_TIME, MGL, MGF, MGC, were missing.
Uses the list returned by \get_level ? sorted alphabetically
to be more user friendly and to easily spot any missing item
in future.
2025-04-21 20:25:09 +02:00
Daniele Forsi IU5HKX
cd092fc654 Fix list of parameters for get_func/set_func
Fixes: OVF_STATUS was spelled wrong, SYNC was missing, SLICE is
not available. Uses the list returned by \get_func ? sorted
alphabetically to be more user friendly and to easily spot any
missing item in future.
2025-04-21 20:25:09 +02:00
Daniele Forsi IU5HKX
f890fcf648 Fix groff syntax
A leading space prevents joining two lines.
2025-04-21 20:25:09 +02:00
Daniele Forsi IU5HKX
d724f04163 Remove duplicated text 2025-04-21 20:24:02 +02:00