Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mono/mono.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorAaron Bockover <abock@xamarin.com>2017-03-22 17:30:36 +0300
committerMarek Safar <marek.safar@gmail.com>2017-03-23 12:18:10 +0300
commit87bb2f581459a1118be7c049981d111b45fd7a8a (patch)
treec71f5806e38ecdf73108399a2b510aa4372397c3 /man
parent4ab98d81cde3d2606051b7190194889d1f13e7b8 (diff)
csharp: support command line arguments for scripts
This adds a command line argument preprocessor that splits command line arguments into two groups, delimited by the "standard" `--` "stop processing" argument, or by the `-s` argument which can be used with Unix shebang syntax (where the path of the file being executed will be appended to the command line specified on the shebang line). - anything before `--` or `-s` will be passed to mcs/csharp as usual - anything after `--` or `-s` will _not_ be processed by mcs/csharp, and will be made available in an `Args` builtin, like `csi` This _finally_ (after almost 10 years) allows `csharp` to be used for proper script authoring! Document the new arguments in the man page. Also remove references to 'gsharp' from the man page.
Diffstat (limited to 'man')
-rw-r--r--man/csharp.175
1 files changed, 57 insertions, 18 deletions
diff --git a/man/csharp.1 b/man/csharp.1
index a0f9e6f4f6a..430a1608968 100644
--- a/man/csharp.1
+++ b/man/csharp.1
@@ -2,31 +2,22 @@
.if t .sp .5v
.if n .sp
..
-.TH csharp 1 "4 September 2008"
+.TH csharp 1 "22 March 2017"
.SH NAME
-csharp, gsharp \- Interactive C# Shell
+csharp \- Interactive C# Shell and Scripting
.SH SYNOPSIS
.B csharp [--attach PID] [-e EXPRESSION] [file1 [file2]]
-[options]
-.P
-.B gsharp [file1 [file2]]
+[compiler-options] [--|-s script-options]
.SH DESCRIPTION
The
.I csharp
-is an interactive C# shell that allows the user to enter and evaluate
-C# statements and expressions from the command line. The regular
+command is an interactive C# shell and scripting host that allows
+the user to enter and evaluate C# statements and expressions from
+the command line or execute C# scripts.
+The regular
.I mcs
command line options can be used in this version of the compiler.
.PP
-The
-.I gsharp
-command is a GUI version of the C# interpreter that uses Gtk# and
-provides an area to attach widgets as well. This version can be
-attached to other Gtk# applications in a safe way as it injects itself
-into the main loop of a Gtk# application, avoiding any problems
-arising from the multi-threaded nature of injecting itself into a
-target process.
-.PP
Files specified in the command line will be loaded and executed as
scripts.
.PP
@@ -35,9 +26,31 @@ Starting with Mono 2.10, the
command can be used as an interpreter executed by executables flagged
with the Unix execute attribute. To do this, make the first line of
your C# source code look like this:
+.PP
.nf
-"#!/usr/bin/csharp"
-Console.WriteLine ("Hello, World");
+ #!/usr/bin/csharp
+ Console.WriteLine ("Hello, World");
+.fi
+.PP
+Starting with Mono 5.0, command line arguments may now be passed
+to the
+.I csharp
+command by specifying either the
+.I -s
+or
+.I --
+(script) options.
+.PP
+The
+.I -s
+option is ideal for interpreting executable scripts that utilize
+shebang syntax (introduced in Mono 2.10). This allows command line
+arguments to be passed to and consumed cleanly by the script:
+.PP
+.nf
+ #!/usr/bin/csharp -s
+ foreach (var arg in Args)
+ Console.WriteLine ($"script argument: {arg}");
.fi
.SH OPTIONS
The commands accept all of the commands that are available to the
@@ -45,6 +58,23 @@ The commands accept all of the commands that are available to the
command, so you can reference assemblies, specify paths, language
level and so on from the command line. In addition, the following
command line options are supported:
+.TP
+.I "\-s" SCRIPT_FILE
+This option is ideal for authoring executable scripts that utilize
+the Unix shebang feature. Unix will implicitly append as an argument
+the path of the script to execute. When the executable is invoked,
+any arguments then passed to it will be available in the
+.I Args
+global. Example:
+.I "#!/usr/bin/env csharp -s"
+.TP
+.I "\-\-"
+Any arguments that follow will not be passed to the compiler driver,
+and instead will be made available in the
+.I Args
+global. Example:
+.I csharp -- a b c
+will result in Args = { "a", "b", "c" } in the interactive shell.
.TP
.I "\-\-attach"
This is an advanced option and should only be used if you have a deep
@@ -290,6 +320,15 @@ statements and expressions are executed are static, they can be
invoked directly from the shell. These are the available properties
and methods:
.TP
+.I Args
+An easy to consume array of any arguments specified after either
+.I -s
+or
+.I --
+on the command line. Ideal for self-executing scripts utilizing the
+.I -s
+option.
+.TP
.I void LoadAssembly(string assembly)
Loads the given assembly. This is equivalent to passing the compiler
the -r: flag with the specified string.