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

Add manpage #211

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add manpage #211

wants to merge 1 commit into from

Conversation

mariogrip
Copy link
Contributor

This adds a manpage for btop

This is still WIP as it's still missing to be included in makefiles and is still missing some things like configuration file and keyboard navigation/bindings. but i put it up here for early review.

@mariogrip mariogrip mentioned this pull request Dec 13, 2021
@heitorPB
Copy link

Have you considered writing this as a Markdown/restructuredText and using something like Pandoc to generate the man page file? This might be easier to main and integrate in the long term.

@mariogrip
Copy link
Contributor Author

Have you considered writing this as a Markdown/restructuredText and using something like Pandoc to generate the man page file? This might be easier to main and integrate in the long term.

This would be a better idea indeed, there is also help2doc that creates it based on the --help output. but i went with this for the initial debian pkg.

@aristocratos
Copy link
Owner

@mariogrip
Great initiative and a good start!

@FYHenry
Copy link

FYHenry commented May 7, 2023

Intergrate the manpage

For a better integration many lines can be appended in the Makefile file.

End of the install rule :

  @printf "\033[1;92mInstalling manpage to: \033[1;97m$(DESTDIR)$(PREFIX)/share/man/man1/btop.1\033[0m\n"
  @mkdir -p $(DESTDIR)$(PREFIX)/share/man/man1/
  @cp -p man/btop.1 $(DESTDIR)$(PREFIX)/share/man/man1/btop.1

End of the uninstall rule :

  @printf "\033[1;91mRemoving: \033[1;97m$(DESTDIR)$(PREFIX)/share/man/man1/btop.1\033[0m\n"
  @rm -rf $(DESTDIR)$(PREFIX)/share/man/man1/btop.1

In this example the man/btop.1 file needs to be added in the repository.
After the user can type man btop.

@ottok
Copy link
Contributor

ottok commented Jan 18, 2024

I just submitted #724 which is slightly more complete than this draft, and it has the man page source in Markdown so that it is easier for people to read it directly on GitHub (or GitLab or even in plain text) and then it compiles to troff using a widely available lightweight tool called lowdown.

@ottok
Copy link
Contributor

ottok commented Mar 5, 2024

Hi @mariogrip! Note that c767099 got merged now. Would you like to rebase your work and help improve/polish the manpage.md file?

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.

5 participants