From: Vitezslav S. <sa...@ma...> - 2003-06-02 10:16:19
|
Hi! I'm trying to get the documentation right, but my English is not that good to do it myself. Is there any native speaking American or Englishman who can correct my patches like the one below? Thanks, Vita diff -urN -X /home/samel/joe/dontdiff 04-dont_beep/joe.1.in 05-doc_typos/joe.1.in --- 04-dont_beep/joe.1.in 2001-10-29 14:39:51.000000000 +0000 +++ 05-doc_typos/joe.1.in 2003-06-01 11:18:58.000000000 +0000 @@ -13,7 +13,7 @@ .B jpico [global-options] [ [local-options] filename ]... .SH Description JOE is a powerful ASCII-text screen editor. It has a "mode-less" user -interface which is similer to many user-friendly PC editors. Users of +interface which is similar to many user-friendly PC editors. Users of Micro-Pro's WordStar or Borland's "Turbo" languages will feel at home. JOE is a full featured UNIX screen-editor though, and has many features for editing programs and text. @@ -34,7 +34,7 @@ terms of the GNU General Public License as published by the Free Software Foundation. I have no plans for turning JOE into a commercial or share-ware product. JOE is available over the Internet from -\fBwww.sourceforge.net/projects/joe-editor\fR. +\fBhttp://www.sourceforge.net/projects/joe-editor/\fR. .SH Usage @@ -78,14 +78,14 @@ ESC .). Use \fB^K H\fR to dismiss the help window. You can customize the keyboard layout, the help screens and a number of -behavior defaults by copying JOE's initialization file (usually -\fB@sysconfdir@/joerc\fR) to \fB.joerc\fR in your home directory and then +behavior defaults by copying JOE's initialization file (by default +in /usr/local/etc/joerc\fR) to \fB.joerc\fR in your home directory and then by modifying it. See the section \fBjoerc\fR below. To have JOE used as your default editor for e-mail and News, you need to set the \fBEDITOR\fR and \fBVISUAL\fR environment variables in your shell initialization file (\fB.cshrc\fR or \fB.profile\fR) to refer to JOE (joe -usually resides as \fB@bindir@/joe\fR). +resides by default as \fB/usr/local/bin/joe\fR). There are a number of other obscure invocation parameters which may have to be set, particularly if your terminal screen is not updating as you think it @@ -777,16 +777,27 @@ \fBquota -v | joe - | mail root\fR, if you want to complain about your low quota. - .SH The\ joerc file \fB^T\fR options, the help screens and the key-sequence to editor command bindings are all defined in JOE's initialization file. If you make a copy -of this file (which normally resides in \fB@sysconfdir@/joerc\fR) to +of this file (which resides by default in \fB/usr/local/etc/joerc\fR) to \fB$HOME/.joerc\fR, you can customize these setting to your liking. The syntax of the initialization file should be fairly obvious and there are further instruction in it. .SH Acknowledgements -JOE was writen by Joseph H. Allen. If you have bug reports or questions, -e-mail them to jh...@wo.... Larry Foard (en...@wo...) -and Gary Gray (gg...@wo...) also helped with the creation of JOE. +JOE was originally writen by Joseph H. Allen. His latest release was in +January 1995. Since then there was no sign of development from him, no mails +answered, so Marek Grac took over the maintainership of joe in 2001. Marek then +merged all the patches from the RedHat's joe and included new build system +(using automake and autoconf GNU packages). Then the team joined +Vitezslav Samel, who is still slowly cleaning up the sources and merging +(or refusing) requests and trying to squash out all the bug reports. + +Marek Grac created a project at SourceForge.net +(http://sf.net/projects/joe-editor/) where all problems or question can be +discussed. This place is also home of other joe developers. + +If you have any bug reports or questions, e-mail them to +jo...@li... and/or fill in bug track entry on +the joe's homepage. |
From: Josip R. <jo...@sr...> - 2003-06-02 10:39:00
|
On Mon, Jun 02, 2003 at 12:06:08PM +0200, Vitezslav Samel wrote: > product. JOE is available over the Internet from > -\fBwww.sourceforge.net/projects/joe-editor\fR. > +\fBhttp://www.sourceforge.net/projects/joe-editor/\fR. BTW, this can be done with: .UR http://www.sourceforge.net/projects/joe-editor/ .UE I don't know if this is a groff-only extension, though... > -behavior defaults by copying JOE's initialization file (usually > -\fB@sysconfdir@/joerc\fR) to \fB.joerc\fR in your home directory and then > +behavior defaults by copying JOE's initialization file (by default > +in /usr/local/etc/joerc\fR) to \fB.joerc\fR in your home directory and then ~~ Missed a \fB there. > To have JOE used as your default editor for e-mail and News, you need to set > the \fBEDITOR\fR and \fBVISUAL\fR environment variables in your shell > initialization file (\fB.cshrc\fR or \fB.profile\fR) to refer to JOE (joe > -usually resides as \fB@bindir@/joe\fR). > +resides by default as \fB/usr/local/bin/joe\fR). Actually, this is needless -- there's no need to use the full path in the $EDITOR and $VISUAL variables, unless of course joe is not in $PATH, but that's kinda silly. If I were you, I'd just lose the whole parenthesized clause. > -of this file (which normally resides in \fB@sysconfdir@/joerc\fR) to > +of this file (which resides by default in \fB/usr/local/etc/joerc\fR) to What exactly is the purpose of removing @sysconfdir@? I think it's nice to be able to customize the manual page. When I make a .deb package out of it, it won't be in /usr/local/etc but in /etc, and users who read this might be confused. > .SH Acknowledgements > -JOE was writen by Joseph H. Allen. If you have bug reports or questions, > -e-mail them to jh...@wo.... Larry Foard (en...@wo...) > -and Gary Gray (gg...@wo...) also helped with the creation of JOE. > +JOE was originally writen by Joseph H. Allen. His latest release was in > +January 1995. Since then there was no sign of development from him, no mails > +answered, so Marek Grac took over the maintainership of joe in 2001. Marek then > +merged all the patches from the RedHat's joe and included new build system ~~~~~~~~~~~~~~~~ replace with: Red Hat's joe package > +(using automake and autoconf GNU packages). ~~~~~~~~~~~~~ remove > +Then the team joined Vitezslav Samel, The other way around :) > +who is still slowly cleaning up the sources and merging > +(or refusing) requests and trying to squash out all the bug reports. I'd suggest: Later, Vitezslav Samel joined the team and started slowly cleaning up the sources and processing bugs and feature requests. > +Marek Grac created a project at SourceForge.net > +(http://sf.net/projects/joe-editor/) where all problems or question can be ~~~~~~~~~~~ replace with: and questions > +If you have any bug reports or questions, e-mail them to > +jo...@li... and/or fill in bug track entry on "bug track entry" just doesn't sound right to me. "fill in a new entry in the bug tracker"? "file a bug report"? > +the joe's homepage. ~~~ remove -- 2. That which causes joy or happiness. |
From: Koblinger E. <eg...@uh...> - 2003-06-02 10:47:36
|
> > -of this file (which normally resides in \fB@sysconfdir@/joerc\fR) to > > +of this file (which resides by default in \fB/usr/local/etc/joerc\fR) to > > What exactly is the purpose of removing @sysconfdir@? I think it's nice to > be able to customize the manual page. When I make a .deb package out of it, > it won't be in /usr/local/etc but in /etc, and users who read this might be > confused. I was halfway typing the same question :-))) Yes, auto{conf,make,godknows} macros should be used so that the manpage corresponds to the actual configure options, and not to configure without any options at all. cheers, Egmont |
From: Josip R. <jo...@sr...> - 2003-06-02 10:49:22
|
On Mon, Jun 02, 2003 at 12:38:46PM +0200, Josip Rodin wrote: > > .SH Acknowledgements > > -JOE was writen by Joseph H. Allen. If you have bug reports or questions, > > -e-mail them to jh...@wo.... Larry Foard (en...@wo...) > > -and Gary Gray (gg...@wo...) also helped with the creation of JOE. > > +JOE was originally writen by Joseph H. Allen. His latest release was in > > +January 1995. Since then there was no sign of development from him, Oh and I forgot to mention the point of quoting this part: IMHO you shouldn't skip the mention of Larry Foard and Gary Gray (but do skip their e-mails, they're needless) -- the mention doesn't hurt and it's nice to honour past contributors. -- 2. That which causes joy or happiness. |
From: Vitezslav S. <sa...@ma...> - 2003-06-02 14:36:28
|
On Mon, Jun 02, 2003 at 12:38:46PM +0200, Josip Rodin wrote: > On Mon, Jun 02, 2003 at 12:06:08PM +0200, Vitezslav Samel wrote: > > product. JOE is available over the Internet from > > -\fBwww.sourceforge.net/projects/joe-editor\fR. > > +\fBhttp://www.sourceforge.net/projects/joe-editor/\fR. > > BTW, this can be done with: > > .UR > http://www.sourceforge.net/projects/joe-editor/ > .UE > > I don't know if this is a groff-only extension, though... Well, I'm not going to go through the *roff manuals; if there's anybody who speaks fluently in language for man pages it would be great if he goes through the man page and update it to current style (but which is portable to all the systems which is joe portable to) > > -behavior defaults by copying JOE's initialization file (usually > > -\fB@sysconfdir@/joerc\fR) to \fB.joerc\fR in your home directory and then > > +behavior defaults by copying JOE's initialization file (by default > > +in /usr/local/etc/joerc\fR) to \fB.joerc\fR in your home directory and then > ~~ > Missed a \fB there. My fault; fixed. > > To have JOE used as your default editor for e-mail and News, you need to set > > the \fBEDITOR\fR and \fBVISUAL\fR environment variables in your shell > > initialization file (\fB.cshrc\fR or \fB.profile\fR) to refer to JOE (joe > > -usually resides as \fB@bindir@/joe\fR). > > +resides by default as \fB/usr/local/bin/joe\fR). > > Actually, this is needless -- there's no need to use the full path in the > $EDITOR and $VISUAL variables, unless of course joe is not in $PATH, but > that's kinda silly. If I were you, I'd just lose the whole parenthesized > clause. Replaced with examples. > > -of this file (which normally resides in \fB@sysconfdir@/joerc\fR) to > > +of this file (which resides by default in \fB/usr/local/etc/joerc\fR) to > > What exactly is the purpose of removing @sysconfdir@? I think it's nice to > be able to customize the manual page. When I make a .deb package out of it, > it won't be in /usr/local/etc but in /etc, and users who read this might be > confused. Because I haven't found a clean soultion hwo to do it with automake/autoconf. > > .SH Acknowledgements > > -JOE was writen by Joseph H. Allen. If you have bug reports or questions, > > -e-mail them to jh...@wo.... Larry Foard (en...@wo...) > > -and Gary Gray (gg...@wo...) also helped with the creation of JOE. > > +JOE was originally writen by Joseph H. Allen. His latest release was in > > +January 1995. Since then there was no sign of development from him, no mails > > +answered, so Marek Grac took over the maintainership of joe in 2001. Marek then > > +merged all the patches from the RedHat's joe and included new build system > ~~~~~~~~~~~~~~~~ > replace with: Red Hat's joe package Done. > > +(using automake and autoconf GNU packages). > ~~~~~~~~~~~~~ > remove Removed. > > +Then the team joined Vitezslav Samel, > > The other way around :) > > > +who is still slowly cleaning up the sources and merging > > +(or refusing) requests and trying to squash out all the bug reports. > > I'd suggest: > > Later, Vitezslav Samel joined the team and started slowly cleaning up the > sources and processing bugs and feature requests. Done. > > +Marek Grac created a project at SourceForge.net > > +(http://sf.net/projects/joe-editor/) where all problems or question can be > ~~~~~~~~~~~ > replace with: and questions Done. > > +If you have any bug reports or questions, e-mail them to > > +jo...@li... and/or fill in bug track entry on > > "bug track entry" just doesn't sound right to me. "fill in a new entry in > the bug tracker"? "file a bug report"? Done (the first one). > > +the joe's homepage. > ~~~ > remove Done. Here is the changed patch (against current CVS): Cheers, Vita diff -urN -X /home/samel/joe/dontdiff 04-dont_beep/joe.1.in 05-doc/joe.1.in --- 04-dont_beep/joe.1.in Mon Oct 29 14:39:51 2001 +++ 05-doc/joe.1.in Mon Jun 2 13:30:54 2003 @@ -13,7 +13,7 @@ .B jpico [global-options] [ [local-options] filename ]... .SH Description JOE is a powerful ASCII-text screen editor. It has a "mode-less" user -interface which is similer to many user-friendly PC editors. Users of +interface which is similar to many user-friendly PC editors. Users of Micro-Pro's WordStar or Borland's "Turbo" languages will feel at home. JOE is a full featured UNIX screen-editor though, and has many features for editing programs and text. @@ -34,7 +34,7 @@ terms of the GNU General Public License as published by the Free Software Foundation. I have no plans for turning JOE into a commercial or share-ware product. JOE is available over the Internet from -\fBwww.sourceforge.net/projects/joe-editor\fR. +\fBhttp://www.sourceforge.net/projects/joe-editor/\fR. .SH Usage @@ -78,14 +78,15 @@ ESC .). Use \fB^K H\fR to dismiss the help window. You can customize the keyboard layout, the help screens and a number of -behavior defaults by copying JOE's initialization file (usually -\fB@sysconfdir@/joerc\fR) to \fB.joerc\fR in your home directory and then +behavior defaults by copying JOE's initialization file (by default +in \fB/usr/local/etc/joerc\fR) to \fB.joerc\fR in your home directory and then by modifying it. See the section \fBjoerc\fR below. To have JOE used as your default editor for e-mail and News, you need to set the \fBEDITOR\fR and \fBVISUAL\fR environment variables in your shell -initialization file (\fB.cshrc\fR or \fB.profile\fR) to refer to JOE (joe -usually resides as \fB@bindir@/joe\fR). +initialization file (\fB.cshrc\fR or \fB.profile\fR) to refer to JOE (for +example "setenv EDITOR joe" in c-style or "export EDITOR=joe" in sh-style +shell). There are a number of other obscure invocation parameters which may have to be set, particularly if your terminal screen is not updating as you think it @@ -777,16 +778,27 @@ \fBquota -v | joe - | mail root\fR, if you want to complain about your low quota. - .SH The\ joerc file \fB^T\fR options, the help screens and the key-sequence to editor command bindings are all defined in JOE's initialization file. If you make a copy -of this file (which normally resides in \fB@sysconfdir@/joerc\fR) to +of this file (which resides by default in \fB/usr/local/etc/joerc\fR) to \fB$HOME/.joerc\fR, you can customize these setting to your liking. The syntax of the initialization file should be fairly obvious and there are further instruction in it. .SH Acknowledgements -JOE was writen by Joseph H. Allen. If you have bug reports or questions, -e-mail them to jh...@wo.... Larry Foard (en...@wo...) -and Gary Gray (gg...@wo...) also helped with the creation of JOE. +JOE was originally writen by Joseph H. Allen with help by Larry Ford and +Gary Gray. His latest release was in January 1995. Since then there was no sign +of development from him, no mails answered, so Marek Grac took over +the maintainership of joe in 2001. Marek then merged all the patches from +the Red Hat's joe package and included new build system (using automake and +autoconf). Later, Vitezslav Samel joined the team and started slowly +cleaning up the sources and processing bugs and feature requests. + +Marek Grac created a project at SourceForge.net +(http://sf.net/projects/joe-editor/) where all problems and questions can be +discussed. This place is also home of other joe developers. + +If you have any bug reports or questions, e-mail them to +jo...@li... and/or fill in a new entry in bug tracker on +joe's homepage. |
From: Josip R. <jo...@sr...> - 2003-06-16 13:29:43
|
On Mon, Jun 02, 2003 at 03:33:59PM +0200, Vitezslav Samel wrote: > > > -of this file (which normally resides in \fB@sysconfdir@/joerc\fR) to > > > +of this file (which resides by default in \fB/usr/local/etc/joerc\fR) to > > > > What exactly is the purpose of removing @sysconfdir@? I think it's nice to > > be able to customize the manual page. When I make a .deb package out of it, > > it won't be in /usr/local/etc but in /etc, and users who read this might be > > confused. > > Because I haven't found a clean soultion hwo to do it with > automake/autoconf. Define clean solution? -- 2. That which causes joy or happiness. |
From: Moritz B. <bar...@gm...> - 2003-06-16 13:37:26
|
Hi, On Mon, Jun 16, 2003 at 15:29:28 +0200, Josip Rodin wrote: > Define clean solution? (> 2. That which causes joy or happiness. Is this your definition, Josip? ;->) If autotools aren't able to handle the file both as a *.in and as a man page at the same time, you may have to define an "sed" rule to replace the "@...@" parts. Sorry, no examples handy. Greetings, Moritz |
From: Josip R. <jo...@sr...> - 2003-06-16 14:22:17
|
On Mon, Jun 16, 2003 at 03:39:21PM +0200, Moritz Barsnick wrote: > If autotools aren't able to handle the file both as a *.in and as a man > page at the same time, you may have to define an "sed" rule to replace > the "@...@" parts. Sorry, no examples handy. I think I know what you mean after looking at the sources: it's backwards, some of the @variables@ get expanded into ${variables}. I'll go look around other source trees to see how this is to be handled best. -- 2. That which causes joy or happiness. |