Skip to content

wcurl.md: markdown version of the man page#45

Merged
bagder merged 3 commits into
mainfrom
bagder/wcurl.md
Apr 16, 2025
Merged

wcurl.md: markdown version of the man page#45
bagder merged 3 commits into
mainfrom
bagder/wcurl.md

Conversation

@bagder
Copy link
Copy Markdown
Member

@bagder bagder commented Apr 15, 2025

converts to wcurl.1 with 'cd2nroff' in the curl scripts directory

This version is converted from the wcurl.1 file in git right now (using nroff2cd).

This markdown version is easier to edit and maintain than the nroff one. However, it needs to be converted into a .1 file to make it into a proper man page.

I'm interested in feedback on this.

  • Should we remove the wcurl.1 file from git? (probably, right?)
  • Should we add a makefile or something that makes the conversion or should we just document how to do it?

@Kangie
Copy link
Copy Markdown

Kangie commented Apr 16, 2025

Markdown is far easier to maintain, so this seems reasonable.

I don't see any issues removing the (always out-of-date since it's no longer the source of truth) checked-in version of the manpage - If we really want it distributed alongside the script that could be handled for "release" packaging via CI, leaving only downstreams that want to package it separately.

Since we were discussing including the script with curl releases anyway (along with the manpage, I assume), I think the number of end users impacted by this is going to be vanishingly small. LGTM!

@bagder
Copy link
Copy Markdown
Member Author

bagder commented Apr 16, 2025

Thanks!

I want this version landed so that I can use this when I import a wcurl snapshot into the curl tree (curl/curl#17035). Then the normal curl build will generate (and install) the proper man page version.

@bagder bagder merged commit da76e10 into main Apr 16, 2025
5 checks passed
@bagder bagder deleted the bagder/wcurl.md branch April 16, 2025 06:35
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