The code that takes fish documentation and turns it into help output
has been redone a bit.

It's still using Doxygen to generate roff markup as the first step.
(roff is the markup language used by man pages, so we are generating
man pages)

Previously, fish used the nroff command while building fish to convert
the man pages into text output, simplified the output using the col
command, and then saved those prerendered pages inside the fish
binary.

Now, fish installs the roff markup in separate files, and when a help
page is needed, nroff is called to generate the help page. Rendering a
halpe page is done using the __fish_print_help shellscript function.

Advantages:

* nroff output does not always seem to be terminal independant, it can
contain sequences for setting terminal color. Previously fish used the
col command to strip away such sequences, but this did not always
work. The latest nroff verion on gentoo left stray characters.
* shellscript functions like vared, alias and continue can display
their help pages instead of launching the help browser, like they used
to do.
* If anyone wants to translate the help pages to new languages, it
will be much easier to handle.
* New nroff versions can use color support to make the help pages look cooler.

Not the most exciting change in the world, but it was a bit lame that
calling 'vared --help' would launch the help browser. No more. As
usual, patch is in the darcs tree.

-- 
Axel

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Fish-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/fish-users

Reply via email to