Skip to content

Commit 03eb122

Browse files
ka9qka9q
committed
install some skeletal documentation
1 parent 389d5d8 commit 03eb122

9 files changed

Lines changed: 176 additions & 33 deletions

File tree

‎Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ localstatedir ?= /var
1313
pkgdatadir ?= $(datadir)/ka9q-radio
1414
pkglibdir ?= $(libdir)/ka9q-radio
1515
statedir ?= $(localstatedir)/lib/ka9q-radio
16+
mandir ?= $(prefix)/share/man
1617
PKG_CONFIG_PATH=
1718
LD_LIBRARY_PATH=
1819

‎debian/copyright‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2-
Source: <url://example.com>
2+
Source: https://github.com/ka9q/ka9q-radio
33
Upstream-Name: ka9q-radio
4-
Upstream-Contact: <preferred name and address to reach the upstream project>
4+
Upstream-Contact: Phil Karn <karn@ka9q.net>
55

66
Files:
77
*
88
Copyright:
9-
<years> <put author's name and email here>
10-
<years> <likewise for another author>
9+
2026 Phil Karn, KA9Q
1110
License: GPL-3.0+
1211

1312
Files:
1413
debian/*
1514
Copyright:
16-
2026 Phil Karn <karn@bart.ka9q.net>
15+
2026 Phil Karn <karn@ka9q.net>
1716
License: GPL-3.0+
1817

1918
License: GPL-3.0+

‎debian/ka9q-radio.doc-base.ex‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎debian/ka9q-radio.install‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ etc/sysctl.d/*
1010
etc/modprobe.d/*
1111
usr/lib/hfdl/*
1212
etc/cron.d/*
13-
lib/udev/rules.d/*
14-
lib/systemd/system/*
13+
usr/lib/udev/rules.d/*
14+
usr/lib/systemd/system/*
1515
usr/lib/*
16+
usr/share/man/man1/*
17+
usr/share/man/man8/*

‎debian/rules‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ override_dh_auto_build:
4141
$(MAKE) $(PLUGIN_FLAGS)
4242

4343
override_dh_auto_install:
44-
$(MAKE) $(PLUGIN_FLAGS) install DESTDIR=$(CURDIR)/debian/tmp prefix=/usr systemdunitdir=/lib/systemd/system udevdir=/lib/udev/rules.d
44+
$(MAKE) $(PLUGIN_FLAGS) install DESTDIR=$(CURDIR)/debian/tmp prefix=/usr systemdunitdir=/usr/lib/systemd/system udevdir=/usr/lib/udev/rules.d
4545

4646
override_dh_installsystemd:
4747
dh_installsystemd --no-enable --no-start

‎docs/Makefile‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
# -*- makefile -*-
2-
3-
# dummy make for ka9q-radio docs
4-
# Copyright 2025, Phil Karn, KA9Q
1+
# Copyright 2026, Phil Karn, KA9Q
52

63
.PHONY: clean all install
74

@@ -12,5 +9,6 @@ clean:
129
@true
1310

1411
install:
15-
@true
12+
install -m 0644 monitor.1 control.1 $(DESTDIR)$(mandir)/man1
13+
install -m 0644 radiod.8 $(DESTDIR)$(mandir)/man8
1614

‎docs/control.1‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
.\" Hey, EMACS: -*- nroff -*-
2+
.\" (C) Copyright 2026 Phil Karn <karn@bart.ka9q.net>,
3+
.\"
4+
.\" First parameter, NAME, should be all caps
5+
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
6+
.\" other parameters are allowed: see man(7), man(1)
7+
.TH Ka9q-radio SECTION "April 28 2026"
8+
.\" Please adjust this date whenever revising the manpage.
9+
.\"
10+
.\" Some roff macros, for reference:
11+
.\" .nh disable hyphenation
12+
.\" .hy enable hyphenation
13+
.\" .ad l left justify
14+
.\" .ad b justify to both left and right margins
15+
.\" .nf disable filling
16+
.\" .fi enable filling
17+
.\" .br insert line break
18+
.\" .sp <n> insert n+1 empty lines
19+
.\" for manpage-specific macros, see man(7)
20+
.SH NAME
21+
control \- control and monitor a ka9q-radio channel
22+
.SH SYNOPSIS
23+
.B control
24+
.RI [ options ] " files" ...
25+
.br
26+
.B bar
27+
.RI [ options ] " files" ...
28+
.SH DESCRIPTION
29+
This manual page documents briefly the
30+
.B control
31+
command.
32+
.PP
33+
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
34+
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
35+
.\" respectively.
36+
\fBcontrol\fP is used to control and monitor the status of a single channel in ka9q-radio.
37+
More later.
38+
.SH OPTIONS
39+
These programs follow the usual GNU command line syntax, with long
40+
options starting with two dashes ('\-').
41+
A summary of options is included below.
42+
For a complete description, see the Info files.
43+
.TP
44+
.B \-h, \-\-help
45+
Show summary of options.
46+
.TP
47+
.B \-v, \-\-version
48+
Show version of program.
49+
.SH SEE ALSO
50+
.BR radiod (8),
51+
.BR monitor (1).
52+
.br
53+
The programs are documented fully by
54+
.IR "The Rise and Fall of a Fooish Bar" ,
55+
available via the Info system.

‎docs/monitor.1‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.\" Hey, EMACS: -*- nroff -*-
2+
.\" (C) Copyright 2026 Phil Karn <karn@bart.ka9q.net>,
3+
.\"
4+
.\" First parameter, NAME, should be all caps
5+
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
6+
.\" other parameters are allowed: see man(7), man(1)
7+
.TH Ka9q-radio SECTION "April 28 2026"
8+
.\" Please adjust this date whenever revising the manpage.
9+
.\"
10+
.\" Some roff macros, for reference:
11+
.\" .nh disable hyphenation
12+
.\" .hy enable hyphenation
13+
.\" .ad l left justify
14+
.\" .ad b justify to both left and right margins
15+
.\" .nf disable filling
16+
.\" .fi enable filling
17+
.\" .br insert line break
18+
.\" .sp <n> insert n+1 empty lines
19+
.\" for manpage-specific macros, see man(7)
20+
.SH NAME
21+
monitor \- monitor multicast RTP audio streams
22+
.SH SYNOPSIS
23+
.B monitor
24+
.RI [ options ] " multicast-groups" ...
25+
.SH DESCRIPTION
26+
This manual page documents briefly the
27+
.B monitor
28+
command.
29+
.PP
30+
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
31+
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
32+
.\" respectively.
33+
\fBmonitor\fP joins the specified multicast groups and decodes and plays any
34+
audio streams.
35+
.SH OPTIONS
36+
These programs follow the usual GNU command line syntax, with long
37+
options starting with two dashes ('\-').
38+
A summary of options is included below.
39+
For a complete description, see the Info files.
40+
.TP
41+
.B \-h, \-\-help
42+
Show summary of options.
43+
.TP
44+
.B \-v, \-\-version
45+
Show version of program.
46+
.SH SEE ALSO
47+
.BR control (1),
48+
.BR radiod (8).
49+
.br
50+
The programs are documented fully by
51+
.IR "The Rise and Fall of a Fooish Bar" ,
52+
available via the Info system.

‎docs/radiod.8‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.\" Hey, EMACS: -*- nroff -*-
2+
.\" (C) Copyright 2026 Phil Karn <karn@bart.ka9q.net>,
3+
.\"
4+
.\" First parameter, NAME, should be all caps
5+
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
6+
.\" other parameters are allowed: see man(7), man(1)
7+
.TH Ka9q-radio SECTION "April 28 2026"
8+
.\" Please adjust this date whenever revising the manpage.
9+
.\"
10+
.\" Some roff macros, for reference:
11+
.\" .nh disable hyphenation
12+
.\" .hy enable hyphenation
13+
.\" .ad l left justify
14+
.\" .ad b justify to both left and right margins
15+
.\" .nf disable filling
16+
.\" .fi enable filling
17+
.\" .br insert line break
18+
.\" .sp <n> insert n+1 empty lines
19+
.\" for manpage-specific macros, see man(7)
20+
.SH NAME
21+
ka9q-radio \- radio spectrum server
22+
.SH SYNOPSIS
23+
.B ka9q-radio
24+
.RI [ options ] " files" ...
25+
.br
26+
.B bar
27+
.RI [ options ] " files" ...
28+
.SH DESCRIPTION
29+
This manual page documents briefly the
30+
.B ka9q-radio
31+
and
32+
.B bar
33+
commands.
34+
.PP
35+
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
36+
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
37+
.\" respectively.
38+
\fBka9q-radio\fP is a program that works magic. (to be completed)
39+
.SH OPTIONS
40+
These programs follow the usual GNU command line syntax, with long
41+
options starting with two dashes ('\-').
42+
A summary of options is included below.
43+
For a complete description, see the Info files.
44+
.TP
45+
.B \-h, \-\-help
46+
Show summary of options.
47+
.TP
48+
.B \-v, \-\-version
49+
Show version of program.
50+
.SH SEE ALSO
51+
.BR control (1),
52+
.BR monitor (1).
53+
.br
54+
The programs are documented fully by
55+
.IR "The Rise and Fall of a Fooish Bar" ,
56+
available via the Info system.

0 commit comments

Comments
 (0)
⚡