Re: man page formatting
On Sat, Jul 21, 2001 at 07:48:17PM +, Mikhael Goikhman wrote: On 21 Jul 2001 19:26:09 +0200, Dominik Vogt wrote: The recent fixes in the man page for Solaris etc. (\f...) broke the bold typeface of the reformatted sections. For example: .TP .BI Menu menu-name [ position ] [ double-click-action ] was changed to .IP Menu \fImenu-name\fP [ \fIposition\fP ] [ \fIdouble-click-action\fP ] The Menu, [ and ] parts of the old version are bold while they are not in the new one. Of course this can be fixed by adding more \fB...\fP pairs, but I'd *really* prefer to find a way to do that without \f... Isn't there a way to split the .BI lines into several? Any ideas are welcome. I suggest the following style for all commands: .B Menu .I menu-name .BI[ position ] .BI[ double-click-action ] .B Popup .I popup-name .BI [ position ] .BI [ default-action ] I.e. use .B for command, .I for mandatory parameters, .BI for optional. I also think, the spaces in braces are not really needed: .BI [ position ] Looks good to me. The only thing I don't get working is the indentation of the text paragraphs: .TP .B Menu .I menu-name .BI[ position ] bla blub results in Menu menu-name [ position ] bla blub and .TP .B Menu .I menu-name .BI[ position ] bla blub gives me Menu menu-name [ position ] bla blub bla blub but we want Menu menu-name [ position ] bla blub bla blub This syntax is more readable in my opinion. I may do all these changes. Bye Dominik ^_^ ^_^ -- I.e. use .B for command, .I for mandatory parameters, .BI for optional. I also think, the spaces in braces are not really needed: .BI [ position ] Looks good to me. The only thing I don't get working is the indentation of the text paragraphs: .TP .B Menu . This syntax is more readable in my opinion. I may do all these changes. Regards, . This syntax is more readable in my opinion. I may do all these changes. Regards, Mikhael. -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED] Bye Dominik ^_^ ^_^ -- Dominik Vogt, [EMAIL PROTECTED] Reply-To: [EMAIL PROTECTED] -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
Re: man page formatting (Hey, I remember this)
Dominik Vogt [EMAIL PROTECTED] writes: On Sat, Jul 21, 2001 at 07:48:17PM +, Mikhael Goikhman wrote: On 21 Jul 2001 19:26:09 +0200, Dominik Vogt wrote: Looks like somebody unplugged a clogged mail server. -- Dan Espen 444 Hoes Lane Room RRC 1C-214 E-mail: [EMAIL PROTECTED] Piscataway, NJ 08854 Phone: (732) 699-5570 -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
Re: man page formatting
[Sorry to quote it all, not everyone keeps July threads.] On 10 Jul 2001 18:57:07 +0200, Dominik Vogt wrote: On Sat, Jul 21, 2001 at 07:48:17PM +, Mikhael Goikhman wrote: On 21 Jul 2001 19:26:09 +0200, Dominik Vogt wrote: The recent fixes in the man page for Solaris etc. (\f...) broke the bold typeface of the reformatted sections. For example: .TP .BI Menu menu-name [ position ] [ double-click-action ] was changed to .IP Menu \fImenu-name\fP [ \fIposition\fP ] [ \fIdouble-click-action\fP ] The Menu, [ and ] parts of the old version are bold while they are not in the new one. Of course this can be fixed by adding more \fB...\fP pairs, but I'd *really* prefer to find a way to do that without \f... Isn't there a way to split the .BI lines into several? Any ideas are welcome. I suggest the following style for all commands: .B Menu .I menu-name .BI[ position ] .BI[ double-click-action ] .B Popup .I popup-name .BI [ position ] .BI [ default-action ] I.e. use .B for command, .I for mandatory parameters, .BI for optional. I also think, the spaces in braces are not really needed: .BI [ position ] Looks good to me. The only thing I don't get working is the indentation of the text paragraphs: .TP .B Menu .I menu-name .BI[ position ] bla blub results in Menu menu-name [ position ] bla blub and .TP .B Menu .I menu-name .BI[ position ] bla blub gives me Menu menu-name [ position ] bla blub bla blub but we want Menu menu-name [ position ] bla blub bla blub My own conclusion in July was we should write our own macro instead of .TP, but looking at /usr/lib/groff/tmac/tmac.an where .de TP is defined gave me headache. This is learnable for sure, but may be someone else is already familar with this hieroglyphic language? And I am still sure we don't need spaces (remember, braces are in bold or even in different color), i.e. I prefer this bold-inverse output: Menu menu-name [position] [double-click-action] bla blub Regards, Mikhael. -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
Re: man page formatting
Dan Espen [EMAIL PROTECTED] writes: Dominik Vogt [EMAIL PROTECTED] writes: On Sat, Jul 21, 2001 at 07:48:17PM +, Mikhael Goikhman wrote: On 21 Jul 2001 19:26:09 +0200, Dominik Vogt wrote: The recent fixes in the man page for Solaris etc. (\f...) broke the bold typeface of the reformatted sections. For example: .TP .BI Menu menu-name [ position ] [ double-click-action ] was changed to .IP Menu \fImenu-name\fP [ \fIposition\fP ] [ \fIdouble-click-action I meant to mark them as bold, oh, I see, the first 2 that I did I copied verbatim from the 2.2.x version of the manual. ... I tried using multiple .BI commands but the text ran into the paragraph. I wonder if the .BI command used in Linux would work with the vendors nroff/troff, perhaps all we need to do is copy the .BI macro into the file(s) we need it in. Maybe I'll have some time to check later... It looks to me like the Linux .BI command is dependent on groff's .while command which doesn't appear to available on Solaris. -- Dan Espen 444 Hoes Lane Room RRC 1C-214 E-mail: [EMAIL PROTECTED] Piscataway, NJ 08854 Phone: (732) 699-5570 -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
Re: man page formatting
On Sun, Jul 22, 2001 at 10:48:41AM -0400, Dan Espen wrote: Dan Espen [EMAIL PROTECTED] writes: Dominik Vogt [EMAIL PROTECTED] writes: On Sat, Jul 21, 2001 at 07:48:17PM +, Mikhael Goikhman wrote: On 21 Jul 2001 19:26:09 +0200, Dominik Vogt wrote: The recent fixes in the man page for Solaris etc. (\f...) broke the bold typeface of the reformatted sections. For example: .TP .BI Menu menu-name [ position ] [ double-click-action ] was changed to .IP Menu \fImenu-name\fP [ \fIposition\fP ] [ \fIdouble-click-action I meant to mark them as bold, oh, I see, the first 2 that I did I copied verbatim from the 2.2.x version of the manual. ... I tried using multiple .BI commands but the text ran into the paragraph. I wonder if the .BI command used in Linux would work with the vendors nroff/troff, perhaps all we need to do is copy the .BI macro into the file(s) we need it in. Maybe I'll have some time to check later... It looks to me like the Linux .BI command is dependent on groff's .while command which doesn't appear to available on Solaris. And what about macros like .BR or .IR? Do they suffer from the same problem? Bye Dominik ^_^ ^_^ -- Dominik Vogt, [EMAIL PROTECTED] Reply-To: [EMAIL PROTECTED] -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
Re: man page formatting
Dominik Vogt [EMAIL PROTECTED] writes: On Sun, Jul 22, 2001 at 10:48:41AM -0400, Dan Espen wrote: Dan Espen [EMAIL PROTECTED] writes: Dominik Vogt [EMAIL PROTECTED] writes: On Sat, Jul 21, 2001 at 07:48:17PM +, Mikhael Goikhman wrote: On 21 Jul 2001 19:26:09 +0200, Dominik Vogt wrote: The recent fixes in the man page for Solaris etc. (\f...) broke the bold typeface of the reformatted sections. For example: .TP .BI Menu menu-name [ position ] [ double-click-action was changed to .IP Menu \fImenu-name\fP [ \fIposition\fP ] [ \fIdouble-click-ac I meant to mark them as bold, oh, I see, the first 2 that I did I copied verbatim from the 2.2.x version of the manual. ... I tried using multiple .BI commands but the text ran into the paragraph. I wonder if the .BI command used in Linux would work with the vendors nroff/troff, perhaps all we need to do is copy the .BI macro into the file(s) we need it in. Maybe I'll have some time to check later... It looks to me like the Linux .BI command is dependent on groff's .while command which doesn't appear to available on Solaris. And what about macros like .BR or .IR? Do they suffer from the same problem? Yes they do, but I didn't see any instances of those macros with more than 6 arguments. The only man page I've looked at so far is the fvwm man page. -- Dan Espen 444 Hoes Lane Room RRC 1C-214 E-mail: [EMAIL PROTECTED] Piscataway, NJ 08854 Phone: (732) 699-5570 -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
Re: man page formatting
On Sun, Jul 22, 2001 at 12:35:06PM -0400, Dan Espen wrote: Dominik Vogt [EMAIL PROTECTED] writes: On Sun, Jul 22, 2001 at 10:48:41AM -0400, Dan Espen wrote: It looks to me like the Linux .BI command is dependent on groff's .while command which doesn't appear to available on Solaris. And what about macros like .BR or .IR? Do they suffer from the same problem? Yes they do, but I didn't see any instances of those macros with more than 6 arguments. The only man page I've looked at so far is the fvwm man page. The other man pages still use the \f... approach. Bye Dominik ^_^ ^_^ -- Dominik Vogt, [EMAIL PROTECTED] Reply-To: [EMAIL PROTECTED] -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
Re: man page formatting
On 21 Jul 2001 19:26:09 +0200, Dominik Vogt wrote: The recent fixes in the man page for Solaris etc. (\f...) broke the bold typeface of the reformatted sections. For example: .TP .BI Menu menu-name [ position ] [ double-click-action ] was changed to .IP Menu \fImenu-name\fP [ \fIposition\fP ] [ \fIdouble-click-action\fP ] The Menu, [ and ] parts of the old version are bold while they are not in the new one. Of course this can be fixed by adding more \fB...\fP pairs, but I'd *really* prefer to find a way to do that without \f... Isn't there a way to split the .BI lines into several? Any ideas are welcome. I suggest the following style for all commands: .B Menu .I menu-name .BI[ position ] .BI[ double-click-action ] .B Popup .I popup-name .BI [ position ] .BI [ default-action ] I.e. use .B for command, .I for mandatory parameters, .BI for optional. I also think, the spaces in braces are not really needed: .BI [ position ] This syntax is more readable in my opinion. I may do all these changes. Regards, Mikhael. -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
Re: man page formatting
On Sat, Jul 21, 2001 at 07:48:17PM +, Mikhael Goikhman wrote: On 21 Jul 2001 19:26:09 +0200, Dominik Vogt wrote: The recent fixes in the man page for Solaris etc. (\f...) broke the bold typeface of the reformatted sections. For example: .TP .BI Menu menu-name [ position ] [ double-click-action ] was changed to .IP Menu \fImenu-name\fP [ \fIposition\fP ] [ \fIdouble-click-action\fP ] The Menu, [ and ] parts of the old version are bold while they are not in the new one. Of course this can be fixed by adding more \fB...\fP pairs, but I'd *really* prefer to find a way to do that without \f... Isn't there a way to split the .BI lines into several? Any ideas are welcome. I suggest the following style for all commands: .B Menu .I menu-name .BI[ position ] .BI[ double-click-action ] .B Popup .I popup-name .BI [ position ] .BI [ default-action ] I.e. use .B for command, .I for mandatory parameters, .BI for optional. I also think, the spaces in braces are not really needed: .BI [ position ] But they *are* needed: .BI Menu [ option ] would look like this (minus typefaces): Menu[option] Of course one could argue about the spaces inside the brackets: .BI Menu [ option ] Menu [ option ] versus .BI Menu [ option ] Menu [option] This syntax is more readable in my opinion. I may do all these changes. Yes, the syntax looks mush better. But then, you will have to add something like .IP behind the syntax or you will get the text right behind the syntax: .B Popup .I popup-name .BI [ position ] blabla bla -- Popup popup-name [ position ] blabla bla With .IP the next paragraph is properly indented, but a blank line is inserted too: .B Popup .I popup-name .BI [ position ] .IP blabla bla -- Popup popup-name [ position ] blabla bla Currently, there is no such blank line. Perhaps there is a way to suppress it? Bye Dominik ^_^ ^_^ -- Dominik Vogt, [EMAIL PROTECTED] Reply-To: [EMAIL PROTECTED] -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
Re: man page formatting
Dominik Vogt [EMAIL PROTECTED] writes: On Sat, Jul 21, 2001 at 07:48:17PM +, Mikhael Goikhman wrote: On 21 Jul 2001 19:26:09 +0200, Dominik Vogt wrote: The recent fixes in the man page for Solaris etc. (\f...) broke the bold typeface of the reformatted sections. For example: .TP .BI Menu menu-name [ position ] [ double-click-action ] was changed to .IP Menu \fImenu-name\fP [ \fIposition\fP ] [ \fIdouble-click-action\f P ] The Menu, [ and ] parts of the old version are bold while they are not in the new one. Of course this can be fixed by adding more \fB...\fP pairs, but I'd *really* prefer to find a way to do that without \f... Isn't there a way to split the .BI lines into several? Any ideas are welcome. I suggest the following style for all commands: .B Menu .I menu-name .BI[ position ] .BI[ double-click-action ] .B Popup .I popup-name .BI [ position ] .BI [ default-action ] I.e. use .B for command, .I for mandatory parameters, .BI for optional. I also think, the spaces in braces are not really needed: .BI [ position ] But they *are* needed: .BI Menu [ option ] would look like this (minus typefaces): Menu[option] Of course one could argue about the spaces inside the brackets: .BI Menu [ option ] Menu [ option ] versus .BI Menu [ option ] Menu [option] This syntax is more readable in my opinion. I may do all these changes. Yes, the syntax looks mush better. But then, you will have to add something like .IP behind the syntax or you will get the text right behind the syntax: .B Popup .I popup-name .BI [ position ] blabla bla -- Popup popup-name [ position ] blabla bla With .IP the next paragraph is properly indented, but a blank line is inserted too: .B Popup .I popup-name .BI [ position ] .IP blabla bla -- Popup popup-name [ position ] blabla bla Currently, there is no such blank line. Perhaps there is a way to suppress it? I tried using multiple .BI commands but the text ran into the paragraph. I wonder if the .BI command used in Linux would work with the vendors nroff/troff, perhaps all we need to do is copy the .BI macro into the file(s) we need it in. Maybe I'll have some time to check later... -- Dan Espen 444 Hoes Lane Room RRC 1C-214 E-mail: [EMAIL PROTECTED] Piscataway, NJ 08854 Phone: (732) 699-5570 -- Visit the official FVWM web page at URL:http://www.fvwm.org/. To unsubscribe from the list, send unsubscribe fvwm-workers in the body of a message to [EMAIL PROTECTED] To report problems, send mail to [EMAIL PROTECTED]
