ioctl manpages?

ioctl manpages?

[Darrick J. Wong]

Hi,

Just out of curiosity, how does one submit manpages for specific
ioctls?  There's a manpage for ioctl() itself, but I can't find
anything for things like, say, FIEMAP or FICLONE or FICLONERANGE.
I guess they'd be section 2, right?

Something like /usr/share/man/man2/ficlone.2.gz?  Or a separate
ioctl-ficlone.2.gz, just in case there's ever a ficlone syscall?

--Darrick

Re: ioctl manpages?

[Michael Kerrisk (man-pages)]

Hello Darrick,

On 12/15/2015 09:33 AM, Darrick J. Wong wrote:
> Hi,
> 
> Just out of curiosity, how does one submit manpages for specific
> ioctls?  There's a manpage for ioctl() itself, but I can't find
> anything for things like, say, FIEMAP or FICLONE or FICLONERANGE.
> I guess they'd be section 2, right?

Yes. (And it sure would be nice to see some of those documented.
Is this an offer? :-) )

> Something like /usr/share/man/man2/ficlone.2.gz?  Or a separate
> ioctl-ficlone.2.gz, just in case there's ever a ficlone syscall?

We already have ioctl_fat.2 and ioctl_list.2, so I'd say 
ioctl_ficlone.2 and so on.

Cheers,

Michael



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

Re: ioctl manpages?

[Darrick J. Wong]

On Tue, Dec 15, 2015 at 12:53:26PM +0100, Michael Kerrisk (man-pages) wrote:
> Hello Darrick,
> 
> On 12/15/2015 09:33 AM, Darrick J. Wong wrote:
> > Hi,
> > 
> > Just out of curiosity, how does one submit manpages for specific
> > ioctls?  There's a manpage for ioctl() itself, but I can't find
> > anything for things like, say, FIEMAP or FICLONE or FICLONERANGE.
> > I guess they'd be section 2, right?
> 
> Yes. (And it sure would be nice to see some of those documented.
> Is this an offer? :-) )

Yep.  Given that we're hoisting clone, clone-range, and (hopefully) dedupe into
the VFS, it seems like a good time to document how they work.

> > Something like /usr/share/man/man2/ficlone.2.gz?  Or a separate
> > ioctl-ficlone.2.gz, just in case there's ever a ficlone syscall?
> 
> We already have ioctl_fat.2 and ioctl_list.2, so I'd say 
> ioctl_ficlone.2 and so on.

Aha, out of date manpages git repo. :(  So there are ioctl manpages after all!

Ok, horrifying troff spaghetti will follow soon.

--D

> 
> Cheers,
> 
> Michael
> 
> 
> 
> -- 
> Michael Kerrisk
> Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
> Linux/UNIX System Programming Training: http://man7.org/training/