[Mono-docs-list] Man page support and Linking

Miguel de Icaza miguel@ximian.com
Tue, 26 Oct 2004 12:01:01 -0400


> However, as much of Mono.Posix is just a wrapping over existing
> functions, most of which already have their own man pages, I see little
> point in duplicating all of this documentation.  Thus, two questions:

I still believe that we should put the documentation in place for the
specific routines, we should not assume that the user knows what a
syscall/method name maps to.

> 1.  Does monodoc support man pages yet?  If not, when will it?

We have a hack today that converts some of the man pages from Mono into
a xhtml file that we include in the handbook.

Linking across providers currently does not work, this must be looked
into (there is a bug report on this I believe).

> 2.  Is it/will it be possible to link between the different sets of
> providers?  For example, the initial Mono.Posix documentation will be in
> the ECMA format, and I'd like (e.g.) Mono.Posix.Syscall.read() to be a
> hyperlink to the read(2) man page.

I still think we should maintain our documentation, a copy/paste job
might be all that we need.