aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/gmkin.Rd15
1 files changed, 14 insertions, 1 deletions
diff --git a/man/gmkin.Rd b/man/gmkin.Rd
index 29a4f8c..2677aa9 100644
--- a/man/gmkin.Rd
+++ b/man/gmkin.Rd
@@ -9,7 +9,20 @@
for an explanation how this toolkit works.
}
\usage{
- gmkin()
+ gmkin(script_name, show.log = FALSE)
+}
+\arguments{
+ \item{script_name}{
+ During development, a script name with a local working version
+ of gmkin can be passed. Defaults to the location of the gmkin.R script
+ shipped with the package.
+ }
+ \item{show.log}{
+ During development, it may be useful to see the log of the Rook apps.
+ }
+}
+\examples{
+ \dontrun{gmkin()} # Start the gmkin GUI
}
\value{
The function is called for its side effect, namely starting the GUI in a browser.

Contact - Imprint