Difference between revisions of "Help plugin"
From Code::Blocks
Line 1: | Line 1: | ||
− | + | == General == | |
+ | |||
{{Infobox_Plugin| | {{Infobox_Plugin| | ||
name = Help | | name = Help | | ||
Line 8: | Line 9: | ||
}} | }} | ||
− | [[ | + | [[Image:Man01.png|right|thumb|Help File view]] |
− | + | == Add New Help Files == | |
+ | * Open the help dialog ''Settings->Environmanet->Help Files'' and hit ''Add''. | ||
+ | * Enter a name for the help files you want to add | ||
+ | * Select one of the below listened methods to add new help files and enter the url, command or whatever is shown below into the textentry box. | ||
+ | == Formats == | ||
+ | === Man Pages === | ||
In recent nightly snapshots the help plugin has been greatly enhanced to support MAN pages, too. On Linux they are usually installed anyway, for Windows you might want to download them e.g. from here: http://www.win.tue.nl/~aeb/linux/man | In recent nightly snapshots the help plugin has been greatly enhanced to support MAN pages, too. On Linux they are usually installed anyway, for Windows you might want to download them e.g. from here: http://www.win.tue.nl/~aeb/linux/man | ||
+ | |||
+ | man:/usr/share/man | ||
+ | |||
+ | === HTTP Sites === | ||
+ | http://www.google.de/search?hl=de&q=$(keyword)&btnG=Google-Suche&meta= | ||
+ | |||
+ | === CHM Files === | ||
+ | You can find c++ chm help files at: http://onnerby.se/~daniel/chm/ | ||
+ | Just add them via the dialog | ||
+ | For Linux you have to install a chm viewer to be able to open chm files. There are severals like gnochm, kchmviewer, xchm and so on. | ||
+ | |||
+ | === Custom Commands === | ||
+ | firefox file:///<envvar>/html/$(keyword).html | ||
+ | |||
+ | == Links == | ||
+ | * [[Using yelp as a help viewer]] | ||
+ | * [[Using devhelp as a help viewer]] | ||
+ | |||
+ | |||
+ | [[Category:Code::Blocks Contrib Plugins]] |
Revision as of 10:05, 15 November 2008
General
Help
Developer(s): | Paúl Andrés Jiménez |
Maintainer(s): | Paúl Andrés Jiménez |
Version: |
Add New Help Files
- Open the help dialog Settings->Environmanet->Help Files and hit Add.
- Enter a name for the help files you want to add
- Select one of the below listened methods to add new help files and enter the url, command or whatever is shown below into the textentry box.
Formats
Man Pages
In recent nightly snapshots the help plugin has been greatly enhanced to support MAN pages, too. On Linux they are usually installed anyway, for Windows you might want to download them e.g. from here: http://www.win.tue.nl/~aeb/linux/man
man:/usr/share/man
HTTP Sites
http://www.google.de/search?hl=de&q=$(keyword)&btnG=Google-Suche&meta=
CHM Files
You can find c++ chm help files at: http://onnerby.se/~daniel/chm/ Just add them via the dialog For Linux you have to install a chm viewer to be able to open chm files. There are severals like gnochm, kchmviewer, xchm and so on.
Custom Commands
firefox file:///<envvar>/html/$(keyword).html