diff options
Diffstat (limited to 'documentation/make_header')
| -rwxr-xr-x | documentation/make_header | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/documentation/make_header b/documentation/make_header index 44af365dc..a8909b85a 100755 --- a/documentation/make_header +++ b/documentation/make_header @@ -8,12 +8,16 @@ # # Usage: # -# $ sh make_header input-file output-file +# $ sh make_header doxygen_path input-file output-file # -# where 'input-file' is the pure (LaTeX) title page (template) -# and 'output-file' is the generated (LaTeX) title page (template) -# to be used by `make' or `cmake` to generate the final LaTeX page -# header (combined doxygen template + FLTK title page). +# where +# - 'doxygen_path' is the full path to the doxygen executable +# or just 'doxygen'. If the full path is used an arbitrary +# doxygen executable and thus doxygen version can be used. +# - 'input-file' is the pure (LaTeX) title page (template) +# - 'output-file' is the generated (LaTeX) title page (template) +# that is used by `make' or `cmake` to generate the final LaTeX +# page header (combined doxygen template + FLTK title page). # #======================================================================= # This script requires a posix shell and uses the following commands: @@ -21,8 +25,9 @@ #======================================================================= # input and output file names -FLTK_HEAD="$1" -DOXY_HEAD="$2" +DOXY_CMD="$1" +FLTK_HEAD="$2" +DOXY_HEAD="$3" # temp file DOXY_TEMP="doxy-header.tex.$$" @@ -43,7 +48,7 @@ fi # with our PDF document title page (LaTeX code) and write the # result to $DOXY_HEAD. -doxygen -w latex $DOXY_TEMP /dev/null /dev/null +$DOXY_CMD -w latex $DOXY_TEMP /dev/null /dev/null # combine three parts of these files to the output file # using '( ... ) > $DOXY_HEAD' to write (concatenate) |