File: findGhostscript.System.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (65 lines) | stat: -rw-r--r-- 2,029 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  System.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{System$findGhostscript}
\alias{System$findGhostscript}
\alias{findGhostscript.System}
\alias{System.findGhostscript}
\alias{findGhostscript,System-method}

\title{Searches for a Ghostview executable on the current system}

\description{
  Searches for a Ghostview executable on the current system.
}

\usage{
## Static method (use this):
## System$findGhostscript(updateRGSCMD=TRUE, firstOnly=TRUE, force=FALSE, ...)

## Don't use the below:
\method{findGhostscript}{System}(static, updateRGSCMD=TRUE, firstOnly=TRUE, force=FALSE, ...)
}

\arguments{
  \item{updateRGSCMD}{If \code{\link[base:logical]{TRUE}} and Ghostscript is found, then the system
    environment variable \code{\link[base]{R_GSCMD}} is set to the (first) path
    found.}
  \item{firstOnly}{If \code{\link[base:logical]{TRUE}}, only the first executable is returned.}
  \item{force}{If \code{\link[base:logical]{TRUE}}, existing \code{\link[base]{R_GSCMD}} is ignored,
    otherwise not.}
  \item{...}{Not used.}
}


\value{
  Returns a \code{\link[base]{character}} \code{\link[base]{vector}} of full and normalized pathnames
  where Ghostscript executables are found.
}

\examples{\dontrun{
  print(System$findGhostscript())
}}

\author{Henrik Bengtsson}

\references{
 [1] \emph{How to use Ghostscript}, Ghostscript, 2022
     \url{https://ghostscript.com/docs/9.55.0/Use.htm}\cr
 [2] \emph{Environment variable}, Wikipedia, 2013.
     \url{https://en.wikipedia.org/wiki/Environment_variable}\cr
 [3] \emph{Environment.SpecialFolder Enumeration},
     Microsoft, 2013.
     \url{https://learn.microsoft.com/en-us/dotnet/api/system.environment.specialfolder}\cr
}

\seealso{
  For more information see \code{\link{System}}.
}
\keyword{internal}
\keyword{methods}