Re: [Groff] Avoiding the pod2man mistake

2006-12-29 Thread Eric S. Raymond
Werner LEMBERG <[EMAIL PROTECTED]>: > Hmm. What do you mean with `man package'? AFAIK, it's the job of the > man formatter (this is, groff) to provide the macros to format a man > page. I'm not aware of any other, non-roff package which contains an > equivalent to `an-old.tmac' (which is loaded

Re: [Groff] Avoiding the pod2man mistake

2006-12-29 Thread Werner LEMBERG
> > BTW, I see a major obstacle to extend man as you suggest: groff > > isn't always installed with its latest version. I can imagine to > > add an update to the 1.18 series which comes with the man > > extensions, but many, many platforms won't have this. So maybe > > the current way is to reall

Re: [Groff] Avoiding the pod2man mistake

2006-12-29 Thread Eric S. Raymond
Werner LEMBERG <[EMAIL PROTECTED]>: > BTW, I see a major obstacle to extend man as you suggest: groff isn't > always installed with its latest version. I can imagine to add an > update to the 1.18 series which comes with the man extensions, but > many, many platforms won't have this. So maybe the

Re: [Groff] Avoiding the pod2man mistake

2006-12-29 Thread Werner LEMBERG
> If we're going to extend man, we should do it properly, with the new > definitions in the man package itself. I don't object basically. However... > Werner, I know it looks like an easy compromise, a soft option. But > don't go there. *Bad* idea... :-) I will provide macro definitions (for

[Groff] Re: Avoiding the pod2man mistake

