Remove documentation that lives in dotnet/cli repo
This commit is contained in:
Nick Guerrera
parent
46f0cbfd76
commit
7dc5587e9c
6 changed files with 0 additions and 374 deletions
|
|
@ -1,10 +0,0 @@
|
|||
ASP.NET Core Command Line Tools
|
||||
===============================
|
||||
|
||||
The .NET Core CLI includes some commands that are specific to ASP.NET Core projects.
|
||||
|
||||
- dotnet dev-certs
|
||||
- dotnet user-secrets
|
||||
- dotnet sql-cache
|
||||
|
||||
For more information on these tools, see <https://github.com/aspnet/DotNetTools>.
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
.\" Automatically generated by Pandoc 2.2.1
|
||||
.\"
|
||||
.TH "dotnet build\-server command \- .NET Core CLI" "1" "" "" ".NET Core"
|
||||
.hy
|
||||
.SH dotnet\-build
|
||||
.PP
|
||||
.SH NAME
|
||||
.PP
|
||||
\f[C]dotnet\ build\-server\f[] \- Interacts with servers started by a build.
|
||||
.SH SYNOPSIS
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
dotnet\ build\-server\ shutdown\ [\-\-msbuild]\ [\-\-razor]\ [\-\-vbcscompiler]
|
||||
dotnet\ build\-server\ shutdown\ [\-h|\-\-help]
|
||||
dotnet\ build\-server\ [\-h|\-\-help]
|
||||
\f[]
|
||||
.fi
|
||||
.SS Commands
|
||||
.PP
|
||||
\f[C]shutdown\f[]
|
||||
.PP
|
||||
Shuts down build servers that are started from dotnet.
|
||||
By default, all servers are shut down.
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\f[C]\-h|\-\-help\f[]
|
||||
.PP
|
||||
Prints out a short help for the command.
|
||||
.PP
|
||||
\f[C]\-\-msbuild\f[]
|
||||
.PP
|
||||
Shuts down the MSBuild build server.
|
||||
.PP
|
||||
\f[C]\-\-razor\f[]
|
||||
.PP
|
||||
Shuts down the Razor build server.
|
||||
.PP
|
||||
\f[C]\-\-vbcscompiler\f[]
|
||||
.PP
|
||||
Shuts down the VB/C# compiler build server.
|
||||
.SH AUTHORS
|
||||
mairaw.
|
||||
|
|
@ -1,116 +0,0 @@
|
|||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.2.1
|
||||
.\"
|
||||
.TH "dotnet tool install command \- .NET Core CLI" "1" "" "" ".NET Core"
|
||||
.hy
|
||||
.SH dotnet tool install
|
||||
.PP
|
||||
.SH NAME
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ install\f[] \- Installs the specified .NET Core Global Tool on your machine.
|
||||
.SH SYNOPSIS
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
dotnet\ tool\ install\ <PACKAGE_NAME>\ <\-g|\-\-global>\ [\-\-add\-source]\ [\-\-configfile]\ [\-\-framework]\ [\-v|\-\-verbosity]\ [\-\-version]
|
||||
dotnet\ tool\ install\ <PACKAGE_NAME>\ <\-\-tool\-path>\ [\-\-add\-source]\ [\-\-configfile]\ [\-\-framework]\ [\-v|\-\-verbosity]\ [\-\-version]
|
||||
dotnet\ tool\ install\ <\-h|\-\-help>
|
||||
\f[]
|
||||
.fi
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \f[C]dotnet\ tool\ install\f[] command provides a way for you to install .NET Core Global Tools on your machine.
|
||||
To use the command, you either have to specify that you want a user\-wide installation using the \f[C]\-\-global\f[] option or you specify a path to install it using the \f[C]\-\-tool\-path\f[] option.
|
||||
.PP
|
||||
Global Tools are installed in the following directories by default when you specify the \f[C]\-g\f[] (or \f[C]\-\-global\f[]) option:
|
||||
.PP
|
||||
.TS
|
||||
tab(@);
|
||||
l l.
|
||||
T{
|
||||
OS
|
||||
T}@T{
|
||||
Path
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Linux/macOS
|
||||
T}@T{
|
||||
\f[C]$HOME/.dotnet/tools\f[]
|
||||
T}
|
||||
T{
|
||||
Windows
|
||||
T}@T{
|
||||
\f[C]%USERPROFILE%\\.dotnet\\tools\f[]
|
||||
T}
|
||||
.TE
|
||||
.SS Arguments
|
||||
.PP
|
||||
\f[C]PACKAGE_NAME\f[]
|
||||
.PP
|
||||
Name/ID of the NuGet package that contains the .NET Core Global Tool to install.
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\f[C]\-\-add\-source\ <SOURCE>\f[]
|
||||
.PP
|
||||
Adds an additional NuGet package source to use during installation.
|
||||
.PP
|
||||
\f[C]\-\-configfile\ <FILE>\f[]
|
||||
.PP
|
||||
The NuGet configuration (\f[I]nuget.config\f[]) file to use.
|
||||
.PP
|
||||
\f[C]\-\-framework\ <FRAMEWORK>\f[]
|
||||
.PP
|
||||
Specifies the target framework to install the tool for.
|
||||
By default, the .NET Core SDK tries to choose the most appropriate target framework.
|
||||
.PP
|
||||
\f[C]\-g|\-\-global\f[]
|
||||
.PP
|
||||
Specifies that the installation is user wide.
|
||||
Can't be combined with the \f[C]\-\-tool\-path\f[] option.
|
||||
If you don't specify this option, you must specify the \f[C]\-\-tool\-path\f[] option.
|
||||
.PP
|
||||
\f[C]\-h|\-\-help\f[]
|
||||
.PP
|
||||
Prints out a short help for the command.
|
||||
.PP
|
||||
\f[C]\-\-tool\-path\ <PATH>\f[]
|
||||
.PP
|
||||
Specifies the location where to install the Global Tool.
|
||||
PATH can be absolute or relative.
|
||||
If PATH doesn't exist, the command tries to create it.
|
||||
Can't be combined with the \f[C]\-\-global\f[] option.
|
||||
If you don't specify this option, you must specify the \f[C]\-\-global\f[] option.
|
||||
.PP
|
||||
\f[C]\-v|\-\-verbosity\ <LEVEL>\f[]
|
||||
.PP
|
||||
Sets the verbosity level of the command.
|
||||
Allowed values are \f[C]q[uiet]\f[], \f[C]m[inimal]\f[], \f[C]n[ormal]\f[], \f[C]d[etailed]\f[], and \f[C]diag[nostic]\f[].
|
||||
.PP
|
||||
\f[C]\-\-version\ <VERSION_NUMBER>\f[]
|
||||
.PP
|
||||
The version of the tool to install.
|
||||
By default, the latest stable package version is installed.
|
||||
Use this option to install preview or older versions of the tool.
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Installs the dotnetsay Global Tool in the default location:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ install\ \-g\ dotnetsay\f[]
|
||||
.PP
|
||||
Installs the dotnetsay Global Tool on a specific Windows folder:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ install\ dotnetsay\ \-\-tool\-path\ c:\\global\-tools\f[]
|
||||
.PP
|
||||
Installs the dotnetsay Global Tool on a specific Linux/macOS folder:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ install\ dotnetsay\ \-\-tool\-path\ ~/bin\f[]
|
||||
.PP
|
||||
Installs version 2.0.0 of the dotnetsay Global Tool:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ install\ \-g\ dotnetsay\ \-\-version\ 2.0.0\f[]
|
||||
.SS See also
|
||||
.PP
|
||||
\&.NET Core Global Tools
|
||||
.SH AUTHORS
|
||||
mairaw.
|
||||
|
|
@ -1,59 +0,0 @@
|
|||
.\" Automatically generated by Pandoc 2.2.1
|
||||
.\"
|
||||
.TH "dotnet tool list command \- .NET Core CLI" "1" "" "" ".NET Core"
|
||||
.hy
|
||||
.SH dotnet tool list
|
||||
.PP
|
||||
.SH NAME
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ list\f[] \- Lists all .NET Core Global Tools currently installed in the default directory on your machine or in the specified path.
|
||||
.SH SYNOPSIS
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
dotnet\ tool\ list\ <\-g|\-\-global>
|
||||
dotnet\ tool\ list\ <\-\-tool\-path>
|
||||
dotnet\ tool\ list\ <\-h|\-\-help>
|
||||
\f[]
|
||||
.fi
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \f[C]dotnet\ tool\ list\f[] command provides a way for you to list all .NET Core Global Tools installed user\-wide on your machine (current user profile) or in the specified path.
|
||||
The command lists the package name, version installed, and the Global Tool command.
|
||||
To use the list command, you either have to specify that you want to see all user\-wide tools using the \f[C]\-\-global\f[] option or specify a custom path using the \f[C]\-\-tool\-path\f[] option.
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\f[C]\-g|\-\-global\f[]
|
||||
.PP
|
||||
Lists user\-wide Global Tools.
|
||||
Can't be combined with the \f[C]\-\-tool\-path\f[] option.
|
||||
If you don't specify this option, you must specify the \f[C]\-\-tool\-path\f[] option.
|
||||
.PP
|
||||
\f[C]\-h|\-\-help\f[]
|
||||
.PP
|
||||
Prints out a short help for the command.
|
||||
.PP
|
||||
\f[C]\-\-tool\-path\ <PATH>\f[]
|
||||
.PP
|
||||
Specifies a custom location where to find Global Tools.
|
||||
PATH can be absolute or relative.
|
||||
Can't be combined with the \f[C]\-\-global\f[] option.
|
||||
If you don't specify this option, you must specify the \f[C]\-\-global\f[] option.
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Lists all Global Tools installed user\-wide on your machine (current user profile):
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ list\ \-g\f[]
|
||||
.PP
|
||||
Lists the Global Tools from a specific Windows folder:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ list\ \-\-tool\-path\ c:\\global\-tools\f[]
|
||||
.PP
|
||||
Lists the Global Tools from a specific Linux/macOS folder:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ list\ \-\-tool\-path\ ~/bin\f[]
|
||||
.SS See also
|
||||
.PP
|
||||
\&.NET Core Global Tools
|
||||
.SH AUTHORS
|
||||
mairaw.
|
||||
|
|
@ -1,64 +0,0 @@
|
|||
.\" Automatically generated by Pandoc 2.2.1
|
||||
.\"
|
||||
.TH "dotnet tool uninstall command \- .NET Core CLI" "1" "" "" ".NET Core"
|
||||
.hy
|
||||
.SH dotnet tool uninstall
|
||||
.PP
|
||||
.SH NAME
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ uninstall\f[] \- Uninstalls the specified .NET Core Global Tool from your machine.
|
||||
.SH SYNOPSIS
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
dotnet\ tool\ uninstall\ <PACKAGE_NAME>\ <\-g|\-\-global>
|
||||
dotnet\ tool\ uninstall\ <PACKAGE_NAME>\ <\-\-tool\-path>
|
||||
dotnet\ tool\ uninstall\ <\-h|\-\-help>
|
||||
\f[]
|
||||
.fi
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \f[C]dotnet\ tool\ uninstall\f[] command provides a way for you to uninstall .NET Core Global Tools from your machine.
|
||||
To use the command, you either have to specify that you want to remove a user\-wide tool using the \f[C]\-\-global\f[] option or specify a path to where the tool is installed using the \f[C]\-\-tool\-path\f[] option.
|
||||
.SS Arguments
|
||||
.PP
|
||||
\f[C]PACKAGE_NAME\f[]
|
||||
.PP
|
||||
Name/ID of the NuGet package that contains the .NET Core Global Tool to uninstall.
|
||||
You can find the package name using the dotnet tool list command.
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\f[C]\-g|\-\-global\f[]
|
||||
.PP
|
||||
Specifies that the tool to be removed is from a user\-wide installation.
|
||||
Can't be combined with the \f[C]\-\-tool\-path\f[] option.
|
||||
If you don't specify this option, you must specify the \f[C]\-\-tool\-path\f[] option.
|
||||
.PP
|
||||
\f[C]\-h|\-\-help\f[]
|
||||
.PP
|
||||
Prints out a short help for the command.
|
||||
.PP
|
||||
\f[C]\-\-tool\-path\ <PATH>\f[]
|
||||
.PP
|
||||
Specifies the location where to uninstall the Global Tool.
|
||||
PATH can be absolute or relative.
|
||||
Can't be combined with the \f[C]\-\-global\f[] option.
|
||||
If you don't specify this option, you must specify the \f[C]\-\-global\f[] option.
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Uninstalls the dotnetsay Global Tool:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ uninstall\ \-g\ dotnetsay\f[]
|
||||
.PP
|
||||
Uninstalls the dotnetsay Global Tool from a specific Windows folder:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ uninstall\ dotnetsay\ \-\-tool\-path\ c:\\global\-tools\f[]
|
||||
.PP
|
||||
Uninstalls the dotnetsay Global Tool from a specific Linux/macOS folder:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ uninstall\ dotnetsay\ \-\-tool\-path\ ~/bin\f[]
|
||||
.SS See also
|
||||
.PP
|
||||
\&.NET Core Global Tools
|
||||
.SH AUTHORS
|
||||
mairaw.
|
||||
|
|
@ -1,82 +0,0 @@
|
|||
.\" Automatically generated by Pandoc 2.2.1
|
||||
.\"
|
||||
.TH "dotnet tool update command \- .NET Core CLI" "1" "" "" ".NET Core"
|
||||
.hy
|
||||
.SH dotnet tool update
|
||||
.PP
|
||||
.SH NAME
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ update\f[] \- Updates the specified .NET Core Global Tool on your machine.
|
||||
.SH SYNOPSIS
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
dotnet\ tool\ update\ <PACKAGE_NAME>\ <\-g|\-\-global>\ [\-\-configfile]\ [\-\-framework]\ [\-v|\-\-verbosity]
|
||||
dotnet\ tool\ update\ <PACKAGE_NAME>\ <\-\-tool\-path>\ [\-\-configfile]\ [\-\-framework]\ [\-v|\-\-verbosity]
|
||||
dotnet\ tool\ update\ <\-h|\-\-help>
|
||||
\f[]
|
||||
.fi
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \f[C]dotnet\ tool\ update\f[] command provides a way for you to update .NET Core Global Tools on your machine to the latest stable version of the package.
|
||||
The command uninstalls and reinstalls a tool, effectively updating it.
|
||||
To use the command, you either have to specify that you want to update a tool from a user\-wide installation using the \f[C]\-\-global\f[] option or specify a path to where the tool is installed using the \f[C]\-\-tool\-path\f[] option.
|
||||
.SS Arguments
|
||||
.PP
|
||||
\f[C]PACKAGE_NAME\f[]
|
||||
.PP
|
||||
Name/ID of the NuGet package that contains the .NET Core Global Tool to update.
|
||||
You can find the package name using the dotnet tool list command.
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\f[C]\-\-add\-source\ <SOURCE>\f[]
|
||||
.PP
|
||||
Adds an additional NuGet package source to use during installation.
|
||||
.PP
|
||||
\f[C]\-\-configfile\ <FILE>\f[]
|
||||
.PP
|
||||
The NuGet configuration (\f[I]nuget.config\f[]) file to use.
|
||||
.PP
|
||||
\f[C]\-\-framework\ <FRAMEWORK>\f[]
|
||||
.PP
|
||||
Specifies the target framework to update the tool for.
|
||||
.PP
|
||||
\f[C]\-g|\-\-global\f[]
|
||||
.PP
|
||||
Specifies that the update is for a user\-wide tool.
|
||||
Can't be combined with the \f[C]\-\-tool\-path\f[] option.
|
||||
If you don't specify this option, you must specify the \f[C]\-\-tool\-path\f[] option.
|
||||
.PP
|
||||
\f[C]\-h|\-\-help\f[]
|
||||
.PP
|
||||
Prints out a short help for the command.
|
||||
.PP
|
||||
\f[C]\-\-tool\-path\ <PATH>\f[]
|
||||
.PP
|
||||
Specifies the location where the Global Tool is installed.
|
||||
PATH can be absolute or relative.
|
||||
Can't be combined with the \f[C]\-\-global\f[] option.
|
||||
If you don't specify this option, you must specify the \f[C]\-\-global\f[] option.
|
||||
.PP
|
||||
\f[C]\-v|\-\-verbosity\ <LEVEL>\f[]
|
||||
.PP
|
||||
Sets the verbosity level of the command.
|
||||
Allowed values are \f[C]q[uiet]\f[], \f[C]m[inimal]\f[], \f[C]n[ormal]\f[], \f[C]d[etailed]\f[], and \f[C]diag[nostic]\f[].
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Updates the dotnetsay Global Tool:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ update\ \-g\ dotnetsay\f[]
|
||||
.PP
|
||||
Updates the dotnetsay Global Tool located on a specific Windows folder:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ update\ dotnetsay\ \-\-tool\-path\ c:\\global\-tools\f[]
|
||||
.PP
|
||||
Updates the dotnetsay Global Tool located on a specific Linux/macOS folder:
|
||||
.PP
|
||||
\f[C]dotnet\ tool\ update\ dotnetsay\ \-\-tool\-path\ ~/bin\f[]
|
||||
.SS See also
|
||||
.PP
|
||||
\&.NET Core Global Tools
|
||||
.SH AUTHORS
|
||||
mairaw.
|
||||
Loading…
Add table
Reference in a new issue