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

Create manual page #42

Merged
merged 4 commits into from
May 28, 2024
Merged

Create manual page #42

merged 4 commits into from
May 28, 2024

Conversation

polluks
Copy link
Contributor

@polluks polluks commented May 24, 2024

Requires help2man, you may adjust install.

Requires help2man, you may adjust install.
Copy link
Owner

@rricharz rricharz left a comment

Choose a reason for hiding this comment

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

I habe no experience with help2man, but as far as I understand your solution requires help2man to be installed by the end user.

Would it make sense to install help2man in make, if the command does not exist.

@polluks
Copy link
Contributor Author

polluks commented May 24, 2024

I know what you mean, but a system dependent packaging tool, like apt install help2man, should not be part of a makefile. By the way it works pretty well for tek4010.

@rricharz
Copy link
Owner

help2man has more dependencies than tek4010. tek4010 was written to limit the number of dependencies.

In my opinion the proper solution would therefore be to

  1. Add something like „make man“ to make a manual page by the maintainer after the maintainer has installed for example help2man manually. Save the man page in the repo at a suitable place.

  2. Fix the „install“ script to install the provided man page in the man database without using commands which are not installed in the standard distribution.

If you agree, please provide and test this solution. I don‘t have much time to work on tek4010 myself at the moment.

@polluks
Copy link
Contributor Author

polluks commented May 28, 2024

done

@rricharz rricharz merged commit 7f8e6ac into rricharz:master May 28, 2024
rricharz added a commit that referenced this pull request May 28, 2024
This reverts commit 7f8e6ac, reversing
changes made to eb2a37d.
@rricharz
Copy link
Owner

Unfortunately this does not work

make man fails with error in help2man

copy man page fails due to permission problem and location

@polluks
Copy link
Contributor Author

polluks commented May 28, 2024 via email

@rricharz
Copy link
Owner

rricharz commented May 28, 2024

This pull request has been closed. See issue #44 for a possible future enhancement.

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