Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 426634 - sys-apps/file: magic man page might be better in section 5 than section 4
Summary: sys-apps/file: magic man page might be better in section 5 than section 4
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: [OLD] Core system (show other bugs)
Hardware: All Linux
: Normal minor (vote)
Assignee: Gentoo's Team for Core System packages
URL: http://mx.gw.com/pipermail/file/2016/...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-07-14 19:58 UTC by Jonathan Callen (RETIRED)
Modified: 2016-05-13 19:12 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jonathan Callen (RETIRED) gentoo-dev 2012-07-14 19:58:34 UTC
sys-apps/file-5.11 installs the man page for magic as magic(4) instead of magic(5).  As this page describes a configuration file, it should be installed in section 5 (as a comment in the file itself indicates).  Upstream allows us to control this via a --enable-fsect-man5 flag to configure.
Comment 1 SpanKY gentoo-dev 2012-07-20 21:08:51 UTC
i think section 4 is appropriate.  it's describing the magic file format -- that's not really a "configuration file", it's a "special database type file".
Comment 2 Jonathan Callen (RETIRED) gentoo-dev 2012-07-20 21:36:14 UTC
What it isn't is a "device node", which is what section 4 is for.

Some excepts from intro(4) and intro(5):

intro(4):
    DESCRIPTION
       Section 4 of the manual describes special files (devices).

    FILES
       /dev/* -- device files

intro(5):
    DESCRIPTION
        Section 5 of the manual describes various file formats and protocols,
        and the corresponding C structures, if any.



To me, this reads as magic(?), describing a file format, would be in section 5, not section 4.
Comment 3 SpanKY gentoo-dev 2016-05-13 18:59:28 UTC
(In reply to Jonathan Callen from comment #2)

that depends on the system.  section 4 is not well standardized.

https://docs.oracle.com/cd/E53394_01/html/E54775/index.html
Comment 4 SpanKY gentoo-dev 2016-05-13 19:12:41 UTC
`man man` also says:
  4    Special files (usually found in /dev)

so while section 4 isn't wrong for this, other distros have moved to section 5, and it's also not wrong for it.  so i've added the configure flag upstream provides to the 5.27 version.

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=44b276923b08eaa58ae67154ceb22654ab4e16a7