#! /bin/sh ## Rd2dvi -- Convert man pages (*.Rd help files) via LaTeX to DVI/PDF. ## ## Examples: ## R CMD Rd2dvi /path/to/Rsrc/src/library/base/man/Normal.Rd ## R CMD Rd2dvi `grep -l "\\keyword{distr" \ ## /path/to/Rsrc/src/library/base/man/*.Rd | sort | uniq` revision='$Revision: 1.33.4.3 $' version=`set - ${revision}; echo ${2}` version="Rd2dvi ${version} Copyright (C) 2000-2001 The R Core Development Team. This is free software; see the GNU General Public Licence version 2 or later for copying conditions. There is NO warranty." usage="Usage: R CMD Rd2dvi [options] files Generate DVI (or PDF) output from the Rd sources specified by files, by either giving the paths to the files, or the path to a directory with the sources of a package. Options: -h, --help print short help message and exit -v, --version print version info and exit --debug turn on shell debugging (set -x) --no-clean do not remove created temporary files --no-preview do not preview generated output file --os=NAME use OS subdir \`NAME' (unix, mac or windows) --OS=NAME the same as \`--os' -o, --output=FILE write output to FILE --pdf generate PDF output --title=NAME use NAME as the title of the document -V, --verbose report on what is done Report bugs to ." TEXINPUTS=.:${R_HOME}/share/texmf:${TEXINPUTS} export TEXINPUTS start_dir=`pwd` clean=true debug=false out_ext="dvi" output="" preview=xdvi verbose=false OSdir=${R_OSTYPE-"unix"} ## Need a `safe' echo which does not interpret backslash-escaped ## characters in SysV style. echo="sh ${R_HOME}/share/sh/echo.sh" while test -n "${1}"; do case ${1} in -h|--help) ${echo} "${usage}"; exit 0 ;; -v|--version) ${echo} "${version}"; exit 0 ;; --debug) debug=true ;; --no-clean) clean=false ;; --no-preview) preview=false ;; --pdf) out_ext="pdf"; preview=false; R_RD4DVI=${R_RD4PDF-"ae,hyper"}; R_LATEXCMD=${PDFLATEX-pdflatex} ;; --title=*) title=`echo "${1}" | sed -e 's/[^=]*=//'` ;; -o) if test -n "`echo ${2} | sed 's/^-.*//'`"; then output="${2}"; shift else ${echo} "ERROR: option \`${1}' requires an argument" exit 1 fi ;; --output=*) output=`echo "${1}" | sed -e 's/[^=]*=//'` ;; --OS=*|--os=*) OSdir=`echo "${1}" | sed -e 's/[^=]*=//'` ;; -V|--verbose) verbose=${echo} ;; --|*) break ;; esac shift done if test -z "${output}"; then output=Rd2.${out_ext} fi if ${debug}; then set -x; fi . ${R_HOME}/share/sh/dcf.sh # get_dcf_field() Rdconv_dir_or_files_to_LaTeX () { ## Convert Rd files in a dir or a list of Rd files to LaTeX, appending ## the result to OUTFILE. ## Usage: ## Rdconv_dir_or_files_to_LaTeX OUTFILE DIR ## Rdconv_dir_or_files_to_LaTeX OUTFILE FILES ${verbose} $@ out="${1}" shift if test -d ${1}; then files=`ls ${1}/*.[Rr]d` if test -d ${1}/${OSdir}; then files="${files} `ls ${1}/${OSdir}/*.[Rr]d`" fi files=`LC_ALL=C ${echo} ${files} | sort` else files="${@}" fi echo "Converting Rd files to LaTeX ..." for f in ${files}; do ${echo} ${f} ${R_CMD} Rdconv -t latex ${f} >> ${out} done } Rd_DESCRIPTION_to_LaTeX () { ## Typeset the contents of a DESCRIPTION file in a LaTeX description ## list. ## Usage: ## Rd_DESCRIPTION_to_LaTeX FILE fields=`sed '/^[ ]/d; s/^\([^:]*\):.*$/\1/' $1` ${echo} "\\begin{description}" ${echo} "\\raggedright{}" for f in `${echo} "${fields}" | sed '/Package/d; /Bundle/d;'`; do text=`get_dcf_field ${f} ${1}` ${echo} "\\item[${f}] \\AsIs{${text}}" done ${echo} "\\end{description}" } is_bundle=no is_base_package=no file_sed='s/[_$]/\\&/g' toc="\\Rdcontents{\\R{} topics documented:}" if test -d "${1}"; then if test -f ${1}/DESCRIPTION; then if test -n "`grep '^Bundle:' ${1}/DESCRIPTION`"; then echo "Hmm ... looks like a package bundle" is_bundle=yes bundle_name=`get_dcf_field Bundle "${1}/DESCRIPTION"` bundle_pkgs=`get_dcf_field Contains "${1}/DESCRIPTION"` title=${title-"Bundle \`${bundle_name}'"} else echo "Hmm ... looks like a package" package_name=`get_dcf_field Package "${1}/DESCRIPTION"` title=${title-"Package \`${package_name}'"} dir=${1}/man fi elif test -f ${1}/DESCRIPTION.in && \ test -n "`grep '^Priority: *base' ${1}/DESCRIPTION.in`"; then is_base_package=yes echo "Hmm ... looks like a package from the R distribution" package_name=`get_dcf_field Package "${1}/DESCRIPTION.in"` title=${title-"Package \`${package_name}'"} dir=${1}/man else if test -d ${1}/man; then dir=${1}/man else dir=${1} fi subj0=`${echo} ${dir} | sed -e ${file_sed}` subj="all in \\file{${subj0}}" fi else if test ${#} -gt 1 ; then subj=" etc."; else subj= toc= fi subj0=`${echo} ${1} | sed -e ${file_sed}` subj="\\file{${subj0}}${subj}" fi title=${title-"\\R{} documentation}} \\par\\bigskip{{\\Large of ${subj}"} ## Prepare for building the documentation. if test -f ${output}; then ${echo} "file \`${output}' exists; please remove first" exit 1 fi build_dir=.Rd2dvi${$} if test -d ${build_dir}; then rm -rf ${build_dir} || echo "cannot write to build dir" && exit 2 fi mkdir ${build_dir} ## Rd2.tex part 1: header cat > ${build_dir}/Rd2.tex <> ${build_dir}/Rd2.tex <> ${build_dir}/Rd2.tex fi if test "${is_base_package}" = yes; then R_version=unknown if test -f ${1}/../../../VERSION; then R_version=`cat ${1}/../../../VERSION` fi Rd_DESCRIPTION_to_LaTeX ${1}/DESCRIPTION.in | \ sed "s/@VERSION@/${R_version}/" >> ${build_dir}/Rd2.tex fi else cat >> ${build_dir}/Rd2.tex <> ${build_dir}/Rd2.tex cat >> ${build_dir}/Rd2.tex <> ${build_dir}/Rd2.tex Rdconv_dir_or_files_to_LaTeX ${build_dir}/Rd2.tex ${dir-${@}} else cat >> ${build_dir}/Rd2.tex <> ${build_dir}/Rd2.tex if test -f ${1}/${p}/DESCRIPTION.in; then Rd_DESCRIPTION_to_LaTeX ${1}/${p}/DESCRIPTION.in \ >> ${build_dir}/Rd2.tex fi Rdconv_dir_or_files_to_LaTeX ${build_dir}/Rd2.tex ${1}/${p}/man ${echo} "\\clearpage{}" >> ${build_dir}/Rd2.tex done ${echo} "\\cleardoublepage{}" >> ${build_dir}/Rd2.tex fi ## Rd2.tex part 3: footer cat >> ${build_dir}/Rd2.tex <