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

Full stops in first column need to be escaped in man page output (Origin: bugzilla #652277) #4294

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.7.4 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2011-06-10 11:33:25 +0000, Mattias Ellert wrote:

The following mark up:

/**
@page installation How to install
@brief This section describes the installation process

To intall the software do

@code
tar -zxf code-1.0.tar.gz
cd code-1.0
autoreconf -f
./configure
make
make install
@Endcode
*/

generates a man page that when view with man looks like:

NAME
installation - How to install This section describes the installation
process

   To intall the software do

   tar -zxf code-1.0.tar.gz
   cd code-1.0
   autoreconf -f
   make
   make install

As can be seen the line "./configure" is not displayed. The line is present in the generated man page, but man uses periods in the first column to indicate a macro - so man treats the line as on undefined macro and displays nothing.

PS. Should really both the page title and the brief description be displayed on the first line to the right of the hyphen? It think this looks odd.

On 2011-07-18 20:39:18 +0000, Bas Wijnen wrote:

Debian's lintian says about this:

N: This test uses man's --warnings option to enable groff warnings that
N: catch common mistakes, such as putting . or ' characters at the start of
N: a line when they are intended as literal text rather than groff
N: commands. This can be fixed either by reformatting the paragraph so that
N: these characters are not at the start of a line, or by adding a
N: zero-width space (&) immediately before them.

On 2011-08-10 12:22:00 +0000, Dimitri van Heesch wrote:

(In reply to comment # 1)

Debian's lintian says about this:

N: This test uses man's --warnings option to enable groff warnings that
N: catch common mistakes, such as putting . or ' characters at the start of
N: a line when they are intended as literal text rather than groff
N: commands. This can be fixed either by reformatting the paragraph so that
N: these characters are not at the start of a line, or by adding a
N: zero-width space (&) immediately before them.

Thanks for the tip. This works fine.

On 2011-08-14 14:04:51 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.5. 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.

On 2011-08-27 12:23:07 +0000, albert wrote:

Created attachment 194917
Remove single quote in output when writing a dot

I get the impression that the ' (single quote) should not be in the filter subroutine in mandocvisitor.cpp

On 2011-08-27 13:43:07 +0000, Dimitri van Heesch wrote:

Indeed. I'll take over the patch.

On 2011-09-19 19:41:15 +0000, Howard Chu wrote:

Ah sorry, I just submitted this same patch in Bug# 659514

On 2011-12-03 18:22:50 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.6. 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.

@doxygen doxygen closed this Jul 2, 2018

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