How to generate man pages for Torque code under Linux using DOxygen
by Benoit Touchette · 11/24/2004 (6:00 pm) · 3 comments
Download Code File
Requirements: DOXgyen 1.3.7 or higher, Cfg file, Torque code.
Steps
- create a directory called doc in your source tree (top level)
- download the cfg to the doc directory we just created
- run doxgen command. ie.
doxygen doc/doxygen.man.cfg
- switch the root user. ie running 'su' should do :)
- You should now have a directory called documentation/man/man9.
move this man9 directory to either /usr/local/man or /usr/man. ie
mv documentation/man/man9 /usr/local/man/
- enjoy your new found freedom by not searching for information in related files
but by doing 'man XXXX' as you would other commands or library functions libc,
GL, etc. ie.
man AIPlayer
Requirements: DOXgyen 1.3.7 or higher, Cfg file, Torque code.
Steps
- create a directory called doc in your source tree (top level)
- download the cfg to the doc directory we just created
- run doxgen command. ie.
doxygen doc/doxygen.man.cfg
- switch the root user. ie running 'su' should do :)
- You should now have a directory called documentation/man/man9.
move this man9 directory to either /usr/local/man or /usr/man. ie
mv documentation/man/man9 /usr/local/man/
- enjoy your new found freedom by not searching for information in related files
but by doing 'man XXXX' as you would other commands or library functions libc,
GL, etc. ie.
man AIPlayer
About the author
#2
11/26/2004 (3:59 pm)
Thanks Benoit, good for people to know. 
#3
Make the directory "./doc/doxygen/man" and put the .cfg file in there.
Now edit the toplevel Makefile and add the following under the "php_docs:" section.
Now you can do:
You'll still have to copy/symlink the manfiles wherever you want them to be though. This just cleans up the making process a bit.
I also edited the .cfg a bit... here's the diff output:
05/01/2005 (9:23 pm)
Just thought I'd add what I did to get this working with the makefiles...Make the directory "./doc/doxygen/man" and put the .cfg file in there.
Now edit the toplevel Makefile and add the following under the "php_docs:" section.
man_docs:
# Assumes Doxygen is in your path
@doxygen doc/doxygen/man/doxygen.man.cfgNow you can do:
make man_docs
You'll still have to copy/symlink the manfiles wherever you want them to be though. This just cleans up the making process a bit.
I also edited the .cfg a bit... here's the diff output:
@@ -116 +116 @@ -STRIP_FROM_PATH = c:/torque/ +STRIP_FROM_PATH = @@ -443,0 +444 @@ + */.svn/* \ @@ -695 +696 @@ -LATEX_CMD_NAME = c:\wtools\texmf\miktex\bin\latex +LATEX_CMD_NAME = /usr/bin/latex @@ -701 +702 @@ -MAKEINDEX_CMD_NAME = c:\wtools\texmf\miktex\bin\makeindex +MAKEINDEX_CMD_NAME = /usr/bin/makeindex @@ -1097 +1098 @@ -DOT_PATH = "c:\Program Files\ATT\Graphviz\bin" +DOT_PATH = ""
Torque Owner Jerry Shaw
Roaming Gamer LLC