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 page extension is incorrect (Origin: bugzilla #730418) #5483

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status VERIFIED severity major in component general for ---
Reported in version 1.8.6 on platform Other
Assigned to: Dimitri van Heesch

On 2014-05-20 05:59:35 +0000, Olli Vanhoja wrote:

If I change MAN_EXTENSION to something else than .3 the extension is appended to the string ".3" instead of replacing the default extension.

For example I wanted to generate man pages with extension .9 and wrote MAN_EXTENSION = .9 to the doxyfile. Now instead of man9 directory and *.9 files I have a directory called man39 and bunch of man pages named *.39.

On 2014-05-20 19:11:48 +0000, albert wrote:

I've just send a proposed patch to github (pull request 173)

On 2014-05-22 07:01:48 +0000, Olli Vanhoja wrote:

I'm not expert on this subject but it seems to me that at least GNU man doesn't understand section names with more than one letter. So based on that I don't think it's good idea to ever append anything after '3' or any other number, unless there is some special use for it in Doxygen?

Another thing is that section names like 'n', 'x' and 'p' seems to be quite usual, even not mentioned in the POSIX standard afaik. So those could be allowed too if not already allowed.

On 2014-05-22 17:15:17 +0000, albert wrote:

Can you give a link to the the Posix standard where the man extension is described?

On 2014-05-22 18:57:08 +0000, Olli Vanhoja wrote:

Hmmh... seems that POSIX doesn't speak much about how man pages should be stored or sectioned. Wikipedia however mentions some common sections available in different systems: http://en.wikipedia.org/wiki/Man_page#Manual_sections
Interestingly there is actually section called '1M' in System V, so possibly some systems may then have a support for arbitrarily named sections.

So this is the only specification about behavior of map pages I could locate:
http://pubs.opengroup.org/onlinepubs/9699919799/utilities/man.html
"no attempt is made to specify naming conventions for reference page files, nor even to mandate that they are files at all"

On 2014-08-21 17:15:45 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.8. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant (preferrably in the form of a self-contained example).

@doxygen doxygen closed this Jul 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment