The R Project SVN R

Rev

Rev 59039 | Rev 63690 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 59039 Rev 61433
Line 39... Line 39...
39
  \item{index}{logical: should indices be prepared?}
39
  \item{index}{logical: should indices be prepared?}
40
}
40
}
41
\details{
41
\details{
42
  \code{texi2pdf} is a wrapper for the common case of
42
  \code{texi2pdf} is a wrapper for the common case of
43
  \code{texi2dvi(pdf = TRUE)}.
43
  \code{texi2dvi(pdf = TRUE)}.
44
  
44
 
45
  Despite the name, this is used in \R to compile LaTeX files,
45
  Despite the name, this is used in \R to compile LaTeX files,
46
  specifically those generated from vignettes.  It
46
  specifically those generated from vignettes.  It
47
  ensures that the \file{\var{\link{R_HOME}}/share/texmf} directory is
47
  ensures that the \file{\var{\link{R_HOME}}/share/texmf} directory is
48
  in the \env{TEXINPUTS} path, so \R style files such as \file{Sweave}
48
  in the \env{TEXINPUTS} path, so \R style files such as \file{Sweave}
49
  and \file{Rd} will be found.  The search path used is first the
49
  and \file{Rd} will be found.  The search path used is first the
50
  existing \env{TEXINPUTS} setting (or the current directory if unset),
50
  existing \env{TEXINPUTS} setting (or the current directory if unset),
51
  then elements of \code{texinputs}, then
51
  then elements of \code{texinputs}, then
52
  \file{\var{R_HOME}/share/texmf} and finally the default
52
  \file{\var{R_HOME}/share/texmf} and finally the default
53
  path.  Analogous changes are made to \env{BIBINPUTS} and
53
  path.  Analogous changes are made to \env{BIBINPUTS} and
54
  \env{BSTINPUTS} settings.
54
  \env{BSTINPUTS} settings.
55
  
55
 
56
  MiKTeX has a \code{texi2dvi} executable but no other Windows TeX
56
  MiKTeX has a \code{texi2dvi} executable but no other Windows TeX
57
  installation that we know of does, so emulation is used on e.g. TeXLive
57
  installation that we know of does, so emulation is used on e.g. TeXLive
58
  installations on Windows.
58
  installations on Windows.
59
  
59
 
60
  Occasionally indices contain special characters which cause indexing
60
  Occasionally indices contain special characters which cause indexing
61
  to fail (particularly when using the \samp{hyperref} LaTeX package)
61
  to fail (particularly when using the \samp{hyperref} LaTeX package)
62
  even on valid input.  The argument \code{index = FALSE} is provided to
62
  even on valid input.  The argument \code{index = FALSE} is provided to
63
  allow package manuals to be made when this happens: it uses emulation.
63
  allow package manuals to be made when this happens: it uses emulation.
64
}
64
}
Line 72... Line 72...
72
  spaces.
72
  spaces.
73
 
73
 
74
  The three possible approaches all have their quirks.  For example the
74
  The three possible approaches all have their quirks.  For example the
75
  Unix-alike \code{texi2dvi} script removes ancillary files that already
75
  Unix-alike \code{texi2dvi} script removes ancillary files that already
76
  exist but the other two approaches do not (and may get confused by
76
  exist but the other two approaches do not (and may get confused by
77
  such files). 
77
  such files).
78
}
78
}
79
\value{
79
\value{
80
  Invisible \code{NULL}.  Used for the side effect of creating a dvi or
80
  Invisible \code{NULL}.  Used for the side effect of creating a dvi or
81
  PDF file in the current working directory (and maybe other files,
81
  PDF file in the current working directory (and maybe other files,
82
  especially if \code{clean = FALSE}). 
82
  especially if \code{clean = FALSE}).
83
}
83
}
84
\author{
84
\author{
85
  Originally Achim Zeileis but largely rewritten by R-core.
85
  Originally Achim Zeileis but largely rewritten by R-core.
86
}
86
}
87
\keyword{utilities}
87
\keyword{utilities}