Skip to content

Added a simple manpage#3674

Merged
ten9876 merged 1 commit into
aethersdr:mainfrom
dawkagaming:manpage
Jun 20, 2026
Merged

Added a simple manpage#3674
ten9876 merged 1 commit into
aethersdr:mainfrom
dawkagaming:manpage

Conversation

@dawkagaming

Copy link
Copy Markdown
Contributor

Hello,

I added a simple manual page for AetherSDR.

Of course, it is only for the sake of standards, but I think it is not a problem to add it 😄

I also tried to a add proper CMake install rule, but I am not sure if it is good.

Thanks
Dawid Kulas
SP9SKA

@dawkagaming dawkagaming requested review from a team as code owners June 19, 2026 23:39
@dawkagaming dawkagaming force-pushed the manpage branch 2 times, most recently from 2df687b to 3bf731a Compare June 19, 2026 23:52

@aethersdr-agent aethersdr-agent Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, Dawid — a man page is a nice standards touch, and the install rule slots cleanly into the existing non-Apple install() block. CI is green across the board (build, macOS, Windows, CodeQL, accessibility), so the configure-time gzip and ${CMAKE_INSTALL_MANDIR}/man1 install resolve correctly. 73 SP9SKA 👍

A few optional, non-blocking suggestions:

1. Consider installing the page uncompressed. file(ARCHIVE_CREATE ...) runs at configure time, so edits to aethersdr.1 won't be re-gzipped until CMake reconfigures (there's no build-time dependency on the source). man reads uncompressed pages fine, and distro packaging helpers (Debian's dh_installman, etc.) prefer to handle compression themselves — a pre-gzipped page can even conflict with them. Installing the raw file is simpler and avoids both issues:

install(FILES packaging/linux/aethersdr.1
    DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
)

2. Leading whitespace in the DESCRIPTION. The .SH DESCRIPTION lines start with a space ( AetherSDR brings...). In roff a line beginning with whitespace forces a break and preserves the indent, which can render the paragraph a little oddly. Dropping the leading spaces lets it fill normally.

3. Empty .TH date field. The date field in .TH AETHERSDR "1" " " ... is blank — minor, but a date or version string there is the usual convention.

None of these block merge — the page is functional as-is. Nice contribution.


🤖 aethersdr-agent · cost: $2.3319 · model: claude-opus-4-8

@ten9876 ten9876 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving. Rebased onto main (resolving the CMakeLists conflict with #3673 — both the metainfo and man-page installs now coexist), and tidied the man page: stripped the leading-space lines (DESCRIPTION now fills correctly), added a real .TH date + proper "User Commands" manual title, and a SEE ALSO. Switched the install to ship the man page uncompressed so distro packaging can compress per its own policy. Renders clean under groff with no warnings. Thanks @dawkagaming — 73 SP9SKA.

@ten9876 ten9876 enabled auto-merge (squash) June 20, 2026 03:11
@ten9876 ten9876 merged commit 0553f71 into aethersdr:main Jun 20, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants