[Frugalware-devel] fst api documentation

[Alex Smith]

VMiklos wrote:
> hi,
> 
> $subject is a frequently asked topic, so today i started to work on
> this, let's see what's ready:
> 
> a sample "updated" schema:
> http://frugalware.org/~vmiklos/docs/asciidoc/man/aspell.sh
> 
> the syntax is easy:
> ###
> # this will be included in the
> # manpage
> ###
> 
> here is a stupid makefile:
> http://frugalware.org/~vmiklos/docs/asciidoc/man/Makefile
> 
> and here is the result:
> http://frugalware.org/~vmiklos/docs/asciidoc/man/aspell.sh.3
> 
> if you like it then i would update /source/include/skel.sh and (with
> time) all the .shs, though probably it'll take some time (but preferably
> before rc2)
> 
> so what is documented is:
> - short description
> - an example
> - options
> - overwritten/appended variables
> - provided functions
> 
> anything else i've missed? :)
> 
> opinions? :)
> 
> udv / greetings,
> VMiklos

Looks great :)

-- 
Alex Smith
Frugalware Linux developer - http://www.frugalware.org