Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Man pages for offline documentation reading #5163

Closed
cuppajoe123 opened this issue Jan 2, 2022 · 2 comments
Closed

Man pages for offline documentation reading #5163

cuppajoe123 opened this issue Jan 2, 2022 · 2 comments
Assignees
Milestone

Comments

@cuppajoe123
Copy link

Hello,
As a Linux user, man pages are generally a very helpful resource for reading documentation, but I noticed that SDL2 does not have any man pages available. The package I installed came with HTML pages from the wiki, but I would prefer to be able to read the docs from the command line. Has there been any discussion on creating man pages, or is there not enough interest?

@slouken
Copy link
Collaborator

slouken commented Jan 2, 2022

We talked about it a long time ago, but there wasn't any feasible way to do this and keep the documentation up to date.

Now that the wiki is bridged to the SDL headers, this might be more feasible, but Ryan and I don't have time to do something like this. You're welcome to submit a pull request that adds this functionality if you want.

@icculus icculus self-assigned this Jan 3, 2022
@icculus icculus added this to the 2.0.20 milestone Jan 6, 2022
@icculus icculus closed this as completed in 5d3f6b0 Jan 6, 2022
@icculus
Copy link
Collaborator

icculus commented Jan 6, 2022

Okay, try this:

git clone https://github.com/libsdl-org/SDL SDL
git clone https://github.com/libsdl-org/sdlwiki sdlwiki
./SDL/build-scripts/wikiheaders.pl SDL sdlwiki --copy-to-manpages
man SDL/man/SDL_OpenAudio.3

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

No branches or pull requests

3 participants