[Pkg-utopia-maintainers] Bug#604784: Bug#604784: Bug#604784: /usr/bin/palimpsest: man page missing

[Michael Biebl]

On 26.11.2010 06:31, Vincent Cheng wrote:
> I've tried to search for as much documentation as I could find about
> gnome-disk-utility/palimpsest, but my search has turned up rather fruitless;
> Gnome's documentation is very brief (
> http://library.gnome.org/users/palimpsest/stable/advanced.html.en) and the
> documentation in gnome-disk-utility's source tarball is centered on the
> libgdu API, not on the usage of palimpsest itself. I'm having trouble
> finding a reliable source of documentation to improve upon the manual page
> that I've written so far.

Agreed, the current documentation about how to *use" palimpsest is scarce.
I guess the best way to write documentation is to actually use palimpsest.

> For the moment, I've just added a brief example section in the man page.
> (I'm sorry, but I don't see "..TH" anywhere though). If/when I find

See the file you attached to the bug report:
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=604784
http://bugs.debian.org/cgi-bin/bugreport.cgi?msg=5;filename=palimpsest.1;att=1;bug=604784

Looks though as the file you attached now doesn't have the format errors anymore.

> additional sources of documentation to expand upon what I've written so far,
> I'll definitely have another go at this.
> 
> As for writing documentation based on Yelp, I think it would be a great idea
> as well to expand on the little information available via Yelp on
> palimpsest; I'll have to look into that later. At the moment, I still have a
> lot to learn about writing manual pages. :)

Thanks for your efforts so far.
Let me know if you need any further help.

Michael

-- 
Why is it that all of the instruments seeking intelligent life in the
universe are pointed away from Earth?

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 900 bytes
Desc: OpenPGP digital signature
URL: <http://lists.alioth.debian.org/pipermail/pkg-utopia-maintainers/attachments/20101126/91ed1242/attachment.pgp>