| % File src/library/base/man/commandArgs.Rd |
| % Part of the R package, https://www.R-project.org |
| % Copyright 1995-2018 R Core Team |
| % Distributed under GPL 2 or later |
| |
| \name{commandArgs} |
| \alias{commandArgs} |
| \title{Extract Command Line Arguments} |
| \description{ |
| Provides access to a copy of the command line arguments supplied when |
| this \R session was invoked. |
| } |
| \usage{ |
| commandArgs(trailingOnly = FALSE) |
| } |
| \arguments{ |
| \item{trailingOnly}{logical. Should only arguments after |
| \option{--args} be returned?} |
| } |
| \details{ |
| These arguments are captured before the standard \R command line |
| processing takes place. This means that they are the unmodified |
| values. This is especially useful with the \option{--args} |
| command-line flag to \R, as all of the command line after that flag |
| is skipped. |
| } |
| \value{ |
| A character vector containing the name of the executable and the |
| user-supplied command line arguments. The first element is the name |
| of the executable by which \R was invoked. The exact form of this |
| element is platform dependent: it may be the fully qualified name, or |
| simply the last component (or basename) of the application, or for an |
| embedded \R it can be anything the programmer supplied. |
| |
| If \code{trailingOnly = TRUE}, a character vector of those arguments |
| (if any) supplied after \option{--args}. |
| } |
| \seealso{\code{\link{R.home}()}, \code{\link{Startup}} |
| #ifdef unix |
| and \code{\link{BATCH}} |
| #endif |
| } |
| \examples{ |
| commandArgs() |
| ## Spawn a copy of this application as it was invoked, |
| ## subject to shell quoting issues |
| ## system(paste(commandArgs(), collapse = " ")) |
| } |
| \keyword{environment} |
| \keyword{sysdata} |
| \keyword{programming} |