Re: [Freedos-devel] Creating packages
Hi Robert, > Of course, all have documentation in standard man pages. ;-) That is not standard, that is Unix ;-) > AFAIK FreeDOS doesn't come with a man page reader. So what's > the best method to make documentation accessible to DOS users? We have the HTMLHELP system. You should contact Fritz Mueller to have your pages integrated into the collection. Look at the zip contents (old ones or better his variant) to get some idea about the standard style of such help pages. Basically they do look similar to MS DOS HELP but are rendered in (simple) HTML. > My idea is to put original groff files to the "doc" folder... > DJGPP's groff, strip line feeds from (to make a simple ASCII file) Sure, you can always put some nice docs into doc, but it would be okay to have the ASCII version in doc/PACKAGENAME/*.txt instead of putting it into help/PACKAGENAME.en if you ask me ;-) Eric - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
I think you have two options: 1. process the man files using roff, with output as text. I wouldn't strip linefeeds - instead, I'd convert the ^H output so that bold and underlined text appear as normal text (the FreeDOS MORE program and other DOS "pager" programs do not interpret ^H backspacing to do bold and underline.) I had once written a tool to automatically strip out backspaced characters (for example, "_^HH_^He_^Hl_^Hl_^Ho" becomes "Hello") but it's not hard to write your own. As you suggest, the output from this could go in the "DOC" folder with the other READMEs. 2. groff has an option to generate html output (not sure if djgpp's groff can do this, though.) So I suppose you could process the man files using groff's html output generator, and include those as "html Help" pages. -jh On Wed, Apr 9, 2008 at 3:32 AM, Robert Riebisch <[EMAIL PROTECTED]> wrote: > Hi! > > I'm porting some small tools to (Free)DOS using latest Open Watcom > C/C++. Of course, all have documentation in standard man pages. ;-) > AFAIK FreeDOS doesn't come with a man page reader. So what's the best > method to make documentation accessible to DOS users? > > My idea is to put original groff files to the "doc" folder (along with > other READMEs). Additionally I'd like to preprocess such files with > DJGPP's groff, strip line feeds from (to make a simple ASCII file) and > put these new files to the "help" folder. > > What do you think? > > Robert Riebisch - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
Eric Auer wrote: > > AFAIK FreeDOS doesn't come with a man page reader. So what's > > the best method to make documentation accessible to DOS users? > > We have the HTMLHELP system. You should contact Fritz Mueller Is fritz.mueller [at] mail.com still valid? > to have your pages integrated into the collection. Look at the > zip contents (old ones or better his variant) to get some idea What zip contents? > > My idea is to put original groff files to the "doc" folder... > > DJGPP's groff, strip line feeds from (to make a simple ASCII file) > > Sure, you can always put some nice docs into doc, but it would > be okay to have the ASCII version in doc/PACKAGENAME/*.txt instead > of putting it into help/PACKAGENAME.en if you ask me ;-) Reasons? What if I have more than language? "doc/PACKAGENAME/*.txt" won't work. We need more standards for FreeDOS! :-p Robert Riebisch -- BTTR Software http://www.bttr-software.de/ - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
Jim Hall wrote: > 1. process the man files using roff, with output as text. I wouldn't > strip linefeeds - instead, I'd convert the ^H output so that bold and Sorry, my mistake: I don't want to strip (CR)LF line feeds, but reverse line feeds (control characters). > underlined text appear as normal text (the FreeDOS MORE program and > other DOS "pager" programs do not interpret ^H backspacing to do bold > and underline.) I had once written a tool to automatically strip out > backspaced characters (for example, "_^HH_^He_^Hl_^Hl_^Ho" becomes > "Hello") but it's not hard to write your own. As you suggest, the > output from this could go in the "DOC" folder with the other READMEs. Sounds similar to my proposal. And there's a BSD/Linux tool for that. That's one of those things, I've already ported. ;-) But I still can't decide between DJGPP and OW. DJGPP is bloated and rigid, but has LFN support. OW is very lean and fast, but it's harder to port UNIX stuff. > 2. groff has an option to generate html output (not sure if djgpp's > groff can do this, though.) So I suppose you could process the man > files using groff's html output generator, and include those as "html > Help" pages. Please find a consensus now with Eric! :-) As I already said to Eric: We need more standards (documented)! Robert Riebisch -- BTTR Software http://www.bttr-software.de/ - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
> Is fritz.mueller [at] mail.com still valid? Yes, but why not ask off-list? > What zip contents? HTMLHELP can show HTML pages directly while they are still in a ZIP. But of course you can override by putting unzipped HTMLs on disk. > > be okay to have the ASCII version in doc/PACKAGENAME/*.txt instead > > of putting it into help/PACKAGENAME.en if you ask me ;-) > > Reasons? What if I have more than 1 language? > "doc/PACKAGENAME/*.txt" won't work. True but I doubt that you have more than 1 language. As more packages have doc/ than help/ I assume that people tend to look into doc/ first... ;-) But of course using help/PACKAGENAME.LANGUAGE is okay, too. > We need more standards for FreeDOS! :-p Well then maybe by 2012 we know what we were going to do in 2005 ;-) Eric - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
Eric Auer wrote: > > Is fritz.mueller [at] mail.com still valid? > > Yes, but why not ask off-list? In contrast to you, I don't like off-list discussions. ;-) > > What zip contents? > > HTMLHELP can show HTML pages directly while they are still in a ZIP. > But of course you can override by putting unzipped HTMLs on disk. I see, but I still don't know, which files I should look at. > > > be okay to have the ASCII version in doc/PACKAGENAME/*.txt instead > > > of putting it into help/PACKAGENAME.en if you ask me ;-) > > > > Reasons? What if I have more than 1 language? > > "doc/PACKAGENAME/*.txt" won't work. > > True but I doubt that you have more than 1 language. You're wrong. > As more packages have doc/ than help/ I assume that > people tend to look into doc/ first... ;-) But of OK, but why does help/ exist, when we have htmlhelp? > course using help/PACKAGENAME.LANGUAGE is okay, too. That doesn't answer my question about multiple languages in doc/. > > We need more standards for FreeDOS! :-p > > Well then maybe by 2012 we know what we were going to do in 2005 ;-) Nice. Then we already had FreeDOS 2.0 or 3.0 out. :-p Robert Riebisch -- BTTR Software http://www.bttr-software.de/ - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
Robert Riebisch escreveu: > >> 2. groff has an option to generate html output (not sure if djgpp's >> groff can do this, though.) So I suppose you could process the man >> files using groff's html output generator, and include those as "html >> Help" pages. > > Please find a consensus now with Eric! :-) I vote for this one... *IF* it achieves a good readability!! Alain - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
Just tested it on my Linux system (don't have FreeDOS loaded at the mo') using groff -man -Thtml .1 > .html ..then viewing with elinks (text-only web browser.) You get a table of contents at the top of the page, but the page itself is very readable. Looks great. -jh On Wed, Apr 9, 2008 at 10:55 AM, Alain M. <[EMAIL PROTECTED]> wrote: > > Robert Riebisch escreveu: > > > > >> 2. groff has an option to generate html output (not sure if djgpp's > >> groff can do this, though.) So I suppose you could process the man > >> files using groff's html output generator, and include those as "html > >> Help" pages. > > > > Please find a consensus now with Eric! :-) > > I vote for this one... *IF* it achieves a good readability!! > > Alain > - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
"Alain M." wrote: > >> 2. groff has an option to generate html output (not sure if djgpp's > >> groff can do this, though.) So I suppose you could process the man > >> files using groff's html output generator, and include those as "html > >> Help" pages. > > > > Please find a consensus now with Eric! :-) > > I vote for this one... *IF* it achieves a good readability!! Do you always have an HTML viewer handy? :-/ -- BTTR Software http://www.bttr-software.de/ - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
Robert Riebisch escreveu: > "Alain M." wrote: > 2. groff has an option to generate html output (not sure if djgpp's groff can do this, though.) So I suppose you could process the man files using groff's html output generator, and include those as "html Help" pages. >>> Please find a consensus now with Eric! :-) >> I vote for this one... *IF* it achieves a good readability!! > > Do you always have an HTML viewer handy? :-/ > Most of the tme I use DOSEMU, so I can use Firefox, but I once tested the htmlhelp for some freedos docs and it is good enough! Alain - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
"Alain M." wrote: > Most of the tme I use DOSEMU, so I can use Firefox, but I once tested > the htmlhelp for some freedos docs and it is good enough! I think, you didn't get the point: Reading even the smallest manual would always require HTMLHELP then. Yes, you could also use "type" or "more", but HTML tag can be very annoying. So I don't like the idea. Robert Riebisch -- BTTR Software http://www.bttr-software.de/ - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
Robert Riebisch escreveu: >> Most of the tme I use DOSEMU, so I can use Firefox, but I once tested >> the htmlhelp for some freedos docs and it is good enough! > > I think, you didn't get the point: Reading even the smallest manual > would always require HTMLHELP then. Yes, you could also use "type" or > "more", but HTML tag can be very annoying. So I don't like the idea. I don't understand why you disagree... Using HTMLHELP looks like the perfect solution, "some" program has allways to be used, and IMHO this is better then using a text viwer or an editor ?? NOTE: the discussion started about OpenWatcom manuals, and that is a biiig package anyway Alain - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
"Alain M." wrote: > > I think, you didn't get the point: Reading even the smallest manual > > would always require HTMLHELP then. Yes, you could also use "type" or > > "more", but HTML tag can be very annoying. So I don't like the idea. > > I don't understand why you disagree... I told you above. > Using HTMLHELP looks like the perfect solution, "some" program has Not to me. > allways to be used, and IMHO this is better then using a text viwer or > an editor I still disagree. > NOTE: the discussion started about OpenWatcom manuals, and that is a > biiig package anyway Of course, reading manuals with hundreds of pages ís no fun, if you don't have hyperlinks or bookmarks, but I was talking about two-page manuals. Robert Riebisch -- BTTR Software http://www.bttr-software.de/ - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
Re: [Freedos-devel] Creating packages
I support Alain's idea, in what regards having the HTML output forward, now that FreeDOS has an HTML reader (and does not have "standard" readers for other formats, rather than TXT). Besides, reading those HTML Help packages as text won't bother you much, they basically open the "literal text" tag, and get all of the text inside (unless the text pages have changed much lately). Aitor 2008/4/11, Alain M. <[EMAIL PROTECTED]>: > > Robert Riebisch escreveu: > >> Most of the tme I use DOSEMU, so I can use Firefox, but I once tested > >> the htmlhelp for some freedos docs and it is good enough! > > > > I think, you didn't get the point: Reading even the smallest manual > > would always require HTMLHELP then. Yes, you could also use "type" or > > "more", but HTML tag can be very annoying. So I don't like the idea. > > I don't understand why you disagree... > > Using HTMLHELP looks like the perfect solution, "some" program has > allways to be used, and IMHO this is better then using a text viwer or > an editor > > ?? > > NOTE: the discussion started about OpenWatcom manuals, and that is a > biiig package anyway > > Alain > > - > This SF.net email is sponsored by the 2008 JavaOne(SM) Conference > Don't miss this year's exciting event. There's still time to save $100. > Use priority code J8TL2D2. > http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone > ___ > Freedos-devel mailing list > Freedos-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/freedos-devel > - This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone ___ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel