\HeaderA{dcf}{Read and Write Data in DCF Format}{dcf}
\aliasA{read.dcf}{dcf}{read.dcf}
\aliasA{write.dcf}{dcf}{write.dcf}
\keyword{print}{dcf}
\keyword{file}{dcf}
\begin{Description}\relax
Reads or writes an \R{} object from/to a file in Debian Control File format.
\end{Description}
\begin{Usage}
\begin{verbatim}
read.dcf(file, fields=NULL)
write.dcf(x, file = "", append = FALSE,
          indent = 0.1 * getOption("width"),
          width = 0.9 * getOption("width"))
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{file}] either a character string naming a file or a connection.
\code{""} indicates output to the console.  For \code{read.dcf} this
can name a \code{gzip}-compressed file.
\item[\code{fields}] Fields to read from the DCF file.  Default is to read all
fields.
\item[\code{x}] the object to be written, typically a data frame.  If not, it
is attempted to coerce \code{x} to a data frame.
\item[\code{append}] logical.  If \code{TRUE}, the output is appended to the
file.  If \code{FALSE}, any existing file of the name is destroyed.
\item[\code{indent}] a positive integer specifying the indentation for
continuation lines in output entries.
\item[\code{width}] a positive integer giving the target column for wrapping
lines in the output.
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
DCF is a simple format for storing databases in plain text files that
can easily be directly read and written by humans.  DCF is used in
various places to store \R{} system information, like descriptions and
contents of packages.

The DCF rules as implemented in \R{} are:
\Enumerate{
\item A database consists of one or more records, each with one or
more named fields. Not every record must contain each field, a
field may appear only once in a record.
\item Regular lines start with a non-whitespace character.
\item Regular lines are of form \code{tag:value}, i.e.,
have a name tag and a value for the field, separated
by \code{:} (only the first \code{:} counts). The value can be
empty (=whitespace only).
\item Lines starting with whitespace are continuation lines (to the
preceding field) if at least one character in the line is non-whitespace.
\item Records are separated by one or more empty (=whitespace only)
lines.
}

\code{read.dcf} returns a character matrix with one line per record
and one column per field. Leading and trailing whitespace of field
values is ignored. If a tag name is specified, but the corresponding
value is empty, then an empty string of length 0 is returned. If the
tag name of a fields is never used in a record, then \code{NA} is
returned.  If there are multiple records with the same tag name, the
last one encountered is returned.
\end{Details}
\begin{SeeAlso}\relax
\code{\LinkA{write.table}{write.table}}.
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
## Create a reduced version of the 'CONTENTS' file in package 'splines'
x <- read.dcf(file = system.file("CONTENTS", package = "splines"),
              fields = c("Entry", "Description"))
write.dcf(x)
\end{ExampleCode}
\end{Examples}

