The R Project SVN R

Rev

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

Rev 70779 Rev 75205
Line 1... Line 1...
1 
% File src/library/utils/man/edit.Rd
 1 
% File src/library/utils/man/edit.Rd
2 
% Part of the R package, https://www.R-project.org
 2 
% Part of the R package, https://www.R-project.org
3 
% Copyright 1995-2014 R Core Team
 3 
% Copyright 1995-2018 R Core Team
4 
% Distributed under GPL 2 or later
 4 
% Distributed under GPL 2 or later
5 
 
 5 
 
6 
\name{edit}
 6 
\name{edit}
7 
\alias{edit}
 7 
\alias{edit}
8 
\alias{edit.default}
 8 
\alias{edit.default}
Line 28... Line 28...
28 
\arguments{
 28 
\arguments{
29 
  \item{name}{a named object that you want to edit. If name is missing
 29 
  \item{name}{a named object that you want to edit. If name is missing
30 
    then the file specified by \code{file} is opened for editing.}
 30 
    then the file specified by \code{file} is opened for editing.}
31 
  \item{file}{a string naming the file to write the edited version to.}
 31 
  \item{file}{a string naming the file to write the edited version to.}
32 
  \item{title}{a display name for the object being edited.}
 32 
  \item{title}{a display name for the object being edited.}
33 
  \item{editor}{usually a string naming the text editor you want to use.
 33 
  \item{editor}{usually a character string naming (or giving the path
34 
    On Unix the default is set from the environment variables
 34 
    to) the text editor you want to use.  On Unix the default is set from
35 
    \env{EDITOR} or \env{VISUAL} if either is set, otherwise \code{vi}
 35 
    the environment variables \env{EDITOR} or \env{VISUAL} if either is
36 
    is used.  On Windows it defaults to \code{"internal"}, the script
 36 
    set, otherwise \code{vi} is used.  On Windows it defaults to
37 
    editor.  On the macOS GUI the argument is ignored and the document
 37 
    \code{"internal"}, the script editor.  On the macOS GUI the argument
38 
    editor is always used.
 38 
    is ignored and the document editor is always used.
39 
 
 39 
 
40 
    \code{editor} can also be a function, in which case it is called
 40 
    \code{editor} can also be an \R function, in which case it is called
41 
    with the arguments \code{name}, \code{file}, and \code{title}.  Note
 41 
    with the arguments \code{name}, \code{file}, and \code{title}.  Note
42 
    that such a function will need to independently implement all
 42 
    that such a function will need to independently implement all
43 
    desired functionality.
 43 
    desired functionality.
44 
  }
 44 
  }
45 
  \item{\dots}{further arguments to be passed to or from methods.}
 45 
  \item{\dots}{further arguments to be passed to or from methods.}