I want to update the man page. Which file to edit? Inkscape.pod seems much more editable, but inkscape.1.in is more recent in the CVS, as pjrm changed it directly:
http://cvs.sourceforge.net/viewcvs.py/inkscape/inkscape/inkscape.1.in?rev=1....
So, which one is the real source?
On Tue, Sep 07, 2004 at 07:05:42PM -0300, bulia byak wrote:
I want to update the man page. Which file to edit? Inkscape.pod seems much more editable, but inkscape.1.in is more recent in the CVS, as pjrm changed it directly:
http://cvs.sourceforge.net/viewcvs.py/inkscape/inkscape/inkscape.1.in?rev=1....
So, which one is the real source?
According to cvs log (haven't yet confirmed with diffs), inkscape.1 hasn't been updated from inkscape.pod since 2003-12-06, despite a number of changes having been made to each of them since then (by various people).
pod2man at least to the one in perl 5.8.4 produces bad troff, using hyphens instead of ASCII minus signs for flags.
I believe there are other things that convert to troff if we don't like editing troff. I haven't used any, so can't comment on how good they are.
pjrm.
On Wed, Sep 08, 2004 at 09:57:45AM +1000, Peter Moulder wrote:
pod2man at least to the one in perl 5.8.4 produces bad troff, using hyphens instead of ASCII minus signs for flags.
Correction: sometimes it uses hyphens where it should use minus signs, and sometimes it uses minus signs where it should use hyphens, and sometimes it gets things right.
I'm trying to merge changes now.
pjrm.
Correction: sometimes it uses hyphens where it should use minus signs, and sometimes it uses minus signs where it should use hyphens, and sometimes it gets things right.
This makes no difference for my "man inkscape" display. Why does it matter?
I'm trying to merge changes now.
Please wait, I have merged your changes back into .pod already and made many other changes there. Will commit now.
On Tue, Sep 07, 2004 at 09:41:54PM -0300, bulia byak wrote:
Correction: sometimes it uses hyphens where it should use minus signs, and sometimes it uses minus signs where it should use hyphens, and sometimes it gets things right.
This makes no difference for my "man inkscape" display.
Depends on what charset (LC_CTYPE) the user has. It makes a difference for UTF-8, use of which is becoming increasingly common. In particular, it means that people can't use mouse copy&paste from man pages.
pjrm.
Depends on what charset (LC_CTYPE) the user has. It makes a difference for UTF-8, use of which is becoming increasingly common. In particular, it means that people can't use mouse copy&paste from man pages.
Are you sure it's the problem wtih man page and not with the software you use to display it?
Thinking of which, I don't see why we may need minus signs at all. All options use hyphens. In the text, hyphens are acceptable as substitutes for em-dashes. So why is the minus sign needed?
On Tue, 7 Sep 2004, bulia byak wrote:
I want to update the man page. Which file to edit? Inkscape.pod seems much more editable, but inkscape.1.in is more recent in the CVS, as pjrm changed it directly:
http://cvs.sourceforge.net/viewcvs.py/inkscape/inkscape/inkscape.1.in?rev=1....
So, which one is the real source?
inkscape.pod is the one I used to produce the inkscape.1.in file. Editing the raw man syntax is a pain. IIRC, I used pod2man to make the man page itself.
The one issue I ran into is that the generator was titling the man page "User Contributed Perl Documentation", which of course it is not. I manually changed it to say "Scalable Vector Graphics Application", "Inkscape-0.36".
What we really ought to do is include directives in the makefile to run pod2man on the pod file as part of the make process, to generate the inkscape.1.in file, and then sed the title properly, including updating the version number.
Bryce
inkscape.pod is the one I used to produce the inkscape.1.in file. Editing the raw man syntax is a pain. IIRC, I used pod2man to make the man page itself.
I tried this and it works, except that it leaves [% INCLUDE AUTHORS %] unprocessed. What's the trick to make this work?
What we really ought to do is include directives in the makefile to run pod2man on the pod file as part of the make process, to generate the inkscape.1.in file, and then sed the title properly, including updating the version number.
Agreed.
On Tue, 7 Sep 2004, bulia byak wrote:
inkscape.pod is the one I used to produce the inkscape.1.in file. Editing the raw man syntax is a pain. IIRC, I used pod2man to make the man page itself.
I tried this and it works, except that it leaves [% INCLUDE AUTHORS %] unprocessed. What's the trick to make this work?
Ah, I believe I simply manually inserted the contents of the AUTHORS file to replace that. The desire was to automate that inclusion, and presumably we should be able to do that, I just did not know how.
Bryce
On the website I wrote a script that does all this but converts the manpage to html.
Here is the SED I used to replace AUTHORS:
AUTHORS_CLEAN=`sed -e "/^$/d" -e ':a;N;$!ba;s/\n/, /g' $AUTHORS`
Where AUTHORS is the path to the AUTHORS file...
Also, here is my script located on the website and is run as cron job every night:
/home/users/k/ki/kidproto/inkscape/inkscape_project/scripts/manpage2website.sh
That directive could be added to the Makefile and automated...do with the above as you wish...
Jon
On Wed, 2004-09-08 at 11:15, Bryce Harrington wrote:
On Tue, 7 Sep 2004, bulia byak wrote:
inkscape.pod is the one I used to produce the inkscape.1.in file. Editing the raw man syntax is a pain. IIRC, I used pod2man to make the man page itself.
I tried this and it works, except that it leaves [% INCLUDE AUTHORS %] unprocessed. What's the trick to make this work?
Ah, I believe I simply manually inserted the contents of the AUTHORS file to replace that. The desire was to automate that inclusion, and presumably we should be able to do that, I just did not know how.
Bryce
This SF.Net email is sponsored by BEA Weblogic Workshop FREE Java Enterprise J2EE developer tools! Get your free copy of BEA WebLogic Workshop 8.1 today. http://ads.osdn.com/?ad_id=5047&alloc_id=10808&op=click _______________________________________________ Inkscape-devel mailing list Inkscape-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-devel
participants (4)
-
Bryce Harrington -
bulia byak -
Jon Phillips -
Peter Moulder