Re: call for help with man pages
Thanks! I didn't know that, I'll rip those out of the konq man page, seperate them, and edit the ones I've done to refer to them. Luckily I've only got about five done so far. Lets see, at this rate, I'll be done with the kde man pages just in time for Gnome and KDE to merge, and right after pigs fly :-) *hint hint* Volunteers always welcome! *hint hint* B-) Thanks, D.A.Bishop On Tue, Apr 17, 2001 at 08:39:28PM +0200, Achim Bohnet wrote: > On Friday 13 April 2001 04:02, Ivan E. Moore II wrote: > > > > > > Do you have a "template" or something we can work off of? If you had a > > > standard > > > > here is one for konqueror I just threw together..probably still needs some > > tweaks...but it's short sweet and to the point. > > FWIW the QT and KDE options are the same and supported by all KDE > (GUI) apps. Would make sense to put them into seperate manpages are > refer to them from the other manual pages. > > An better/easier alternative to *roff markup would be POD. > As an example skeleton use what's after __END__ in e.g. /usr/bin/rename. > If you do a pod2man /usr/bin/rename you get a valid man page. > > Achim > > > Ivan > > > > -- > > > > Ivan E. Moore II > > [EMAIL PROTECTED] > > http://snowcrash.tdyc.com > > GPG KeyID=90BCE0DD > > GPG Fingerprint=F2FC 69FD 0DA0 4FB8 225E 27B6 7645 8141 90BC E0DD > > > > > Content-Type: text/plain; charset="us-ascii"; name="Attachment: 1" > Content-Transfer-Encoding: 7bit > Content-Description: > > > > -- > To UNSUBSCRIBE, email to [EMAIL PROTECTED] > with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED] >
Re: call for help with man pages
On Friday 13 April 2001 04:02, Ivan E. Moore II wrote: > > > > Do you have a "template" or something we can work off of? If you had a > > standard > > here is one for konqueror I just threw together..probably still needs some > tweaks...but it's short sweet and to the point. FWIW the QT and KDE options are the same and supported by all KDE (GUI) apps. Would make sense to put them into seperate manpages are refer to them from the other manual pages. An better/easier alternative to *roff markup would be POD. As an example skeleton use what's after __END__ in e.g. /usr/bin/rename. If you do a pod2man /usr/bin/rename you get a valid man page. Achim > Ivan > > -- > > Ivan E. Moore II > [EMAIL PROTECTED] > http://snowcrash.tdyc.com > GPG KeyID=90BCE0DD > GPG Fingerprint=F2FC 69FD 0DA0 4FB8 225E 27B6 7645 8141 90BC E0DD > Content-Type: text/plain; charset="us-ascii"; name="Attachment: 1" Content-Transfer-Encoding: 7bit Content-Description:
Re: call for help with man pages
Just run 'man ./filename.1'. It will read the man page just like it was system-wide. I'm working on organizing that list Ivan sent out, and will repost it minus the dupes and grouped in a little bit. On Fri, Apr 13, 2001 at 10:26:31PM +1000, David Kempe wrote: > On Friday 13 April 2001 13:12, David Bishop wrote: > >3) A (probably) short list of people willing to help out > > Add me to that list, however How do we test the man page from Ivan's template > once we have written it? I think the syntax is easy enough, I just want to > know what its going to look like i guess. > > Dave
Re: call for help with man pages
On Friday 13 April 2001 13:12, David Bishop wrote: >3) A (probably) short list of people willing to help out Add me to that list, however How do we test the man page from Ivan's template once we have written it? I think the syntax is easy enough, I just want to know what its going to look like i guess. Dave
Re: call for help with man pages
> 1) A list of the packages that we need to do this for I can easily do this with lintian. :) once 2.2-alpha1 is out the door I'll create a list of all binaries that need man pages. Ivan -- Ivan E. Moore II [EMAIL PROTECTED] http://snowcrash.tdyc.com GPG KeyID=90BCE0DD GPG Fingerprint=F2FC 69FD 0DA0 4FB8 225E 27B6 7645 8141 90BC E0DD
Re: call for help with man pages
On Thursday 12 April 2001 20:02, Ivan E. Moore II wrote: > > Do you have a "template" or something we can work off of? If you had a > > standard > > here is one for konqueror I just threw together..probably still needs some > tweaks...but it's short sweet and to the point. > > Ivan So, call to arms. Gather round, my countrymen, and I'll tell you a tale of Brer. Nevermind, I think I just mixed four different speeches in two sentences :-) Is there a list of the programs that we should be doing this for? A central repository to send these to (or just the mailing list) so as to keep the duplication of effort to a minimum? Free milkshakes for everyone that helps? Just making sure you were still paying attention. If there is a way to query dpkg about what binaries there are in the kde packages, that would at least give us a list to work off of. If no one else is interested, I hereby volunteer to help coordinate this, via keeping some sort of list of what's been done, what's left, and (if necessary) who's working on what. I don't have enough to do at work anyways So, to sum up this ramble (it's late for me), here's what I need to get off the ground: 1) A list of the packages that we need to do this for 2) Hopefully have that list annotated and grouped with "common", "seperate", and "special" (i.e., Ivan feels he would do a better job) packages marked 3) A (probably) short list of people willing to help out 4) I can't think of anything else. Response? The Eternally Tired One, D.A.Bishop
Re: call for help with man pages
> > Do you have a "template" or something we can work off of? If you had a > standard here is one for konqueror I just threw together..probably still needs some tweaks...but it's short sweet and to the point. Ivan -- Ivan E. Moore II [EMAIL PROTECTED] http://snowcrash.tdyc.com GPG KeyID=90BCE0DD GPG Fingerprint=F2FC 69FD 0DA0 4FB8 225E 27B6 7645 8141 90BC E0DD .TH "konqueror" "1" "2.1" "KDE Development Team <[EMAIL PROTECTED]>" "Net" .SH "NAME" konqueror \- Web browser, file manager, ... .SH "SYNTAX" konqueror [Qt\-options] [KDE\-options] [options] [URL] .br .SH "DESCRIPTION" KDE's advanced File Manager, Web Browser and Document Viewer .SH "OPTIONS" Generic options: \-\-helpShow help about options \-\-help\-qt Show Qt specific options \-\-help\-kdeShow KDE specific options \-\-help\-allShow all options \-\-author Show author information \-v, \-\-version Show version information \-\-license Show license information \-\-End of options Qt options: \-\-displayUse the X\-server display 'displayname'. \-\-session Restore the application for the given 'sessionId'. \-\-cmapCauses the application to install a private color map on an 8\-bit display. \-\-ncolsLimits the number of colors allocated in the color cube on a 8\-bit display, if the application is using the QApplication::ManyColor color specification. \-\-nograb tells Qt to never grab the mouse or the keyboard. \-\-dograb running under a debugger can cause an implicit \-nograb, use \-dograb to override. \-\-syncswitches to synchronous mode for debugging. \-\-fn, \-\-fontdefines the application font. \-\-bg, \-\-background sets the default background color and an application palette (light and dark shades are calculated). \-\-fg, \-\-foreground sets the default foreground color. \-\-btn, \-\-buttonsets the default button color. \-\-name sets the application name. \-\-titlesets the application title (caption). \-\-visual TrueColorforces the application to use a TrueColor visual on an 8\-bit display. \-\-inputstyle sets XIM (X Input Method) input style. Possible values are onthespot, overthespot, offthespot and root. \-\-im set XIM server. \-\-noxim disable XIM. KDE options: \-\-captionUse 'caption' as name in the titlebar. \-\-icon Use 'icon' as the application icon. \-\-miniicon Use 'icon' as the icon in the titlebar. \-\-dcopserver Use the DCOP Server specified by 'server'. \-\-nocrashhandler Disable crash handler, to get core dumps. \-\-waitforwm Waits for a WM_NET compatible windowmanager. \-\-style
Re: call for help with man pages
> I started to do something with this a couple of months ago. Basically I > used help2man, slightly modified as it wants --help but the kde binaries > respond to -help... > > Hmm... maybe one? common manpage for each upstream source package, ie > kdelibs, kdebase, kdegraphics, list the binaries provided by the source > package and point to /usr/share/doc/kde/HTML/$pkg? > > Then use 100's of symlinks? Or do you think more fine-grained detail? I'm thinking at least 1 common man page per binary package. For example.. if you just create one common kdebase man page..and just install konqueror you don't get the man page... plus I also think that some binaries should have their own man page... and other's will definatly need common man pages kfmclient,konqueror,khelpcenter - all should have a common man page IMO dcopserver, dcopidl,dcopidl2cpp,dcop - common probably kbuildsycoca, cupsdconf, kdb2html - seperate man pages kdeinit,kdeinit_wrapper,kdeinit_shell,kdeinit_shutdown - common kcmnit, kdesu - seperate *.kss - common there are some examples of what I'm wanting... Ivan -- Ivan E. Moore II [EMAIL PROTECTED] http://snowcrash.tdyc.com GPG KeyID=90BCE0DD GPG Fingerprint=F2FC 69FD 0DA0 4FB8 225E 27B6 7645 8141 90BC E0DD
Re: call for help with man pages
On Thu, Apr 12, 2001 at 03:50:48PM -0600, Ivan E. Moore II wrote: > Ok...so as I work on these 2.2 packages one of the policy bits that is still > yet to be dealt with is man pages. According to policy every binary must > have a manpage. (even if there is a common one which others link to) Well > KDE doesn't do man pages...they do docbook...so I need help. > > soo... anyone willing to help create a man page for every binary even some > common man pages. IMO all that is really needed in these are: > >1: basic description >2: pointers to full documentation >3: copyright info (basic..it's GPL'd and the authors are... type of info) >4: command line info if available > > I'm looking at this for the 2.2 release so we will need to work off the > 2.2 packages and binaries. There are several tools which can help with > this... > take a look at all the docbook* packages and there are also man page editors > now. > I started to do something with this a couple of months ago. Basically I used help2man, slightly modified as it wants --help but the kde binaries respond to -help... Hmm... maybe one? common manpage for each upstream source package, ie kdelibs, kdebase, kdegraphics, list the binaries provided by the source package and point to /usr/share/doc/kde/HTML/$pkg? Then use 100's of symlinks? Or do you think more fine-grained detail? Gordon Sadler
Re: call for help with man pages
On Thu, Apr 12, 2001 at 04:03:49PM -0600, david wrote: > > Do you have a "template" or something we can work off of? If you had a > standard > file that I could then plug in different binary names and info, that would > help > out immensly (i.e., I'd prefer not to have to learn docbook for just a few > man > pages, but I'm fine with making up descriptions and copying/pasting > command-line > info). Thanks! I will create one. Ivan -- Ivan E. Moore II [EMAIL PROTECTED] http://snowcrash.tdyc.com GPG KeyID=90BCE0DD GPG Fingerprint=F2FC 69FD 0DA0 4FB8 225E 27B6 7645 8141 90BC E0DD
Re: call for help with man pages
Do you have a "template" or something we can work off of? If you had a standard file that I could then plug in different binary names and info, that would help out immensly (i.e., I'd prefer not to have to learn docbook for just a few man pages, but I'm fine with making up descriptions and copying/pasting command-line info). Thanks! D.A.Bishop On Thu, Apr 12, 2001 at 03:50:48PM -0600, Ivan E. Moore II wrote: > Ok...so as I work on these 2.2 packages one of the policy bits that is still > yet to be dealt with is man pages. According to policy every binary must > have a manpage. (even if there is a common one which others link to) Well > KDE doesn't do man pages...they do docbook...so I need help. > > soo... anyone willing to help create a man page for every binary even some > common man pages. IMO all that is really needed in these are: > >1: basic description >2: pointers to full documentation >3: copyright info (basic..it's GPL'd and the authors are... type of info) >4: command line info if available > > I'm looking at this for the 2.2 release so we will need to work off the > 2.2 packages and binaries. There are several tools which can help with > this... > take a look at all the docbook* packages and there are also man page editors > now. > > Ivan > -- > > Ivan E. Moore II > [EMAIL PROTECTED] > http://snowcrash.tdyc.com > GPG KeyID=90BCE0DD > GPG Fingerprint=F2FC 69FD 0DA0 4FB8 225E 27B6 7645 8141 90BC E0DD > > > -- > To UNSUBSCRIBE, email to [EMAIL PROTECTED] > with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED] >
call for help with man pages
Ok...so as I work on these 2.2 packages one of the policy bits that is still yet to be dealt with is man pages. According to policy every binary must have a manpage. (even if there is a common one which others link to) Well KDE doesn't do man pages...they do docbook...so I need help. soo... anyone willing to help create a man page for every binary even some common man pages. IMO all that is really needed in these are: 1: basic description 2: pointers to full documentation 3: copyright info (basic..it's GPL'd and the authors are... type of info) 4: command line info if available I'm looking at this for the 2.2 release so we will need to work off the 2.2 packages and binaries. There are several tools which can help with this... take a look at all the docbook* packages and there are also man page editors now. Ivan -- Ivan E. Moore II [EMAIL PROTECTED] http://snowcrash.tdyc.com GPG KeyID=90BCE0DD GPG Fingerprint=F2FC 69FD 0DA0 4FB8 225E 27B6 7645 8141 90BC E0DD
