Re: Writing manpages (was: Re: Man and UTF-8.)
Hi Rogério, Em Wed, Nov 18, 2009 at 07:33:22AM -0200, Rogério Brito escreveu: | Date: Wed, 18 Nov 2009 07:33:22 -0200 | From: Rogério Brito rbr...@ime.usp.br | To: debian-mentors@lists.debian.org | Subject: Re: Writing manpages (was: Re: Man and UTF-8.) | | I guess that I only have two options left, as it seems: Perl's pod | format or docbook. The only problem with docbook is that I don't know | how to avoid the torrent of markups and typing some of them is long. | | Now, if there were some LaTeX - man, that would be amazing. Have you ever tried txt2tags ? http://txt2tags.sourceforge.net/ You can write almost anything using its wiki format and convert to man, latex, wikiwiki, and so on ;-) It's really simple to use it :D Cheers, LEslie -- To UNSUBSCRIBE, email to debian-mentors-requ...@lists.debian.org with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Re: Writing manpages (was: Re: Man and UTF-8.)
On Wed, Nov 18, 2009 at 05:30:33AM -0200, Rogerio Brito wrote: On Nov 17 2009, Roger Leigh wrote: However, TTBOMK UTF-8 manpages should be OK as well, though I have found some issues with more esoteric characters. I would suggest reporting bugs or contacting the maintainer or groff upstream if you run into problems here. OK, since the project strongly advises for the availability of manpages (and I love manpages), comes the question: what do you people use to type manpages? Using troff is simply nasty and hard, with all the typesetting getting in the way of seeing the content that one has typing (that's not to even mention the need to memorize the black magic-esque mnemonics). Just for the record (and I know I'm resurrecting an already pretty much closed discussion), I personally am quite used to writing mdoc manual pages. Well, okay, so that shows my FreeBSD alignment ;) But IMHO mdoc is a *lot* more readable (and writeable) than plain troff with the an macros. All the utilities that I've developed (e.g. confget, pslist, and timelimit in Debian) have their manpages in mdoc format, and when I need to write a manpage for something else, I use it too (like I converted the wmanager manpages to mdoc when I took over the package). Of course, I like both reST and POD too, it's just that mdoc is a bit closer to the manpage structure than POD, and reST just wasn't around ten years ago :) And I'm pretty much used to mdoc by now :) G'luck, Peter -- Peter Pentchev r...@ringlet.netr...@space.bgr...@freebsd.org PGP key:http://people.FreeBSD.org/~roam/roam.key.asc Key fingerprint 2EE7 A7A5 17FC 124C F115 C354 651E EFB0 2527 DF13 This sentence every third, but it still comprehensible. pgp1Wfl6BAAfK.pgp Description: PGP signature
Re: Writing manpages (was: Re: Man and UTF-8.)
Le Wed, Nov 18, 2009 at 05:30:33AM -0200, Rogério Brito a écrit : But what do you people use to edit manpages that you maintain frequently? Dear Rogério, I found jEdit (http://www.jedit.org/) quite convenient to write and modify Docbook XML manpages. It is not packaged in Debian, but Upstream offers a Debian package. -- Charles Plessy Tsurumi, Kanagawa, Japan -- To UNSUBSCRIBE, email to debian-mentors-requ...@lists.debian.org with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Re: Writing manpages (was: Re: Man and UTF-8.)
Hi, Joachim.
On Nov 18 2009, Joachim Wiedorn wrote:
Am Wed, 18 Nov 2009 05:30:33 -0200 schrieb Rogério Brito rbr...@ime.usp.br:
But what do you people use to edit manpages that you maintain
frequently?
I find the simplest way is to use *ManEdit*.
Is this the same as gmanedit (that's the only one that seems to be
available in the archives)? I remember having used it some ages ago and
I wasn't impressed, but that was a long time ago.
At the beginning you can get templates for the structure of the man
page. There are support for header and sections. There are some
shortcuts for formatting. But you also must know syntax elements of
manpages: TP LP and so on.
This is what I'm trying to avoid. When I edit the bare *roff sources, I
usually end up having line breaks where I don't want and not having
where I want and it takes me some round trips to get it as I wanted.
I guess that I only have two options left, as it seems: Perl's pod
format or docbook. The only problem with docbook is that I don't know
how to avoid the torrent of markups and typing some of them is long.
Now, if there were some LaTeX - man, that would be amazing.
Anyway, I will give gmanedit a try right now. Let's see if my
impressions still hold.
Other opinions and suggestions are very welcome.
Regards, Rogério Brito.
--
Rogério Brito : rbr...@{mackenzie,ime.usp}.br : GPG key 1024D/7C2CAEB8
http://www.ime.usp.br/~rbrito : http://meusite.mackenzie.com.br/rbrito
Projects: algorithms.berlios.de : lame.sf.net : vrms.alioth.debian.org
--
To UNSUBSCRIBE, email to debian-mentors-requ...@lists.debian.org
with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Re: Writing manpages (was: Re: Man and UTF-8.)
2009/11/18 Rogério Brito rbr...@ime.usp.br: On Nov 18 2009, Joachim Wiedorn wrote: I find the simplest way is to use *ManEdit*. Is this the same as gmanedit (that's the only one that seems to be available in the archives)? I remember having used it some ages ago and I wasn't impressed, but that was a long time ago. Nope, manedit seems to have been removed from the archive due to the GTK+ 1.2 removal: http://packages.debian.org/search?keywords=manedit http://bugs.debian.org/515844 Looks like it is dead upstream too: http://wolfpack.twu.net/ManEdit/ -- bye, pabs http://wiki.debian.org/PaulWise -- To UNSUBSCRIBE, email to debian-mentors-requ...@lists.debian.org with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Writing manpages (was: Re: Man and UTF-8.)
On Nov 17 2009, Roger Leigh wrote:
However, TTBOMK UTF-8 manpages should be OK as well, though I have
found some issues with more esoteric characters. I would suggest
reporting bugs or contacting the maintainer or groff upstream if
you run into problems here.
OK, since the project strongly advises for the availability of manpages
(and I love manpages), comes the question: what do you people use to
type manpages?
Using troff is simply nasty and hard, with all the typesetting getting
in the way of seeing the content that one has typing (that's not to even
mention the need to memorize the black magic-esque mnemonics).
I'm seriously considering using a dedicated editor for this purpose, but
all of the ones that I've looked at either show the high noise/signal
rate or are too verbose (like docbook manpage).
The best so far that I found seems to be Perl's pod format. At least,
the markup doesn't pollute my view.
But what do you people use to edit manpages that you maintain
frequently?
Regards, Rogério Brito.
--
Rogério Brito : rbr...@{mackenzie,ime.usp}.br : GPG key 1024D/7C2CAEB8
http://www.ime.usp.br/~rbrito : http://meusite.mackenzie.com.br/rbrito
Projects: algorithms.berlios.de : lame.sf.net : vrms.alioth.debian.org
--
To UNSUBSCRIBE, email to debian-mentors-requ...@lists.debian.org
with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Re: Writing manpages (was: Re: Man and UTF-8.)
Hello, Am Wed, 18 Nov 2009 05:30:33 -0200 schrieb Rogério Brito rbr...@ime.usp.br: But what do you people use to edit manpages that you maintain frequently? I find the simplest way is to use *ManEdit*. At the beginning you can get templates for the structure of the man page. There are support for header and sections. There are some shortcuts for formatting. But you also must know syntax elements of manpages: TP LP and so on. Fondest regards, Joachim Wiedorn signature.asc Description: PGP signature
