Hi again,
this time I'm writing to the list as Evolution tricked me the first
time.
On Thu, 2009-04-02 at 00:59 +0200, Grammostola Rosea wrote:
> > I really got accustomed to help2man because creating man pages is a snap
> > with it. All it takes is the following:
> >
> > * A sanely formated text file (w/ optional troff commands)
> >
> What is a sanely formated text file and what do you mean with (w/
> optional troff commands)?
help2man only extracts very little information from your program's help
and version string:
* The program name
* Its version
* Its allowed parameters
That will do for a simple man page with the usual sections:
* NAME
* SYNOPSIS
* OPTIONS
* AUTHOR
* COPYRIGHT
By specifying an additional text file you can include your own sections
between OPTIONS and AUTHOR. This file really is a simple text file with
only a few rules: Section names occupy a single line and are put in
square brackets, paragraphs are split by a blank line. Like this:
------------------------------8<------------------------------------
[PURPOSE]
The purpose of fancyhello is to extend the classic hello world program
with extended multimedia features. For the very first time you can
enhance the hello world greeting with video, sound and slideshows. Also
you can broadcast the performance on the Internet.
Besides that the program tries to mimic several cultural greeting habits
in a most accurate fashion.
[KNOWN BUGS]
Once you got the program running there's no reliable way to stop it.
Some users reported limited success with SIGTERM or SIGKILL but other
reports stated that the program has even been able to "survive" kernel
panic.
------------------------------8<------------------------------------
Got it? As long as you stick to floating text it is all very easy and
you'll never need to use troff commands for formating. (Man pages are
special troff documents). But the point is that you still can do if you
need to. e.g. if you need to define a bulleted list. Just like this:
------------------------------8<------------------------------------
[ABOUT THE USER-INTERFACE]
The user-interface mainly consists of six tabs:
.br
\h'3' \(bu Create Bank Files
.br
\h'3' \(bu Import Registrations
.br
\h'3' \(bu Quick Rename
.br
\h'3' \(bu Print/Export Setlist
.br
\h'3' \(bu Keyboard Information
.br
\h'3' \(bu About
------------------------------8<------------------------------------
Yours sincerely,
Dennis Schulmeister
-- Dennis Schulmeister - Schifferstr. 1 - 76189 Karlsruhe - Germany Tel: +49 721/5978883 - Mob: +49 152/01994400 - eMail: dennis@windows3.de Now moved to the corridor: Hermes! (http://ncc-1701a.homelinux.net) Besides that: http://www.denchris.de - http://www.motagator.net/bands/65 <GnuPG KeyIDs: B8382C97, 01AD62DE> _______________________________________________ Linux-audio-dev mailing list Linux-audio-dev@lists.linuxaudio.org http://lists.linuxaudio.org/mailman/listinfo/linux-audio-devReceived on Thu Apr 2 04:15:02 2009
This archive was generated by hypermail 2.1.8 : Thu Apr 02 2009 - 04:15:02 EEST