2006-12-29 Thread Eric S. Raymond
Ralph Corderoy <[EMAIL PROTECTED]>: > Man pages work across Unix, they're not Free Software OS only. The > solution needs to work across Unix where -man hasn't changed in years > and won't. And this is why proprietary Unix is dying, and I'm encouraging it to die faster. -- http

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Eric S. Raymond
D. E. Evans <[EMAIL PROTECTED]>: > P.S. I know that Eric is shooting for something more dynamic, but > does this have to be made anymore complicated than a better export > facility for groff (improvements or replace for grohtml that is > both standardized for HTML, and perhaps has an XSLT function

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread D. E. Evans
We definitely need a good guide for writing man pages, based on our discussion -- something like a man-to-html.howto. This guide should contain (as an appendix) those macro definitions which a man writer can then simply copy and paste. I agree. Ironically, what we have is currently i

Re: [Groff] Mom/Mac OSX strangeness

2006-12-29 Thread Peter Schaffter
On Fri, Dec 29, 2006, Larry Kollar wrote: > > In the 1.5 version of the mom macros, I added some definitions to > > facilitate the drawing of common graphical objects (rules, boxes, > > ellipses). All of them use the \D escape. > > > > ... Recently, a user wrote me saying the macros *don't* work

Re: [Groff] Mom/Mac OSX strangeness

2006-12-29 Thread Larry Kollar
> In the 1.5 version of the mom macros, I added some definitions to > facilitate the drawing of common graphical objects (rules, boxes, > ellipses). All of them use the \D escape. > > ... Recently, a user wrote me saying the macros *don't* work on his Mac > box (OSX) with groff 1.19.1. That's b

Re: Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Clarke Echols
I wrote a template for how to write man pages back about 1989 or 1990 for use inside of HP. I think the file name was how_to_write_manpages.1 and the title line was .TH how_to_write_manpages(1) or something very similar. It was a template that had the coding and explained what to do where and ho

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Meg McRoberts
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 pa

[Groff] Mom/Mac OSX strangeness

2006-12-29 Thread Peter Schaffter
In the 1.5 version of the mom macros, I added some definitions to facilitate the drawing of common graphical objects (rules, boxes, ellipses). All of them use the \D escape. The macros work fine with groff 1.19.2 (from the repository) on boxes running GNU/Linux. Recently, a user wrote me saying

Re: Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread M Bianchi
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

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Ralph Corderoy
Hi Mike, > > http://home.alltel.net/kollar/groff/effman.tar.gz > > The gzipped tarfile isn't found. There's http://home.alltel.net/kollar/groff/effman.html Perhaps that's it. Cheers, Ralph. ___ Groff mailing list Groff@gnu.org http://lists

[Groff] Re: Avoiding the pod2man mistake

2006-12-29 Thread Ralph Corderoy
Hi Eric, > Ralph Corderoy <[EMAIL PROTECTED]>: > > It seems modern-day perl(1) still does that to an extent, e.g. .Vb > > and .Ve for verbatim text and lots of strings for accents, etc. > > Perhaps groff's guide to writing a man page should stick to > > `standard' macros in -man and provide a sui

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread mhobgood
Larry, The gzipped tarfile isn't found. Cordially, Mike Hobgood On Dec 29, 2006, at 9:38 AM, Larry Kollar wrote: http://home.alltel.net/kollar/groff/effman.tar.gz ___ Groff mailing list Groff@gnu.org http://lists.gnu.org/mailman/listinfo/g

Re: [Groff] Semantic tagging and accessibility

2006-12-29 Thread Eric S. Raymond
Susan Jolly <[EMAIL PROTECTED]>: > Here's just one small example where DocBook scale semantic tagging makes a > difference to English braille in a way that might be unexpected to someone > unfamiliar with braille rules. Braille is to some extent a shorthand and > uses each of the letters to repres

[Groff] Avoiding the pod2man mistake

2006-12-29 Thread Eric S. Raymond
Ralph Corderoy <[EMAIL PROTECTED]>: > It seems modern-day perl(1) still does that to an extent, e.g. .Vb and > .Ve for verbatim text and lots of strings for accents, etc. Perhaps > groff's guide to writing a man page should stick to `standard' macros in > -man and provide a suitably licensed heade

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Ralph Corderoy
Hi Gunnar, > > > > We definitely need a good guide for writing man pages, based on > > > > our discussion -- something like a man-to-html.howto. This > > > > guide should contain (as an appendix) those macro definitions > > > > which a man writer can then simply copy and paste. Agreed. I've be

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Gunnar Ritter
Werner LEMBERG <[EMAIL PROTECTED]> wrote: > > > We definitely need a good guide for writing man pages, based on > > > our discussion -- something like a man-to-html.howto. This guide > > > should contain (as an appendix) those macro definitions which a > > > man writer can then simply copy and pa

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Larry Kollar
> We definitely need a good guide for writing man pages, based on our > discussion -- something like a man-to-html.howto. This guide should > contain (as an appendix) those macro definitions which a man writer > can then simply copy and paste. That was one of the thrusts of my "Writing Effective

[Groff] Semantic tagging and accessibility

2006-12-29 Thread Susan Jolly
I've been following this discussion with great interest. I'm involved in the Braille-in-DAISY project which is looking to enhance DtBook (which is to some extent a variant of DocBook) with the additional tags necessary to make possible the first fully automatic transcription to braille. I'd like

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Gunnar Ritter
Werner LEMBERG <[EMAIL PROTECTED]> wrote: > http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html > > However, those rules are not really helpful IMHO in our discussion how > such macros should look like. It gives an overview about the types of arguments that need to be handled

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Werner LEMBERG
> > We definitely need a good guide for writing man pages, based on > > our discussion -- something like a man-to-html.howto. This guide > > should contain (as an appendix) those macro definitions which a > > man writer can then simply copy and paste. > > How about creating a SourceForge project

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Werner LEMBERG
> > I tend to advocate the use of .DS/.DE, .TQ, .EX/.EE, .SY, .OP, and > > probably other nifty things to be used within man pages, > > *together* with its macro definitions in the preamble. This gives > > us both a decent markup and backwards compatibility. > > This is certainly an acceptable p

Re: [Groff] Re: Simplifying groff documentation

2006-12-29 Thread Ralph Corderoy
Hi Gunnar, > To avoid misunderstandings, I repeat that the situation is completely > different for other troff-related aspects. We certainly do not need to > care whether arbitrary documents compile with AIX troff. But nroff > -man is a special case. I think that's a good point as someone who ha

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Gunnar Ritter
Werner LEMBERG <[EMAIL PROTECTED]> wrote: > We definitely need a good guide for writing man pages, based on our > discussion -- something like a man-to-html.howto. This guide should > contain (as an appendix) those macro definitions which a man writer > can then simply copy and paste. How about

Re: [Groff] Re: Simplifying groff documentation

2006-12-29 Thread Gunnar Ritter
Meg McRoberts <[EMAIL PROTECTED]> wrote: > I'm not sure of the solution but it seems that, if they could write in > docbook, this opens the option of using an XML WYSIWYG editor if necessary. Tools for conversion from DocBook to man are readily available. Gunnar ___

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Gunnar Ritter
Werner LEMBERG <[EMAIL PROTECTED]> wrote: > I tend to advocate the use of .DS/.DE, .TQ, .EX/.EE, .SY, .OP, and > probably other nifty things to be used within man pages, *together* > with its macro definitions in the preamble. This gives us both a > decent markup and backwards compatibility. Thi

Re: [Groff] Re: Simplifying groff documentation

2006-12-29 Thread Meg McRoberts
Trust me, I'm no fan of WYSIWYG tools! But while I would rather write in raw *roff, I have to face the reality that it's not easy to convince the "youngsters" that it's worth the effort to learn it. The nice thing about DocBook is that it's possible for me to work in text format and other people

Re: [Groff] Re: Simplifying groff documentation

2006-12-29 Thread Eric S. Raymond
Zvezdan Petkovic <[EMAIL PROTECTED]>: > What I was more concerned with is general writing. > Does an author of the book need to bother with semantic tagging on a > scale that DocBook _requires_? Personally, I like the kind of capabilities it gives me. Moving the Jargon File from Texinfo to Doc

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Eric S. Raymond
Werner LEMBERG <[EMAIL PROTECTED]>: > > .TP++ or .TQ > > > > Looks like a normal paragraph break, but continues a .TP list. > > Generally people just use .sp for this, which is why .sp may be > > the only low-level request that's truly essential for man pages. > > How shall .sp replace .TQ in thi

Re: [Groff] Re: Simplifying groff documentation

2006-12-29 Thread Eric S. Raymond
Zvezdan Petkovic <[EMAIL PROTECTED]>: > On Thu, Dec 28, 2006 at 08:51:37PM -0800, Meg McRoberts wrote: > > I'm not sure of the solution but it seems that, if they could write in > > docbook, this opens the option of using an XML WYSIWYG editor if > > necessary. > > Which does not make the writing

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Werner LEMBERG
> > If doclifter handles all these cases as well as you already > > described there is no need for an exception to man format. > > It's going to be Werner's decision, ultimately. I tend to advocate the use of .DS/.DE, .TQ, .EX/.EE, .SY, .OP, and probably other nifty things to be used within man p

Re: [Groff] The case against the case against .EX/.EE & .DS/.DE

2006-12-29 Thread Werner LEMBERG
> .TP++ or .TQ > > Looks like a normal paragraph break, but continues a .TP list. > Generally people just use .sp for this, which is why .sp may be > the only low-level request that's truly essential for man pages. How shall .sp replace .TQ in this particular case? Please give an example for thi