[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Groff] The case against the case against .EX/.EE & .DS/.DE
From: |
Meg McRoberts |
Subject: |
Re: [Groff] The case against the case against .EX/.EE & .DS/.DE |
Date: |
Fri, 29 Dec 2006 12:08:12 -0800 (PST) |
Yes, this is exactly what we need! I find that most people
tend to take an existing man page to use as the basis for a
new page anyhow, often with interesting results. A template
file that is designed for this purpose would be much better,
although we may need more than one -- the structure of pages
for commands, files, and functions have significant differences.
It would also be nice to have a template for a package of man pages
to be added to the system. This is a little dicier because it is
going to be different for different platforms, but providing information
for Linux platforms would be a good start.
meg
--- M Bianchi <address@hidden> wrote:
> On Fri, Dec 29, 2006 at 10:38:39AM -0500, Larry Kollar wrote:
> > :
> > When you're writing a
> > document (like a manpage) that can be displayed in a large number of ways
> > -- text on a console, PDF/print (allowing the user to choose the point size
> > with the -S option, remember), or HTML... or DocBook via doclifter, for
> > that
> > matter -- you have to think *guidance* rather than *control* and trust your
> > tools.
> > :
>
> The best way I know to _encourage_ compliance is a template file that
> illustrates and explains the common markup/macros in situ.
>
> Copy it to glurp.1 , open glurp.1 in whatever editor you like, comment out
> the items you don't think you need (because .\" , \# and .ig are
> explained inside), change the ones you do and voila! the man page she is
> done!
>
> Maybe a man_page_template(5) ?
>
> --
> Mike Bianchi
>
>
> _______________________________________________
> Groff mailing list
> address@hidden
> http://lists.gnu.org/mailman/listinfo/groff
>