On 24.11.2010 11:32, Vincent Cheng wrote: > Package: gnome-disk-utility > Version: 2.30.1-2 > Severity: normal > File: /usr/bin/palimpsest > > As a Debian Google Code-In student, I'd like to submit a missing manual page > for palimpsest (attached with this bug report). Please let me know if you > think anything needs to be changed. >
Hi Vincent, thanks for your contribution. Such patches should best be sent upstream directly, so I'm bringing David into the loop here. But tbh, I think integrating a proper help system (based on yelp) would be much more valuable to our users as you can e.g. include graphics/screenshots and it is directly accessible from within the gui. See [1] for more details if you are interested in working on this. The man page itself has a few formatting errors (e.g. ..TH, should be .TH) and is very short. It doesn't really offer more information than the package description and the output of palimpsest --help. To be really useful you should explain e.g. the command line args in more detail, provide an EXAMPLE section etc. Cheers, Michael [1] http://library.gnome.org/admin/system-admin-guide/stable/help-0.html.en -- Why is it that all of the instruments seeking intelligent life in the universe are pointed away from Earth?
..TH PALIMPSEST "1" "November 2010" "gnome-disk-utility 2.30.1" ..SH NAME palimpsest \- tool to manage disk drives and media. ..SH SYNOPSIS ..B palimpsest [\fIOPTIONS...\fR] ..SH DESCRIPTION ..B palimpsest (from the gnome-disk-utility project) is a graphical tool to manage disk drives and media. It utilizes udisks and is able to format and partition drives, mount and unmount partitions, and query S.M.A.R.T. attributes. ..SH OPTIONS ..TP ..BR \-h ", " \-\-help\fR Shows help options. ..TP ..BR \-\-show\-volume =\fIDEVICE\fR Volume to show. ..TP ..BR \-\-show\-drive =\fIDEVICE\fR Drive to show. ..TP ..BR \-a ", " \-\-address\fR D-Bus address to connect to. ..TP ..BR \-\-display =\fIDISPLAY\fR X display to use. ..TP In addition, the usual GTK+ and GNOME command line options apply. See the output of --help for details. ..SH SEE ALSO ..PP \fBudisks\fR(1) ..SH AUTHOR ..PP This manual page was written by Vincent Cheng <[email protected]>, for the Debian project (and may be used by others).
signature.asc
Description: OpenPGP digital signature
