\Header{prompt}{Produce Prototype of an \R Documentation File}
\alias{prompt.default}{prompt}
\keyword{documentation}{prompt}
\begin{Usage}
\begin{verbatim}
prompt(object, ...)

prompt.default(object,
    filename = paste(name, ".Rd", sep = ""),
    force.function = FALSE)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\texttt{object}] an \R\ object, typically a function
\item[\texttt{filename}] name of the output file
\item[\texttt{force.function}] treat \texttt{object} as function in any case
\end{ldescription}
\end{Arguments}
\begin{Description}
The main goal is to facilitate the constructing of files documenting R
functions.

An ASCII file \texttt{filename} is produced containing the proper
function and argument names of \texttt{object}.  You have to edit it
before adding the documentation to the source tree, i.e., (currently)
to \file{\$RHOME/src/library/base/man/}.\end{Description}
\begin{SeeAlso}
\texttt{\Link{help}} and the tutorial about writing \R\ documentation,
currently in the file \file{\$RHOME/doc/manual/writing-Rd.tex}.\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
prompt(plot.default)
prompt(interactive, force.f = TRUE)
\end{ExampleCode}
\end{Examples}

