File: parseDebian.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 (57 lines) | stat: -rw-r--r-- 1,675 bytes parent folder | download | duplicates (5)
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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% 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$parseDebian}
\alias{System$parseDebian}
\alias{parseDebian.System}
\alias{System.parseDebian}
\alias{parseDebian,System-method}

\title{Parses a string, file or connection for Debian formatted parameters}

\usage{
## Static method (use this):
## System$parseDebian(text=NULL, file=NULL, keys=NULL, ...)

## Don't use the below:
\method{parseDebian}{System}(this, text=NULL, file=NULL, keys=NULL, ...)
}

\arguments{
  \item{text}{The text to be parsed. Default value is \code{\link[base]{NULL}}.}
  \item{file}{Name file, a \code{File} object or connection to be parsed.
    Default value is \code{\link[base]{NULL}}.}
  \item{keys}{The keys (names of the parameters) to be retrieved.
    If \code{\link[base]{NULL}} all fields are returned. Default value is \code{\link[base]{NULL}}.}

 Either, \code{text} or \code{file} must be given.
}

\description{
  Parses a text, file or a connection for Debian formatted parameters.
  A file in Debian format contains rows with parameters of the form
  \code{KEY=VALUE}. It is allowed to have duplicated keys.
}

\value{
  Returns a named \code{\link[base]{list}} of parameter values.
}

\examples{
 file <- file.path(Package("R.utils")$path, "DESCRIPTION")
 l <- System$parseDebian(file=file)
 print(l)
}

\author{Henrik Bengtsson}

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