mirrors/dotnet-installer
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Update documentation (#3549)

Browse source 
* Updating README.md files as well as man pages

This aligns with the latest changes in the official documentation. It also aligns dotnet test readme.md to official docs and introduces a new doc in the "Documentation" directory that deals with dotnet test protocols.
This commit is contained in:
Zlatko Knezevic 2016-06-14 06:42:21 -07:00 • committed by GitHub
parent 18c8a2724a
commit 4da4f95e21
16 changed files with 971 additions and 404 deletions
Download patch file Download diff file Expand all files Collapse all files

96
Documentation/manpages/sdk/dotnet-run.1
View file

@ -1,46 +1,88 @@
.\" Automatically generated by Pandoc 1.15.1
.\"
.hy
.TH "dotnet-run" "1" "January 2016" "" ""
.SH NAME
.TH "DOTNET\-RUN" "1" "June 2016" "" ""
.SS NAME
.PP
dotnet\-run \-\- Runs source code \[aq]in\-place\[aq] without any
explicit compile or launch commands.
.SH SYNOPSIS
.SS SYNOPSIS
.PP
\f[C]dotnet\ run\ [\-\-verbose]\f[]
.SH DESCRIPTION
\f[C]dotnet\ run\ [\-\-framework]\ [\-\-configuration]\ \ \ \ \ [\-\-project]\ [\-\-help]\ [\-\-]\f[]
.SS DESCRIPTION
.PP
The run command provides a convenient option to run source code with one
command.
The \f[C]dotnet\ run\f[] command provides a convenient option to run
your application from the source code with one command.
It compiles source code, generates an output program and then runs that
program.
This command is useful for fast iterative development and can also be
used to run a source\-distributed program (e.g.
website).
used to run a source\-distributed program (for example, a website).
.PP
This command relies on \f[C]dotnet\-compile(1)\f[] to compile source
inputs to a .NET assembly, before launching the program.
The requirements for and handling of source inputs for this command are
all inherited from the compile command.
The documentation for the compile command provides more information on
This command relies on \f[C]dotnet\ build\f[] (dotnet-build.md) to build
source inputs to a .NET assembly, before launching the program.
The requirements for this command and the handling of source inputs are
all inherited from the build command.
The documentation for the build command provides more information on
those requirements.
.PP
Output files, are written to the child \f[C]bin\f[] folder, which will
be created if it doesn\[aq]t exist.
Output files are written to the child \f[C]bin\f[] folder, which will be
created if it doesn\[aq]t exist.
Files will be overwritten as needed.
Temporary files are written to the child \f[C]obj\f[] folder.
.SH OPTIONS
.PP
\-v, \-\-verbose
.IP
.nf
\f[C]
Prints\ verbose\ logging\ information,\ to\ follow\ the\ flow\ of\ execution\ of\ the\ command.
\f[]
.fi
.SH SEE ALSO
In case of a project with multiple specified frameworks,
\f[C]dotnet\ run\f[] will first select the .NET Core frameworks.
If those do not exist, it will error out.
To specify other frameworks, use the \f[C]\-\-framework\f[] argument.
.PP
dotnet\-compile(1), dotnet\-publish(1)
The \f[C]dotnet\ run\f[] command must be used in the context of
projects, not built assemblies.
If you\[aq]re trying to execute a DLL instead, you should use
\f[C]dotnet\f[] (dotnet.md) without any command like in the following
example:
.PP
\f[C]dotnet\ myapp.dll\f[]
.PP
For more information about the \f[C]dotnet\f[] driver, see the \&.NET
Core Command Line Tools (CLI) (overview.md) topic.
.SS OPTIONS
.PP
\f[C]\-\-\f[]
.PP
Delimits arguments to \f[C]dotnet\ run\f[] from arguments for the
application being run.
All arguments after this one will be passed to the application being
run.
.PP
\f[C]\-f\f[], \f[C]\-\-framework\f[] [FID]
.PP
Runs the application for a given framework identifier (FID).
.PP
\f[C]\-c\f[], \f[C]\-\-configuration\ [Debug|Release]\f[]
.PP
Configuration to use when publishing.
The default value is "Debug".
.PP
\f[C]\-p\f[], \f[C]\-\-project\ [PATH]\f[]
.PP
Specifies which project to run.
It can be a path to a project.json file or to a directory containing a
project.json file.
It defaults to current directory if not specified.
.SS EXAMPLES
.PP
\f[C]dotnet\ run\f[]
.PP
Runs the project in the current directory.
.PP
\f[C]dotnet\ run\ \-\-project\ /projects/proj1/project.json\f[]
.PP
Runs the project specified.
.PP
\f[C]dotnet\ run\ \-\-configuration\ Release\ \-\-\ \-\-help\f[]
.PP
Runs the project in the current directory.
The \f[C]\-\-help\f[] argument above is passed to the application being
run, since the \f[C]\-\-\f[] argument was used.
.SH AUTHORS
Zlatko Knezevic zlakne\@microsoft.com.
Microsoft Corporation dotnetclifeedback\@microsoft.com.