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

SYNOPSIS format in man-page is not unified #194

Open
miztake opened this issue Apr 25, 2021 · 1 comment
Open

SYNOPSIS format in man-page is not unified #194

miztake opened this issue Apr 25, 2021 · 1 comment

Comments

@miztake
Copy link
Contributor

miztake commented Apr 25, 2021

The SYNOPSIS format is different for each man-page.
The following patterns can be seen.

pattern 1:
Header file is bold.
Function prototype is not bold.
e.g.: audit_open(3)

pattern 2:
Header file is not bold.
Function prototype is only function name bold.
e.g.: set_aumessage_mode(3)

pattern 3:
Both header files and function prototypes are bold.
e.g.: audit_log_semanage_message(3)

Other patterns also exist.

The inconsistent format does not cause bugs.
Therefore, I don't consider it a serious issue.
However, readability is higher when the format is unified.

For example, glibc seems to have the following format.

Header file is bold.
Function prototype is bold, but its argument is not bold, it is underlined.
The arguments in DESCRIPTION are also underlined

@stevegrubb
Copy link
Member

This is true. They have been modified many times by other people adding italics, bold, and various other formatting.

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

2 participants