dotnet-installer/Documentation/manpages/dotnet.1
2016-01-06 19:21:36 -08:00

160 lines
3.1 KiB
Groff

.\" Automatically generated by Pandoc 1.15.1
.\"
.hy
.TH "dotnet-cli" "1" "January 2016" "" ""
.SH NAME
.PP
dotnet \-\- general driver for running the command\-line commands
.SH SYNOPSIS
.PP
dotnet [\-\-version] [\-\-help] [\-\-verbose] < command > [< args >]
.SH DESCRIPTION
.PP
dotnet is a generic driver for the CLI toolchain.
Invoked on its own, it will give out brief usage instructions.
.PP
Each specific feature is implemented as a command.
In order to use the feature, it is specified after dotnet, i.e.
\f[C]dotnet\ compile\f[].
All of the arguments following the command are command\[aq]s own
arguments.
.SH OPTIONS
.PP
\f[C]\-v,\ \-\-verbose\f[]
.IP
.nf
\f[C]
Enable\ verbose\ output.
\f[]
.fi
.PP
\f[C]\-\-version\f[]
.IP
.nf
\f[C]
Print\ out\ the\ version\ of\ the\ CLI\ tooling
\f[]
.fi
.PP
\f[C]\-h,\ \-\-help\f[]
.IP
.nf
\f[C]
Print\ out\ a\ short\ help\ and\ a\ list\ of\ current\ commands.\
\f[]
.fi
.SH DOTNET COMMANDS
.PP
The following commands exist for dotnet.
.PP
\f[C]dotnet\-compile(1)\f[]
.IP
.nf
\f[C]
Compile\ the\ application\ to\ either\ an\ intermidiate\ language\ (IL)\ or\ to\ a\ native\ binary.\
\f[]
.fi
.PP
\f[C]dotnet\-restore(1)\f[]
.IP
.nf
\f[C]
Restores\ the\ dependencies\ for\ a\ given\ application.\
\f[]
.fi
.PP
\f[C]dotnet\-run(1)\f[]
.IP
.nf
\f[C]
Runs\ the\ application\ from\ source.
\f[]
.fi
.PP
\f[C]dotnet\-publish(1)\f[]
.IP
.nf
\f[C]
Publishes\ a\ flat\ directory\ that\ contains\ the\ application\ and\ its\ dependencies,\ including\ the\ runtime\ binaries.\
\f[]
.fi
.PP
\f[C]dotnet\-test(1)\f[]
.IP
.nf
\f[C]
Runs\ tests\ using\ a\ test\ runner\ specified\ in\ project.json.
\f[]
.fi
.PP
\f[C]dotnet\-new(1)\f[]
.IP
.nf
\f[C]
Initializes\ a\ sample\ .NET\ Core\ console\ application.\
\f[]
.fi
.SH EXAMPLES
.PP
\f[C]dotnew\ new\f[]
.IP
.nf
\f[C]
Initializes\ a\ sample\ .NET\ Core\ console\ application\ that\ can\ be\ compiled\ and\ ran.
\f[]
.fi
.PP
\f[C]dotnet\ restore\f[]
.IP
.nf
\f[C]
Restores\ dependencies\ for\ a\ given\ application.\
\f[]
.fi
.PP
\f[C]dotnet\ compile\f[]
.IP
.nf
\f[C]
Compiles\ the\ application\ in\ a\ given\ directory.\
\f[]
.fi
.SH ENVIRONMENT
.PP
\f[C]DOTNET_HOME\f[]
.IP
.nf
\f[C]
Points\ to\ the\ base\ directory\ that\ contains\ the\ runtime\ and\ the\ binaries\ directories.\ The\ runtime\ will\ be\ used\ to\ run\ the\ executable\ file\ that\ is\ dropped\ after\ compiling.\ Not\ needed\ for\ native\ compilation.\ \
\f[]
.fi
.PP
\f[C]DOTNET_PACKAGES\f[]
.IP
.nf
\f[C]
The\ primary\ package\ cache.\ If\ not\ set,\ defaults\ to\ $HOME/.nuget/packages\ on\ Unix\ or\ %LOCALAPPDATA%\\NuGet\\Packages\ (TBD)\ on\ Windows.
\f[]
.fi
.PP
\f[C]DOTNET_PACKAGES_CACHE\f[]
.IP
.nf
\f[C]
The\ secondary\ cache.\ This\ is\ used\ by\ shared\ hosters\ (such\ as\ Azure)\ to\ provide\ a\ cache\ of\ pre\-downloaded\ common\ packages\ on\ a\ faster\ disk.\ If\ not\ set\ it\ is\ not\ used.
\f[]
.fi
.PP
\f[C]DOTNET_SERVICING\f[]
.IP
.nf
\f[C]
Specifies\ the\ location\ of\ the\ servicing\ index\ to\ use\ by\ the\ shared\ host\ when\ loading\ the\ runtime.\
\f[]
.fi
.SH SEE ALSO
.PP
dotnet\-compile(1), dotnet\-run(1), dotnet\-publish(1),
dotnet\-restore(1)
.SH AUTHORS
Zlatko Knezevic zlakne\@microsoft.com.