On 8/14/06, Martin Baehr <[EMAIL PROTECTED]> wrote: > On Mon, Aug 14, 2006 at 02:06:27PM +0200, Axel Liljencrantz wrote: > > You are not the first to comment on the fact that it feels weird that > > the shell launches new windows like this, and I agree. The reason why > > fish doesn't use man-pages is simple: hyperlinks. Having hyperlinks in > > the documentation enables the reader to quickly move between related > > subjects to find the section he/she is looking for, which I think is a > > very large benefit, bigger than all the associated downsides. > > how many hyperlinks are there in the builtin reference page? > i counted less than a dozend. there are man->html converters out there > that can turn manpage references into links, or other converters which > can generate man and html format from a common base (not sure if that's > docbook or something else)
A quick grep tells me the docs contain roughly 100 hyperlinks. Not a huge number, but enough to be a major advantage, IMO. > > > As Frederik pointed out, you can customize which browser is used using > > e.g. 'set -U BROWSER links', so this should not be a major problem. > > on some systems needing to install any browser could be a problem. > it is just another dependency, and that's not good for something > as important as documentation. (in some cases i could not even run man > and had to read the manpages from source, there i would have preferred a > real plaintext format. the simpler the better) Having manual pages for fish as well as the regular documentation seems like a good idea. The documentation is written in Doxygen, which is a semi-ugly mix of html-tags and TeX, looks a lot like e.g. JavaDoc. Not the best language to write the documentation in, but one of the advantages is that there actually is an option to create man-pages from the documentation. I accept patches... > > > This is documented in the help section for the help command, which can > > be found by typing 'help help'. > > which i could not see of course ;-) Oh, the irony. > > > This of course means that most of the time, fish has no idea what > > browser is used to display the help. I guess in that case, one simply > > writes 'help is being displayed in a window of your default browser' > > or something like that. > > i used: > echo "help is being displayed in a window of" $fish_browser > which tells me exactly what i want to know, namely which executable fish > has found for use. help is being displayed in x-www-browser is not helpful, IMO. I added this to help.fish: set -l browser_name $fish_browser switch $fish_browser case 'htmlview' 'x-www-browser' set browser_name (_ 'your default browser') end printf (_ 'help: Help is being displayed in %s\n') $browser_name The strange bits with '_' are for providing translations to other languages. > > greetings, martin. > -- > cooperative communication with sTeam - caudium, pike, roxen and unix > offering: programming, training and administration - anywhere in the world > -- > pike programmer travelling and working in europe open-steam.org > unix system- bahai.or.at iaeste.(tuwien.ac|or).at > administrator (caudium|gotpike).org is.schon.org > Martin Bähr http://www.iaeste.or.at/~mbaehr/ > -- Axel ------------------------------------------------------------------------- Using Tomcat but need to do more? Need to support web services, security? Get stuff done quickly with pre-integrated technology to make your job easier Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 _______________________________________________ Fish-users mailing list Fish-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/fish-users