usql Add basic manual page

Create a minimal manual page for Linux/Unix systems. Also improve the README to be explicit about increasingly more popular MySQL alternatives MariaDB and TiDB.

Apr 12 '25 08:04 ottok

While I understand the need, I'm a bit worried about the maintenance that this man file would require.

I would like to see the generation of this file being added to the Makefile or the CI

Apr 12 '25 10:04 ccoVeille

I did the initial version with help2man, but it isn't complete enough. Thus this man page cannot be generated automatically right now.

If you later decide to expand the output of usql --help to generate a full man page worth of contents, feel free to copy code from https://salsa.debian.org/debian/debcraft/-/blob/main/Makefile?ref_type=heads#L28-40 to automate the man page maintenance.

Apr 12 '25 10:04 ottok

I'm a simple reviewer here. A random Gopher, using the tool. I shared my concern, your reply is clear and documented. I like that.

Let's wait for a maintainer feedbacks.

Apr 12 '25 13:04 ccoVeille

This man page is planned to be included in upcoming Debian package of usql. Debian packaging draft visible at https://salsa.debian.org/go-team/packages/usql/-/merge_requests/1

Apr 12 '25 14:04 ottok

I assumed it was the reason behind this need 👍

Apr 12 '25 14:04 ccoVeille

@ottok appreciate the work, thanks. Please be aware that it's the release-19 branch that releases are currently being cut from. I'll review and merge, assuming everything is OK.

Apr 12 '25 23:04 kenshaw

@ottok appreciate the work, thanks. Please be aware that it's the release-19 branch that releases are currently being cut from. I'll review and merge, assuming everything is OK.

The PR targets the default branch in this repository. I am happy to change target branch, rebase and polish as many time as needed once you have feedback.

Apr 13 '25 08:04 ottok

@ottok no need to retarget. I was just mentioning the branch as you mentioned you were rolling this into a Debian release.

Apr 13 '25 11:04 kenshaw