Re: [RFC] Requirements for man page generation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Markus,

Em Fri, 15 Jul 2016 19:39:34 +0200
Markus Heiser <markus.heiser@xxxxxxxxxxx> escreveu:

> >>> 	$ man ./foo
> >>> 
> >>> ┌─────┬────────┐
> >>> │0000 │ foobar │
> >>> ├─────┼────────┤
> >>> │1111 │        │
> >>> │2222 │        │
> >>> ├─────┤        │
> >>> │   r │ foo    │
> >>> ├─────┼────────┤
> >>> │3333 │        │
> >>> │4444 │    bar │
> >>> └─────┴────────┘
> >>> 
> >>> Yet, I'm not sure how portable is to use such preprocessor.    
> >> 
> >> About portability, the tbl man page says:
> >> 
> >>  The output generated by GNU tbl cannot
> >>  be processed with Unix troff; it must be
> >>  processed with GNU troff.  
> > 
> > Yes, I know, but I suspect that the original Unix troff has
> > long gone on Linux distributions.  
> 
> unanimous ..  this is what I wanted to express ;-)

Btw, just found one man page using tables on my system: memset(3).
	man-pages-4.06-2.fc24.noarch
	http://man7.org/linux/man-pages/man3/memset.3.html

That's the table on it:

       ┌──────────┬───────────────┬─────────┐
       │Interface │ Attribute     │ Value   │
       ├──────────┼───────────────┼─────────┤
       │memset()  │ Thread safety │ MT-Safe │
       └──────────┴───────────────┴─────────┘


.TS
allbox;
lb lb lb
l l l.
Interface       Attribute       Value
T{
.BR memset ()
T}      Thread safety   MT-Safe
.TE

Other manpages for functions at string.h also use tables:
	http://man7.org/linux/man-pages/man3/strcpy.3.html

So, it seems OK to use tables on our manpages too.

-- 
Thanks,
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux