14272 lines
450 KiB
Diff
14272 lines
450 KiB
Diff
From e71948468d166cd5df3edf610cf225a3350c755e Mon Sep 17 00:00:00 2001
|
|
From: Omair Majid <omajid@redhat.com>
|
|
Date: Wed, 29 Sep 2021 16:50:41 -0400
|
|
Subject: [PATCH] Update man pages
|
|
|
|
The current .NET man pages were updated a long time ago and are missing
|
|
docs for a number of components, including `dotnet format` and `dotnet
|
|
workload install`.
|
|
|
|
Please use `man ./relative/path/to/file.1` to see the rendered views.
|
|
|
|
There's two major changes in this commit:
|
|
|
|
1. Update the tooling and toolset to generate the man pages
|
|
|
|
2. The actual changes (addition/updates) for the man pages
|
|
|
|
For the first, the container has been updated to use a newer pandoc and
|
|
python3. The pandoc filter has been updated to remove the link-removal
|
|
since it doesn't seem necessary for this version of pandoc anymore. Also
|
|
added another early pass over the document files: this inlines all
|
|
!INCLUDE'd references so the manual pages are complete.
|
|
|
|
Fixes: #21449
|
|
---
|
|
.../manpages/sdk/dotnet-add-package.1 | 47 +-
|
|
.../manpages/sdk/dotnet-add-reference.1 | 30 +-
|
|
.../manpages/sdk/dotnet-build-server.1 | 16 +-
|
|
documentation/manpages/sdk/dotnet-build.1 | 97 +-
|
|
documentation/manpages/sdk/dotnet-clean.1 | 27 +-
|
|
.../sdk/dotnet-environment-variables.1 | 135 ++
|
|
documentation/manpages/sdk/dotnet-format.1 | 198 ++
|
|
documentation/manpages/sdk/dotnet-help.1 | 20 +-
|
|
.../manpages/sdk/dotnet-install-script.1 | 305 +++-
|
|
.../manpages/sdk/dotnet-list-package.1 | 72 +-
|
|
.../manpages/sdk/dotnet-list-reference.1 | 28 +-
|
|
documentation/manpages/sdk/dotnet-migrate.1 | 22 +-
|
|
documentation/manpages/sdk/dotnet-msbuild.1 | 32 +-
|
|
.../manpages/sdk/dotnet-new-install.1 | 85 +
|
|
documentation/manpages/sdk/dotnet-new-list.1 | 164 ++
|
|
.../manpages/sdk/dotnet-new-sdk-templates.1 | 1603 +++++++++++++++++
|
|
.../manpages/sdk/dotnet-new-search.1 | 149 ++
|
|
.../manpages/sdk/dotnet-new-uninstall.1 | 56 +
|
|
.../manpages/sdk/dotnet-new-update.1 | 34 +
|
|
documentation/manpages/sdk/dotnet-new.1 | 1573 +++-------------
|
|
.../manpages/sdk/dotnet-nuget-add-source.1 | 123 ++
|
|
.../manpages/sdk/dotnet-nuget-delete.1 | 27 +-
|
|
.../sdk/dotnet-nuget-disable-source.1 | 55 +
|
|
.../manpages/sdk/dotnet-nuget-enable-source.1 | 55 +
|
|
.../manpages/sdk/dotnet-nuget-list-source.1 | 54 +
|
|
.../manpages/sdk/dotnet-nuget-locals.1 | 25 +-
|
|
.../manpages/sdk/dotnet-nuget-push.1 | 98 +-
|
|
.../manpages/sdk/dotnet-nuget-remove-source.1 | 55 +
|
|
.../manpages/sdk/dotnet-nuget-sign.1 | 242 +++
|
|
.../manpages/sdk/dotnet-nuget-trust.1 | 468 +++++
|
|
.../manpages/sdk/dotnet-nuget-update-source.1 | 89 +
|
|
.../manpages/sdk/dotnet-nuget-verify.1 | 341 ++++
|
|
documentation/manpages/sdk/dotnet-pack.1 | 130 +-
|
|
documentation/manpages/sdk/dotnet-publish.1 | 485 +++--
|
|
.../manpages/sdk/dotnet-remove-package.1 | 37 +-
|
|
.../manpages/sdk/dotnet-remove-reference.1 | 76 +-
|
|
documentation/manpages/sdk/dotnet-restore.1 | 326 ++--
|
|
documentation/manpages/sdk/dotnet-run.1 | 417 ++---
|
|
documentation/manpages/sdk/dotnet-sdk-check.1 | 76 +
|
|
documentation/manpages/sdk/dotnet-sln.1 | 201 ++-
|
|
documentation/manpages/sdk/dotnet-store.1 | 113 +-
|
|
documentation/manpages/sdk/dotnet-test.1 | 574 +++---
|
|
.../manpages/sdk/dotnet-tool-install.1 | 206 ++-
|
|
documentation/manpages/sdk/dotnet-tool-list.1 | 101 +-
|
|
.../manpages/sdk/dotnet-tool-restore.1 | 103 ++
|
|
documentation/manpages/sdk/dotnet-tool-run.1 | 50 +
|
|
.../manpages/sdk/dotnet-tool-search.1 | 122 ++
|
|
.../manpages/sdk/dotnet-tool-uninstall.1 | 97 +-
|
|
.../manpages/sdk/dotnet-tool-update.1 | 195 +-
|
|
documentation/manpages/sdk/dotnet-vstest.1 | 418 ++---
|
|
.../manpages/sdk/dotnet-workload-install.1 | 196 ++
|
|
.../manpages/sdk/dotnet-workload-list.1 | 51 +
|
|
.../manpages/sdk/dotnet-workload-repair.1 | 118 ++
|
|
.../manpages/sdk/dotnet-workload-restore.1 | 124 ++
|
|
.../manpages/sdk/dotnet-workload-search.1 | 70 +
|
|
.../manpages/sdk/dotnet-workload-uninstall.1 | 59 +
|
|
.../manpages/sdk/dotnet-workload-update.1 | 137 ++
|
|
documentation/manpages/sdk/dotnet.1 | 652 +++----
|
|
documentation/manpages/tool/Dockerfile | 4 +-
|
|
.../manpages/tool/man-pandoc-filter.py | 16 +-
|
|
.../remove-metadata-and-embed-includes.py | 67 +
|
|
documentation/manpages/tool/run_docker.sh | 2 +-
|
|
.../manpages/tool/update-man-pages.sh | 5 +-
|
|
63 files changed, 8258 insertions(+), 3295 deletions(-)
|
|
create mode 100644 documentation/manpages/sdk/dotnet-environment-variables.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-format.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-new-install.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-new-list.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-new-sdk-templates.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-new-search.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-new-uninstall.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-new-update.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-nuget-add-source.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-nuget-disable-source.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-nuget-enable-source.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-nuget-list-source.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-nuget-remove-source.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-nuget-sign.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-nuget-trust.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-nuget-update-source.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-nuget-verify.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-sdk-check.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-tool-restore.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-tool-run.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-tool-search.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-workload-install.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-workload-list.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-workload-repair.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-workload-restore.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-workload-search.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-workload-uninstall.1
|
|
create mode 100644 documentation/manpages/sdk/dotnet-workload-update.1
|
|
mode change 100644 => 100755 documentation/manpages/tool/man-pandoc-filter.py
|
|
create mode 100755 documentation/manpages/tool/remove-metadata-and-embed-includes.py
|
|
mode change 100644 => 100755 documentation/manpages/tool/run_docker.sh
|
|
mode change 100644 => 100755 documentation/manpages/tool/update-man-pages.sh
|
|
|
|
diff --git a/documentation/manpages/sdk/dotnet-add-package.1 b/documentation/manpages/sdk/dotnet-add-package.1
|
|
index deed5dd94f..6ec932214f 100644
|
|
--- a/documentation/manpages/sdk/dotnet-add-package.1
|
|
+++ b/documentation/manpages/sdk/dotnet-add-package.1
|
|
@@ -1,28 +1,36 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet add package command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet add package
|
|
.PP
|
|
-\f[B]This article applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet add package\f[R] - Adds a package reference to a project file.
|
|
.SH SYNOPSIS
|
|
-.PP
|
|
-\f[C]dotnet add [<PROJECT>] package <PACKAGE_NAME> [-h|--help] [-f|--framework] [--interactive] [-n|--no-restore] [--package-directory] [-s|--source] [-v|--version]\f[R]
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet add [<PROJECT>] package <PACKAGE_NAME>
|
|
+ [-f|--framework <FRAMEWORK>] [--interactive]
|
|
+ [-n|--no-restore] [--package-directory <PACKAGE_DIRECTORY>]
|
|
+ [--prerelease] [-s|--source <SOURCE>] [-v|--version <VERSION>]
|
|
+
|
|
+dotnet add package -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet add package\f[R] command provides a convenient option to add a package reference to a project file.
|
|
After running the command, there\[cq]s a compatibility check to ensure the package is compatible with the frameworks in the project.
|
|
If the check passes, a \f[C]<PackageReference>\f[R] element is added to the project file and dotnet restore is run.
|
|
.PP
|
|
-.PP
|
|
For example, adding \f[C]Newtonsoft.Json\f[R] to \f[I]ToDo.csproj\f[R] produces output similar to the following example:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
- Writing C:\[rs]Users\[rs]mairaw\[rs]AppData\[rs]Local\[rs]Temp\[rs]tmp95A8.tmp
|
|
+Writing C:\[rs]Users\[rs]me\[rs]AppData\[rs]Local\[rs]Temp\[rs]tmp95A8.tmp
|
|
info : Adding PackageReference for package \[aq]Newtonsoft.Json\[aq] into project \[aq]C:\[rs]projects\[rs]ToDo\[rs]ToDo.csproj\[aq].
|
|
log : Restoring packages for C:\[rs]Temp\[rs]projects\[rs]consoleproj\[rs]consoleproj.csproj...
|
|
info : GET https://api.nuget.org/v3-flatcontainer/newtonsoft.json/index.json
|
|
@@ -42,6 +50,14 @@ The \f[I]ToDo.csproj\f[R] file now contains a \f[C]<PackageReference>\f[R] eleme
|
|
<PackageReference Include=\[dq]Newtonsoft.Json\[dq] Version=\[dq]12.0.1\[dq] />
|
|
\f[R]
|
|
.fi
|
|
+.SS Implicit restore
|
|
+.PP
|
|
+You don\[cq]t have to run \f[C]dotnet restore\f[R] because it\[cq]s run implicitly by all commands that require a restore to occur, such as \f[C]dotnet new\f[R], \f[C]dotnet build\f[R], \f[C]dotnet run\f[R], \f[C]dotnet test\f[R], \f[C]dotnet publish\f[R], and \f[C]dotnet pack\f[R].
|
|
+To disable implicit restore, use the \f[C]--no-restore\f[R] option.
|
|
+.PP
|
|
+The \f[C]dotnet restore\f[R] command is still useful in certain scenarios where explicitly restoring makes sense, such as continuous integration builds in Azure DevOps Services or in build systems that need to explicitly control when the restore occurs.
|
|
+.PP
|
|
+For information about how to manage NuGet feeds, see the \f[C]dotnet restore\f[R] documentation.
|
|
.SS Arguments
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]PROJECT\f[B]\f[R]
|
|
@@ -64,17 +80,17 @@ The package reference to add.
|
|
Adds a package reference only when targeting a specific framework.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Allows the command to stop and wait for user input or action (for example, to complete authentication).
|
|
-Available since .NET Core 2.1 SDK, version 2.1.400 or later.
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]-n|--no-restore\f[B]\f[R]
|
|
@@ -91,10 +107,17 @@ The default package restore location is \f[C]%userprofile%\[rs].nuget\[rs]packag
|
|
For more information, see Managing the global packages, cache, and temp folders in NuGet.
|
|
.RE
|
|
.IP \[bu] 2
|
|
+\f[B]\f[CB]--prerelease\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows prerelease packages to be installed.
|
|
+Available since .NET Core 5 SDK
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
\f[B]\f[CB]-s|--source <SOURCE>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-The NuGet package source to use during the restore operation.
|
|
+The URI of the NuGet package source to use during the restore operation.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]-v|--version <VERSION>\f[B]\f[R]
|
|
diff --git a/documentation/manpages/sdk/dotnet-add-reference.1 b/documentation/manpages/sdk/dotnet-add-reference.1
|
|
index 5389d478ce..4ca212564a 100644
|
|
--- a/documentation/manpages/sdk/dotnet-add-reference.1
|
|
+++ b/documentation/manpages/sdk/dotnet-add-reference.1
|
|
@@ -1,16 +1,23 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet add reference command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet add reference
|
|
.PP
|
|
-\f[B]This article applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet add reference\f[R] - Adds project-to-project (P2P) references.
|
|
.SH SYNOPSIS
|
|
-.PP
|
|
-\f[C]dotnet add [<PROJECT>] reference [-f|--framework] <PROJECT_REFERENCES> [-h|--help] [--interactive]\f[R]
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet add [<PROJECT>] reference [-f|--framework <FRAMEWORK>]
|
|
+ [--interactive] <PROJECT_REFERENCES>
|
|
+
|
|
+dotnet add reference -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet add reference\f[R] command provides a convenient option to add project references to a project.
|
|
@@ -39,26 +46,27 @@ If not specified, the command searches the current directory for one.
|
|
.PP
|
|
Project-to-project (P2P) references to add.
|
|
Specify one or more projects.
|
|
-Glob patterns are supported on Unix/Linux-based systems.
|
|
+Glob patterns (https://en.wikipedia.org/wiki/Glob_(programming)) are supported on Unix/Linux-based systems.
|
|
.RE
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Adds project references only when targeting a specific framework using the TFM format.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Adds project references only when targeting a specific framework.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Allows the command to stop and wait for user input or action (for example, to complete authentication).
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
Available since .NET Core 3.0 SDK.
|
|
.RE
|
|
.SH EXAMPLES
|
|
diff --git a/documentation/manpages/sdk/dotnet-build-server.1 b/documentation/manpages/sdk/dotnet-build-server.1
|
|
index e378f13a32..e87f43a4c5 100644
|
|
--- a/documentation/manpages/sdk/dotnet-build-server.1
|
|
+++ b/documentation/manpages/sdk/dotnet-build-server.1
|
|
@@ -1,10 +1,10 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet build-server command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet build-server
|
|
.PP
|
|
-\f[B]This article applies to: \[OK]\f[R] .NET Core 2.1 SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet build-server\f[R] - Interacts with servers started by a build.
|
|
@@ -13,8 +13,10 @@
|
|
.nf
|
|
\f[C]
|
|
dotnet build-server shutdown [--msbuild] [--razor] [--vbcscompiler]
|
|
-dotnet build-server shutdown [-h|--help]
|
|
-dotnet build-server [-h|--help]
|
|
+
|
|
+dotnet build-server shutdown -h|--help
|
|
+
|
|
+dotnet build-server -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SS Commands
|
|
@@ -27,10 +29,10 @@ By default, all servers are shut down.
|
|
.RE
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--msbuild\f[B]\f[R]
|
|
diff --git a/documentation/manpages/sdk/dotnet-build.1 b/documentation/manpages/sdk/dotnet-build.1
|
|
index 26787ebed2..8d8dc8eff0 100644
|
|
--- a/documentation/manpages/sdk/dotnet-build.1
|
|
+++ b/documentation/manpages/sdk/dotnet-build.1
|
|
@@ -1,10 +1,10 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet build command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet build
|
|
.PP
|
|
-\f[B]This article applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet build\f[R] - Builds a project and all of its dependencies.
|
|
@@ -12,11 +12,15 @@
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet build [<PROJECT>|<SOLUTION>] [-c|--configuration] [-f|--framework] [--force]
|
|
- [--interactive] [--no-dependencies] [--no-incremental] [--no-restore] [--nologo]
|
|
- [-o|--output] [-r|--runtime] [-v|--verbosity] [--version-suffix]
|
|
+dotnet build [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
|
|
+ [-c|--configuration <CONFIGURATION>] [-f|--framework <FRAMEWORK>]
|
|
+ [--force] [--interactive] [--no-dependencies] [--no-incremental]
|
|
+ [--no-restore] [--nologo] [--no-self-contained] [--os <OS>]
|
|
+ [-o|--output <OUTPUT_DIRECTORY>] [-r|--runtime <RUNTIME_IDENTIFIER>]
|
|
+ [--self-contained [true|false]] [--source <SOURCE>]
|
|
+ [-v|--verbosity <LEVEL>] [--version-suffix <VERSION_SUFFIX>]
|
|
|
|
-dotnet build [-h|--help]
|
|
+dotnet build -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
@@ -39,18 +43,26 @@ For executable projects targeting versions earlier than .NET Core 3.0, library d
|
|
They\[cq]re resolved from the NuGet global packages folder at run time.
|
|
With that in mind, the product of \f[C]dotnet build\f[R] isn\[cq]t ready to be transferred to another machine to run.
|
|
To create a version of the application that can be deployed, you need to publish it (for example, with the dotnet publish command).
|
|
-For more information, see .NET Core Application Deployment.
|
|
+For more information, see .NET Application Deployment.
|
|
.PP
|
|
For executable projects targeting .NET Core 3.0 and later, library dependencies are copied to the output folder.
|
|
This means that if there isn\[cq]t any other publish-specific logic (such as Web projects have), the build output should be deployable.
|
|
+.SS Implicit restore
|
|
.PP
|
|
Building requires the \f[I]project.assets.json\f[R] file, which lists the dependencies of your application.
|
|
The file is created when \f[C]dotnet restore\f[R] is executed.
|
|
Without the assets file in place, the tooling can\[cq]t resolve reference assemblies, which results in errors.
|
|
-With .NET Core 1.x SDK, you needed to explicitly run \f[C]dotnet restore\f[R] before running \f[C]dotnet build\f[R].
|
|
-Starting with .NET Core 2.0 SDK, \f[C]dotnet restore\f[R] runs implicitly when you run \f[C]dotnet build\f[R].
|
|
-If you want to disable implicit restore when running the build command, you can pass the \f[C]--no-restore\f[R] option.
|
|
.PP
|
|
+You don\[cq]t have to run \f[C]dotnet restore\f[R] because it\[cq]s run implicitly by all commands that require a restore to occur, such as \f[C]dotnet new\f[R], \f[C]dotnet build\f[R], \f[C]dotnet run\f[R], \f[C]dotnet test\f[R], \f[C]dotnet publish\f[R], and \f[C]dotnet pack\f[R].
|
|
+To disable implicit restore, use the \f[C]--no-restore\f[R] option.
|
|
+.PP
|
|
+The \f[C]dotnet restore\f[R] command is still useful in certain scenarios where explicitly restoring makes sense, such as continuous integration builds in Azure DevOps Services or in build systems that need to explicitly control when the restore occurs.
|
|
+.PP
|
|
+For information about how to manage NuGet feeds, see the \f[C]dotnet restore\f[R] documentation.
|
|
+.PP
|
|
+This command supports the \f[C]dotnet restore\f[R] options when passed in the long form (for example, \f[C]--source\f[R]).
|
|
+Short form options, such as \f[C]-s\f[R], are not supported.
|
|
+.SS Executable or library output
|
|
.PP
|
|
Whether the project is executable or not is determined by the \f[C]<OutputType>\f[R] property in the project file.
|
|
The following example shows a project that produces executable code:
|
|
@@ -73,8 +85,17 @@ For more information, see Incremental Builds.
|
|
In addition to its options, the \f[C]dotnet build\f[R] command accepts MSBuild options, such as \f[C]-p\f[R] for setting properties or \f[C]-l\f[R] to define a logger.
|
|
For more information about these options, see the MSBuild Command-Line Reference.
|
|
Or you can also use the dotnet msbuild command.
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] When \f[C]dotnet build\f[R] is run automatically by \f[C]dotnet run\f[R], arguments like \f[C]-property:property=value\f[R] aren\[cq]t respected.
|
|
+.RE
|
|
.PP
|
|
Running \f[C]dotnet build\f[R] is equivalent to running \f[C]dotnet msbuild -restore\f[R]; however, the default verbosity of the output is different.
|
|
+.SS Workload manifest downloads
|
|
+.PP
|
|
+When you run this command, it initiates an asynchronous background download of advertising manifests for workloads.
|
|
+If the download is still running when this command finishes, the download is stopped.
|
|
+For more information, see Advertising manifests.
|
|
.SS Arguments
|
|
.PP
|
|
\f[C]PROJECT | SOLUTION\f[R]
|
|
@@ -83,7 +104,17 @@ The project or solution file to build.
|
|
If a project or solution file isn\[cq]t specified, MSBuild searches the current working directory for a file that has a file extension that ends in either \f[I]proj\f[R] or \f[I]sln\f[R] and uses that file.
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-c|--configuration {Debug|Release}\f[B]\f[R]
|
|
+\f[B]\f[CB]-a|--arch <ARCHITECTURE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the target architecture.
|
|
+This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
|
|
+For example, on a \f[C]win-x64\f[R] machine, specifying \f[C]--arch x86\f[R] sets the RID to \f[C]win-x86\f[R].
|
|
+If you use this option, don\[cq]t use the \f[C]-r|--runtime\f[R] option.
|
|
+Available since .NET 6 Preview 7.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Defines the build configuration.
|
|
@@ -102,13 +133,12 @@ The framework must be defined in the project file.
|
|
.PP
|
|
Forces all dependencies to be resolved even if the last restore was successful.
|
|
Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
|
|
-Available since .NET Core 2.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
@@ -136,7 +166,6 @@ This flag turns off incremental compilation and forces a clean rebuild of the pr
|
|
.RS 2
|
|
.PP
|
|
Doesn\[cq]t execute an implicit restore during build.
|
|
-Available since .NET Core 2.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--nologo\f[B]\f[R]
|
|
@@ -146,6 +175,13 @@ Doesn\[cq]t display the startup banner or the copyright message.
|
|
Available since .NET Core 3.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-self-contained\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Publishes the application as a framework dependent application.
|
|
+A compatible .NET runtime must be installed on the target machine to run the application.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
\f[B]\f[CB]-o|--output <OUTPUT_DIRECTORY>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
@@ -154,19 +190,44 @@ If not specified, the default path is \f[C]./bin/<configuration>/<framework>/\f[
|
|
For projects with multiple target frameworks (via the \f[C]TargetFrameworks\f[R] property), you also need to define \f[C]--framework\f[R] when you specify this option.
|
|
.RE
|
|
.IP \[bu] 2
|
|
+\f[B]\f[CB]--os <OS>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the target operating system (OS).
|
|
+This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
|
|
+For example, on a \f[C]win-x64\f[R] machine, specifying \f[C]--os os\f[R] sets the RID to \f[C]os-x64\f[R].
|
|
+If you use this option, don\[cq]t use the \f[C]-r|--runtime\f[R] option.
|
|
+Available since .NET 6 Preview 7.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
\f[B]\f[CB]-r|--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Specifies the target runtime.
|
|
For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
+If you use this option, use \f[C]--self-contained\f[R] or \f[C]--no-self-contained\f[R] also.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--self-contained [true|false]\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Publishes the .NET runtime with the application so the runtime doesn\[cq]t need to be installed on the target machine.
|
|
+The default is \f[C]true\f[R] if a runtime identifier is specified.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The URI of the NuGet package source to use during the restore operation.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Sets the MSBuild verbosity level.
|
|
+Sets the verbosity level of the command.
|
|
Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--version-suffix <VERSION_SUFFIX>\f[B]\f[R]
|
|
@@ -208,7 +269,7 @@ dotnet build --runtime ubuntu.18.04-x64
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Build the project and use the specified NuGet package source during the restore operation (.NET Core 2.0 SDK and later versions):
|
|
+Build the project and use the specified NuGet package source during the restore operation:
|
|
.RS 2
|
|
.IP
|
|
.nf
|
|
diff --git a/documentation/manpages/sdk/dotnet-clean.1 b/documentation/manpages/sdk/dotnet-clean.1
|
|
index 008eade6f1..2c0c8cd5d7 100644
|
|
--- a/documentation/manpages/sdk/dotnet-clean.1
|
|
+++ b/documentation/manpages/sdk/dotnet-clean.1
|
|
@@ -1,10 +1,10 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet clean command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet clean
|
|
.PP
|
|
-\f[B]This topic applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet clean\f[R] - Cleans the output of a project.
|
|
@@ -12,9 +12,12 @@
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet clean [<PROJECT>|<SOLUTION>] [-c|--configuration] [-f|--framework] [--interactive]
|
|
- [--nologo] [-o|--output] [-r|--runtime] [-v|--verbosity]
|
|
-dotnet clean [-h|--help]
|
|
+dotnet clean [<PROJECT>|<SOLUTION>] [-c|--configuration <CONFIGURATION>]
|
|
+ [-f|--framework <FRAMEWORK>] [--interactive]
|
|
+ [--nologo] [-o|--output <OUTPUT_DIRECTORY>]
|
|
+ [-r|--runtime <RUNTIME_IDENTIFIER>] [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet clean -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
@@ -31,11 +34,11 @@ The MSBuild project or solution to clean.
|
|
If a project or solution file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in \f[I]proj\f[R] or \f[I]sln\f[R], and uses that file.
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-c|--configuration {Debug|Release}\f[B]\f[R]
|
|
+\f[B]\f[CB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Defines the build configuration.
|
|
-The default value is \f[C]Debug\f[R].
|
|
+The default for most projects is \f[C]Debug\f[R], but you can override the build configuration settings in your project.
|
|
This option is only required when cleaning if you specified it during build time.
|
|
.RE
|
|
.IP \[bu] 2
|
|
@@ -47,10 +50,10 @@ The framework must be defined in the project file.
|
|
If you specified the framework at build time, you must specify the framework when cleaning.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
@@ -80,15 +83,15 @@ Specify the \f[C]-f|--framework <FRAMEWORK>\f[R] switch with the output director
|
|
.PP
|
|
Cleans the output folder of the specified runtime.
|
|
This is used when a self-contained deployment was created.
|
|
-Option available since .NET Core 2.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Sets the MSBuild verbosity level.
|
|
+Sets the verbosity level of the command.
|
|
Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
The default is \f[C]normal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
.RE
|
|
.SH EXAMPLES
|
|
.IP \[bu] 2
|
|
diff --git a/documentation/manpages/sdk/dotnet-environment-variables.1 b/documentation/manpages/sdk/dotnet-environment-variables.1
|
|
new file mode 100644
|
|
index 0000000000..61dd16b4b8
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-environment-variables.1
|
|
@@ -0,0 +1,135 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH Environment variables used by .NET SDK, .NET CLI, and .NET runtime
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
+.PP
|
|
+Use the following environment variables to configure the .NET SDK, .NET CLI, and .NET runtime.
|
|
+.SS \f[C]DOTNET_ROOT\f[R], \f[C]DOTNET_ROOT(x86)\f[R]
|
|
+.PP
|
|
+Specifies the location of the .NET runtimes, if they are not installed in the default location.
|
|
+The default location on Windows is \f[C]C:\[rs]Program Files\[rs]dotnet\f[R].
|
|
+The default location on Linux and macOS is \f[C]/usr/share/dotnet\f[R].
|
|
+This environment variable is used only when running apps via generated executables (apphosts).
|
|
+\f[C]DOTNET_ROOT(x86)\f[R] is used instead when running a 32-bit executable on a 64-bit OS.
|
|
+.SS \f[C]NUGET_PACKAGES\f[R]
|
|
+.PP
|
|
+The global packages folder.
|
|
+If not set, it defaults to \f[C]\[ti]/.nuget/packages\f[R] on Unix or \f[C]%userprofile%\[rs].nuget\[rs]packages\f[R] on Windows.
|
|
+.SS \f[C]DOTNET_SERVICING\f[R]
|
|
+.PP
|
|
+Specifies the location of the servicing index to use by the shared host when loading the runtime.
|
|
+.SS \f[C]DOTNET_NOLOGO\f[R]
|
|
+.PP
|
|
+Specifies whether .NET welcome and telemetry messages are displayed on first run.
|
|
+Set to \f[C]true\f[R] to mute these messages (values \f[C]true\f[R], \f[C]1\f[R], or \f[C]yes\f[R] accepted) or set to \f[C]false\f[R] to allow (values \f[C]false\f[R], \f[C]0\f[R], or \f[C]no\f[R] accepted).
|
|
+If not set, the default is \f[C]false\f[R] and the messages will be displayed on first run.
|
|
+This flag has no effect on telemetry (see \f[C]DOTNET_CLI_TELEMETRY_OPTOUT\f[R] for opting out of sending telemetry).
|
|
+.SS \f[C]DOTNET_CLI_TELEMETRY_OPTOUT\f[R]
|
|
+.PP
|
|
+Specifies whether data about the .NET tools usage is collected and sent to Microsoft.
|
|
+Set to \f[C]true\f[R] to opt-out of the telemetry feature (values \f[C]true\f[R], \f[C]1\f[R], or \f[C]yes\f[R] accepted).
|
|
+Otherwise, set to \f[C]false\f[R] to opt into the telemetry features (values \f[C]false\f[R], \f[C]0\f[R], or \f[C]no\f[R] accepted).
|
|
+If not set, the default is \f[C]false\f[R] and the telemetry feature is active.
|
|
+.SS \f[C]DOTNET_MULTILEVEL_LOOKUP\f[R]
|
|
+.PP
|
|
+Specifies whether .NET runtime, shared framework, or SDK are resolved from the global location.
|
|
+If not set, it defaults to 1 (logical \f[C]true\f[R]).
|
|
+Set to 0 (logical \f[C]false\f[R]) to not resolve from the global location and have isolated .NET installations.
|
|
+For more information about multi-level lookup, see Multi-level SharedFX Lookup (https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/multilevel-sharedfx-lookup.md).
|
|
+.SS \f[C]DOTNET_ROLL_FORWARD\f[R]
|
|
+.PP
|
|
+Determines roll forward behavior.
|
|
+For more information, see the \f[C]--roll-forward\f[R] option earlier in this article.
|
|
+\f[B]Available starting with .NET Core 3.x.\f[R]
|
|
+.SS \f[C]DOTNET_ROLL_FORWARD_TO_PRERELEASE\f[R]
|
|
+.PP
|
|
+If set to \f[C]1\f[R] (enabled), enables rolling forward to a pre-release version from a release version.
|
|
+By default (\f[C]0\f[R] - disabled), when a release version of .NET runtime is requested, roll-forward will only consider installed release versions.
|
|
+\f[B]Available starting with .NET Core 3.x.\f[R]
|
|
+.PP
|
|
+For more information, see Roll forward.
|
|
+.SS \f[C]DOTNET_ROLL_FORWARD_ON_NO_CANDIDATE_FX\f[R]
|
|
+.PP
|
|
+Disables minor version roll forward, if set to \f[C]0\f[R].
|
|
+For more information, see Roll forward.
|
|
+.PP
|
|
+This setting is superseded in .NET Core 3.0 by \f[C]DOTNET_ROLL_FORWARD\f[R].
|
|
+The new settings should be used instead.
|
|
+.SS \f[C]DOTNET_CLI_UI_LANGUAGE\f[R]
|
|
+.PP
|
|
+Sets the language of the CLI UI using a locale value such as \f[C]en-us\f[R].
|
|
+The supported values are the same as for Visual Studio.
|
|
+For more information, see the section on changing the installer language in the Visual Studio installation documentation.
|
|
+The .NET resource manager rules apply, so you don\[cq]t have to pick an exact match\[em]you can also pick descendants in the \f[C]CultureInfo\f[R] tree.
|
|
+For example, if you set it to \f[C]fr-CA\f[R], the CLI will find and use the \f[C]fr\f[R] translations.
|
|
+If you set it to a language that is not supported, the CLI falls back to English.
|
|
+.SS \f[C]DOTNET_DISABLE_GUI_ERRORS\f[R]
|
|
+.PP
|
|
+For GUI-enabled generated executables - disables dialog popup, which normally shows for certain classes of errors.
|
|
+It only writes to \f[C]stderr\f[R] and exits in those cases.
|
|
+.SS \f[C]DOTNET_ADDITIONAL_DEPS\f[R]
|
|
+.PP
|
|
+Equivalent to CLI option \f[C]--additional-deps\f[R].
|
|
+.SS \f[C]DOTNET_RUNTIME_ID\f[R]
|
|
+.PP
|
|
+Overrides the detected RID.
|
|
+.SS \f[C]DOTNET_SHARED_STORE\f[R]
|
|
+.PP
|
|
+Location of the \[lq]shared store\[rq] which assembly resolution falls back to in some cases.
|
|
+.SS \f[C]DOTNET_STARTUP_HOOKS\f[R]
|
|
+.PP
|
|
+List of assemblies to load and execute startup hooks from.
|
|
+.SS \f[C]DOTNET_BUNDLE_EXTRACT_BASE_DIR\f[R]
|
|
+.PP
|
|
+Specifies a directory to which a single-file application is extracted before it is executed.
|
|
+\f[B]Available starting with .NET Core 3.x.\f[R]
|
|
+.PP
|
|
+For more information, see Single-file executables.
|
|
+.SS \f[C]COREHOST_TRACE\f[R]
|
|
+.PP
|
|
+Controls diagnostics tracing from the hosting components, such as \f[C]dotnet.exe\f[R], \f[C]hostfxr\f[R], and \f[C]hostpolicy\f[R].
|
|
+.IP \[bu] 2
|
|
+\f[C]COREHOST_TRACE=[0/1]\f[R] - default is \f[C]0\f[R] - tracing disabled.
|
|
+If set to \f[C]1\f[R], diagnostics tracing is enabled.
|
|
+.IP \[bu] 2
|
|
+\f[C]COREHOST_TRACEFILE=<file path>\f[R] - only has effect if tracing is enabled via \f[C]COREHOST_TRACE=1\f[R].
|
|
+When set, the tracing information is written to the specified file, otherwise the tracing information is written to \f[C]stderr\f[R].
|
|
+\f[B]Available starting with .NET Core 3.x.\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[C]COREHOST_TRACE_VERBOSITY=[1/2/3/4]\f[R] - default is \f[C]4\f[R].
|
|
+The setting is used only when tracing is enabled via \f[C]COREHOST_TRACE=1\f[R].
|
|
+\f[B]Available starting with .NET Core 3.x.\f[R]
|
|
+.RS 2
|
|
+.IP \[bu] 2
|
|
+\f[C]4\f[R] - all tracing information is written
|
|
+.IP \[bu] 2
|
|
+\f[C]3\f[R] - only informational, warning and error messages are written
|
|
+.IP \[bu] 2
|
|
+\f[C]2\f[R] - only warning and error messages are written
|
|
+.IP \[bu] 2
|
|
+\f[C]1\f[R] - only error messages are written
|
|
+.RE
|
|
+.PP
|
|
+The typical way to get detailed trace information about application startup is to set \f[C]COREHOST_TRACE=1\f[R] and\f[C]COREHOST_TRACEFILE=host_trace.txt\f[R] and then run the application.
|
|
+A new file \f[C]host_trace.txt\f[R] will be created in the current directory with the detailed information.
|
|
+.SS \f[C]DOTNET_CLI_WORKLOAD_UPDATE_NOTIFY_DISABLE\f[R]
|
|
+.PP
|
|
+Disables background download of advertising manifests for workloads.
|
|
+Default is \f[C]false\f[R] - not disabled.
|
|
+If set to \f[C]true\f[R], downloading is disabled.
|
|
+For more information, see Advertising manifests.
|
|
+.SS \f[C]DOTNET_CLI_WORKLOAD_UPDATE_NOTIFY_INTERVAL_HOURS\f[R]
|
|
+.PP
|
|
+Specifies the minimum number of hours between background downloads of advertising manifests for workloads.
|
|
+Default is \f[C]24\f[R] - no more frequently than once a day.
|
|
+For more information, see Advertising manifests.
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+dotnet command
|
|
+.IP \[bu] 2
|
|
+Runtime Configuration Files (https://github.com/dotnet/sdk/blob/main/documentation/specs/runtime-configuration-file.md)
|
|
+.IP \[bu] 2
|
|
+\&.NET runtime configuration settings
|
|
diff --git a/documentation/manpages/sdk/dotnet-format.1 b/documentation/manpages/sdk/dotnet-format.1
|
|
new file mode 100644
|
|
index 0000000000..9ca1d4e620
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-format.1
|
|
@@ -0,0 +1,198 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet format
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6.x SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet format\f[R] - Formats code to match \f[C]editorconfig\f[R] settings.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet format [options] [<PROJECT | SOLUTION>]
|
|
+
|
|
+dotnet format -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+\f[C]dotnet format\f[R] is a code formatter that applies style preferences to a project or solution.
|
|
+Preferences will be read from an \f[I].editorconfig\f[R] file, if present, otherwise a default set of preferences will be used.
|
|
+For more information, see the EditorConfig documentation.
|
|
+.SS Arguments
|
|
+.PP
|
|
+\f[C]PROJECT | SOLUTION\f[R]
|
|
+.PP
|
|
+The MSBuild project or solution to run code formatting on.
|
|
+If a project or solution file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in \f[I]proj\f[R] or \f[I]sln\f[R], and uses that file.
|
|
+.SH OPTIONS
|
|
+.PP
|
|
+None of the options below are required for the \f[C]dotnet format\f[R] command to succeed but can be used to further customize what is formatted and by which rules.
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--diagnostics <DIAGNOSTICS>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+A space-separated list of diagnostic IDs to use as a filter when fixing code style or third party issues.
|
|
+Default value is whichever IDs are listed in the \f[I]editorconfig\f[R] file.
|
|
+For a list of built-in analyzer rule IDs that you can specify, see the list of IDs for code-analysis quality rules.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--severity\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The minumum severity of diagnostics to fix.
|
|
+Allowed values are \f[C]info\f[R], \f[C]warn\f[R], and \f[C]error\f[R].
|
|
+The default value is \f[C]warn\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore before formatting.
|
|
+Default is to do implicit restore.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--verify-no-changes\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Verifies that no formatting changes would be performed.
|
|
+Terminates with a non zero exit code if any files would have been formatted.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--include <INCLUDE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+A space-separated list of relative file or folder paths to include in formatting.
|
|
+All files in the solution or project are formatted if empty.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--exclude <EXCLUDE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+A space-separated list of relative file or folder paths to exclude from formatting.
|
|
+The default is none.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--include-generated\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Formats files generated by the SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+Default value is \f[C]m[inimal]\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--binarylog <BINARY-LOG-PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Logs all project or solution load information to a binary log file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--report <REPORT-PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Produces a JSON report in the directory specified by \f[C]<REPORT_PATH>\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Shows help and usage information
|
|
+.RE
|
|
+.SS Subcommands
|
|
+.SS Whitespace
|
|
+.PP
|
|
+\f[C]dotnet format whitespace\f[R] - Formats code to match \f[C]editorconfig\f[R] settings for whitespace.
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet format whitespace\f[R] subcommand will only run formatting rules associated with whitespace formatting.
|
|
+For a complete list of possible formatting options that you can specify in your \f[I].editorconfig\f[R] file, see the whitespace formatting documentation.
|
|
+.SS Style
|
|
+.PP
|
|
+\f[C]dotnet format style\f[R] - Formats code to match EditorConfig settings for code style.
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet format style\f[R] subcommand will only run formatting rule associated with code style formatting.
|
|
+For a complete list of possible formatting options that you can specify in your \f[C]editorconfig\f[R] file see the code style documentation.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--severity\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The minimum severity of diagnostics to fix.
|
|
+Allowed values are \f[C]info\f[R], \f[C]warn\f[R], and \f[C]error\f[R].
|
|
+The default value is \f[C]warn\f[R]
|
|
+.RE
|
|
+.SS Analyzers
|
|
+.PP
|
|
+\f[C]dotnet format analyzers\f[R] - Formats code to match \f[C]editorconfig\f[R] settings for analyzers.
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet format analyzers\f[R] subcommand will only run formatting rule associated with analyzers.
|
|
+For a list of possible analyzer rules that you can specify in your \f[C]editorconfig\f[R] file see the list of ids for code-analysis quality rules.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--diagnostics <DIAGNOSTICS>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+A space separated list of diagnostic ids to use as a filter when fixing code quality or 3rd party issues.
|
|
+Default value is whichever ids are listed in the \f[C]editorconfig\f[R] file.
|
|
+For a list of built-in analyzer rule ids that you can specify see the list of ids see the documentation of code-analysis quality rules.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--severity\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The minimum severity of diagnostics to fix.
|
|
+Allowed values are \f[C]info\f[R], \f[C]warn\f[R], and \f[C]error\f[R].
|
|
+The default value is \f[C]warn\f[R]
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Format all code in the solution:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet format ./solution.sln
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Clean up all code in the application project:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet format ./src/application.csproj
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Verify that all code is correctly formatted:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet format --verify-no-changes
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Clean up all code in the \f[I]src\f[R] and \f[I]tests\f[R] directory but not in \f[I]src/submodule-a\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet format --include ./src/ ./tests/ --exclude ./src/submodule-a/
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-help.1 b/documentation/manpages/sdk/dotnet-help.1
|
|
index c60cece94c..0fe1fe7117 100644
|
|
--- a/documentation/manpages/sdk/dotnet-help.1
|
|
+++ b/documentation/manpages/sdk/dotnet-help.1
|
|
@@ -1,16 +1,20 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet help command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet help reference
|
|
.PP
|
|
-\f[B]This article applies to: \[OK]\f[R] .NET Core 2.0 SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.0 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet help\f[R] - Shows more detailed documentation online for the specified command.
|
|
.SH SYNOPSIS
|
|
-.PP
|
|
-\f[C]dotnet help <COMMAND_NAME> [-h|--help]\f[R]
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet help <COMMAND_NAME> [-h|--help]
|
|
+\f[R]
|
|
+.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet help\f[R] command opens up the reference page for more detailed information about the specified command at docs.microsoft.com.
|
|
@@ -19,15 +23,15 @@ The \f[C]dotnet help\f[R] command opens up the reference page for more detailed
|
|
\f[B]\f[CB]COMMAND_NAME\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Name of the .NET Core CLI command.
|
|
+Name of the .NET CLI command.
|
|
For a list of the valid CLI commands, see CLI commands.
|
|
.RE
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.SH EXAMPLES
|
|
.IP \[bu] 2
|
|
diff --git a/documentation/manpages/sdk/dotnet-install-script.1 b/documentation/manpages/sdk/dotnet-install-script.1
|
|
index 09d91ee3fa..5a05a02300 100644
|
|
--- a/documentation/manpages/sdk/dotnet-install-script.1
|
|
+++ b/documentation/manpages/sdk/dotnet-install-script.1
|
|
@@ -1,51 +1,125 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet-install scripts" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet-install scripts reference
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet-install.ps1\f[R] | \f[C]dotnet-install.sh\f[R] - Script used to install the .NET Core CLI tools and the shared runtime.
|
|
+\f[C]dotnet-install.ps1\f[R] | \f[C]dotnet-install.sh\f[R] - Script used to install the .NET SDK and the shared runtime.
|
|
.SH SYNOPSIS
|
|
.PP
|
|
Windows:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet-install.ps1 [-Architecture <ARCHITECTURE>] [-AzureFeed]
|
|
+ [-Channel <CHANNEL>] [-DryRun] [-FeedCredential]
|
|
+ [-InstallDir <DIRECTORY>] [-JSonFile <JSONFILE>]
|
|
+ [-NoCdn] [-NoPath] [-ProxyAddress] [-ProxyBypassList <LIST_OF_URLS>]
|
|
+ [-ProxyUseDefaultCredentials] [-Quality <QUALITY>] [-Runtime <RUNTIME>]
|
|
+ [-SkipNonVersionedFiles] [-UncachedFeed] [-Verbose]
|
|
+ [-Version <VERSION>]
|
|
+
|
|
+Get-Help ./dotnet-install.ps1
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
-\f[C]dotnet-install.ps1 [-Channel] [-Version] [-InstallDir] [-Architecture] [-SharedRuntime] [-Runtime] [-DryRun] [-NoPath] [-Verbose] [-AzureFeed] [-UncachedFeed] [-NoCdn] [-FeedCredential] [-ProxyAddress] [-ProxyUseDefaultCredentials] [-SkipNonVersionedFiles] [-Help]\f[R]
|
|
-.PP
|
|
-macOS/Linux:
|
|
+Linux/macOS:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet-install.sh [--architecture <ARCHITECTURE>] [--azure-feed]
|
|
+ [--channel <CHANNEL>] [--dry-run] [--feed-credential]
|
|
+ [--install-dir <DIRECTORY>] [--jsonfile <JSONFILE>]
|
|
+ [--no-cdn] [--no-path] [--quality <QUALITY>]
|
|
+ [--runtime <RUNTIME>] [--runtime-id <RID>]
|
|
+ [--skip-non-versioned-files] [--uncached-feed] [--verbose]
|
|
+ [--version <VERSION>]
|
|
+
|
|
+dotnet-install.sh --help
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
-\f[C]dotnet-install.sh [--channel] [--version] [--install-dir] [--architecture] [--runtime] [--dry-run] [--no-path] [--verbose] [--azure-feed] [--uncached-feed] [--no-cdn] [--feed-credential] [--runtime-id] [--skip-non-versioned-files] [--help]\f[R]
|
|
+The bash script also reads PowerShell switches, so you can use PowerShell switches with the script on Linux/macOS systems.
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet-install\f[R] scripts are used to perform a non-admin installation of the .NET Core SDK, which includes the .NET Core CLI tools and the shared runtime.
|
|
+The \f[C]dotnet-install\f[R] scripts perform a non-admin installation of the .NET SDK, which includes the .NET CLI and the shared runtime.
|
|
+There are two scripts:
|
|
+.IP \[bu] 2
|
|
+A PowerShell script that works on Windows.
|
|
+.IP \[bu] 2
|
|
+A bash script that works on Linux/macOS.
|
|
+.RS
|
|
.PP
|
|
-We recommend that you use the stable version that is hosted on .NET Core main website.
|
|
-The direct paths to the scripts are:
|
|
+[!NOTE] .NET collects telemetry data.
|
|
+To learn more and how to opt out, see .NET SDK telemetry.
|
|
+.RE
|
|
+.SS Purpose
|
|
+.PP
|
|
+The intended use of the scripts is for Continuous Integration (CI) scenarios, where:
|
|
+.IP \[bu] 2
|
|
+The SDK needs to be installed without user interaction and without admin rights.
|
|
+.IP \[bu] 2
|
|
+The SDK installation doesn\[cq]t need to persist across multiple CI runs.
|
|
+.RS 2
|
|
+.PP
|
|
+The typical sequence of events:
|
|
+.IP \[bu] 2
|
|
+CI is triggered.
|
|
+.IP \[bu] 2
|
|
+CI installs the SDK using one of these scripts.
|
|
+.IP \[bu] 2
|
|
+CI finishes its work and clears temporary data including the SDK installation.
|
|
+.RE
|
|
+.PP
|
|
+To set up a development environment or to run apps, use the installers rather than these scripts.
|
|
+.SS Recommended version
|
|
+.PP
|
|
+We recommend that you use the stable version of the scripts:
|
|
.IP \[bu] 2
|
|
-https://dot.net/v1/dotnet-install.sh (bash, UNIX)
|
|
+Bash (Linux/macOS): <https://dot.net/v1/dotnet-install.sh>
|
|
.IP \[bu] 2
|
|
-https://dot.net/v1/dotnet-install.ps1 (Powershell, Windows)
|
|
+PowerShell (Windows): <https://dot.net/v1/dotnet-install.ps1>
|
|
+.SS Script behavior
|
|
.PP
|
|
-The main usefulness of these scripts is in automation scenarios and non-admin installations.
|
|
-There are two scripts: one is a PowerShell script that works on Windows, and the other is a bash script that works on Linux/macOS.
|
|
Both scripts have the same behavior.
|
|
-The bash script also reads PowerShell switches, so you can use PowerShell switches with the script on Linux/macOS systems.
|
|
+They download the ZIP/tarball file from the CLI build drops and proceed to install it in either the default location or in a location specified by \f[C]-InstallDir|--install-dir\f[R].
|
|
.PP
|
|
-The installation scripts download the ZIP/tarball file from the CLI build drops and proceed to install it in either the default location or in a location specified by \f[C]-InstallDir|--install-dir\f[R].
|
|
By default, the installation scripts download the SDK and install it.
|
|
-If you wish to only obtain the shared runtime, specify the \f[C]--runtime\f[R] argument.
|
|
+If you wish to only obtain the shared runtime, specify the \f[C]-Runtime|--runtime\f[R] argument.
|
|
.PP
|
|
By default, the script adds the install location to the $PATH for the current session.
|
|
-Override this default behavior by specifying the \f[C]--no-path\f[R] argument.
|
|
+Override this default behavior by specifying the \f[C]-NoPath|--no-path\f[R] argument.
|
|
+The script doesn\[cq]t set the \f[C]DOTNET_ROOT\f[R] environment variable.
|
|
.PP
|
|
Before running the script, install the required dependencies.
|
|
.PP
|
|
-You can install a specific version using the \f[C]--version\f[R] argument.
|
|
-The version must be specified as a three-part version (for example, 1.0.0-13232).
|
|
-If not provided, it uses the \f[C]latest\f[R] version.
|
|
+You can install a specific version using the \f[C]-Version|--version\f[R] argument.
|
|
+The version must be specified as a three-part version number, such as \f[C]2.1.0\f[R].
|
|
+If the version isn\[cq]t specified, the script installs the \f[C]latest\f[R] version.
|
|
+.PP
|
|
+The install scripts do not update the registry on Windows.
|
|
+They just download the zipped binaries and copy them to a folder.
|
|
+If you want registry key values to be updated, use the .NET installers.
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-Channel <CHANNEL>\f[B]\f[R]
|
|
+\f[B]\f[CB]-Architecture|--architecture <ARCHITECTURE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Architecture of the .NET binaries to install.
|
|
+Possible values are \f[C]<auto>\f[R], \f[C]amd64\f[R], \f[C]x64\f[R], \f[C]x86\f[R], \f[C]arm64\f[R], and \f[C]arm\f[R].
|
|
+The default value is \f[C]<auto>\f[R], which represents the currently running OS architecture.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-AzureFeed|--azure-feed\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the URL for the Azure feed to the installer.
|
|
+We recommended that you don\[cq]t change this value.
|
|
+The default value is \f[C]https://dotnetcli.azureedge.net/dotnet\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-Channel|--channel <CHANNEL>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Specifies the source channel for the installation.
|
|
@@ -55,145 +129,179 @@ The possible values are:
|
|
.IP \[bu] 2
|
|
\f[C]LTS\f[R] - Long-Term Support channel (most current supported release).
|
|
.IP \[bu] 2
|
|
-Two-part version in X.Y format representing a specific release (for example, \f[C]2.0\f[R] or \f[C]1.0\f[R]).
|
|
+Two-part version in A.B format, representing a specific release (for example, \f[C]2.1\f[R] or \f[C]3.0\f[R]).
|
|
.IP \[bu] 2
|
|
-Branch name.
|
|
-For example, \f[C]release/2.0.0\f[R], \f[C]release/2.0.0-preview2\f[R], or \f[C]main\f[R] (for nightly releases).
|
|
+Three-part version in A.B.Cxx format, representing a specific SDK release (for example, 5.0.1xx or 5.0.2xx).
|
|
+Available since the 5.0 release.
|
|
+.PP
|
|
+The \f[C]version\f[R] parameter overrides the \f[C]channel\f[R] parameter when any version other than \f[C]latest\f[R] is used.
|
|
.PP
|
|
The default value is \f[C]LTS\f[R].
|
|
-For more information on .NET support channels, see the .NET Support Policy page.
|
|
+For more information on .NET support channels, see the .NET Support Policy (https://dotnet.microsoft.com/platform/support/policy/dotnet-core) page.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-Version <VERSION>\f[B]\f[R]
|
|
+\f[B]\f[CB]-DryRun|--dry-run\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Represents a specific build version.
|
|
-The possible values are:
|
|
-.IP \[bu] 2
|
|
-\f[C]latest\f[R] - Latest build on the channel (used with the \f[C]-Channel\f[R] option).
|
|
+If set, the script won\[cq]t perform the installation.
|
|
+Instead, it displays what command line to use to consistently install the currently requested version of the .NET CLI.
|
|
+For example, if you specify version \f[C]latest\f[R], it displays a link with the specific version so that this command can be used deterministically in a build script.
|
|
+It also displays the binary\[cq]s location if you prefer to install or download it yourself.
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[C]coherent\f[R] - Latest coherent build on the channel; uses the latest stable package combination (used with Branch name \f[C]-Channel\f[R] options).
|
|
+\f[B]\f[CB]-FeedCredential|--feed-credential\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Used as a query string to append to the Azure feed.
|
|
+It allows changing the URL to use non-public blob storage accounts.
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-Three-part version in X.Y.Z format representing a specific build version; supersedes the \f[C]-Channel\f[R] option.
|
|
-For example: \f[C]2.0.0-preview2-006120\f[R].
|
|
+\f[B]\f[CB]--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-If not specified, \f[C]-Version\f[R] defaults to \f[C]latest\f[R].
|
|
+Prints out help for the script.
|
|
+Applies only to bash script.
|
|
+For PowerShell, use \f[C]Get-Help ./dotnet-install.ps1\f[R].
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-InstallDir <DIRECTORY>\f[B]\f[R]
|
|
+\f[B]\f[CB]-InstallDir|--install-dir <DIRECTORY>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Specifies the installation path.
|
|
The directory is created if it doesn\[cq]t exist.
|
|
-The default value is *%LocalAppData%.
|
|
+The default value is \f[I]%LocalAppData%on Windows and \f[R]/usr/share/dotnet* on Linux/macOS.
|
|
Binaries are placed directly in this directory.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-Architecture <ARCHITECTURE>\f[B]\f[R]
|
|
+\f[B]\f[CB]-JSonFile|--jsonfile <JSONFILE>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Architecture of the .NET Core binaries to install.
|
|
-Possible values are \f[C]<auto>\f[R], \f[C]amd64\f[R], \f[C]x64\f[R], \f[C]x86\f[R], \f[C]arm64\f[R], and \f[C]arm\f[R].
|
|
-The default value is \f[C]<auto>\f[R], which represents the currently running OS architecture.
|
|
+Specifies a path to a global.json file that will be used to determine the SDK version.
|
|
+The \f[I]global.json\f[R] file must have a value for \f[C]sdk:version\f[R].
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-SharedRuntime\f[B]\f[R]
|
|
+\f[B]\f[CB]-NoCdn|--no-cdn\f[B]\f[R]
|
|
.RS 2
|
|
-.RS
|
|
.PP
|
|
-[!NOTE] This parameter is obsolete and may be removed in a future version of the script.
|
|
-The recommended alternative is the \f[C]Runtime\f[R] option.
|
|
-.RE
|
|
-.PP
|
|
-Installs just the shared runtime bits, not the entire SDK.
|
|
-This is equivalent to specifying \f[C]-Runtime dotnet\f[R].
|
|
+Disables downloading from the Azure Content Delivery Network (CDN) and uses the uncached feed directly.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-Runtime <RUNTIME>\f[B]\f[R]
|
|
+\f[B]\f[CB]-NoPath|--no-path\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Installs just the shared runtime, not the entire SDK.
|
|
-The possible values are:
|
|
-.IP \[bu] 2
|
|
-\f[C]dotnet\f[R] - the \f[C]Microsoft.NETCore.App\f[R] shared runtime.
|
|
-.IP \[bu] 2
|
|
-\f[C]aspnetcore\f[R] - the \f[C]Microsoft.AspNetCore.App\f[R] shared runtime.
|
|
+If set, the installation folder isn\[cq]t exported to the path for the current session.
|
|
+By default, the script modifies the PATH, which makes the .NET CLI available immediately after install.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-DryRun\f[B]\f[R]
|
|
+\f[B]\f[CB]-ProxyAddress\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-If set, the script won\[cq]t perform the installation.
|
|
-Instead, it displays what command line to use to consistently install the currently requested version of the .NET Core CLI.
|
|
-For example, if you specify version \f[C]latest\f[R], it displays a link with the specific version so that this command can be used deterministically in a build script.
|
|
-It also displays the binary\[cq]s location if you prefer to install or download it yourself.
|
|
+If set, the installer uses the proxy when making web requests.
|
|
+(Only valid for Windows.)
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-NoPath\f[B]\f[R]
|
|
+\f[B]\f[CB]-ProxyBypassList <LIST_OF_URLS>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-If set, the installation folder isn\[cq]t exported to the path for the current session.
|
|
-By default, the script modifies the PATH, which makes the CLI tools available immediately after install.
|
|
+If set with \f[C]ProxyAddress\f[R], provides a list of comma-separated urls that will bypass the proxy.
|
|
+(Only valid for Windows.)
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-Verbose\f[B]\f[R]
|
|
+\f[B]\f[CB]ProxyUseDefaultCredentials\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Displays diagnostics information.
|
|
+If set, the installer uses the credentials of the current user when using proxy address.
|
|
+(Only valid for Windows.)
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-AzureFeed\f[B]\f[R]
|
|
+\f[B]\f[CB]-Quality|--quality <QUALITY>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Specifies the URL for the Azure feed to the installer.
|
|
-We recommended that you don\[cq]t change this value.
|
|
-The default value is \f[C]https://dotnetcli.azureedge.net/dotnet\f[R].
|
|
+Downloads the latest build of the specified quality in the channel.
|
|
+The possible values are: \f[C]daily\f[R], \f[C]signed\f[R], \f[C]validated\f[R], \f[C]preview\f[R], \f[C]GA\f[R].
|
|
+Works only in combination with \f[C]channel\f[R].
|
|
+Not applicable for current and LTS channels and will be ignored if one of those channels is used.
|
|
+.PP
|
|
+For an SDK installation, use \f[C]channel\f[R] in \f[C]A.B\f[R] or \f[C]A.B.Cxx\f[R] format.
|
|
+For a runtime installation, use \f[C]channel\f[R] in \f[C]A.B\f[R] format.
|
|
+.PP
|
|
+The \f[C]version\f[R] parameter overrides the \f[C]channel\f[R] and \f[C]quality\f[R] parameters when any \f[C]version\f[R] other than \f[C]latest\f[R] is used.
|
|
+.PP
|
|
+Available since since the 5.0 release.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-UncachedFeed\f[B]\f[R]
|
|
+\f[B]\f[CB]-Runtime|--runtime <RUNTIME>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Allows changing the URL for the uncached feed used by this installer.
|
|
-We recommended that you don\[cq]t change this value.
|
|
+Installs just the shared runtime, not the entire SDK.
|
|
+The possible values are:
|
|
+.IP \[bu] 2
|
|
+\f[C]dotnet\f[R] - the \f[C]Microsoft.NETCore.App\f[R] shared runtime.
|
|
+.IP \[bu] 2
|
|
+\f[C]aspnetcore\f[R] - the \f[C]Microsoft.AspNetCore.App\f[R] shared runtime.
|
|
+.IP \[bu] 2
|
|
+\f[C]windowsdesktop\f[R] - the \f[C]Microsoft.WindowsDesktop.App\f[R] shared runtime.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-NoCdn\f[B]\f[R]
|
|
+\f[B]\f[CB]--runtime-id <RID>\f[B] [Deprecated]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Disables downloading from the Azure Content Delivery Network (CDN) and uses the uncached feed directly.
|
|
+Specifies the runtime identifier for which the tools are being installed.
|
|
+Use \f[C]linux-x64\f[R] for portable Linux.
|
|
+(Only valid for Linux/macOS and for versions earlier than .NET Core 2.1.)
|
|
+.PP
|
|
+\f[B]\f[CB]--os <OPERATING_SYSTEM>\f[B]\f[R]
|
|
+.PP
|
|
+Specifies the operating system for which the tools are being installed.
|
|
+Possible values are: \f[C]osx\f[R], \f[C]linux\f[R], \f[C]linux-musl\f[R], \f[C]freebsd\f[R], \f[C]rhel.6\f[R].
|
|
+(Valid for .NET Core 2.1 and later.)
|
|
+.PP
|
|
+The parameter is optional and should only be used when it\[cq]s required to override the operating system that is detected by the script.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-FeedCredential\f[B]\f[R]
|
|
+\f[B]\f[CB]-SharedRuntime|--shared-runtime\f[B]\f[R]
|
|
.RS 2
|
|
+.RS
|
|
.PP
|
|
-Used as a query string to append to the Azure feed.
|
|
-It allows changing the URL to use non-public blob storage accounts.
|
|
+[!NOTE] This parameter is obsolete and may be removed in a future version of the script.
|
|
+The recommended alternative is the \f[C]-Runtime|--runtime\f[R] option.
|
|
+.RE
|
|
+.PP
|
|
+Installs just the shared runtime bits, not the entire SDK.
|
|
+This option is equivalent to specifying \f[C]-Runtime|--runtime dotnet\f[R].
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-ProxyAddress\f[B]\f[R]
|
|
+\f[B]\f[CB]-SkipNonVersionedFiles|--skip-non-versioned-files\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-If set, the installer uses the proxy when making web requests.
|
|
-(Only valid for Windows)
|
|
+Skips installing non-versioned files, such as \f[I]dotnet.exe\f[R], if they already exist.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]ProxyUseDefaultCredentials\f[B]\f[R]
|
|
+\f[B]\f[CB]-UncachedFeed|--uncached-feed\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-If set, the installer uses the credentials of the current user when using proxy address.
|
|
-(Only valid for Windows)
|
|
+Allows changing the URL for the uncached feed used by this installer.
|
|
+We recommended that you don\[cq]t change this value.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-SkipNonVersionedFiles\f[B]\f[R]
|
|
+\f[B]\f[CB]-Verbose|--verbose\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Skips installing non-versioned files, such as \f[I]dotnet.exe\f[R], if they already exist.
|
|
+Displays diagnostics information.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-Help\f[B]\f[R]
|
|
+\f[B]\f[CB]-Version|--version <VERSION>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out help for the script.
|
|
+Represents a specific build version.
|
|
+The possible values are:
|
|
+.IP \[bu] 2
|
|
+\f[C]latest\f[R] - Latest build on the channel (used with the \f[C]-Channel\f[R] option).
|
|
+.IP \[bu] 2
|
|
+Three-part version in X.Y.Z format representing a specific build version; supersedes the \f[C]-Channel\f[R] option.
|
|
+For example: \f[C]2.0.0-preview2-006120\f[R].
|
|
+.PP
|
|
+If not specified, \f[C]-Version\f[R] defaults to \f[C]latest\f[R].
|
|
.RE
|
|
.SH EXAMPLES
|
|
.IP \[bu] 2
|
|
@@ -217,14 +325,14 @@ macOS/Linux:
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Install the latest version from 2.0 channel to the specified location:
|
|
+Install the latest preview version of the 6.0.1xx SDK to the specified location:
|
|
.RS 2
|
|
.PP
|
|
Windows:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-\&./dotnet-install.ps1 -Channel 2.0 -InstallDir C:\[rs]cli
|
|
+\&./dotnet-install.ps1 -Channel 6.0.1xx -Quality preview -InstallDir C:\[rs]cli
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
@@ -232,19 +340,19 @@ macOS/Linux:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-\&./dotnet-install.sh --channel 2.0 --install-dir \[ti]/cli
|
|
+\&./dotnet-install.sh --channel 6.0.1xx --quality preview --install-dir \[ti]/cli
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Install the 1.1.0 version of the shared runtime:
|
|
+Install the 3.0.0 version of the shared runtime:
|
|
.RS 2
|
|
.PP
|
|
Windows:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-\&./dotnet-install.ps1 -Runtime dotnet -Version 1.1.0
|
|
+\&./dotnet-install.ps1 -Runtime dotnet -Version 3.0.0
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
@@ -252,7 +360,7 @@ macOS/Linux:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-\&./dotnet-install.sh --runtime dotnet --version 1.1.0
|
|
+\&./dotnet-install.sh --runtime dotnet --version 3.0.0
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
@@ -268,14 +376,15 @@ Invoke-WebRequest \[aq]https://dot.net/v1/dotnet-install.ps1\[aq] -Proxy $env:HT
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Obtain script and install .NET Core CLI one-liner examples:
|
|
+Obtain script and install .NET CLI one-liner examples:
|
|
.RS 2
|
|
.PP
|
|
Windows:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-\[at]powershell -NoProfile -ExecutionPolicy unrestricted -Command \[dq][Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; &([scriptblock]::Create((Invoke-WebRequest -UseBasicParsing \[aq]https://dot.net/v1/dotnet-install.ps1\[aq]))) <additional install-script args>\[dq]
|
|
+# Run a separate PowerShell process because the script calls exit, so it will end the current PowerShell session.
|
|
+&powershell -NoProfile -ExecutionPolicy unrestricted -Command \[dq][Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; &([scriptblock]::Create((Invoke-WebRequest -UseBasicParsing \[aq]https://dot.net/v1/dotnet-install.ps1\[aq]))) <additional install-script args>\[dq]
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
@@ -289,6 +398,6 @@ curl -sSL https://dot.net/v1/dotnet-install.sh | bash /dev/stdin <additional ins
|
|
.RE
|
|
.SS See also
|
|
.IP \[bu] 2
|
|
-\&.NET Core releases
|
|
+\&.NET releases (https://github.com/dotnet/core/releases)
|
|
.IP \[bu] 2
|
|
-\&.NET Core Runtime and SDK download archive
|
|
+\&.NET Runtime and SDK download archive (https://github.com/dotnet/core/tree/main/release-notes/download-archives)
|
|
diff --git a/documentation/manpages/sdk/dotnet-list-package.1 b/documentation/manpages/sdk/dotnet-list-package.1
|
|
index 6adfe6e581..5bd48b770e 100644
|
|
--- a/documentation/manpages/sdk/dotnet-list-package.1
|
|
+++ b/documentation/manpages/sdk/dotnet-list-package.1
|
|
@@ -1,9 +1,10 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet list package command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet list package
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.2 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet list package\f[R] - Lists the package references for a project or solution.
|
|
@@ -11,23 +12,28 @@
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet list [<PROJECT>|<SOLUTION>] package [--config] [--framework] [--highest-minor] [--highest-patch]
|
|
- [--include-prerelease] [--include-transitive] [--interactive] [--outdated] [--source]
|
|
-dotnet list package [-h|--help]
|
|
+dotnet list [<PROJECT>|<SOLUTION>] package [--config <SOURCE>]
|
|
+ [--deprecated]
|
|
+ [--framework <FRAMEWORK>] [--highest-minor] [--highest-patch]
|
|
+ [--include-prerelease] [--include-transitive] [--interactive]
|
|
+ [--outdated] [--source <SOURCE>] [-v|--verbosity <LEVEL>]
|
|
+ [--vulnerable]
|
|
+
|
|
+dotnet list package -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet list package\f[R] command provides a convenient option to list all NuGet package references for a specific project or a solution.
|
|
You first need to build the project in order to have the assets needed for this command to process.
|
|
-The following example shows the output of the \f[C]dotnet list package\f[R] command for the SentimentAnalysis project:
|
|
+The following example shows the output of the \f[C]dotnet list package\f[R] command for the SentimentAnalysis (https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/SentimentAnalysis) project:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
Project \[aq]SentimentAnalysis\[aq] has the following package references
|
|
[netcoreapp2.1]:
|
|
Top-level Package Requested Resolved
|
|
- > Microsoft.ML 0.11.0 0.11.0
|
|
+ > Microsoft.ML 1.4.0 1.4.0
|
|
> Microsoft.NETCore.App (A) [2.1.0, ) 2.1.0
|
|
|
|
(A) : Auto-referenced package.
|
|
@@ -36,7 +42,7 @@ Project \[aq]SentimentAnalysis\[aq] has the following package references
|
|
.PP
|
|
The \f[B]Requested\f[R] column refers to the package version specified in the project file and can be a range.
|
|
The \f[B]Resolved\f[R] column lists the version that the project is currently using and is always a single value.
|
|
-The packages displaying an \f[C](A)\f[R] right next to their names represent implicit package references that are inferred from your project settings (\f[C]Sdk\f[R] type, \f[C]<TargetFramework>\f[R] or \f[C]<TargetFrameworks>\f[R] property, etc.)
|
|
+The packages displaying an \f[C](A)\f[R] right next to their names represent implicit package references that are inferred from your project settings (\f[C]Sdk\f[R] type, or \f[C]<TargetFramework>\f[R] or \f[C]<TargetFrameworks>\f[R] property).
|
|
.PP
|
|
Use the \f[C]--outdated\f[R] option to find out if there are newer versions available of the packages you\[cq]re using in your projects.
|
|
By default, \f[C]--outdated\f[R] lists the latest stable packages unless the resolved version is also a prerelease version.
|
|
@@ -47,31 +53,25 @@ The following examples shows the output of the \f[C]dotnet list package --outdat
|
|
\f[C]
|
|
The following sources were used:
|
|
https://api.nuget.org/v3/index.json
|
|
+ C:\[rs]Program Files (x86)\[rs]Microsoft SDKs\[rs]NuGetPackages\[rs]
|
|
|
|
Project \[ga]SentimentAnalysis\[ga] has the following updates to its packages
|
|
[netcoreapp2.1]:
|
|
Top-level Package Requested Resolved Latest
|
|
- > Microsoft.ML 0.11.0 0.11.0 1.0.0-preview
|
|
+ > Microsoft.ML 1.4.0 1.4.0 1.5.0-preview
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
If you need to find out whether your project has transitive dependencies, use the \f[C]--include-transitive\f[R] option.
|
|
Transitive dependencies occur when you add a package to your project that in turn relies on another package.
|
|
-The following example shows the output from running the \f[C]dotnet list package --include-transitive\f[R] command for the HelloPlugin project, which displays top-level packages and the packages they depend on:
|
|
+The following example shows the output from running the \f[C]dotnet list package --include-transitive\f[R] command for the HelloPlugin (https://github.com/dotnet/samples/tree/main/core/extensions/AppWithPlugin/HelloPlugin) project, which displays top-level packages and the packages they depend on:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
Project \[aq]HelloPlugin\[aq] has the following package references
|
|
[netcoreapp3.0]:
|
|
- Top-level Package Requested Resolved
|
|
- > Microsoft.NETCore.Platforms (A) [3.0.0-preview3.19128.7, ) 3.0.0-preview3.19128.7
|
|
- > Microsoft.WindowsDesktop.App (A) [3.0.0-preview3-27504-2, ) 3.0.0-preview3-27504-2
|
|
-
|
|
- Transitive Package Resolved
|
|
- > Microsoft.NETCore.Targets 2.0.0
|
|
- > PluginBase 1.0.0
|
|
-
|
|
-(A) : Auto-referenced package.
|
|
+ Transitive Package Resolved
|
|
+ > PluginBase 1.0.0
|
|
\f[R]
|
|
.fi
|
|
.SS Arguments
|
|
@@ -90,6 +90,12 @@ The NuGet sources to use when searching for newer packages.
|
|
Requires the \f[C]--outdated\f[R] option.
|
|
.RE
|
|
.IP \[bu] 2
|
|
+\f[B]\f[CB]--deprecated\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Displays packages that have been deprecated.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
\f[B]\f[CB]--framework <FRAMEWORK>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
@@ -98,31 +104,31 @@ To specify multiple frameworks, repeat the option multiple times.
|
|
For example: \f[C]--framework netcoreapp2.2 --framework netstandard2.0\f[R].
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--highest-minor\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Considers only the packages with a matching major version number when searching for newer packages.
|
|
-Requires the \f[C]--outdated\f[R] option.
|
|
+Requires the \f[C]--outdated\f[R] or \f[C]--deprecated\f[R] option.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--highest-patch\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Considers only the packages with a matching major and minor version numbers when searching for newer packages.
|
|
-Requires the \f[C]--outdated\f[R] option.
|
|
+Requires the \f[C]--outdated\f[R] or \f[C]--deprecated\f[R] option.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--include-prerelease\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Considers packages with prerelease versions when searching for newer packages.
|
|
-Requires the \f[C]--outdated\f[R] option.
|
|
+Requires the \f[C]--outdated\f[R] or \f[C]--deprecated\f[R] option.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--include-transitive\f[B]\f[R]
|
|
@@ -150,7 +156,23 @@ Lists packages that have newer versions available.
|
|
.RS 2
|
|
.PP
|
|
The NuGet sources to use when searching for newer packages.
|
|
-Requires the \f[C]--outdated\f[R] option.
|
|
+Requires the \f[C]--outdated\f[R] or \f[C]--deprecated\f[R] option.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--vulnerable\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Lists packages that have known vulnerabilities.
|
|
+Cannot be combined with \f[C]--deprecated\f[R] or \f[C]--outdated\f[R] options.
|
|
.RE
|
|
.SH EXAMPLES
|
|
.IP \[bu] 2
|
|
diff --git a/documentation/manpages/sdk/dotnet-list-reference.1 b/documentation/manpages/sdk/dotnet-list-reference.1
|
|
index 61056a5c0e..ef42860081 100644
|
|
--- a/documentation/manpages/sdk/dotnet-list-reference.1
|
|
+++ b/documentation/manpages/sdk/dotnet-list-reference.1
|
|
@@ -1,33 +1,39 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet list reference command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet list reference
|
|
.PP
|
|
-\f[B]This topic applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet list reference\f[R] - Lists project-to-project references.
|
|
.SH SYNOPSIS
|
|
-.PP
|
|
-\f[C]dotnet list [<PROJECT>|<SOLUTION>] reference [-h|--help]\f[R]
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet list [<PROJECT>] reference
|
|
+
|
|
+dotnet list -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet list reference\f[R] command provides a convenient option to list project references for a given project or solution.
|
|
+The \f[C]dotnet list reference\f[R] command provides a convenient option to list project references for a given project.
|
|
.SS Arguments
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]PROJECT | SOLUTION\f[B]\f[R]
|
|
+\f[B]\f[CB]PROJECT\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Specifies the project or solution file to use for listing references.
|
|
-If not specified, the command searches the current directory for a project file.
|
|
+The project file to operate on.
|
|
+If a file is not specified, the command will search the current directory for one.
|
|
.RE
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.SH EXAMPLES
|
|
.IP \[bu] 2
|
|
diff --git a/documentation/manpages/sdk/dotnet-migrate.1 b/documentation/manpages/sdk/dotnet-migrate.1
|
|
index a6895ff5a0..453d640ba2 100644
|
|
--- a/documentation/manpages/sdk/dotnet-migrate.1
|
|
+++ b/documentation/manpages/sdk/dotnet-migrate.1
|
|
@@ -1,10 +1,10 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet migrate command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet migrate
|
|
.PP
|
|
-\f[B]This article applies to: \[OK]\f[R] .NET Core 1.x SDK \f[B]\[OK]\f[R] .NET Core 2.x SDK
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet migrate\f[R] - Migrates a Preview 2 .NET Core project to a .NET Core SDK-style project.
|
|
@@ -12,16 +12,22 @@
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet migrate [<SOLUTION_FILE|PROJECT_DIR>] [--format-report-file-json] [-r|--report-file] [-s|--skip-project-references] [--skip-backup] [-t|--template-file] [-v|--sdk-package-version] [-x|--xproj-file]
|
|
-dotnet migrate [-h|--help]
|
|
+dotnet migrate [<SOLUTION_FILE|PROJECT_DIR>] [--format-report-file-json <REPORT_FILE>]
|
|
+ [-r|--report-file <REPORT_FILE>] [-s|--skip-project-references [Debug|Release]]
|
|
+ [--skip-backup] [-t|--template-file <TEMPLATE_FILE>] [-v|--sdk-package-version]
|
|
+ [-x|--xproj-file]
|
|
+
|
|
+dotnet migrate -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet migrate\f[R] command migrates a valid Preview 2 \f[I]project.json\f[R]-based project to a valid .NET Core SDK-style \f[I]csproj\f[R] project.
|
|
+This command is deprecated.
|
|
+The \f[C]dotnet migrate\f[R] command is no longer available starting with .NET Core 3.0 SDK.
|
|
+It can only migrate a Preview 2 .NET Core project to a 1.x .NET Core project, which is out of support.
|
|
.PP
|
|
By default, the command migrates the root project and any project references that the root project contains.
|
|
-This behavior is disabled using the \f[C]--skip-project-references\f[R] option at runtime.
|
|
+This behavior is disabled using the \f[C]--skip-project-references\f[R] option at run time.
|
|
.PP
|
|
Migration can be performed on the following assets:
|
|
.IP \[bu] 2
|
|
@@ -42,8 +48,6 @@ If you use the \f[C]--report-file <REPORT_FILE>\f[R] option, the output is saved
|
|
The \f[C]dotnet migrate\f[R] command only supports valid Preview 2 \f[I]project.json\f[R]-based projects.
|
|
This means that you cannot use it to migrate DNX or Preview 1 \f[I]project.json\f[R]-based projects directly to MSBuild/csproj projects.
|
|
You first need to manually migrate the project to a Preview 2 \f[I]project.json\f[R]-based project and then use the \f[C]dotnet migrate\f[R] command to migrate the project.
|
|
-.PP
|
|
-The \f[C]dotnet migrate\f[R] command is no longer available starting with .NET Core 3.0 SDK.
|
|
.SS Arguments
|
|
.PP
|
|
\f[C]PROJECT_JSON/GLOBAL_JSON/SOLUTION_FILE/PROJECT_DIR\f[R]
|
|
diff --git a/documentation/manpages/sdk/dotnet-msbuild.1 b/documentation/manpages/sdk/dotnet-msbuild.1
|
|
index a1aaf28852..63a60651c5 100644
|
|
--- a/documentation/manpages/sdk/dotnet-msbuild.1
|
|
+++ b/documentation/manpages/sdk/dotnet-msbuild.1
|
|
@@ -1,26 +1,33 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet msbuild command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet msbuild
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet msbuild\f[R] - Builds a project and all of its dependencies.
|
|
+Note: A solution or project file may need to be specified if there are multiple.
|
|
.SH SYNOPSIS
|
|
-.PP
|
|
-\f[C]dotnet msbuild <msbuild_arguments> [-h]\f[R]
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet msbuild <MSBUILD_ARGUMENTS>
|
|
+
|
|
+dotnet msbuild -h
|
|
+\f[R]
|
|
+.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet msbuild\f[R] command allows access to a fully functional MSBuild.
|
|
.PP
|
|
-The command has the exact same capabilities as the existing MSBuild command-line client for SDK-style project only.
|
|
+The command has the exact same capabilities as the existing MSBuild command-line client for SDK-style projects only.
|
|
The options are all the same.
|
|
-For more information about the available options, see the MSBuild Command-Line Reference.
|
|
+For more information about the available options, see the MSBuild command-line reference.
|
|
.PP
|
|
-The dotnet build command is equivalent to \f[C]dotnet msbuild -restore -target:Build\f[R].
|
|
-\f[C]dotnet build\f[R] is more commonly used for building projects, but \f[C]dotnet msbuild\f[R] gives you more control.
|
|
-For example, if you have a specific target you want to run (without running the build target), you probably want to use \f[C]dotnet msbuild\f[R].
|
|
+The dotnet build command is equivalent to \f[C]dotnet msbuild -restore\f[R].
|
|
+When you don\[cq]t want to build the project and you have a specific target you want to run, use \f[C]dotnet build\f[R] or \f[C]dotnet msbuild\f[R] and specify the target.
|
|
.SH EXAMPLES
|
|
.IP \[bu] 2
|
|
Build a project and its dependencies:
|
|
@@ -38,7 +45,7 @@ Build a project and its dependencies using Release configuration:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet msbuild -p:Configuration=Release
|
|
+dotnet msbuild -property:Configuration=Release
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
@@ -48,7 +55,7 @@ Run the publish target and publish for the \f[C]osx.10.11-x64\f[R] RID:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet msbuild -t:Publish -p:RuntimeIdentifiers=osx.10.11-x64
|
|
+dotnet msbuild -target:Publish -property:RuntimeIdentifiers=osx.10.11-x64
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
@@ -58,7 +65,8 @@ See the whole project with all targets included by the SDK:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet msbuild -pp
|
|
+dotnet msbuild -preprocess
|
|
+dotnet msbuild -preprocess:<fileName>.xml
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-new-install.1 b/documentation/manpages/sdk/dotnet-new-install.1
|
|
new file mode 100644
|
|
index 0000000000..635fcb8afc
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-new-install.1
|
|
@@ -0,0 +1,85 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet new \[en]install option
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.0 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet new --install\f[R] - installs a template package.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --install <PATH|NUGET_ID> [--interactive] [--nuget-source <SOURCE>]
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet new --install\f[R] command installs a template package from the \f[C]PATH\f[R] or \f[C]NUGET_ID\f[R] provided.
|
|
+If you want to install a prerelease version of a template package, specify the version in the format \f[C]<package-name>::<package-version>\f[R].
|
|
+By default, \f[C]dotnet new\f[R] passes * for the version, which represents the latest stable package version.
|
|
+For more information, see the Examples section.
|
|
+.PP
|
|
+If a version of the template was already installed when you run this command, the template will be updated to the specified version, or to the latest stable version if no version was specified.
|
|
+For information on creating custom templates, see Custom templates for dotnet new.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+Available since .NET 5.0 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--nuget-source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+By default, \f[C]dotnet new --install\f[R] uses the hierarchy of NuGet configuration files from the current directory to determine the NuGet source the package can be installed from.
|
|
+If \f[C]--nuget-source\f[R] is specified, the source will be added to the list of sources to be checked.
|
|
+.PD 0
|
|
+.P
|
|
+.PD
|
|
+To check the configured sources for the current directory use \f[C]dotnet nuget list source\f[R].
|
|
+For more information, see Common NuGet Configurations
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Install the latest version of SPA templates for ASP.NET Core:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --install Microsoft.DotNet.Web.Spa.ProjectTemplates
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Install version 2.0 of the SPA templates for ASP.NET Core:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --install Microsoft.DotNet.Web.Spa.ProjectTemplates::2.0.0
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Install version 2.0 of the SPA templates for ASP.NET Core from a custom NuGet source using interactive mode:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --install Microsoft.DotNet.Web.Spa.ProjectTemplates::2.0.0 --nuget-source \[dq]https://api.my-custom-nuget.com/v3/index.json\[dq] --interactive
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+dotnet new command
|
|
+.IP \[bu] 2
|
|
+dotnet new \[en]search option
|
|
+.IP \[bu] 2
|
|
+Custom templates for dotnet new
|
|
diff --git a/documentation/manpages/sdk/dotnet-new-list.1 b/documentation/manpages/sdk/dotnet-new-list.1
|
|
new file mode 100644
|
|
index 0000000000..e0bf9d3ab0
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-new-list.1
|
|
@@ -0,0 +1,164 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet new \[en]list option
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.0 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet new --list\f[R] - Lists available templates to be run using \f[C]dotnet new\f[R].
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new [<TEMPLATE_NAME>] -l|--list [--author <AUTHOR>] [-lang|--language {\[dq]C#\[dq]|\[dq]F#\[dq]|VB}]
|
|
+ [--tag <TAG>] [--type <TYPE>] [--columns <COLUMNS>] [--columns-all]
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet new --list\f[R] option lists available templates to use with \f[C]dotnet new\f[R].
|
|
+If the is specified, lists templates containing the specified name.
|
|
+This option lists only default and installed templates.
|
|
+To find templates in NuGet that you can install locally, use the \f[C]--search\f[R] option.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]TEMPLATE_NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+If the argument is specified, only the templates containing \f[C]<TEMPLATE_NAME>\f[R] in template name or short name will be shown.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--author <AUTHOR>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Filters templates based on template author.
|
|
+Partial match is supported.
|
|
+Available since .NET Core 5.0.300 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--columns <COLUMNS>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Comma-separated list of columns to display in the output.
|
|
+The supported columns are:
|
|
+.IP \[bu] 2
|
|
+\f[C]language\f[R] - A comma-separated list of languages supported by the template.
|
|
+.IP \[bu] 2
|
|
+\f[C]tags\f[R] - The list of template tags.
|
|
+.IP \[bu] 2
|
|
+\f[C]author\f[R] - The template author.
|
|
+.IP \[bu] 2
|
|
+\f[C]type\f[R] - The template type: project or item.
|
|
+.PP
|
|
+The template name and short name are always shown.
|
|
+The default list of columns is template name, short name, language, and tags.
|
|
+This list is equivalent to specifying \f[C]--columns=language,tags\f[R].
|
|
+Available since .NET Core 5.0.300 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--columns-all\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Displays all columns in the output.
|
|
+Available since .NET Core 5.0.300 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-lang|--language {C#|F#|VB}\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Filters templates based on language supported by the template.
|
|
+The language accepted varies by the template.
|
|
+Not valid for some templates.
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] Some shells interpret \f[C]#\f[R] as a special character.
|
|
+In those cases, enclose the language parameter value in quotes.
|
|
+For example, \f[C]dotnet new --list --language \[dq]F#\[dq]\f[R].
|
|
+.RE
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tag <TAG>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Filters templates based on template tags.
|
|
+To be selected, a template must have at least one tag that exactly matches the criteria.
|
|
+Available since .NET Core 5.0.300 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--type <TYPE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Filters templates based on template type.
|
|
+Predefined values are \f[C]project\f[R] and \f[C]item\f[R].
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+List all templates
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --list
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+List all Single Page Application (SPA) templates:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new spa --list
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+List all templates matching the \f[I]we\f[R] substring.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new we --list
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+List all templates matching the \f[I]we\f[R] substring that support the F# language.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new we --list --language \[dq]F#\[dq]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+List all item templates.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --list --type item
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+List all C# templates, showing the author and the type in the output.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --list --language \[dq]C#\[dq] --columns \[dq]author,type\[dq]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+dotnet new command
|
|
+.IP \[bu] 2
|
|
+dotnet new \[en]search option
|
|
+.IP \[bu] 2
|
|
+Custom templates for dotnet new
|
|
diff --git a/documentation/manpages/sdk/dotnet-new-sdk-templates.1 b/documentation/manpages/sdk/dotnet-new-sdk-templates.1
|
|
new file mode 100644
|
|
index 0000000000..a84c5bbf84
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-new-sdk-templates.1
|
|
@@ -0,0 +1,1603 @@
|
|
+'\" t
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH .NET default templates for dotnet new
|
|
+.PP
|
|
+When you install the .NET SDK (https://dotnet.microsoft.com/download), you receive over a dozen built-in templates for creating projects and files, including console apps, class libraries, unit test projects, ASP.NET Core apps (including Angular (https://angular.io/) and React (https://reactjs.org/) projects), and configuration files.
|
|
+To list the built-in templates, run the \f[C]dotnet new\f[R] command with the \f[C]-l|--list\f[R] option:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --list
|
|
+\f[R]
|
|
+.fi
|
|
+.PP
|
|
+The following table shows the templates that come pre-installed with the .NET SDK.
|
|
+The default language for the template is shown inside the brackets.
|
|
+Click on the short name link to see the specific template options.
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l l l l.
|
|
+T{
|
|
+Templates
|
|
+T}@T{
|
|
+Short name
|
|
+T}@T{
|
|
+Language
|
|
+T}@T{
|
|
+Tags
|
|
+T}@T{
|
|
+Introduced
|
|
+T}
|
|
+_
|
|
+T{
|
|
+Console Application
|
|
+T}@T{
|
|
+\f[C]console\f[R]
|
|
+T}@T{
|
|
+[C#], F#, VB
|
|
+T}@T{
|
|
+Common/Console
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+Class library
|
|
+T}@T{
|
|
+\f[C]classlib\f[R]
|
|
+T}@T{
|
|
+[C#], F#, VB
|
|
+T}@T{
|
|
+Common/Library
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+WPF Application
|
|
+T}@T{
|
|
+\f[C]wpf\f[R]
|
|
+T}@T{
|
|
+[C#], VB
|
|
+T}@T{
|
|
+Common/WPF
|
|
+T}@T{
|
|
+3.0 (5.0 for VB)
|
|
+T}
|
|
+T{
|
|
+WPF Class library
|
|
+T}@T{
|
|
+\f[C]wpflib\f[R]
|
|
+T}@T{
|
|
+[C#], VB
|
|
+T}@T{
|
|
+Common/WPF
|
|
+T}@T{
|
|
+3.0 (5.0 for VB)
|
|
+T}
|
|
+T{
|
|
+WPF Custom Control Library
|
|
+T}@T{
|
|
+\f[C]wpfcustomcontrollib\f[R]
|
|
+T}@T{
|
|
+[C#], VB
|
|
+T}@T{
|
|
+Common/WPF
|
|
+T}@T{
|
|
+3.0 (5.0 for VB)
|
|
+T}
|
|
+T{
|
|
+WPF User Control Library
|
|
+T}@T{
|
|
+\f[C]wpfusercontrollib\f[R]
|
|
+T}@T{
|
|
+[C#], VB
|
|
+T}@T{
|
|
+Common/WPF
|
|
+T}@T{
|
|
+3.0 (5.0 for VB)
|
|
+T}
|
|
+T{
|
|
+Windows Forms (WinForms) Application
|
|
+T}@T{
|
|
+\f[C]winforms\f[R]
|
|
+T}@T{
|
|
+[C#], VB
|
|
+T}@T{
|
|
+Common/WinForms
|
|
+T}@T{
|
|
+3.0 (5.0 for VB)
|
|
+T}
|
|
+T{
|
|
+Windows Forms (WinForms) Class library
|
|
+T}@T{
|
|
+\f[C]winformslib\f[R]
|
|
+T}@T{
|
|
+[C#], VB
|
|
+T}@T{
|
|
+Common/WinForms
|
|
+T}@T{
|
|
+3.0 (5.0 for VB)
|
|
+T}
|
|
+T{
|
|
+Worker Service
|
|
+T}@T{
|
|
+\f[C]worker\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Common/Worker/Web
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+T{
|
|
+Unit Test Project
|
|
+T}@T{
|
|
+\f[C]mstest\f[R]
|
|
+T}@T{
|
|
+[C#], F#, VB
|
|
+T}@T{
|
|
+Test/MSTest
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+NUnit 3 Test Project
|
|
+T}@T{
|
|
+\f[C]nunit\f[R]
|
|
+T}@T{
|
|
+[C#], F#, VB
|
|
+T}@T{
|
|
+Test/NUnit
|
|
+T}@T{
|
|
+2.1.400
|
|
+T}
|
|
+T{
|
|
+NUnit 3 Test Item
|
|
+T}@T{
|
|
+\f[C]nunit-test\f[R]
|
|
+T}@T{
|
|
+[C#], F#, VB
|
|
+T}@T{
|
|
+Test/NUnit
|
|
+T}@T{
|
|
+2.2
|
|
+T}
|
|
+T{
|
|
+xUnit Test Project
|
|
+T}@T{
|
|
+\f[C]xunit\f[R]
|
|
+T}@T{
|
|
+[C#], F#, VB
|
|
+T}@T{
|
|
+Test/xUnit
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+Razor Component
|
|
+T}@T{
|
|
+\f[C]razorcomponent\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/ASP.NET
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+T{
|
|
+Razor Page
|
|
+T}@T{
|
|
+\f[C]page\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/ASP.NET
|
|
+T}@T{
|
|
+2.0
|
|
+T}
|
|
+T{
|
|
+MVC ViewImports
|
|
+T}@T{
|
|
+\f[C]viewimports\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/ASP.NET
|
|
+T}@T{
|
|
+2.0
|
|
+T}
|
|
+T{
|
|
+MVC ViewStart
|
|
+T}@T{
|
|
+\f[C]viewstart\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/ASP.NET
|
|
+T}@T{
|
|
+2.0
|
|
+T}
|
|
+T{
|
|
+Blazor Server App
|
|
+T}@T{
|
|
+\f[C]blazorserver\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/Blazor
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+T{
|
|
+Blazor WebAssembly App
|
|
+T}@T{
|
|
+\f[C]blazorwasm\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/Blazor/WebAssembly
|
|
+T}@T{
|
|
+3.1.300
|
|
+T}
|
|
+T{
|
|
+ASP.NET Core Empty
|
|
+T}@T{
|
|
+\f[C]web\f[R]
|
|
+T}@T{
|
|
+[C#], F#
|
|
+T}@T{
|
|
+Web/Empty
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+ASP.NET Core Web App (Model-View-Controller)
|
|
+T}@T{
|
|
+\f[C]mvc\f[R]
|
|
+T}@T{
|
|
+[C#], F#
|
|
+T}@T{
|
|
+Web/MVC
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+ASP.NET Core Web App
|
|
+T}@T{
|
|
+\f[C]webapp, razor\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/MVC/Razor Pages
|
|
+T}@T{
|
|
+2.2, 2.0
|
|
+T}
|
|
+T{
|
|
+ASP.NET Core with Angular
|
|
+T}@T{
|
|
+\f[C]angular\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/MVC/SPA
|
|
+T}@T{
|
|
+2.0
|
|
+T}
|
|
+T{
|
|
+ASP.NET Core with React.js
|
|
+T}@T{
|
|
+\f[C]react\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/MVC/SPA
|
|
+T}@T{
|
|
+2.0
|
|
+T}
|
|
+T{
|
|
+ASP.NET Core with React.js and Redux
|
|
+T}@T{
|
|
+\f[C]reactredux\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/MVC/SPA
|
|
+T}@T{
|
|
+2.0
|
|
+T}
|
|
+T{
|
|
+Razor Class Library
|
|
+T}@T{
|
|
+\f[C]razorclasslib\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/Razor/Library/Razor Class Library
|
|
+T}@T{
|
|
+2.1
|
|
+T}
|
|
+T{
|
|
+ASP.NET Core Web API
|
|
+T}@T{
|
|
+\f[C]webapi\f[R]
|
|
+T}@T{
|
|
+[C#], F#
|
|
+T}@T{
|
|
+Web/WebAPI
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+ASP.NET Core gRPC Service
|
|
+T}@T{
|
|
+\f[C]grpc\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/gRPC
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+T{
|
|
+dotnet gitignore file
|
|
+T}@T{
|
|
+\f[C]gitignore\f[R]
|
|
+T}@T{
|
|
+T}@T{
|
|
+Config
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+T{
|
|
+global.json file
|
|
+T}@T{
|
|
+\f[C]globaljson\f[R]
|
|
+T}@T{
|
|
+T}@T{
|
|
+Config
|
|
+T}@T{
|
|
+2.0
|
|
+T}
|
|
+T{
|
|
+NuGet Config
|
|
+T}@T{
|
|
+\f[C]nugetconfig\f[R]
|
|
+T}@T{
|
|
+T}@T{
|
|
+Config
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+Dotnet local tool manifest file
|
|
+T}@T{
|
|
+\f[C]tool-manifest\f[R]
|
|
+T}@T{
|
|
+T}@T{
|
|
+Config
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+T{
|
|
+Web Config
|
|
+T}@T{
|
|
+\f[C]webconfig\f[R]
|
|
+T}@T{
|
|
+T}@T{
|
|
+Config
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+Solution File
|
|
+T}@T{
|
|
+\f[C]sln\f[R]
|
|
+T}@T{
|
|
+T}@T{
|
|
+Solution
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+Protocol Buffer File
|
|
+T}@T{
|
|
+\f[C]proto\f[R]
|
|
+T}@T{
|
|
+T}@T{
|
|
+Web/gRPC
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+.TE
|
|
+.SS Template options
|
|
+.PP
|
|
+Each template may have additional options available.
|
|
+The core templates have the following additional options:
|
|
+.SS \f[C]console\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.PP
|
|
+The following table lists the default values according to the SDK version number you\[cq]re using:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+SDK version
|
|
+T}@T{
|
|
+Default value
|
|
+T}
|
|
+_
|
|
+T{
|
|
+5.0
|
|
+T}@T{
|
|
+\f[C]net5.0\f[R]
|
|
+T}
|
|
+T{
|
|
+3.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.1\f[R]
|
|
+T}
|
|
+T{
|
|
+3.0
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.0\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+The ability to create a project for an earlier TFM depends on having that version of the SDK installed.
|
|
+For example, if you have only SDK 5.0 installed, then the only value available for \f[C]--framework\f[R] is \f[C]net5.0\f[R].
|
|
+If you install SDK 3.1, the value \f[C]netcoreapp3.1\f[R] becomes available for \f[C]--framework\f[R].
|
|
+If you install SDK 2.1, \f[C]netcoreapp2.1\f[R] becomes available, and so on.
|
|
+So by specifying \f[C]--framework netcoreapp2.1\f[R] you can use SDK 2.1 even while running \f[C]dotnet new\f[R] in SDK 5.0.
|
|
+.PP
|
|
+Alternatively, to create a project that targets a framework earlier than the SDK that you\[cq]re using, you might be able to do it by installing the NuGet package for the template.
|
|
+Common (https://www.nuget.org/packages?q=Microsoft.DotNet.Common.ProjectTemplates), web (https://www.nuget.org/packages?q=Microsoft.DotNet.Web.ProjectTemplates), and SPA (https://www.nuget.org/packages?q=Microsoft.DotNet.Web.Spa.ProjectTemplates) project types use different packages per target framework moniker (TFM).
|
|
+For example, to create a \f[C]console\f[R] project that targets \f[C]netcoreapp1.0\f[R], run \f[C]dotnet new --install\f[R] on \f[C]Microsoft.DotNet.Common.ProjectTemplates.1.x\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--langVersion <VERSION_NUMBER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the \f[C]LangVersion\f[R] property in the created project file.
|
|
+For example, use \f[C]--langVersion 7.3\f[R] to use C# 7.3.
|
|
+Not supported for F#.
|
|
+Available since .NET Core 2.2 SDK.
|
|
+.PP
|
|
+For a list of default C# versions, see Defaults.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+If specified, doesn\[cq]t execute an implicit restore during project creation.
|
|
+Available since .NET Core 2.2 SDK.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]classlib\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+Values: \f[C]net5.0\f[R] or \f[C]netcoreapp<version>\f[R] to create a .NET Class Library or \f[C]netstandard<version>\f[R] to create a .NET Standard Class Library.
|
|
+The default value for .NET 5.0 SDK is \f[C]net5.0\f[R].
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--langVersion <VERSION_NUMBER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the \f[C]LangVersion\f[R] property in the created project file.
|
|
+For example, use \f[C]--langVersion 7.3\f[R] to use C# 7.3.
|
|
+Not supported for F#.
|
|
+Available since .NET Core 2.2 SDK.
|
|
+.PP
|
|
+For a list of default C# versions, see Defaults.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]wpf\f[R], \f[C]wpflib\f[R], \f[C]wpfcustomcontrollib\f[R], \f[C]wpfusercontrollib\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+The default value is \f[C]net5.0\f[R].
|
|
+Available since .NET Core 3.1 SDK.
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--langVersion <VERSION_NUMBER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the \f[C]LangVersion\f[R] property in the created project file.
|
|
+For example, use \f[C]--langVersion 7.3\f[R] to use C# 7.3.
|
|
+.PP
|
|
+For a list of default C# versions, see Defaults.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]winforms\f[R], \f[C]winformslib\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--langVersion <VERSION_NUMBER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the \f[C]LangVersion\f[R] property in the created project file.
|
|
+For example, use \f[C]--langVersion 7.3\f[R] to use C# 7.3.
|
|
+.PP
|
|
+For a list of default C# versions, see Defaults.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]worker\f[R], \f[C]grpc\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+The default value is \f[C]netcoreapp3.1\f[R].
|
|
+Available since .NET Core 3.1 SDK.
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--exclude-launch-settings\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Excludes \f[I]launchSettings.json\f[R] from the generated template.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]mstest\f[R], \f[C]xunit\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+Option available since .NET Core 3.0 SDK.
|
|
+.PP
|
|
+The following table lists the default values according to the SDK version number you\[cq]re using:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+SDK version
|
|
+T}@T{
|
|
+Default value
|
|
+T}
|
|
+_
|
|
+T{
|
|
+5.0
|
|
+T}@T{
|
|
+\f[C]net5.0\f[R]
|
|
+T}
|
|
+T{
|
|
+3.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.1\f[R]
|
|
+T}
|
|
+T{
|
|
+3.0
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.0\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-p|--enable-pack\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Enables packaging for the project using dotnet pack.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]nunit\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+.PP
|
|
+The following table lists the default values according to the SDK version number you\[cq]re using:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+SDK version
|
|
+T}@T{
|
|
+Default value
|
|
+T}
|
|
+_
|
|
+T{
|
|
+5.0
|
|
+T}@T{
|
|
+\f[C]net5.0\f[R]
|
|
+T}
|
|
+T{
|
|
+3.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.1\f[R]
|
|
+T}
|
|
+T{
|
|
+3.0
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.0\f[R]
|
|
+T}
|
|
+T{
|
|
+2.2
|
|
+T}@T{
|
|
+\f[C]netcoreapp2.2\f[R]
|
|
+T}
|
|
+T{
|
|
+2.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp2.1\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-p|--enable-pack\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Enables packaging for the project using dotnet pack.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]page\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-na|--namespace <NAMESPACE_NAME>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Namespace for the generated code.
|
|
+The default value is \f[C]MyApp.Namespace\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-np|--no-pagemodel\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Creates the page without a PageModel.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]viewimports\f[R], \f[C]proto\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-na|--namespace <NAMESPACE_NAME>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Namespace for the generated code.
|
|
+The default value is \f[C]MyApp.Namespace\f[R].
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]blazorserver\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-au|--auth <AUTHENTICATION_TYPE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The type of authentication to use.
|
|
+The possible values are:
|
|
+.IP \[bu] 2
|
|
+\f[C]None\f[R] - No authentication (Default).
|
|
+.IP \[bu] 2
|
|
+\f[C]Individual\f[R] - Individual authentication.
|
|
+.IP \[bu] 2
|
|
+\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
+.IP \[bu] 2
|
|
+\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
+.IP \[bu] 2
|
|
+\f[C]MultiOrg\f[R] - Organizational authentication for multiple tenants.
|
|
+.IP \[bu] 2
|
|
+\f[C]Windows\f[R] - Windows authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--aad-b2c-instance <INSTANCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Azure Active Directory B2C instance to connect to.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]https://login.microsoftonline.com/tfp/\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-ssp|--susi-policy-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The sign-in and sign-up policy ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-rp|--reset-password-policy-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The reset password policy ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-ep|--edit-profile-policy-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The edit profile policy ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--aad-instance <INSTANCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Azure Active Directory instance to connect to.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
+The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--client-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Client ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] authentication.
|
|
+The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--domain <DOMAIN>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The domain for the directory tenant.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]qualified.domain.name\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tenant-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The TenantId ID of the directory to connect to.
|
|
+Use with \f[C]SingleOrg\f[R] authentication.
|
|
+The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--callback-path <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The request path within the application\[cq]s base path of the redirect URI.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]/signin-oidc\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-r|--org-read-access\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows this application read-access to the directory.
|
|
+Only applies to \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--exclude-launch-settings\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Excludes \f[I]launchSettings.json\f[R] from the generated template.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-https\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Turns off HTTPS.
|
|
+This option only applies if \f[C]Individual\f[R], \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] aren\[cq]t being used for \f[C]--auth\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-uld|--use-local-db\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies LocalDB should be used instead of SQLite.
|
|
+Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]blazorwasm\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+.PP
|
|
+The following table lists the default values according to the SDK version number you\[cq]re using:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+SDK version
|
|
+T}@T{
|
|
+Default value
|
|
+T}
|
|
+_
|
|
+T{
|
|
+5.0
|
|
+T}@T{
|
|
+\f[C]net5.0\f[R]
|
|
+T}
|
|
+T{
|
|
+3.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.1\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-ho|--hosted\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Includes an ASP.NET Core host for the Blazor WebAssembly app.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-au|--auth <AUTHENTICATION_TYPE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The type of authentication to use.
|
|
+The possible values are:
|
|
+.IP \[bu] 2
|
|
+\f[C]None\f[R] - No authentication (Default).
|
|
+.IP \[bu] 2
|
|
+\f[C]Individual\f[R] - Individual authentication.
|
|
+.IP \[bu] 2
|
|
+\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
+.IP \[bu] 2
|
|
+\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--authority <AUTHORITY>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The authority of the OIDC provider.
|
|
+Use with \f[C]Individual\f[R] authentication.
|
|
+The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--aad-b2c-instance <INSTANCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Azure Active Directory B2C instance to connect to.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]https://aadB2CInstance.b2clogin.com/\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-ssp|--susi-policy-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The sign-in and sign-up policy ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--aad-instance <INSTANCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Azure Active Directory instance to connect to.
|
|
+Use with \f[C]SingleOrg\f[R] authentication.
|
|
+The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--client-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Client ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]Individual\f[R] authentication in standalone scenarios.
|
|
+The default value is \f[C]33333333-3333-3333-33333333333333333\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--domain <DOMAIN>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The domain for the directory tenant.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]qualified.domain.name\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--app-id-uri <URI>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The App ID Uri for the server API you want to call.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]api.id.uri\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--api-client-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Client ID for the API that the server hosts.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-s|--default-scope <SCOPE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The API scope the client needs to request to provision an access token.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]user_impersonation\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tenant-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The TenantId ID of the directory to connect to.
|
|
+Use with \f[C]SingleOrg\f[R] authentication.
|
|
+The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-r|--org-read-access\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows this application read-access to the directory.
|
|
+Only applies to \f[C]SingleOrg\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--exclude-launch-settings\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Excludes \f[I]launchSettings.json\f[R] from the generated template.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-p|--pwa\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+produces a Progressive Web Application (PWA) supporting installation and offline use.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-https\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Turns off HTTPS.
|
|
+This option only applies if \f[C]Individual\f[R], \f[C]IndividualB2C\f[R], or \f[C]SingleOrg\f[R] aren\[cq]t being used for \f[C]--auth\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-uld|--use-local-db\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies LocalDB should be used instead of SQLite.
|
|
+Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--called-api-url <URL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+URL of the API to call from the web app.
|
|
+Only applies to \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication without an ASP.NET Core host specified.
|
|
+The default value is \f[C]https://graph.microsoft.com/v1.0/me\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--calls-graph\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies if the web app calls Microsoft Graph.
|
|
+Only applies to \f[C]SingleOrg\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--called-api-scopes <SCOPES>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Scopes to request to call the API from the web app.
|
|
+Only applies to \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication without an ASP.NET Core host specified.
|
|
+The default is \f[C]user.read\f[R].
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]web\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--exclude-launch-settings\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Excludes \f[I]launchSettings.json\f[R] from the generated template.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+Option not available in .NET Core 2.2 SDK.
|
|
+.PP
|
|
+The following table lists the default values according to the SDK version number you\[cq]re using:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+SDK version
|
|
+T}@T{
|
|
+Default value
|
|
+T}
|
|
+_
|
|
+T{
|
|
+5.0
|
|
+T}@T{
|
|
+\f[C]net5.0\f[R]
|
|
+T}
|
|
+T{
|
|
+3.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.1\f[R]
|
|
+T}
|
|
+T{
|
|
+3.0
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.0\f[R]
|
|
+T}
|
|
+T{
|
|
+2.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp2.1\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-https\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Turns off HTTPS.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]mvc\f[R], \f[C]webapp\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-au|--auth <AUTHENTICATION_TYPE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The type of authentication to use.
|
|
+The possible values are:
|
|
+.IP \[bu] 2
|
|
+\f[C]None\f[R] - No authentication (Default).
|
|
+.IP \[bu] 2
|
|
+\f[C]Individual\f[R] - Individual authentication.
|
|
+.IP \[bu] 2
|
|
+\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
+.IP \[bu] 2
|
|
+\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
+.IP \[bu] 2
|
|
+\f[C]MultiOrg\f[R] - Organizational authentication for multiple tenants.
|
|
+.IP \[bu] 2
|
|
+\f[C]Windows\f[R] - Windows authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--aad-b2c-instance <INSTANCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Azure Active Directory B2C instance to connect to.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]https://login.microsoftonline.com/tfp/\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-ssp|--susi-policy-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The sign-in and sign-up policy ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-rp|--reset-password-policy-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The reset password policy ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-ep|--edit-profile-policy-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The edit profile policy ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--aad-instance <INSTANCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Azure Active Directory instance to connect to.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
+The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--client-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Client ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] authentication.
|
|
+The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--domain <DOMAIN>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The domain for the directory tenant.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]qualified.domain.name\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tenant-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The TenantId ID of the directory to connect to.
|
|
+Use with \f[C]SingleOrg\f[R] authentication.
|
|
+The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--callback-path <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The request path within the application\[cq]s base path of the redirect URI.
|
|
+Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]/signin-oidc\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-r|--org-read-access\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows this application read-access to the directory.
|
|
+Only applies to \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--exclude-launch-settings\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Excludes \f[I]launchSettings.json\f[R] from the generated template.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-https\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Turns off HTTPS.
|
|
+This option only applies if \f[C]Individual\f[R], \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] aren\[cq]t being used.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-uld|--use-local-db\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies LocalDB should be used instead of SQLite.
|
|
+Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+Option available since .NET Core 3.0 SDK.
|
|
+.PP
|
|
+The following table lists the default values according to the SDK version number you\[cq]re using:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+SDK version
|
|
+T}@T{
|
|
+Default value
|
|
+T}
|
|
+_
|
|
+T{
|
|
+5.0
|
|
+T}@T{
|
|
+\f[C]net5.0\f[R]
|
|
+T}
|
|
+T{
|
|
+3.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.1\f[R]
|
|
+T}
|
|
+T{
|
|
+3.0
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.0\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--use-browserlink\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Includes BrowserLink in the project.
|
|
+Option not available in .NET Core 2.2 and 3.1 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-rrc|--razor-runtime-compilation\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Determines if the project is configured to use Razor runtime compilation in Debug builds.
|
|
+Option available since .NET Core 3.1.201 SDK.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]angular\f[R], \f[C]react\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-au|--auth <AUTHENTICATION_TYPE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The type of authentication to use.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.PP
|
|
+The possible values are:
|
|
+.IP \[bu] 2
|
|
+\f[C]None\f[R] - No authentication (Default).
|
|
+.IP \[bu] 2
|
|
+\f[C]Individual\f[R] - Individual authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--exclude-launch-settings\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Excludes \f[I]launchSettings.json\f[R] from the generated template.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-https\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Turns off HTTPS.
|
|
+This option only applies if authentication is \f[C]None\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-uld|--use-local-db\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies LocalDB should be used instead of SQLite.
|
|
+Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+Option not available in .NET Core 2.2 SDK.
|
|
+.PP
|
|
+The following table lists the default values according to the SDK version number you\[cq]re using:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+SDK version
|
|
+T}@T{
|
|
+Default value
|
|
+T}
|
|
+_
|
|
+T{
|
|
+5.0
|
|
+T}@T{
|
|
+\f[C]net5.0\f[R]
|
|
+T}
|
|
+T{
|
|
+3.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.1\f[R]
|
|
+T}
|
|
+T{
|
|
+3.0
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.0\f[R]
|
|
+T}
|
|
+T{
|
|
+2.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp2.0\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]reactredux\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--exclude-launch-settings\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Excludes \f[I]launchSettings.json\f[R] from the generated template.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+Option not available in .NET Core 2.2 SDK.
|
|
+.PP
|
|
+The following table lists the default values according to the SDK version number you\[cq]re using:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+SDK version
|
|
+T}@T{
|
|
+Default value
|
|
+T}
|
|
+_
|
|
+T{
|
|
+5.0
|
|
+T}@T{
|
|
+\f[C]net5.0\f[R]
|
|
+T}
|
|
+T{
|
|
+3.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.1\f[R]
|
|
+T}
|
|
+T{
|
|
+3.0
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.0\f[R]
|
|
+T}
|
|
+T{
|
|
+2.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp2.0\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-https\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Turns off HTTPS.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]razorclasslib\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-s|--support-pages-and-views\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Supports adding traditional Razor pages and Views in addition to components to this library.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]webapi\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-au|--auth <AUTHENTICATION_TYPE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The type of authentication to use.
|
|
+The possible values are:
|
|
+.IP \[bu] 2
|
|
+\f[C]None\f[R] - No authentication (Default).
|
|
+.IP \[bu] 2
|
|
+\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
+.IP \[bu] 2
|
|
+\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
+.IP \[bu] 2
|
|
+\f[C]Windows\f[R] - Windows authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--aad-b2c-instance <INSTANCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Azure Active Directory B2C instance to connect to.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+The default value is \f[C]https://login.microsoftonline.com/tfp/\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-ssp|--susi-policy-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The sign-in and sign-up policy ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--aad-instance <INSTANCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Azure Active Directory instance to connect to.
|
|
+Use with \f[C]SingleOrg\f[R] authentication.
|
|
+The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--client-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The Client ID for this project.
|
|
+Use with \f[C]IndividualB2C\f[R] or \f[C]SingleOrg\f[R] authentication.
|
|
+The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--domain <DOMAIN>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The domain for the directory tenant.
|
|
+Use with \f[C]IndividualB2C\f[R] or \f[C]SingleOrg\f[R] authentication.
|
|
+The default value is \f[C]qualified.domain.name\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tenant-id <ID>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The TenantId ID of the directory to connect to.
|
|
+Use with \f[C]SingleOrg\f[R] authentication.
|
|
+The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-r|--org-read-access\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows this application read-access to the directory.
|
|
+Only applies to \f[C]SingleOrg\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--exclude-launch-settings\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Excludes \f[I]launchSettings.json\f[R] from the generated template.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-https\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Turns off HTTPS.
|
|
+\f[C]app.UseHsts\f[R] and \f[C]app.UseHttpsRedirection\f[R] aren\[cq]t added to \f[C]Startup.Configure\f[R].
|
|
+This option only applies if \f[C]IndividualB2C\f[R] or \f[C]SingleOrg\f[R] aren\[cq]t being used for authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-uld|--use-local-db\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies LocalDB should be used instead of SQLite.
|
|
+Only applies to \f[C]IndividualB2C\f[R] authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the framework to target.
|
|
+Option not available in .NET Core 2.2 SDK.
|
|
+.PP
|
|
+The following table lists the default values according to the SDK version number you\[cq]re using:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+SDK version
|
|
+T}@T{
|
|
+Default value
|
|
+T}
|
|
+_
|
|
+T{
|
|
+5.0
|
|
+T}@T{
|
|
+\f[C]net5.0\f[R]
|
|
+T}
|
|
+T{
|
|
+3.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.1\f[R]
|
|
+T}
|
|
+T{
|
|
+3.0
|
|
+T}@T{
|
|
+\f[C]netcoreapp3.0\f[R]
|
|
+T}
|
|
+T{
|
|
+2.1
|
|
+T}@T{
|
|
+\f[C]netcoreapp2.1\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[C]--framework\f[R] for \f[C]console\f[R] projects earlier in this article.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Doesn\[cq]t execute an implicit restore during project creation.
|
|
+.RE
|
|
+.PP
|
|
+ * * * * *
|
|
+.SS \f[C]globaljson\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--sdk-version <VERSION_NUMBER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the version of the .NET SDK to use in the \f[I]global.json\f[R] file.
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+dotnet new command
|
|
+.IP \[bu] 2
|
|
+dotnet new \[en]list option
|
|
+.IP \[bu] 2
|
|
+Custom templates for dotnet new
|
|
+.IP \[bu] 2
|
|
+Create a custom template for dotnet new
|
|
diff --git a/documentation/manpages/sdk/dotnet-new-search.1 b/documentation/manpages/sdk/dotnet-new-search.1
|
|
new file mode 100644
|
|
index 0000000000..8ae7a75e81
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-new-search.1
|
|
@@ -0,0 +1,149 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet new \[en]search option
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 5.0.300 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet new --search\f[R] - searches for the templates supported by \f[C]dotnet new\f[R] on NuGet.org.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new <TEMPLATE_NAME> --search
|
|
+
|
|
+dotnet new [<TEMPLATE_NAME>] --search [--author <AUTHOR>] [-lang|--language {\[dq]C#\[dq]|\[dq]F#\[dq]|VB}]
|
|
+ [--package <PACKAGE>] [--tag <TAG>] [--type <TYPE>]
|
|
+ [--columns <COLUMNS>] [--columns-all]
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet new --search\f[R] option searches for templates supported by \f[C]dotnet new\f[R] on NuGet.org.
|
|
+When the is specified, searches for templates containing the specified name.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]TEMPLATE_NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+If the argument is specified, only templates containing \f[C]<TEMPLATE_NAME>\f[R] in the template name or short name will be shown.
|
|
+The argument is mandatory when \f[C]--author\f[R], \f[C]--language\f[R], \f[C]--package\f[R], \f[C]--tag\f[R] or \f[C]--type\f[R] options are not specified.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--author <AUTHOR>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Filters templates based on template author.
|
|
+Partial match is supported.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--columns <COLUMNS>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Comma-separated list of columns to display in the output.
|
|
+The supported columns are:
|
|
+.IP \[bu] 2
|
|
+\f[C]language\f[R] - A comma-separated list of languages supported by the template.
|
|
+.IP \[bu] 2
|
|
+\f[C]tags\f[R] - The list of template tags.
|
|
+.IP \[bu] 2
|
|
+\f[C]author\f[R] - The template author.
|
|
+.IP \[bu] 2
|
|
+\f[C]type\f[R] - The template type: project or item.
|
|
+.PP
|
|
+The template name, short name, package name and total downloads count are always shown.
|
|
+The default list of columns is template name, short name, author, language, package, and total downloads.
|
|
+This list is equivalent to specifying \f[C]--columns=author,language\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--columns-all\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Displays all columns in the output.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-lang|--language {C#|F#|VB}\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Filters templates based on language supported by the template.
|
|
+The language accepted varies by the template.
|
|
+Not valid for some templates.
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] Some shells interpret \f[C]#\f[R] as a special character.
|
|
+In those cases, enclose the language parameter value in quotes.
|
|
+For example, \f[C]dotnet new --search --language \[dq]F#\[dq]\f[R].
|
|
+.RE
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--package <PACKAGE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Filters templates based on NuGet package ID.
|
|
+Partial match is supported.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tag <TAG>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Filters templates based on template tags.
|
|
+To be selected, a template must have at least one tag that exactly matches the criteria.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--type <TYPE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Filters templates based on template type.
|
|
+Predefined values are \f[C]project\f[R] and \f[C]item\f[R].
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Search for all templates available on NuGet.org matching the \f[I]spa\f[R] substring.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new spa --search
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Search for all templates available on NuGet.org matching the \f[I]we\f[R] substring and supporting the F# language.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new we --search --language \[dq]F#\[dq]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Search for item templates.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --search --type item
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Search for all C# templates, showing the type and tags in the output.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --search --language \[dq]C#\[dq] --columns \[dq]type,tags\[dq]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+dotnet new command
|
|
+.IP \[bu] 2
|
|
+dotnet new \[en]list option
|
|
+.IP \[bu] 2
|
|
+Custom templates for dotnet new
|
|
diff --git a/documentation/manpages/sdk/dotnet-new-uninstall.1 b/documentation/manpages/sdk/dotnet-new-uninstall.1
|
|
new file mode 100644
|
|
index 0000000000..2374f5ed66
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-new-uninstall.1
|
|
@@ -0,0 +1,56 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet new \[en]uninstall option
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.0 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet new --uninstall\f[R] - uninstalls a template package.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --uninstall <PATH|NUGET_ID>
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet new --uninstall\f[R] command uninstalls a template package at the \f[C]PATH\f[R] or \f[C]NUGET_ID\f[R] provided.
|
|
+When the \f[C]<PATH|NUGET_ID>\f[R] value isn\[cq]t specified, all currently installed template packages and their associated templates are displayed.
|
|
+When specifying \f[C]NUGET_ID\f[R], don\[cq]t include the version number.
|
|
+If you don\[cq]t specify a parameter to this option, the command lists the installed templates and details about them.
|
|
+> [!NOTE] > To uninstall a template using a \f[C]PATH\f[R], you need to fully qualify the path.
|
|
+For example, \f[I]C:/Users/<USER>/Documents/Templates/GarciaSoftware.ConsoleTemplate.CSharp\f[R] will work, but \f[I]./GarciaSoftware.ConsoleTemplate.CSharp\f[R] from the containing folder will not.
|
|
+> Don\[cq]t include a final terminating directory slash on your template path.
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+List the installed templates and details about them, including how to uninstall them:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new -u
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Uninstall the SPA templates for ASP.NET Core:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new -u Microsoft.DotNet.Web.Spa.ProjectTemplates
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+dotnet new command
|
|
+.IP \[bu] 2
|
|
+dotnet new \[en]list option
|
|
+.IP \[bu] 2
|
|
+dotnet new \[en]search option
|
|
+.IP \[bu] 2
|
|
+Custom templates for dotnet new
|
|
diff --git a/documentation/manpages/sdk/dotnet-new-update.1 b/documentation/manpages/sdk/dotnet-new-update.1
|
|
new file mode 100644
|
|
index 0000000000..e9f9b5e287
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-new-update.1
|
|
@@ -0,0 +1,34 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet new \[en]update-check and \[en]update-apply options
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.0 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet new --update-check\f[R] checks for available updates for installed template packages.
|
|
+.PP
|
|
+\f[C]dotnet new --update-apply\f[R] applies updates to installed template packages.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new --update-check
|
|
+
|
|
+dotnet new --update-apply
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet new --update-check\f[R] option checks if there are updates available for the template packs that are currently installed.
|
|
+The \f[C]dotnet new --update-apply\f[R] option checks if there are updates available for the template packages that are currently installed and installs them.
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+dotnet new command
|
|
+.IP \[bu] 2
|
|
+dotnet new \[en]search option
|
|
+.IP \[bu] 2
|
|
+dotnet new \[en]install option
|
|
+.IP \[bu] 2
|
|
+Custom templates for dotnet new
|
|
diff --git a/documentation/manpages/sdk/dotnet-new.1 b/documentation/manpages/sdk/dotnet-new.1
|
|
index a9e5a18885..aeb1a6672a 100644
|
|
--- a/documentation/manpages/sdk/dotnet-new.1
|
|
+++ b/documentation/manpages/sdk/dotnet-new.1
|
|
@@ -1,85 +1,75 @@
|
|
-.\"t
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+'\" t
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet new command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet new
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.0 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet new\f[R] - Creates a new project, configuration file, or solution based on the specified template.
|
|
.SH SYNOPSIS
|
|
-.SS .NET Core 2.2
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet new <TEMPLATE> [--dry-run] [--force] [-i|--install] [-lang|--language] [-n|--name] [--nuget-source] [-o|--output] [-u|--uninstall] [Template options]
|
|
-dotnet new <TEMPLATE> [-l|--list] [--type]
|
|
-dotnet new [-h|--help]
|
|
+dotnet new <TEMPLATE> [--dry-run] [--force] [-lang|--language {\[dq]C#\[dq]|\[dq]F#\[dq]|VB}]
|
|
+ [-n|--name <OUTPUT_NAME>] [-o|--output <OUTPUT_DIRECTORY>] [Template options]
|
|
+
|
|
+dotnet new -h|--help
|
|
\f[R]
|
|
.fi
|
|
-.SS .NET Core 2.1
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet new <TEMPLATE> [--force] [-i|--install] [-lang|--language] [-n|--name] [--nuget-source] [-o|--output] [-u|--uninstall] [Template options]
|
|
-dotnet new <TEMPLATE> [-l|--list] [--type]
|
|
-dotnet new [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.SS .NET Core 2.0
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet new <TEMPLATE> [--force] [-i|--install] [-lang|--language] [-n|--name] [-o|--output] [-u|--uninstall] [Template options]
|
|
-dotnet new <TEMPLATE> [-l|--list] [--type]
|
|
-dotnet new [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.SS .NET Core 1.x
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet new <TEMPLATE> [-lang|--language] [-n|--name] [-o|--output] [-all|--show-all] [-h|--help] [Template options]
|
|
-dotnet new <TEMPLATE> [-l|--list]
|
|
-dotnet new [-all|--show-all]
|
|
-dotnet new [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.PP
|
|
- * * * * *
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet new\f[R] command provides a convenient way to initialize a valid .NET Core project.
|
|
+The \f[C]dotnet new\f[R] command creates a .NET project or other artifacts based on a template.
|
|
.PP
|
|
-The command calls the template engine to create the artifacts on disk based on the specified template and options.
|
|
-.SS Arguments
|
|
+The command calls the template engine (https://github.com/dotnet/templating) to create the artifacts on disk based on the specified template and options.
|
|
+.SS Implicit restore
|
|
+.PP
|
|
+You don\[cq]t have to run \f[C]dotnet restore\f[R] because it\[cq]s run implicitly by all commands that require a restore to occur, such as \f[C]dotnet new\f[R], \f[C]dotnet build\f[R], \f[C]dotnet run\f[R], \f[C]dotnet test\f[R], \f[C]dotnet publish\f[R], and \f[C]dotnet pack\f[R].
|
|
+To disable implicit restore, use the \f[C]--no-restore\f[R] option.
|
|
.PP
|
|
-\f[C]TEMPLATE\f[R]
|
|
+The \f[C]dotnet restore\f[R] command is still useful in certain scenarios where explicitly restoring makes sense, such as continuous integration builds in Azure DevOps Services or in build systems that need to explicitly control when the restore occurs.
|
|
+.PP
|
|
+For information about how to manage NuGet feeds, see the \f[C]dotnet restore\f[R] documentation.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]TEMPLATE\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
The template to instantiate when the command is invoked.
|
|
Each template might have specific options you can pass.
|
|
For more information, see Template options.
|
|
.PP
|
|
-If the \f[C]TEMPLATE\f[R] value isn\[cq]t an exact match on text in the \f[B]Templates\f[R] or \f[B]Short Name\f[R] column, a substring match is performed on those two columns.
|
|
-.SS .NET Core 2.2
|
|
+You can run \f[C]dotnet new --list\f[R] to see a list of all installed templates.
|
|
+.PP
|
|
+Starting with .NET Core 3.0 SDK and ending with .NET Core 5.0.300 SDK, the CLI searches for templates in NuGet.org when you invoke the \f[C]dotnet new\f[R] command in the following conditions:
|
|
+.IP \[bu] 2
|
|
+If the CLI can\[cq]t find a template match when invoking \f[C]dotnet new\f[R], not even partial.
|
|
+.IP \[bu] 2
|
|
+If there\[cq]s a newer version of the template available.
|
|
+In this case, the project or artifact is created but the CLI warns you about an updated version of the template.
|
|
+.PP
|
|
+Starting with .NET Core 5.0.300 SDK, the \f[C]--search\f[R] option should be used to search for templates in NuGet.org..
|
|
.PP
|
|
-The command contains a default list of templates.
|
|
-Use \f[C]dotnet new -l\f[R] to obtain a list of the available templates.
|
|
-The following table shows the templates that come pre-installed with the .NET Core SDK 2.2.100.
|
|
+The following table shows the templates that come pre-installed with the .NET SDK.
|
|
The default language for the template is shown inside the brackets.
|
|
+Click on the short name link to see the specific template options.
|
|
+.RE
|
|
.PP
|
|
.TS
|
|
tab(@);
|
|
-l l l l.
|
|
+l l l l l.
|
|
T{
|
|
Templates
|
|
T}@T{
|
|
-Short Name
|
|
+Short name
|
|
T}@T{
|
|
Language
|
|
T}@T{
|
|
Tags
|
|
+T}@T{
|
|
+Introduced
|
|
T}
|
|
_
|
|
T{
|
|
@@ -90,6 +80,8 @@ T}@T{
|
|
[C#], F#, VB
|
|
T}@T{
|
|
Common/Console
|
|
+T}@T{
|
|
+1.0
|
|
T}
|
|
T{
|
|
Class library
|
|
@@ -99,230 +91,140 @@ T}@T{
|
|
[C#], F#, VB
|
|
T}@T{
|
|
Common/Library
|
|
-T}
|
|
-T{
|
|
-Unit Test Project
|
|
-T}@T{
|
|
-\f[C]mstest\f[R]
|
|
-T}@T{
|
|
-[C#], F#, VB
|
|
T}@T{
|
|
-Test/MSTest
|
|
+1.0
|
|
T}
|
|
T{
|
|
-NUnit 3 Test Project
|
|
-T}@T{
|
|
-\f[C]nunit\f[R]
|
|
-T}@T{
|
|
-[C#], F#, VB
|
|
+WPF Application
|
|
T}@T{
|
|
-Test/NUnit
|
|
-T}
|
|
-T{
|
|
-NUnit 3 Test Item
|
|
+\f[C]wpf\f[R]
|
|
T}@T{
|
|
-\f[C]nunit-test\f[R]
|
|
+[C#], VB
|
|
T}@T{
|
|
-[C#], F#, VB
|
|
+Common/WPF
|
|
T}@T{
|
|
-Test/NUnit
|
|
+3.0 (5.0 for VB)
|
|
T}
|
|
T{
|
|
-xUnit Test Project
|
|
-T}@T{
|
|
-\f[C]xunit\f[R]
|
|
-T}@T{
|
|
-[C#], F#, VB
|
|
+WPF Class library
|
|
T}@T{
|
|
-Test/xUnit
|
|
-T}
|
|
-T{
|
|
-Razor Page
|
|
+\f[C]wpflib\f[R]
|
|
T}@T{
|
|
-\f[C]page\f[R]
|
|
+[C#], VB
|
|
T}@T{
|
|
-[C#]
|
|
+Common/WPF
|
|
T}@T{
|
|
-Web/ASP.NET
|
|
+3.0 (5.0 for VB)
|
|
T}
|
|
T{
|
|
-MVC ViewImports
|
|
-T}@T{
|
|
-\f[C]viewimports\f[R]
|
|
-T}@T{
|
|
-[C#]
|
|
+WPF Custom Control Library
|
|
T}@T{
|
|
-Web/ASP.NET
|
|
-T}
|
|
-T{
|
|
-MVC ViewStart
|
|
+\f[C]wpfcustomcontrollib\f[R]
|
|
T}@T{
|
|
-\f[C]viewstart\f[R]
|
|
+[C#], VB
|
|
T}@T{
|
|
-[C#]
|
|
+Common/WPF
|
|
T}@T{
|
|
-Web/ASP.NET
|
|
+3.0 (5.0 for VB)
|
|
T}
|
|
T{
|
|
-ASP.NET Core Empty
|
|
-T}@T{
|
|
-\f[C]web\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
+WPF User Control Library
|
|
T}@T{
|
|
-Web/Empty
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core Web App (Model-View-Controller)
|
|
+\f[C]wpfusercontrollib\f[R]
|
|
T}@T{
|
|
-\f[C]mvc\f[R]
|
|
+[C#], VB
|
|
T}@T{
|
|
-[C#], F#
|
|
+Common/WPF
|
|
T}@T{
|
|
-Web/MVC
|
|
+3.0 (5.0 for VB)
|
|
T}
|
|
T{
|
|
-ASP.NET Core Web App
|
|
-T}@T{
|
|
-\f[C]webapp\f[R], \f[C]razor\f[R]
|
|
-T}@T{
|
|
-[C#]
|
|
+Windows Forms (WinForms) Application
|
|
T}@T{
|
|
-Web/MVC/Razor Pages
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core with Angular
|
|
+\f[C]winforms\f[R]
|
|
T}@T{
|
|
-\f[C]angular\f[R]
|
|
+[C#], VB
|
|
T}@T{
|
|
-[C#]
|
|
+Common/WinForms
|
|
T}@T{
|
|
-Web/MVC/SPA
|
|
+3.0 (5.0 for VB)
|
|
T}
|
|
T{
|
|
-ASP.NET Core with React.js
|
|
+Windows Forms (WinForms) Class library
|
|
T}@T{
|
|
-\f[C]react\f[R]
|
|
-T}@T{
|
|
-[C#]
|
|
-T}@T{
|
|
-Web/MVC/SPA
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core with React.js and Redux
|
|
+\f[C]winformslib\f[R]
|
|
T}@T{
|
|
-\f[C]reactredux\f[R]
|
|
+[C#], VB
|
|
T}@T{
|
|
-[C#]
|
|
+Common/WinForms
|
|
T}@T{
|
|
-Web/MVC/SPA
|
|
+3.0 (5.0 for VB)
|
|
T}
|
|
T{
|
|
-Razor Class Library
|
|
+Worker Service
|
|
T}@T{
|
|
-\f[C]razorclasslib\f[R]
|
|
+\f[C]worker\f[R]
|
|
T}@T{
|
|
[C#]
|
|
T}@T{
|
|
-Web/Razor/Library/Razor Class Library
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core Web API
|
|
-T}@T{
|
|
-\f[C]webapi\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
-T}@T{
|
|
-Web/WebAPI
|
|
-T}
|
|
-T{
|
|
-global.json file
|
|
-T}@T{
|
|
-\f[C]globaljson\f[R]
|
|
-T}@T{
|
|
+Common/Worker/Web
|
|
T}@T{
|
|
-Config
|
|
+3.0
|
|
T}
|
|
T{
|
|
-NuGet Config
|
|
-T}@T{
|
|
-\f[C]nugetconfig\f[R]
|
|
-T}@T{
|
|
+Unit Test Project
|
|
T}@T{
|
|
-Config
|
|
-T}
|
|
-T{
|
|
-Web Config
|
|
+\f[C]mstest\f[R]
|
|
T}@T{
|
|
-\f[C]webconfig\f[R]
|
|
+[C#], F#, VB
|
|
T}@T{
|
|
+Test/MSTest
|
|
T}@T{
|
|
-Config
|
|
+1.0
|
|
T}
|
|
T{
|
|
-Solution File
|
|
-T}@T{
|
|
-\f[C]sln\f[R]
|
|
-T}@T{
|
|
+NUnit 3 Test Project
|
|
T}@T{
|
|
-Solution
|
|
-T}
|
|
-.TE
|
|
-.SS .NET Core 2.1
|
|
-.PP
|
|
-The command contains a default list of templates.
|
|
-Use \f[C]dotnet new -l\f[R] to obtain a list of the available templates.
|
|
-The following table shows the templates that come pre-installed with the .NET Core SDK 2.1.300.
|
|
-The default language for the template is shown inside the brackets.
|
|
-.PP
|
|
-.TS
|
|
-tab(@);
|
|
-l l l l.
|
|
-T{
|
|
-Templates
|
|
+\f[C]nunit\f[R]
|
|
T}@T{
|
|
-Short Name
|
|
+[C#], F#, VB
|
|
T}@T{
|
|
-Language
|
|
+Test/NUnit
|
|
T}@T{
|
|
-Tags
|
|
+2.1.400
|
|
T}
|
|
-_
|
|
T{
|
|
-Console Application
|
|
+NUnit 3 Test Item
|
|
T}@T{
|
|
-\f[C]console\f[R]
|
|
+\f[C]nunit-test\f[R]
|
|
T}@T{
|
|
[C#], F#, VB
|
|
T}@T{
|
|
-Common/Console
|
|
-T}
|
|
-T{
|
|
-Class library
|
|
-T}@T{
|
|
-\f[C]classlib\f[R]
|
|
-T}@T{
|
|
-[C#], F#, VB
|
|
+Test/NUnit
|
|
T}@T{
|
|
-Common/Library
|
|
+2.2
|
|
T}
|
|
T{
|
|
-Unit Test Project
|
|
+xUnit Test Project
|
|
T}@T{
|
|
-\f[C]mstest\f[R]
|
|
+\f[C]xunit\f[R]
|
|
T}@T{
|
|
[C#], F#, VB
|
|
T}@T{
|
|
-Test/MSTest
|
|
+Test/xUnit
|
|
+T}@T{
|
|
+1.0
|
|
T}
|
|
T{
|
|
-xUnit Test Project
|
|
+Razor Component
|
|
T}@T{
|
|
-\f[C]xunit\f[R]
|
|
+\f[C]razorcomponent\f[R]
|
|
T}@T{
|
|
-[C#], F#, VB
|
|
+[C#]
|
|
T}@T{
|
|
-Test/xUnit
|
|
+Web/ASP.NET
|
|
+T}@T{
|
|
+3.0
|
|
T}
|
|
T{
|
|
Razor Page
|
|
@@ -332,6 +234,8 @@ T}@T{
|
|
[C#]
|
|
T}@T{
|
|
Web/ASP.NET
|
|
+T}@T{
|
|
+2.0
|
|
T}
|
|
T{
|
|
MVC ViewImports
|
|
@@ -341,6 +245,8 @@ T}@T{
|
|
[C#]
|
|
T}@T{
|
|
Web/ASP.NET
|
|
+T}@T{
|
|
+2.0
|
|
T}
|
|
T{
|
|
MVC ViewStart
|
|
@@ -350,6 +256,30 @@ T}@T{
|
|
[C#]
|
|
T}@T{
|
|
Web/ASP.NET
|
|
+T}@T{
|
|
+2.0
|
|
+T}
|
|
+T{
|
|
+Blazor Server App
|
|
+T}@T{
|
|
+\f[C]blazorserver\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/Blazor
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+T{
|
|
+Blazor WebAssembly App
|
|
+T}@T{
|
|
+\f[C]blazorwasm\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/Blazor/WebAssembly
|
|
+T}@T{
|
|
+3.1.300
|
|
T}
|
|
T{
|
|
ASP.NET Core Empty
|
|
@@ -359,6 +289,8 @@ T}@T{
|
|
[C#], F#
|
|
T}@T{
|
|
Web/Empty
|
|
+T}@T{
|
|
+1.0
|
|
T}
|
|
T{
|
|
ASP.NET Core Web App (Model-View-Controller)
|
|
@@ -368,15 +300,19 @@ T}@T{
|
|
[C#], F#
|
|
T}@T{
|
|
Web/MVC
|
|
+T}@T{
|
|
+1.0
|
|
T}
|
|
T{
|
|
ASP.NET Core Web App
|
|
T}@T{
|
|
-\f[C]razor\f[R]
|
|
+\f[C]webapp, razor\f[R]
|
|
T}@T{
|
|
[C#]
|
|
T}@T{
|
|
Web/MVC/Razor Pages
|
|
+T}@T{
|
|
+2.2, 2.0
|
|
T}
|
|
T{
|
|
ASP.NET Core with Angular
|
|
@@ -386,6 +322,8 @@ T}@T{
|
|
[C#]
|
|
T}@T{
|
|
Web/MVC/SPA
|
|
+T}@T{
|
|
+2.0
|
|
T}
|
|
T{
|
|
ASP.NET Core with React.js
|
|
@@ -395,6 +333,8 @@ T}@T{
|
|
[C#]
|
|
T}@T{
|
|
Web/MVC/SPA
|
|
+T}@T{
|
|
+2.0
|
|
T}
|
|
T{
|
|
ASP.NET Core with React.js and Redux
|
|
@@ -404,6 +344,8 @@ T}@T{
|
|
[C#]
|
|
T}@T{
|
|
Web/MVC/SPA
|
|
+T}@T{
|
|
+2.0
|
|
T}
|
|
T{
|
|
Razor Class Library
|
|
@@ -413,6 +355,8 @@ T}@T{
|
|
[C#]
|
|
T}@T{
|
|
Web/Razor/Library/Razor Class Library
|
|
+T}@T{
|
|
+2.1
|
|
T}
|
|
T{
|
|
ASP.NET Core Web API
|
|
@@ -422,6 +366,29 @@ T}@T{
|
|
[C#], F#
|
|
T}@T{
|
|
Web/WebAPI
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+ASP.NET Core gRPC Service
|
|
+T}@T{
|
|
+\f[C]grpc\f[R]
|
|
+T}@T{
|
|
+[C#]
|
|
+T}@T{
|
|
+Web/gRPC
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+T{
|
|
+dotnet gitignore file
|
|
+T}@T{
|
|
+\f[C]gitignore\f[R]
|
|
+T}@T{
|
|
+T}@T{
|
|
+Config
|
|
+T}@T{
|
|
+3.0
|
|
T}
|
|
T{
|
|
global.json file
|
|
@@ -430,6 +397,8 @@ T}@T{
|
|
T}@T{
|
|
T}@T{
|
|
Config
|
|
+T}@T{
|
|
+2.0
|
|
T}
|
|
T{
|
|
NuGet Config
|
|
@@ -438,6 +407,18 @@ T}@T{
|
|
T}@T{
|
|
T}@T{
|
|
Config
|
|
+T}@T{
|
|
+1.0
|
|
+T}
|
|
+T{
|
|
+Dotnet local tool manifest file
|
|
+T}@T{
|
|
+\f[C]tool-manifest\f[R]
|
|
+T}@T{
|
|
+T}@T{
|
|
+Config
|
|
+T}@T{
|
|
+3.0
|
|
T}
|
|
T{
|
|
Web Config
|
|
@@ -446,6 +427,8 @@ T}@T{
|
|
T}@T{
|
|
T}@T{
|
|
Config
|
|
+T}@T{
|
|
+1.0
|
|
T}
|
|
T{
|
|
Solution File
|
|
@@ -454,1116 +437,148 @@ T}@T{
|
|
T}@T{
|
|
T}@T{
|
|
Solution
|
|
-T}
|
|
-.TE
|
|
-.SS .NET Core 2.0
|
|
-.PP
|
|
-The command contains a default list of templates.
|
|
-Use \f[C]dotnet new -l\f[R] to obtain a list of the available templates.
|
|
-The following table shows the templates that come pre-installed with the .NET Core SDK 2.0.0.
|
|
-The default language for the template is shown inside the brackets.
|
|
-.PP
|
|
-.TS
|
|
-tab(@);
|
|
-l l l l.
|
|
-T{
|
|
-Templates
|
|
-T}@T{
|
|
-Short Name
|
|
T}@T{
|
|
-Language
|
|
-T}@T{
|
|
-Tags
|
|
+1.0
|
|
T}
|
|
-_
|
|
T{
|
|
-Console Application
|
|
+Protocol Buffer File
|
|
T}@T{
|
|
-\f[C]console\f[R]
|
|
+\f[C]proto\f[R]
|
|
T}@T{
|
|
-[C#], F#, VB
|
|
T}@T{
|
|
-Common/Console
|
|
-T}
|
|
-T{
|
|
-Class library
|
|
-T}@T{
|
|
-\f[C]classlib\f[R]
|
|
-T}@T{
|
|
-[C#], F#, VB
|
|
-T}@T{
|
|
-Common/Library
|
|
-T}
|
|
-T{
|
|
-Unit Test Project
|
|
-T}@T{
|
|
-\f[C]mstest\f[R]
|
|
-T}@T{
|
|
-[C#], F#, VB
|
|
-T}@T{
|
|
-Test/MSTest
|
|
-T}
|
|
-T{
|
|
-xUnit Test Project
|
|
-T}@T{
|
|
-\f[C]xunit\f[R]
|
|
-T}@T{
|
|
-[C#], F#, VB
|
|
-T}@T{
|
|
-Test/xUnit
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core Empty
|
|
-T}@T{
|
|
-\f[C]web\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
-T}@T{
|
|
-Web/Empty
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core Web App (Model-View-Controller)
|
|
-T}@T{
|
|
-\f[C]mvc\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
-T}@T{
|
|
-Web/MVC
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core Web App
|
|
-T}@T{
|
|
-\f[C]razor\f[R]
|
|
-T}@T{
|
|
-[C#]
|
|
-T}@T{
|
|
-Web/MVC/Razor Pages
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core with Angular
|
|
-T}@T{
|
|
-\f[C]angular\f[R]
|
|
-T}@T{
|
|
-[C#]
|
|
-T}@T{
|
|
-Web/MVC/SPA
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core with React.js
|
|
-T}@T{
|
|
-\f[C]react\f[R]
|
|
-T}@T{
|
|
-[C#]
|
|
-T}@T{
|
|
-Web/MVC/SPA
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core with React.js and Redux
|
|
-T}@T{
|
|
-\f[C]reactredux\f[R]
|
|
-T}@T{
|
|
-[C#]
|
|
-T}@T{
|
|
-Web/MVC/SPA
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core Web API
|
|
-T}@T{
|
|
-\f[C]webapi\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
-T}@T{
|
|
-Web/WebAPI
|
|
-T}
|
|
-T{
|
|
-global.json file
|
|
-T}@T{
|
|
-\f[C]globaljson\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Config
|
|
-T}
|
|
-T{
|
|
-Nuget Config
|
|
-T}@T{
|
|
-\f[C]nugetconfig\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Config
|
|
-T}
|
|
-T{
|
|
-Web Config
|
|
-T}@T{
|
|
-\f[C]webconfig\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Config
|
|
-T}
|
|
-T{
|
|
-Solution File
|
|
-T}@T{
|
|
-\f[C]sln\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Solution
|
|
-T}
|
|
-T{
|
|
-Razor Page
|
|
-T}@T{
|
|
-\f[C]page\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Web/ASP.NET
|
|
-T}
|
|
-T{
|
|
-MVC ViewImports
|
|
-T}@T{
|
|
-\f[C]viewimports\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Web/ASP.NET
|
|
-T}
|
|
-T{
|
|
-MVC ViewStart
|
|
-T}@T{
|
|
-\f[C]viewstart\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Web/ASP.NET
|
|
-T}
|
|
-.TE
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-The command contains a default list of templates.
|
|
-Use \f[C]dotnet new -all\f[R] to obtain a list of the available templates.
|
|
-The following table shows the templates that come pre-installed with the .NET Core SDK 1.0.1.
|
|
-The default language for the template is shown inside the brackets.
|
|
-.PP
|
|
-.TS
|
|
-tab(@);
|
|
-l l l l.
|
|
-T{
|
|
-Templates
|
|
-T}@T{
|
|
-Short Name
|
|
-T}@T{
|
|
-Language
|
|
-T}@T{
|
|
-Tags
|
|
-T}
|
|
-_
|
|
-T{
|
|
-Console Application
|
|
-T}@T{
|
|
-\f[C]console\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
-T}@T{
|
|
-Common/Console
|
|
-T}
|
|
-T{
|
|
-Class library
|
|
-T}@T{
|
|
-\f[C]classlib\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
-T}@T{
|
|
-Common/Library
|
|
-T}
|
|
-T{
|
|
-Unit Test Project
|
|
-T}@T{
|
|
-\f[C]mstest\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
-T}@T{
|
|
-Test/MSTest
|
|
-T}
|
|
-T{
|
|
-xUnit Test Project
|
|
-T}@T{
|
|
-\f[C]xunit\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
-T}@T{
|
|
-Test/xUnit
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core Empty
|
|
-T}@T{
|
|
-\f[C]web\f[R]
|
|
-T}@T{
|
|
-[C#]
|
|
-T}@T{
|
|
-Web/Empty
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core Web App
|
|
-T}@T{
|
|
-\f[C]mvc\f[R]
|
|
-T}@T{
|
|
-[C#], F#
|
|
-T}@T{
|
|
-Web/MVC
|
|
-T}
|
|
-T{
|
|
-ASP.NET Core Web API
|
|
-T}@T{
|
|
-\f[C]webapi\f[R]
|
|
-T}@T{
|
|
-[C#]
|
|
-T}@T{
|
|
-Web/WebAPI
|
|
-T}
|
|
-T{
|
|
-Nuget Config
|
|
-T}@T{
|
|
-\f[C]nugetconfig\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Config
|
|
-T}
|
|
-T{
|
|
-Web Config
|
|
-T}@T{
|
|
-\f[C]webconfig\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Config
|
|
-T}
|
|
-T{
|
|
-Solution File
|
|
-T}@T{
|
|
-\f[C]sln\f[R]
|
|
-T}@T{
|
|
-T}@T{
|
|
-Solution
|
|
-T}
|
|
-.TE
|
|
-.PP
|
|
- * * * * *
|
|
-.SH OPTIONS
|
|
-.SS .NET Core 2.2
|
|
-.PP
|
|
-\f[C]--dry-run\f[R]
|
|
-.PP
|
|
-Displays a summary of what would happen if the given command were run if it would result in a template creation.
|
|
-.PP
|
|
-\f[C]--force\f[R]
|
|
-.PP
|
|
-Forces content to be generated even if it would change existing files.
|
|
-This is required when the output directory already contains a project.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out help for the command.
|
|
-It can be invoked for the \f[C]dotnet new\f[R] command itself or for any template, such as \f[C]dotnet new mvc --help\f[R].
|
|
-.PP
|
|
-\f[C]-i|--install <PATH|NUGET_ID>\f[R]
|
|
-.PP
|
|
-Installs a source or template pack from the \f[C]PATH\f[R] or \f[C]NUGET_ID\f[R] provided.
|
|
-If you want to install a prerelease version of a template package, you need to specify the version in the format of \f[C]<package-name>::<package-version>\f[R].
|
|
-By default, \f[C]dotnet new\f[R] passes * for the version, which represents the last stable package version.
|
|
-See an example at the Examples section.
|
|
-.PP
|
|
-For information on creating custom templates, see Custom templates for dotnet new.
|
|
-.PP
|
|
-\f[C]-l|--list\f[R]
|
|
-.PP
|
|
-Lists templates containing the specified name.
|
|
-If invoked for the \f[C]dotnet new\f[R] command, it lists the possible templates available for the given directory.
|
|
-For example if the directory already contains a project, it doesn\[cq]t list all project templates.
|
|
-.PP
|
|
-\f[C]-lang|--language {C#|F#|VB}\f[R]
|
|
-.PP
|
|
-The language of the template to create.
|
|
-The language accepted varies by the template (see defaults in the arguments section).
|
|
-Not valid for some templates.
|
|
-.RS
|
|
-.PP
|
|
-[!NOTE] Some shells interpret \f[C]#\f[R] as a special character.
|
|
-In those cases, you need to enclose the language parameter value, such as \f[C]dotnet new console -lang \[dq]F#\[dq]\f[R].
|
|
-.RE
|
|
-.PP
|
|
-\f[C]-n|--name <OUTPUT_NAME>\f[R]
|
|
-.PP
|
|
-The name for the created output.
|
|
-If no name is specified, the name of the current directory is used.
|
|
-.PP
|
|
-\f[C]--nuget-source\f[R]
|
|
-.PP
|
|
-Specifies a NuGet source to use during install.
|
|
-.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
-.PP
|
|
-Location to place the generated output.
|
|
-The default is the current directory.
|
|
-.PP
|
|
-\f[C]--type\f[R]
|
|
-.PP
|
|
-Filters templates based on available types.
|
|
-Predefined values are \[lq]project\[rq], \[lq]item\[rq], or \[lq]other\[rq].
|
|
-.PP
|
|
-\f[C]-u|--uninstall <PATH|NUGET_ID>\f[R]
|
|
-.PP
|
|
-Uninstalls a source or template pack at the \f[C]PATH\f[R] or \f[C]NUGET_ID\f[R] provided.
|
|
-When excluding the \f[C]<PATH|NUGET_ID>\f[R] value, all currently installed template packs and their associated templates are displayed.
|
|
-.RS
|
|
-.PP
|
|
-[!NOTE] To uninstall a template using a \f[C]PATH\f[R], you need to fully qualify the path.
|
|
-For example, \f[I]C:/Users/<USER>/Documents/Templates/GarciaSoftware.ConsoleTemplate.CSharp\f[R] will work, but \f[I]./GarciaSoftware.ConsoleTemplate.CSharp\f[R] from the containing folder will not.
|
|
-Additionally, do not include a final terminating directory slash on your template path.
|
|
-.RE
|
|
-.SS .NET Core 2.1
|
|
-.PP
|
|
-\f[C]--force\f[R]
|
|
-.PP
|
|
-Forces content to be generated even if it would change existing files.
|
|
-This is required when the output directory already contains a project.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out help for the command.
|
|
-It can be invoked for the \f[C]dotnet new\f[R] command itself or for any template, such as \f[C]dotnet new mvc --help\f[R].
|
|
-.PP
|
|
-\f[C]-i|--install <PATH|NUGET_ID>\f[R]
|
|
-.PP
|
|
-Installs a source or template pack from the \f[C]PATH\f[R] or \f[C]NUGET_ID\f[R] provided.
|
|
-If you want to install a prerelease version of a template package, you need to specify the version in the format of \f[C]<package-name>::<package-version>\f[R].
|
|
-By default, \f[C]dotnet new\f[R] passes * for the version, which represents the last stable package version.
|
|
-See an example at the Examples section.
|
|
-.PP
|
|
-For information on creating custom templates, see Custom templates for dotnet new.
|
|
-.PP
|
|
-\f[C]-l|--list\f[R]
|
|
-.PP
|
|
-Lists templates containing the specified name.
|
|
-If invoked for the \f[C]dotnet new\f[R] command, it lists the possible templates available for the given directory.
|
|
-For example if the directory already contains a project, it doesn\[cq]t list all project templates.
|
|
-.PP
|
|
-\f[C]-lang|--language {C#|F#|VB}\f[R]
|
|
-.PP
|
|
-The language of the template to create.
|
|
-The language accepted varies by the template (see defaults in the arguments section).
|
|
-Not valid for some templates.
|
|
-.RS
|
|
-.PP
|
|
-[!NOTE] Some shells interpret \f[C]#\f[R] as a special character.
|
|
-In those cases, you need to enclose the language parameter value, such as \f[C]dotnet new console -lang \[dq]F#\[dq]\f[R].
|
|
-.RE
|
|
-.PP
|
|
-\f[C]-n|--name <OUTPUT_NAME>\f[R]
|
|
-.PP
|
|
-The name for the created output.
|
|
-If no name is specified, the name of the current directory is used.
|
|
-.PP
|
|
-\f[C]--nuget-source\f[R]
|
|
-.PP
|
|
-Specifies a NuGet source to use during install.
|
|
-.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
-.PP
|
|
-Location to place the generated output.
|
|
-The default is the current directory.
|
|
-.PP
|
|
-\f[C]--type\f[R]
|
|
-.PP
|
|
-Filters templates based on available types.
|
|
-Predefined values are \[lq]project\[rq], \[lq]item\[rq] or \[lq]other\[rq].
|
|
-.PP
|
|
-\f[C]-u|--uninstall <PATH|NUGET_ID>\f[R]
|
|
-.PP
|
|
-Uninstalls a source or template pack at the \f[C]PATH\f[R] or \f[C]NUGET_ID\f[R] provided.
|
|
-.RS
|
|
-.PP
|
|
-[!NOTE] To uninstall a template using a \f[C]PATH\f[R], you need to fully qualify the path.
|
|
-For example, \f[I]C:/Users/<USER>/Documents/Templates/GarciaSoftware.ConsoleTemplate.CSharp\f[R] will work, but \f[I]./GarciaSoftware.ConsoleTemplate.CSharp\f[R] from the containing folder will not.
|
|
-Additionally, do not include a final terminating directory slash on your template path.
|
|
-.RE
|
|
-.SS .NET Core 2.0
|
|
-.PP
|
|
-\f[C]--force\f[R]
|
|
-.PP
|
|
-Forces content to be generated even if it would change existing files.
|
|
-This is required when the output directory already contains a project.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out help for the command.
|
|
-It can be invoked for the \f[C]dotnet new\f[R] command itself or for any template, such as \f[C]dotnet new mvc --help\f[R].
|
|
-.PP
|
|
-\f[C]-i|--install <PATH|NUGET_ID>\f[R]
|
|
-.PP
|
|
-Installs a source or template pack from the \f[C]PATH\f[R] or \f[C]NUGET_ID\f[R] provided.
|
|
-If you want to install a prerelease version of a template package, you need to specify the version in the format of \f[C]<package-name>::<package-version>\f[R].
|
|
-By default, \f[C]dotnet new\f[R] passes * for the version, which represents the last stable package version.
|
|
-See an example at the Examples section.
|
|
-.PP
|
|
-For information on creating custom templates, see Custom templates for dotnet new.
|
|
-.PP
|
|
-\f[C]-l|--list\f[R]
|
|
-.PP
|
|
-Lists templates containing the specified name.
|
|
-If invoked for the \f[C]dotnet new\f[R] command, it lists the possible templates available for the given directory.
|
|
-For example if the directory already contains a project, it doesn\[cq]t list all project templates.
|
|
-.PP
|
|
-\f[C]-lang|--language {C#|F#|VB}\f[R]
|
|
-.PP
|
|
-The language of the template to create.
|
|
-The language accepted varies by the template (see defaults in the arguments section).
|
|
-Not valid for some templates.
|
|
-.RS
|
|
-.PP
|
|
-[!NOTE] Some shells interpret \f[C]#\f[R] as a special character.
|
|
-In those cases, you need to enclose the language parameter value, such as \f[C]dotnet new console -lang \[dq]F#\[dq]\f[R].
|
|
-.RE
|
|
-.PP
|
|
-\f[C]-n|--name <OUTPUT_NAME>\f[R]
|
|
-.PP
|
|
-The name for the created output.
|
|
-If no name is specified, the name of the current directory is used.
|
|
-.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
-.PP
|
|
-Location to place the generated output.
|
|
-The default is the current directory.
|
|
-.PP
|
|
-\f[C]--type\f[R]
|
|
-.PP
|
|
-Filters templates based on available types.
|
|
-Predefined values are \[lq]project\[rq], \[lq]item\[rq] or \[lq]other\[rq].
|
|
-.PP
|
|
-\f[C]-u|--uninstall <PATH|NUGET_ID>\f[R]
|
|
-.PP
|
|
-Uninstalls a source or template pack at the \f[C]PATH\f[R] or \f[C]NUGET_ID\f[R] provided.
|
|
-.RS
|
|
-.PP
|
|
-[!NOTE] To uninstall a template using a source \f[C]PATH\f[R], you need to fully qualify the path.
|
|
-For example, \f[I]C:/Users/<USER>/Documents/Templates/GarciaSoftware.ConsoleTemplate.CSharp\f[R] will work, but \f[I]./GarciaSoftware.ConsoleTemplate.CSharp\f[R] from the containing folder will not.
|
|
-Additionally, do not include a final terminating directory slash on your template path.
|
|
-.PP
|
|
-If you are unable to determine the \f[C]PATH\f[R] or \f[C]NUGET_ID\f[R] argument needed to uninstall a template, running \f[C]dotnet new --uninstall\f[R] without an argument will list all installed templates and the argument required to uninstall them.
|
|
-.RE
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-\f[C]-all|--show-all\f[R]
|
|
-.PP
|
|
-Shows all templates for a specific type of project when running in the context of the \f[C]dotnet new\f[R] command alone.
|
|
-When running in the context of a specific template, such as \f[C]dotnet new web -all\f[R], \f[C]-all\f[R] is interpreted as a force creation flag.
|
|
-This is required when the output directory already contains a project.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out help for the command.
|
|
-It can be invoked for the \f[C]dotnet new\f[R] command itself or for any template, such as \f[C]dotnet new mvc --help\f[R].
|
|
-.PP
|
|
-\f[C]-l|--list\f[R]
|
|
-.PP
|
|
-Lists templates containing the specified name.
|
|
-If invoked for the \f[C]dotnet new\f[R] command, it lists the possible templates available for the given directory.
|
|
-For example if the directory already contains a project, it doesn\[cq]t list all project templates.
|
|
-.PP
|
|
-\f[C]-lang|--language {C#|F#}\f[R]
|
|
-.PP
|
|
-The language of the template to create.
|
|
-The language accepted varies by the template (see defaults in the arguments section).
|
|
-Not valid for some templates.
|
|
-.RS
|
|
-.PP
|
|
-[!NOTE] Some shells interpret \f[C]#\f[R] as a special character.
|
|
-In those cases, you need to enclose the language parameter value, such as \f[C]dotnet new console -lang \[dq]F#\[dq]\f[R].
|
|
-.RE
|
|
-.PP
|
|
-\f[C]-n|--name <OUTPUT_NAME>\f[R]
|
|
-.PP
|
|
-The name for the created output.
|
|
-If no name is specified, the name of the current directory is used.
|
|
-.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
-.PP
|
|
-Location to place the generated output.
|
|
-The default is the current directory.
|
|
-.PP
|
|
- * * * * *
|
|
-.SS Template options
|
|
-.PP
|
|
-Each project template may have additional options available.
|
|
-The core templates have the following additional options:
|
|
-.SS .NET Core 2.2
|
|
-.PP
|
|
-\f[B]console\f[R]
|
|
-.PP
|
|
-\f[C]--langVersion <VERSION_NUMBER>\f[R] - Sets the \f[C]LangVersion\f[R] property in the created project file.
|
|
-For example, use \f[C]--langVersion 7.3\f[R] to use C# 7.3.
|
|
-Not supported for F#.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]angular, react, reactredux\f[R]
|
|
-.PP
|
|
-\f[C]--exclude-launch-settings\f[R] - Exclude \f[I]launchSettings.json\f[R] from the generated template.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[C]--no-https\f[R] - Project doesn\[cq]t require HTTPS.
|
|
-This option only applies if \f[C]IndividualAuth\f[R] or \f[C]OrganizationalAuth\f[R] are not being used.
|
|
-.PP
|
|
-\f[B]razorclasslib\f[R]
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]classlib\f[R]
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R] - Specifies the framework to target.
|
|
-Values: \f[C]netcoreapp2.2\f[R] to create a .NET Core Class Library or \f[C]netstandard2.0\f[R] to create a .NET Standard Class Library.
|
|
-The default value is \f[C]netstandard2.0\f[R].
|
|
-.PP
|
|
-\f[C]--langVersion <VERSION_NUMBER>\f[R] - Sets the \f[C]LangVersion\f[R] property in the created project file.
|
|
-For example, use \f[C]--langVersion 7.3\f[R] to use C# 7.3.
|
|
-Not supported for F#.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]mstest, xunit\f[R]
|
|
-.PP
|
|
-\f[C]-p|--enable-pack\f[R] - Enables packaging for the project using dotnet pack.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]nunit\f[R]
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R] - Specifies the framework to target.
|
|
-The default value is \f[C]netcoreapp2.1\f[R].
|
|
-.PP
|
|
-\f[C]-p|--enable-pack\f[R] - Enables packaging for the project using dotnet pack.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]page\f[R]
|
|
-.PP
|
|
-\f[C]-na|--namespace <NAMESPACE_NAME>\f[R] - Namespace for the generated code.
|
|
-The default value is \f[C]MyApp.Namespace\f[R].
|
|
-.PP
|
|
-\f[C]-np|--no-pagemodel\f[R] - Creates the page without a PageModel.
|
|
-.PP
|
|
-\f[B]viewimports\f[R]
|
|
-.PP
|
|
-\f[C]-na|--namespace <NAMESPACE_NAME>\f[R] - Namespace for the generated code.
|
|
-The default value is \f[C]MyApp.Namespace\f[R].
|
|
-.PP
|
|
-\f[B]web\f[R]
|
|
-.PP
|
|
-\f[C]--exclude-launch-settings\f[R] - Exclude \f[I]launchSettings.json\f[R] from the generated template.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[C]--no-https\f[R] - Project doesn\[cq]t require HTTPS.
|
|
-This option only applies if \f[C]IndividualAuth\f[R] or \f[C]OrganizationalAuth\f[R] are not being used.
|
|
-.PP
|
|
-\f[B]mvc, webapp\f[R]
|
|
-.PP
|
|
-\f[C]-au|--auth <AUTHENTICATION_TYPE>\f[R] - The type of authentication to use.
|
|
-The possible values are:
|
|
-.IP \[bu] 2
|
|
-\f[C]None\f[R] - No authentication (Default).
|
|
-.IP \[bu] 2
|
|
-\f[C]Individual\f[R] - Individual authentication.
|
|
-.IP \[bu] 2
|
|
-\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
-.IP \[bu] 2
|
|
-\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
-.IP \[bu] 2
|
|
-\f[C]MultiOrg\f[R] - Organizational authentication for multiple tenants.
|
|
+Web/gRPC
|
|
+T}@T{
|
|
+3.0
|
|
+T}
|
|
+.TE
|
|
+.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[C]Windows\f[R] - Windows authentication.
|
|
-.PP
|
|
-\f[C]--aad-b2c-instance <INSTANCE>\f[R] - The Azure Active Directory B2C instance to connect to.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/tfp/\f[R].
|
|
+\f[B]\f[CB]--dry-run\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-ssp|--susi-policy-id <ID>\f[R] - The sign-in and sign-up policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]-rp|--reset-password-policy-id <ID>\f[R] - The reset password policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]-ep|--edit-profile-policy-id <ID>\f[R] - The edit profile policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--aad-instance <INSTANCE>\f[R] - The Azure Active Directory instance to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
-.PP
|
|
-\f[C]--client-id <ID>\f[R] - The Client ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] authentication.
|
|
-The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
-.PP
|
|
-\f[C]--domain <DOMAIN>\f[R] - The domain for the directory tenant.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]qualified.domain.name\f[R].
|
|
-.PP
|
|
-\f[C]--tenant-id <ID>\f[R] - The TenantId ID of the directory to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
-.PP
|
|
-\f[C]--callback-path <PATH>\f[R] - The request path within the application\[cq]s base path of the redirect URI.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]/signin-oidc\f[R].
|
|
-.PP
|
|
-\f[C]-r|--org-read-access\f[R] - Allows this application read-access to the directory.
|
|
-Only applies to \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--exclude-launch-settings\f[R] - Exclude \f[I]launchSettings.json\f[R] from the generated template.
|
|
-.PP
|
|
-\f[C]--no-https\f[R] - Project doesn\[cq]t require HTTPS.
|
|
-\f[C]app.UseHsts\f[R] and \f[C]app.UseHttpsRedirection\f[R] aren\[cq]t added to \f[C]Startup.Configure\f[R].
|
|
-This option only applies if \f[C]Individual\f[R], \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] aren\[cq]t being used.
|
|
-.PP
|
|
-\f[C]-uld|--use-local-db\f[R] - Specifies LocalDB should be used instead of SQLite.
|
|
-Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]webapi\f[R]
|
|
-.PP
|
|
-\f[C]-au|--auth <AUTHENTICATION_TYPE>\f[R] - The type of authentication to use.
|
|
-The possible values are:
|
|
-.IP \[bu] 2
|
|
-\f[C]None\f[R] - No authentication (Default).
|
|
-.IP \[bu] 2
|
|
-\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
-.IP \[bu] 2
|
|
-\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
+Displays a summary of what would happen if the given command were run if it would result in a template creation.
|
|
+Available since .NET Core 2.2 SDK.
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[C]Windows\f[R] - Windows authentication.
|
|
-.PP
|
|
-\f[C]--aad-b2c-instance <INSTANCE>\f[R] - The Azure Active Directory B2C instance to connect to.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/tfp/\f[R].
|
|
-.PP
|
|
-\f[C]-ssp|--susi-policy-id <ID>\f[R] - The sign-in and sign-up policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--aad-instance <INSTANCE>\f[R] - The Azure Active Directory instance to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
-.PP
|
|
-\f[C]--client-id <ID>\f[R] - The Client ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] or \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
-.PP
|
|
-\f[C]--domain <DOMAIN>\f[R] - The domain for the directory tenant.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]qualified.domain.name\f[R].
|
|
-.PP
|
|
-\f[C]--tenant-id <ID>\f[R] - The TenantId ID of the directory to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
-.PP
|
|
-\f[C]-r|--org-read-access\f[R] - Allows this application read-access to the directory.
|
|
-Only applies to \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--exclude-launch-settings\f[R] - Exclude \f[I]launchSettings.json\f[R] from the generated template.
|
|
-.PP
|
|
-\f[C]--no-https\f[R] - Project doesn\[cq]t require HTTPS.
|
|
-\f[C]app.UseHsts\f[R] and \f[C]app.UseHttpsRedirection\f[R] aren\[cq]t added to \f[C]Startup.Configure\f[R].
|
|
-This option only applies if \f[C]Individual\f[R], \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] aren\[cq]t being used.
|
|
-.PP
|
|
-\f[C]-uld|--use-local-db\f[R] - Specifies LocalDB should be used instead of SQLite.
|
|
-Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]globaljson\f[R]
|
|
-.PP
|
|
-\f[C]--sdk-version <VERSION_NUMBER>\f[R] - Specifies the version of the .NET Core SDK to use in the \f[I]global.json\f[R] file.
|
|
-.SS .NET Core 2.1
|
|
+\f[B]\f[CB]--force\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[B]console, angular, react, reactredux, razorclasslib\f[R]
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]classlib\f[R]
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R] - Specifies the framework to target.
|
|
-Values: \f[C]netcoreapp2.1\f[R] to create a .NET Core Class Library or \f[C]netstandard2.0\f[R] to create a .NET Standard Class Library.
|
|
-The default value is \f[C]netstandard2.0\f[R].
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]mstest, xunit\f[R]
|
|
-.PP
|
|
-\f[C]-p|--enable-pack\f[R] - Enables packaging for the project using dotnet pack.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]globaljson\f[R]
|
|
-.PP
|
|
-\f[C]--sdk-version <VERSION_NUMBER>\f[R] - Specifies the version of the .NET Core SDK to use in the \f[I]global.json\f[R] file.
|
|
-.PP
|
|
-\f[B]web\f[R]
|
|
-.PP
|
|
-\f[C]--exclude-launch-settings\f[R] - Exclude \f[I]launchSettings.json\f[R] from the generated template.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[C]--no-https\f[R] - Project doesn\[cq]t require HTTPS.
|
|
-This option only applies if \f[C]IndividualAuth\f[R] or \f[C]OrganizationalAuth\f[R] are not being used.
|
|
-.PP
|
|
-\f[B]webapi\f[R]
|
|
-.PP
|
|
-\f[C]-au|--auth <AUTHENTICATION_TYPE>\f[R] - The type of authentication to use.
|
|
-The possible values are:
|
|
-.IP \[bu] 2
|
|
-\f[C]None\f[R] - No authentication (Default).
|
|
-.IP \[bu] 2
|
|
-\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
-.IP \[bu] 2
|
|
-\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
+Forces content to be generated even if it would change existing files.
|
|
+This is required when the template chosen would override existing files in the output directory.
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[C]Windows\f[R] - Windows authentication.
|
|
-.PP
|
|
-\f[C]--aad-b2c-instance <INSTANCE>\f[R] - The Azure Active Directory B2C instance to connect to.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/tfp/\f[R].
|
|
-.PP
|
|
-\f[C]-ssp|--susi-policy-id <ID>\f[R] - The sign-in and sign-up policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--aad-instance <INSTANCE>\f[R] - The Azure Active Directory instance to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
-.PP
|
|
-\f[C]--client-id <ID>\f[R] - The Client ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] or \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
-.PP
|
|
-\f[C]--domain <DOMAIN>\f[R] - The domain for the directory tenant.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]qualified.domain.name\f[R].
|
|
-.PP
|
|
-\f[C]--tenant-id <ID>\f[R] - The TenantId ID of the directory to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
-.PP
|
|
-\f[C]-r|--org-read-access\f[R] - Allows this application read-access to the directory.
|
|
-Only applies to \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--exclude-launch-settings\f[R] - Exclude \f[I]launchSettings.json\f[R] from the generated template.
|
|
-.PP
|
|
-\f[C]-uld|--use-local-db\f[R] - Specifies LocalDB should be used instead of SQLite.
|
|
-Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[C]--no-https\f[R] - Project doesn\[cq]t require HTTPS.
|
|
-\f[C]app.UseHsts\f[R] and \f[C]app.UseHttpsRedirection\f[R] aren\[cq]t added to \f[C]Startup.Configure\f[R].
|
|
-This option only applies if \f[C]Individual\f[R], \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] aren\[cq]t being used.
|
|
-.PP
|
|
-\f[B]mvc, razor\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-au|--auth <AUTHENTICATION_TYPE>\f[R] - The type of authentication to use.
|
|
-The possible values are:
|
|
-.IP \[bu] 2
|
|
-\f[C]None\f[R] - No authentication (Default).
|
|
-.IP \[bu] 2
|
|
-\f[C]Individual\f[R] - Individual authentication.
|
|
-.IP \[bu] 2
|
|
-\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
-.IP \[bu] 2
|
|
-\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
-.IP \[bu] 2
|
|
-\f[C]MultiOrg\f[R] - Organizational authentication for multiple tenants.
|
|
+Prints out help for the command.
|
|
+It can be invoked for the \f[C]dotnet new\f[R] command itself or for any template.
|
|
+For example, \f[C]dotnet new mvc --help\f[R].
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[C]Windows\f[R] - Windows authentication.
|
|
-.PP
|
|
-\f[C]--aad-b2c-instance <INSTANCE>\f[R] - The Azure Active Directory B2C instance to connect to.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/tfp/\f[R].
|
|
-.PP
|
|
-\f[C]-ssp|--susi-policy-id <ID>\f[R] - The sign-in and sign-up policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]-rp|--reset-password-policy-id <ID>\f[R] - The reset password policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]-ep|--edit-profile-policy-id <ID>\f[R] - The edit profile policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--aad-instance <INSTANCE>\f[R] - The Azure Active Directory instance to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
-.PP
|
|
-\f[C]--client-id <ID>\f[R] - The Client ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] authentication.
|
|
-The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
-.PP
|
|
-\f[C]--domain <DOMAIN>\f[R] - The domain for the directory tenant.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]qualified.domain.name\f[R].
|
|
-.PP
|
|
-\f[C]--tenant-id <ID>\f[R] - The TenantId ID of the directory to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
-.PP
|
|
-\f[C]--callback-path <PATH>\f[R] - The request path within the application\[cq]s base path of the redirect URI.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]/signin-oidc\f[R].
|
|
-.PP
|
|
-\f[C]-r|--org-read-access\f[R] - Allows this application read-access to the directory.
|
|
-Only applies to \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--exclude-launch-settings\f[R] - Exclude \f[I]launchSettings.json\f[R] from the generated template.
|
|
-.PP
|
|
-\f[C]--use-browserlink\f[R] - Includes BrowserLink in the project.
|
|
-.PP
|
|
-\f[C]-uld|--use-local-db\f[R] - Specifies LocalDB should be used instead of SQLite.
|
|
-Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[C]--no-https\f[R] - Project doesn\[cq]t require HTTPS.
|
|
-\f[C]app.UseHsts\f[R] and \f[C]app.UseHttpsRedirection\f[R] aren\[cq]t added to \f[C]Startup.Configure\f[R].
|
|
-This option only applies if \f[C]Individual\f[R], \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] aren\[cq]t being used.
|
|
-.PP
|
|
-\f[B]page\f[R]
|
|
-.PP
|
|
-\f[C]-na|--namespace <NAMESPACE_NAME>\f[R] - Namespace for the generated code.
|
|
-The default value is \f[C]MyApp.Namespace\f[R].
|
|
-.PP
|
|
-\f[C]-np|--no-pagemodel\f[R] - Creates the page without a PageModel.
|
|
-.PP
|
|
-\f[B]viewimports\f[R]
|
|
-.PP
|
|
-\f[C]-na|--namespace <NAMESPACE_NAME>\f[R] - Namespace for the generated code.
|
|
-The default value is \f[C]MyApp.Namespace\f[R].
|
|
-.SS .NET Core 2.0
|
|
-.PP
|
|
-\f[B]console, angular, react, reactredux\f[R]
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]classlib\f[R]
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R] - Specifies the framework to target.
|
|
-Values: \f[C]netcoreapp2.0\f[R] to create a .NET Core Class Library or \f[C]netstandard2.0\f[R] to create a .NET Standard Class Library.
|
|
-The default value is \f[C]netstandard2.0\f[R].
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
+\f[B]\f[CB]-lang|--language {C#|F#|VB}\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[B]mstest, xunit\f[R]
|
|
-.PP
|
|
-\f[C]-p|--enable-pack\f[R] - Enables packaging for the project using dotnet pack.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]globaljson\f[R]
|
|
-.PP
|
|
-\f[C]--sdk-version <VERSION_NUMBER>\f[R] - Specifies the version of the .NET Core SDK to use in the \f[I]global.json\f[R] file.
|
|
-.PP
|
|
-\f[B]web\f[R]
|
|
+The language of the template to create.
|
|
+The language accepted varies by the template (see defaults in the arguments section).
|
|
+Not valid for some templates.
|
|
+.RS
|
|
.PP
|
|
-\f[C]--use-launch-settings\f[R] - Includes \f[I]launchSettings.json\f[R] in the generated template output.
|
|
+[!NOTE] Some shells interpret \f[C]#\f[R] as a special character.
|
|
+In those cases, enclose the language parameter value in quotes.
|
|
+For example, \f[C]dotnet new console -lang \[dq]F#\[dq]\f[R].
|
|
+.RE
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-n|--name <OUTPUT_NAME>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
+The name for the created output.
|
|
+If no name is specified, the name of the current directory is used.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-o|--output <OUTPUT_DIRECTORY>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[B]webapi\f[R]
|
|
+Location to place the generated output.
|
|
+The default is the current directory.
|
|
+.RE
|
|
+.SS Template options
|
|
.PP
|
|
-\f[C]-au|--auth <AUTHENTICATION_TYPE>\f[R] - The type of authentication to use.
|
|
-The possible values are:
|
|
+Each template may have additional options defined.
|
|
+For more information, see .NET default templates for \f[C]dotnet new\f[R].
|
|
+.SH EXAMPLES
|
|
.IP \[bu] 2
|
|
-\f[C]None\f[R] - No authentication (Default).
|
|
+Create a C# console application project:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new console
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
+Create an F# console application project in the current directory:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new console --language \[dq]F#\[dq]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
+Create a .NET Standard 2.0 class library project in the specified directory:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new classlib --framework \[dq]netstandard2.0\[dq] -o MyLibrary
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[C]Windows\f[R] - Windows authentication.
|
|
-.PP
|
|
-\f[C]--aad-b2c-instance <INSTANCE>\f[R] - The Azure Active Directory B2C instance to connect to.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/tfp/\f[R].
|
|
-.PP
|
|
-\f[C]-ssp|--susi-policy-id <ID>\f[R] - The sign-in and sign-up policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--aad-instance <INSTANCE>\f[R] - The Azure Active Directory instance to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
-.PP
|
|
-\f[C]--client-id <ID>\f[R] - The Client ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] or \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
-.PP
|
|
-\f[C]--domain <DOMAIN>\f[R] - The domain for the directory tenant.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]qualified.domain.name\f[R].
|
|
-.PP
|
|
-\f[C]--tenant-id <ID>\f[R] - The TenantId ID of the directory to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
-.PP
|
|
-\f[C]-r|--org-read-access\f[R] - Allows this application read-access to the directory.
|
|
-Only applies to \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--use-launch-settings\f[R] - Includes \f[I]launchSettings.json\f[R] in the generated template output.
|
|
-.PP
|
|
-\f[C]-uld|--use-local-db\f[R] - Specifies LocalDB should be used instead of SQLite.
|
|
-Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]mvc, razor\f[R]
|
|
-.PP
|
|
-\f[C]-au|--auth <AUTHENTICATION_TYPE>\f[R] - The type of authentication to use.
|
|
-The possible values are:
|
|
+Create a new ASP.NET Core C# MVC project in the current directory with no authentication:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new mvc -au None
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[C]None\f[R] - No authentication (Default).
|
|
+Create a new xUnit project:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new xunit
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[C]Individual\f[R] - Individual authentication.
|
|
+Create a \f[I]global.json\f[R] in the current directory setting the SDK version to 3.1.101:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new globaljson --sdk-version 3.1.101
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
.IP \[bu] 2
|
|
-\f[C]IndividualB2C\f[R] - Individual authentication with Azure AD B2C.
|
|
+dotnet new \[en]list option
|
|
.IP \[bu] 2
|
|
-\f[C]SingleOrg\f[R] - Organizational authentication for a single tenant.
|
|
+dotnet new \[en]search option
|
|
.IP \[bu] 2
|
|
-\f[C]MultiOrg\f[R] - Organizational authentication for multiple tenants.
|
|
+dotnet new \[en]install option
|
|
.IP \[bu] 2
|
|
-\f[C]Windows\f[R] - Windows authentication.
|
|
-.PP
|
|
-\f[C]--aad-b2c-instance <INSTANCE>\f[R] - The Azure Active Directory B2C instance to connect to.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/tfp/\f[R].
|
|
-.PP
|
|
-\f[C]-ssp|--susi-policy-id <ID>\f[R] - The sign-in and sign-up policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]-rp|--reset-password-policy-id <ID>\f[R] - The reset password policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]-ep|--edit-profile-policy-id <ID>\f[R] - The edit profile policy ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--aad-instance <INSTANCE>\f[R] - The Azure Active Directory instance to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
-The default value is \f[C]https://login.microsoftonline.com/\f[R].
|
|
-.PP
|
|
-\f[C]--client-id <ID>\f[R] - The Client ID for this project.
|
|
-Use with \f[C]IndividualB2C\f[R], \f[C]SingleOrg\f[R], or \f[C]MultiOrg\f[R] authentication.
|
|
-The default value is \f[C]11111111-1111-1111-11111111111111111\f[R].
|
|
-.PP
|
|
-\f[C]--domain <DOMAIN>\f[R] - The domain for the directory tenant.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]qualified.domain.name\f[R].
|
|
-.PP
|
|
-\f[C]--tenant-id <ID>\f[R] - The TenantId ID of the directory to connect to.
|
|
-Use with \f[C]SingleOrg\f[R] authentication.
|
|
-The default value is \f[C]22222222-2222-2222-2222-222222222222\f[R].
|
|
-.PP
|
|
-\f[C]--callback-path <PATH>\f[R] - The request path within the application\[cq]s base path of the redirect URI.
|
|
-Use with \f[C]SingleOrg\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-The default value is \f[C]/signin-oidc\f[R].
|
|
-.PP
|
|
-\f[C]-r|--org-read-access\f[R] - Allows this application read-access to the directory.
|
|
-Only applies to \f[C]SingleOrg\f[R] or \f[C]MultiOrg\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--use-launch-settings\f[R] - Includes \f[I]launchSettings.json\f[R] in the generated template output.
|
|
-.PP
|
|
-\f[C]--use-browserlink\f[R] - Includes BrowserLink in the project.
|
|
-.PP
|
|
-\f[C]-uld|--use-local-db\f[R] - Specifies LocalDB should be used instead of SQLite.
|
|
-Only applies to \f[C]Individual\f[R] or \f[C]IndividualB2C\f[R] authentication.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R] - Doesn\[cq]t execute an implicit restore during project creation.
|
|
-.PP
|
|
-\f[B]page\f[R]
|
|
-.PP
|
|
-\f[C]-na|--namespace <NAMESPACE_NAME>\f[R]- Namespace for the generated code.
|
|
-The default value is \f[C]MyApp.Namespace\f[R].
|
|
-.PP
|
|
-\f[C]-np|--no-pagemodel\f[R] - Creates the page without a PageModel.
|
|
-.PP
|
|
-\f[B]viewimports\f[R]
|
|
-.PP
|
|
-\f[C]-na|--namespace <NAMESPACE_NAME>\f[R]- Namespace for the generated code.
|
|
-The default value is \f[C]MyApp.Namespace\f[R].
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-\f[B]console, xunit, mstest, web, webapi\f[R]
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R] - Specifies the framework to target.
|
|
-Values: \f[C]netcoreapp1.0\f[R] or \f[C]netcoreapp1.1\f[R].
|
|
-The default value is \f[C]netcoreapp1.0\f[R].
|
|
-.PP
|
|
-\f[B]classlib\f[R]
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R] - Specifies the framework to target.
|
|
-Values: \f[C]netcoreapp1.0\f[R], \f[C]netcoreapp1.1\f[R], or \f[C]netstandard1.0\f[R] to \f[C]netstandard1.6\f[R].
|
|
-The default value is \f[C]netstandard1.4\f[R].
|
|
-.PP
|
|
-\f[B]mvc\f[R]
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R] - Specifies the framework to target.
|
|
-Values: \f[C]netcoreapp1.0\f[R] or \f[C]netcoreapp1.1\f[R].
|
|
-The default value is \f[C]netcoreapp1.0\f[R].
|
|
-.PP
|
|
-\f[C]-au|--auth <AUTHENTICATION_TYPE>\f[R] - The type of authentication to use.
|
|
-Values: \f[C]None\f[R] or \f[C]Individual\f[R].
|
|
-The default value is \f[C]None\f[R].
|
|
-.PP
|
|
-\f[C]-uld|--use-local-db\f[R] - Specifies whether or not to use LocalDB instead of SQLite.
|
|
-Values: \f[C]true\f[R] or \f[C]false\f[R].
|
|
-The default value is \f[C]false\f[R].
|
|
-.PP
|
|
- * * * * *
|
|
-.SH EXAMPLES
|
|
-.PP
|
|
-Create a C# console application project by specifying the template name:
|
|
-.PP
|
|
-\f[C]dotnet new \[dq]Console Application\[dq]\f[R]
|
|
-.PP
|
|
-Create an F# console application project in the current directory:
|
|
-.PP
|
|
-\f[C]dotnet new console -lang F#\f[R]
|
|
-.PP
|
|
-Create a .NET Standard class library project in the specified directory (available only with .NET Core SDK 2.0 or later versions):
|
|
-.PP
|
|
-\f[C]dotnet new classlib -lang VB -o MyLibrary\f[R]
|
|
-.PP
|
|
-Create a new ASP.NET Core C# MVC project in the current directory with no authentication:
|
|
-.PP
|
|
-\f[C]dotnet new mvc -au None\f[R]
|
|
-.PP
|
|
-Create a new xUnit project:
|
|
-.PP
|
|
-\f[C]dotnet new xunit\f[R]
|
|
-.PP
|
|
-List all templates available for MVC:
|
|
-.PP
|
|
-\f[C]dotnet new mvc -l\f[R]
|
|
-.PP
|
|
-List all templates matching the \f[I]we\f[R] substring.
|
|
-No exact match is found, so substring matching runs against both the short name and name columns.
|
|
-.PP
|
|
-\f[C]dotnet new we -l\f[R]
|
|
-.PP
|
|
-Attempt to invoke the template matching \f[I]ng\f[R].
|
|
-If a single match can\[cq]t be determined, list the templates that are partial matches.
|
|
-.PP
|
|
-\f[C]dotnet new ng\f[R]
|
|
-.PP
|
|
-Install version 2.0 of the Single Page Application templates for ASP.NET Core (command option available for .NET Core SDK 1.1 and later versions only):
|
|
-.PP
|
|
-\f[C]dotnet new -i Microsoft.DotNet.Web.Spa.ProjectTemplates::2.0.0\f[R]
|
|
-.PP
|
|
-Create a \f[I]global.json\f[R] in the current directory setting the SDK version to 2.0.0 (available only with .NET Core SDK 2.0 or later versions):
|
|
-.PP
|
|
-\f[C]dotnet new globaljson --sdk-version 2.0.0\f[R]
|
|
-.SS See also
|
|
+\&.NET default templates for dotnet new
|
|
.IP \[bu] 2
|
|
Custom templates for dotnet new
|
|
.IP \[bu] 2
|
|
Create a custom template for dotnet new
|
|
.IP \[bu] 2
|
|
-dotnet/dotnet-template-samples GitHub repo
|
|
-.IP \[bu] 2
|
|
-Available templates for dotnet new
|
|
+dotnet/dotnet-template-samples GitHub repo (https://github.com/dotnet/dotnet-template-samples)
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-add-source.1 b/documentation/manpages/sdk/dotnet-nuget-add-source.1
|
|
new file mode 100644
|
|
index 0000000000..30e7176ab9
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-add-source.1
|
|
@@ -0,0 +1,123 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet nuget add source
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1.200 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet nuget add source\f[R] - Add a NuGet source.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget add source <PACKAGE_SOURCE_PATH> [--name <SOURCE_NAME>] [--username <USER>]
|
|
+ [--password <PASSWORD>] [--store-password-in-clear-text]
|
|
+ [--valid-authentication-types <TYPES>] [--configfile <FILE>]
|
|
+
|
|
+dotnet nuget add source -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet nuget add source\f[R] command adds a new package source to your NuGet configuration files.
|
|
+.RS
|
|
+.PP
|
|
+[!WARNING] When adding multiple package sources, be careful not to introduce a dependency confusion vulnerability (https://aka.ms/pkg-sec-wp).
|
|
+.RE
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]PACKAGE_SOURCE_PATH\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Path to the package source.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-n|--name <SOURCE_NAME>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Name of the source.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-p|--password <PASSWORD>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Password to be used when connecting to an authenticated source.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--store-password-in-clear-text\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Enables storing portable package source credentials by disabling password encryption.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-u|--username <USER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Username to be used when connecting to an authenticated source.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--valid-authentication-types <TYPES>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Comma-separated list of valid authentication types for this source.
|
|
+Set this to \f[C]basic\f[R] if the server advertises NTLM or Negotiate and your credentials must be sent using the Basic mechanism, for instance when using a PAT with on-premises Azure DevOps Server.
|
|
+Other valid values include \f[C]negotiate\f[R], \f[C]kerberos\f[R], \f[C]ntlm\f[R], and \f[C]digest\f[R], but these values are unlikely to be useful.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Add \f[C]nuget.org\f[R] as a source:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget add source https://api.nuget.org/v3/index.json -n nuget.org
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Add \f[C]c:\[rs]packages\f[R] as a local source:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget add source c:\[rs]packages
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Add a source that needs authentication:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget add source https://someServer/myTeam -n myTeam -u myUsername -p myPassword --store-password-in-clear-text
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Add a source that needs authentication (then go install credential provider):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget add source https://azureartifacts.microsoft.com/myTeam -n myTeam
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+Package source sections in NuGet.config files
|
|
+.IP \[bu] 2
|
|
+sources command (nuget.exe)
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-delete.1 b/documentation/manpages/sdk/dotnet-nuget-delete.1
|
|
index 18d1261714..931ca4ef7b 100644
|
|
--- a/documentation/manpages/sdk/dotnet-nuget-delete.1
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-delete.1
|
|
@@ -1,10 +1,10 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet nuget delete command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet nuget delete
|
|
.PP
|
|
-\f[B]This topic applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 1.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet nuget delete\f[R] - Deletes or unlists a package from the server.
|
|
@@ -12,15 +12,17 @@
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet nuget delete [<PACKAGE_NAME> <PACKAGE_VERSION>] [--force-english-output] [--interactive] [-k|--api-key] [--no-service-endpoint]
|
|
- [--non-interactive] [-s|--source]
|
|
-dotnet nuget delete [-h|--help]
|
|
+dotnet nuget delete [<PACKAGE_NAME> <PACKAGE_VERSION>] [--force-english-output]
|
|
+ [--interactive] [-k|--api-key <API_KEY>] [--no-service-endpoint]
|
|
+ [--non-interactive] [-s|--source <SOURCE>]
|
|
+
|
|
+dotnet nuget delete -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet nuget delete\f[R] command deletes or unlists a package from the server.
|
|
-For nuget.org, the action is to unlist the package.
|
|
+For nuget.org (https://www.nuget.org/), the action is to unlist the package.
|
|
.SS Arguments
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]PACKAGE_NAME\f[B]\f[R]
|
|
@@ -42,17 +44,18 @@ Version of the package to delete.
|
|
Forces the application to run using an invariant, English-based culture.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Allows the command to block and requires manual action for operations like authentication.
|
|
-Option available since .NET Core 2.2 SDK.
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+Available since .NET Core 3.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]-k|--api-key <API_KEY>\f[B]\f[R]
|
|
@@ -102,5 +105,3 @@ dotnet nuget delete Microsoft.AspNetCore.Mvc 1.0 --non-interactive
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
-.SH AUTHORS
|
|
-karann-msft.
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-disable-source.1 b/documentation/manpages/sdk/dotnet-nuget-disable-source.1
|
|
new file mode 100644
|
|
index 0000000000..82b33e9876
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-disable-source.1
|
|
@@ -0,0 +1,55 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet nuget disable source
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1.200 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet nuget disable source\f[R] - Disable a NuGet source.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget disable source <NAME> [--configfile <FILE>]
|
|
+
|
|
+dotnet nuget disable source -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet nuget disable source\f[R] command disables an existing source in your NuGet configuration files.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Name of the source.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Disable a source with name of \f[C]mySource\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget disable source mySource
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+Package source sections in NuGet.config files
|
|
+.IP \[bu] 2
|
|
+sources command (nuget.exe)
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-enable-source.1 b/documentation/manpages/sdk/dotnet-nuget-enable-source.1
|
|
new file mode 100644
|
|
index 0000000000..fd3703fc79
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-enable-source.1
|
|
@@ -0,0 +1,55 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet nuget enable source
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1.200 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet nuget enable source\f[R] - Enable a NuGet source.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget enable source <NAME> [--configfile <FILE>]
|
|
+
|
|
+dotnet nuget enable source -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet nuget enable source\f[R] command enables an existing source in your NuGet configuration files.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Name of the source.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Enable a source with name of \f[C]mySource\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget enable source mySource
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+Package source sections in NuGet.config files
|
|
+.IP \[bu] 2
|
|
+sources command (nuget.exe)
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-list-source.1 b/documentation/manpages/sdk/dotnet-nuget-list-source.1
|
|
new file mode 100644
|
|
index 0000000000..4058caab9f
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-list-source.1
|
|
@@ -0,0 +1,54 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet nuget list source
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1.200 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet nuget list source\f[R] - Lists all configured NuGet sources.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget list source [--format [Detailed|Short]] [--configfile <FILE>]
|
|
+
|
|
+dotnet nuget list source -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet nuget list source\f[R] command lists all existing sources from your NuGet configuration files.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--format [Detailed|Short]\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The format of the list command output: \f[C]Detailed\f[R] (the default) and \f[C]Short\f[R].
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+List configured sources from the current directory:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget list source
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+Package source sections in NuGet.config files
|
|
+.IP \[bu] 2
|
|
+sources command (nuget.exe)
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-locals.1 b/documentation/manpages/sdk/dotnet-nuget-locals.1
|
|
index 99d8d9eaf1..dc77be9fc7 100644
|
|
--- a/documentation/manpages/sdk/dotnet-nuget-locals.1
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-locals.1
|
|
@@ -1,10 +1,10 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet nuget locals command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet nuget locals
|
|
.PP
|
|
-\f[B]This topic applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet nuget locals\f[R] - Clears or lists local NuGet resources.
|
|
@@ -13,7 +13,8 @@
|
|
.nf
|
|
\f[C]
|
|
dotnet nuget locals <CACHE_LOCATION> [(-c|--clear)|(-l|--list)] [--force-english-output]
|
|
-dotnet nuget locals [-h|--help]
|
|
+
|
|
+dotnet nuget locals -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
@@ -46,10 +47,10 @@ The other cache locations aren\[cq]t affected.
|
|
Forces the application to run using an invariant, English-based culture.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]-c|--clear\f[B]\f[R]
|
|
@@ -73,7 +74,7 @@ Displays the paths of all the local cache directories (http-cache directory, glo
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet nuget locals \[en]l all
|
|
+dotnet nuget locals all -l
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
@@ -83,7 +84,7 @@ Displays the path for the local http-cache directory:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet nuget locals --list http-cache
|
|
+dotnet nuget locals http-cache --list
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
@@ -93,7 +94,7 @@ Clears all files from all local cache directories (http-cache directory, global-
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet nuget locals --clear all
|
|
+dotnet nuget locals all --clear
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
@@ -103,7 +104,7 @@ Clears all files in local global-packages cache directory:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet nuget locals -c global-packages
|
|
+dotnet nuget locals global-packages -c
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
@@ -113,12 +114,10 @@ Clears all files in local temporary cache directory:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet nuget locals -c temp
|
|
+dotnet nuget locals temp -c
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
.SS Troubleshooting
|
|
.PP
|
|
For information on common problems and errors while using the \f[C]dotnet nuget locals\f[R] command, see Managing the NuGet cache.
|
|
-.SH AUTHORS
|
|
-karann-msft.
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-push.1 b/documentation/manpages/sdk/dotnet-nuget-push.1
|
|
index 000e3e567e..3727158258 100644
|
|
--- a/documentation/manpages/sdk/dotnet-nuget-push.1
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-push.1
|
|
@@ -1,10 +1,10 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet nuget push command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet nuget push
|
|
.PP
|
|
-\f[B]This topic applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet nuget push\f[R] - Pushes a package to the server and publishes it.
|
|
@@ -12,9 +12,13 @@
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet nuget push [<ROOT>] [-d|--disable-buffering] [--force-english-output] [--interactive] [-k|--api-key] [-n|--no-symbols]
|
|
- [--no-service-endpoint] [-s|--source] [-sk|--symbol-api-key] [-ss|--symbol-source] [-t|--timeout]
|
|
-dotnet nuget push [-h|--help]
|
|
+dotnet nuget push [<ROOT>] [-d|--disable-buffering] [--force-english-output]
|
|
+ [--interactive] [-k|--api-key <API_KEY>] [-n|--no-symbols]
|
|
+ [--no-service-endpoint] [-s|--source <SOURCE>] [--skip-duplicate]
|
|
+ [-sk|--symbol-api-key <API_KEY>] [-ss|--symbol-source <SOURCE>]
|
|
+ [-t|--timeout <TIMEOUT>]
|
|
+
|
|
+dotnet nuget push -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
@@ -23,6 +27,10 @@ The \f[C]dotnet nuget push\f[R] command pushes a package to the server and publi
|
|
The push command uses server and credential details found in the system\[cq]s NuGet config file or chain of config files.
|
|
For more information on config files, see Configuring NuGet Behavior.
|
|
NuGet\[cq]s default configuration is obtained by loading \f[I]%AppData%.config\f[R] (Windows) or \f[I]$HOME/.local/share\f[R] (Linux/macOS), then loading any \f[I]nuget.config\f[R] or \f[I].nuget.config\f[R] starting from the root of drive and ending in the current directory.
|
|
+.PP
|
|
+The command pushes an existing package.
|
|
+It doesn\[cq]t create a package.
|
|
+To create a package, use \f[C]dotnet pack\f[R].
|
|
.SS Arguments
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]ROOT\f[B]\f[R]
|
|
@@ -44,15 +52,18 @@ Disables buffering when pushing to an HTTP(S) server to reduce memory usage.
|
|
Forces the application to run using an invariant, English-based culture.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Allows the command to block and requires manual action for operations like authentication.
|
|
-Option available since .NET Core 2.2 SDK.
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+Available since .NET Core 3.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]-k|--api-key <API_KEY>\f[B]\f[R]
|
|
@@ -78,7 +89,16 @@ Option available since .NET Core 2.1 SDK.
|
|
.RS 2
|
|
.PP
|
|
Specifies the server URL.
|
|
-This option is required unless \f[C]DefaultPushSource\f[R] config value is set in the NuGet config file.
|
|
+NuGet identifies a UNC or local folder source and simply copies the file there instead of pushing it using HTTP.
|
|
+> [!IMPORTANT] > Starting with NuGet 3.4.2, this is a mandatory parameter unless the NuGet config file specifies a \f[C]DefaultPushSource\f[R] value.
|
|
+For more information, see Configuring NuGet behavior.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--skip-duplicate\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+When pushing multiple packages to an HTTP(S) server, treats any 409 Conflict response as a warning so that the push can continue.
|
|
+Available since .NET Core 3.1 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]-sk|--symbol-api-key <API_KEY>\f[B]\f[R]
|
|
@@ -98,11 +118,11 @@ Specifies the symbol server URL.
|
|
.PP
|
|
Specifies the timeout for pushing to a server in seconds.
|
|
Defaults to 300 seconds (5 minutes).
|
|
-Specifying 0 (zero seconds) applies the default value.
|
|
+Specifying 0 applies the default value.
|
|
.RE
|
|
.SH EXAMPLES
|
|
.IP \[bu] 2
|
|
-Pushes \f[I]foo.nupkg\f[R] to the default push source, specifying an API key:
|
|
+Push \f[I]foo.nupkg\f[R] to the default push source specified in the NuGet config file, using an API key:
|
|
.RS 2
|
|
.IP
|
|
.nf
|
|
@@ -112,17 +132,25 @@ dotnet nuget push foo.nupkg -k 4003d786-cc37-4004-bfdf-c4f3e8ef9b3a
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Push \f[I]foo.nupkg\f[R] to the custom push source \f[C]https://customsource\f[R], specifying an API key:
|
|
+Push \f[I]foo.nupkg\f[R] to the official NuGet server, specifying an API key:
|
|
.RS 2
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
+dotnet nuget push foo.nupkg -k 4003d786-cc37-4004-bfdf-c4f3e8ef9b3a -s https://api.nuget.org/v3/index.json
|
|
+\f[R]
|
|
+.fi
|
|
+.IP \[bu] 2
|
|
+Push \f[I]foo.nupkg\f[R] to the custom push source \f[C]https://customsource\f[R], specifying an API key:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
dotnet nuget push foo.nupkg -k 4003d786-cc37-4004-bfdf-c4f3e8ef9b3a -s https://customsource/
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Pushes \f[I]foo.nupkg\f[R] to the default push source:
|
|
+Push \f[I]foo.nupkg\f[R] to the default push source specified in the NuGet config file:
|
|
.RS 2
|
|
.IP
|
|
.nf
|
|
@@ -132,7 +160,7 @@ dotnet nuget push foo.nupkg
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Pushes \f[I]foo.symbols.nupkg\f[R] to the default symbols source:
|
|
+Push \f[I]foo.symbols.nupkg\f[R] to the default symbols source:
|
|
.RS 2
|
|
.IP
|
|
.nf
|
|
@@ -142,7 +170,7 @@ dotnet nuget push foo.symbols.nupkg
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Pushes \f[I]foo.nupkg\f[R] to the default push source, specifying a 360-second timeout:
|
|
+Push \f[I]foo.nupkg\f[R] to the default push source specified in the NuGet config file, with a 360-second timeout:
|
|
.RS 2
|
|
.IP
|
|
.nf
|
|
@@ -152,19 +180,45 @@ dotnet nuget push foo.nupkg --timeout 360
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Pushes all \f[I].nupkg\f[R] files in the current directory to the default push source:
|
|
+Push all \f[I].nupkg\f[R] files in the current directory to the default push source specified in the NuGet config file:
|
|
.RS 2
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet nuget push *.nupkg
|
|
+dotnet nuget push \[dq]*.nupkg\[dq]
|
|
\f[R]
|
|
.fi
|
|
.RS
|
|
.PP
|
|
[!NOTE] If this command doesn\[cq]t work, it might be due to a bug that existed in older versions of the SDK (.NET Core 2.1 SDK and earlier versions).
|
|
-To fix this, upgrade your SDK version or run the following command instead: \f[C]dotnet nuget push **/*.nupkg\f[R]
|
|
+To fix this, upgrade your SDK version or run the following command instead: \f[C]dotnet nuget push \[dq]**/*.nupkg\[dq]\f[R]
|
|
+.RE
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] The enclosing quotes are required for shells such as bash that perform file globbing.
|
|
+For more information, see NuGet/Home#4393 (https://github.com/NuGet/Home/issues/4393#issuecomment-667618120).
|
|
.RE
|
|
.RE
|
|
-.SH AUTHORS
|
|
-karann-msft.
|
|
+.IP \[bu] 2
|
|
+Push all \f[I].nupkg\f[R] files to the default push source specified in the NuGet config file, even if a 409 Conflict response is returned by an HTTP(S) server:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget push \[dq]*.nupkg\[dq] --skip-duplicate
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Push all \f[I].nupkg\f[R] files in the current directory to a local feed directory:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget push \[dq]*.nupkg\[dq] -s c:\[rs]mydir
|
|
+\f[R]
|
|
+.fi
|
|
+.PP
|
|
+This command doesn\[cq]t store packages in a hierarchical folder structure, which is recommended to optimize performance.
|
|
+For more information, see Local feeds.
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-remove-source.1 b/documentation/manpages/sdk/dotnet-nuget-remove-source.1
|
|
new file mode 100644
|
|
index 0000000000..1beede5e47
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-remove-source.1
|
|
@@ -0,0 +1,55 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet nuget remove source
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1.200 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet nuget remove source\f[R] - Remove a NuGet source.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget remove source <NAME> [--configfile <FILE>]
|
|
+
|
|
+dotnet nuget remove source -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet nuget remove source\f[R] command removes an existing source from your NuGet configuration files.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Name of the source.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Remove a source with name of \f[C]mySource\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget remove source mySource
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+Package source sections in NuGet.config files
|
|
+.IP \[bu] 2
|
|
+sources command (nuget.exe)
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-sign.1 b/documentation/manpages/sdk/dotnet-nuget-sign.1
|
|
new file mode 100644
|
|
index 0000000000..7cc812ab19
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-sign.1
|
|
@@ -0,0 +1,242 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet nuget sign
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6.0 Preview 5 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet nuget sign\f[R] - Signs all the NuGet packages matching the first argument with a certificate.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign [<package-path(s)>]
|
|
+ [--certificate-path <PATH>]
|
|
+ [--certificate-store-name <STORENAME>]
|
|
+ [--certificate-store-location <STORELOCATION>]
|
|
+ [--certificate-subject-name <SUBJECTNAME>]
|
|
+ [--certificate-fingerprint <FINGERPRINT>]
|
|
+ [--certificate-password <PASSWORD>]
|
|
+ [--hash-algorithm <HASHALGORITHM>]
|
|
+ [-o|--output <OUTPUT DIRECTORY>]
|
|
+ [--overwrite]
|
|
+ [--timestamp-hash-algorithm <HASHALGORITHM>]
|
|
+ [--timestamper <TIMESTAMPINGSERVER>]
|
|
+ [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet nuget sign -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet nuget sign\f[R] command signs all the packages matching the first argument with a certificate.
|
|
+The certificate with the private key can be obtained from a file or from a certificate installed in a certificate store by providing a subject name or a SHA-1 fingerprint.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]package-path(s)\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the file path to the package(s) to be signed.
|
|
+Multiple arguments can be passed in to sign multiple packages.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--certificate-path <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the file path to the certificate to be used in signing the package.
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] This option currently supports only \f[C]PKCS12 (PFX)\f[R] files that contain the certificate\[cq]s private key.
|
|
+.RE
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--certificate-store-name <STORENAME>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the name of the X.509 certificate store to use to search for the certificate.
|
|
+Defaults to :::no-loc text=\[lq]\[dq]My\[dq]\[rq]:::, the X.509 certificate store for personal certificates.
|
|
+This option should be used when specifying the certificate via \f[C]--certificate-subject-name\f[R] or \f[C]--certificate-fingerprint\f[R] options.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--certificate-store-location <STORELOCATION>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the name of the X.509 certificate store use to search for the certificate.
|
|
+Defaults to :::no-loc text=\[lq]\[dq]CurrentUser\[dq]\[rq]:::, the X.509 certificate store used by the current user.
|
|
+This option should be used when specifying the certificate via \f[C]--certificate-subject-name\f[R] or \f[C]--certificate-fingerprint\f[R] options.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--certificate-subject-name <SUBJECTNAME>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the subject name of the certificate used to search a local certificate store for the certificate.
|
|
+The search is a case-insensitive string comparison using the supplied value, which will find all certificates with the subject name containing that string, regardless of other subject values.
|
|
+The certificate store can be specified by \f[C]--certificate-store-name\f[R] and \f[C]--certificate-store-location\f[R] options.
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] This option currently supports only a single matching certificate in the result.
|
|
+If there are multiple matching certificates in the result, or no matching certificate in the result, the sign command will fail.
|
|
+.RE
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--certificate-fingerprint <FINGERPRINT>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+SHA-1 fingerprint of the certificate used to search a local certificate store for the certificate.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--certificate-password <PASSWORD>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the certificate password, if needed.
|
|
+If a certificate is password protected but no password is provided, the sign command will fail.
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] The \f[C]sign\f[R] command only supports non-interactive mode.
|
|
+There won\[cq]t be any prompt for a password at run time.
|
|
+.RE
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--hash-algorithm <HASHALGORITHM>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Hash algorithm to be used to sign the package.
|
|
+Defaults to SHA256.
|
|
+Possible values are SHA256, SHA384, and SHA512.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-o|--output\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the directory where the signed package should be saved.
|
|
+If this option is not specified, by default the original package is overwritten by the signed package.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--overwrite\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Indicate that the current signature should be overwritten.
|
|
+By default the command will fail if the package already has a signature.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--timestamp-hash-algorithm <HASHALGORITHM>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Hash algorithm to be used by the RFC 3161 timestamp server.
|
|
+Defaults to SHA256.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--timestamper <TIMESTAMPINGSERVER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+URL to an RFC 3161 timestamping server.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Sign \f[I]foo.nupkg\f[R] with certificate \f[I]cert.pfx\f[R] (not password protected):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign foo.nupkg --certificate-path cert.pfx
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Sign \f[I]foo.nupkg\f[R] with certificate \f[I]cert.pfx\f[R] (password protected):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign foo.nupkg --certificate-path cert.pfx --certificate-password password
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Sign \f[I]foo.nupkg\f[R] with certificate (password protected) matches with the specified SHA-1 fingerprint in the default certificate store (CurrentUser):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign foo.nupkg --certificate-fingerprint 89967D1DD995010B6C66AE24FF8E66885E6E03A8 --certificate-password password
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Sign \f[I]foo.nupkg\f[R] with certificate (password protected) matches with the specified subject name :::no-loc text=\[lq]\[dq]Test certificate for testing signing\[dq]\[rq]::: in the default certificate store (CurrentUser):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign foo.nupkg --certificate-subject-name \[dq]Test certificate for testing signing\[dq] --certificate-password password
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Sign \f[I]foo.nupkg\f[R] with certificate (password protected) matches with the specified SHA-1 fingerprint in the certificate store CurrentUser:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign foo.nupkg --certificate-fingerprint 89967D1DD995010B6C66AE24FF8E66885E6E03A8 --certificate-password password --certificate-store-location CurrentUser --certificate-store-name Root
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Sign multiple NuGet packages - \f[I]foo.nupkg\f[R] and \f[I]all .nupkg files in the directory specified\f[R] with certificate \f[I]cert.pfx\f[R] (not password protected):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign foo.nupkg c:\[rs]mydir\[rs]*.nupkg --certificate-path cert.pfx
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Sign \f[I]foo.nupkg\f[R] with certificate \f[I]cert.pfx\f[R] (password protected), and timestamp with \f[C]http://timestamp.test\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign foo.nupkg --certificate-path cert.pfx --certificate-password password --timestamper http://timestamp.test
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Sign \f[I]foo.nupkg\f[R] with certificate \f[I]cert.pfx\f[R] (not password protected) and save the signed package under specified directory:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign foo.nupkg --certificate-path cert.pfx --output c:\[rs]signed\[rs]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Sign \f[I]foo.nupkg\f[R] with certificate \f[I]cert.pfx\f[R] (not password protected) and overwrite the current signature if the package is already signed:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget sign foo.nupkg --certificate-path cert.pfx --overwrite
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-trust.1 b/documentation/manpages/sdk/dotnet-nuget-trust.1
|
|
new file mode 100644
|
|
index 0000000000..99f3950586
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-trust.1
|
|
@@ -0,0 +1,468 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet nuget trust
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 5.0.300 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet nuget trust\f[R] - Gets or sets trusted signers to the NuGet configuration.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust [command] [Options]
|
|
+
|
|
+dotnet nuget trust -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet nuget trust\f[R] command manages the trusted signers.
|
|
+By default, NuGet accepts all authors and repositories.
|
|
+These commands allow you to specify only a specific subset of signers whose signatures will be accepted, while rejecting all others.
|
|
+For more information, see Common NuGet configurations.
|
|
+For details on what the nuget.config schema looks like, refer to the NuGet config file reference.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.SS Commands
|
|
+.PP
|
|
+If no command is specified, the command will default to \f[C]list\f[R].
|
|
+.SS \f[C]list\f[R]
|
|
+.PP
|
|
+Lists all the trusted signers in the configuration.
|
|
+This option will include all the certificates (with fingerprint and fingerprint algorithm) each signer has.
|
|
+If a certificate has a preceding [U], it means that certificate entry has allowUntrustedRoot set as true.
|
|
+.SS Synopsis:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust list [--configfile <PATH>] [-h|--help] [-v, --verbosity <LEVEL>]
|
|
+\f[R]
|
|
+.fi
|
|
+.SS Options:
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SS \f[C]sync\f[R]
|
|
+.PP
|
|
+Deletes the current list of certificates and replaces them with an up-to-date list from the repository.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust sync <NAME> [--configfile <PATH>] [-h|--help] [-v, --verbosity <LEVEL>]
|
|
+\f[R]
|
|
+.fi
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The name of the existing trusted signer to sync.
|
|
+.RE
|
|
+.SS Options:
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SS \f[C]remove\f[R]
|
|
+.PP
|
|
+Removes any trusted signers that match the given name.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust remove <NAME> [--configfile <PATH>] [-h|--help] [-v, --verbosity <LEVEL>]
|
|
+\f[R]
|
|
+.fi
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The name of the existing trusted signer to remove.
|
|
+.RE
|
|
+.SS Options:
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SS \f[C]author\f[R]
|
|
+.PP
|
|
+Adds a trusted signer with the given name, based on the author signature of the package.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust author <NAME> <PACKAGE> [--allow-untrusted-root] [--configfile <PATH>] [-h|--help] [-v, --verbosity <LEVEL>]
|
|
+\f[R]
|
|
+.fi
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The name of the trusted signer to add.
|
|
+If \f[C]NAME\f[R] already exists in the configuration, the signature is appended.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]PACKAGE\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The given \f[C]PACKAGE\f[R] should be a local path to the signed \f[I].nupkg\f[R] file.
|
|
+.RE
|
|
+.SS Options:
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--allow-untrusted-root\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies if the certificate for the trusted signer should be allowed to chain to an untrusted root.
|
|
+This is not recommended.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SS \f[C]repository\f[R]
|
|
+.PP
|
|
+Adds a trusted signer with the given name, based on the repository signature or countersignature of a signed package.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust repository <NAME> <PACKAGE> [--allow-untrusted-root] [--configfile <PATH>] [-h|--help] [--owners <LIST>] [-v, --verbosity <LEVEL>]
|
|
+\f[R]
|
|
+.fi
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The name of the trusted signer to add.
|
|
+If \f[C]NAME\f[R] already exists in the configuration, the signature is appended.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]PACKAGE\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The given \f[C]PACKAGE\f[R] should be a local path to the signed \f[I].nupkg\f[R] file.
|
|
+.RE
|
|
+.SS Options:
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--allow-untrusted-root\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies if the certificate for the trusted signer should be allowed to chain to an untrusted root.
|
|
+This is not recommended.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--owners <LIST>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Semicolon-separated list of trusted owners to further restrict the trust of a repository.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SS \f[C]certificate\f[R]
|
|
+.PP
|
|
+Adds a trusted signer with the given name, based on a certificate fingerprint.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust certificate <NAME> <FINGERPRINT> [--algorithm <ALGORITHM>] [--allow-untrusted-root] [--configfile <PATH>] [-h|--help] [-v, --verbosity <LEVEL>]
|
|
+\f[R]
|
|
+.fi
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The name of the trusted signer to add.
|
|
+If a trusted signer with the given name already exists, the certificate item is added to that signer.
|
|
+Otherwise a trusted author is created with a certificate item from the given certificate information.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]FINGERPRINT\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The fingerprint of the certificate.
|
|
+.RE
|
|
+.SS Options:
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--algorithm <ALGORITHM>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the hash algorithm used to calculate the certificate fingerprint.
|
|
+Defaults to SHA256.
|
|
+Values supported are SHA256, SHA384 and SHA512.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--allow-untrusted-root\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies if the certificate for the trusted signer should be allowed to chain to an untrusted root.
|
|
+This is not recommended.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SS \f[C]source\f[R]
|
|
+.PP
|
|
+Adds a trusted signer based on a given package source.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust source <NAME> [--configfile <PATH>] [-h|--help] [--owners <LIST>] [--source-url] [-v, --verbosity <LEVEL>]
|
|
+\f[R]
|
|
+.fi
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The name of the trusted signer to add.
|
|
+If only \f[C]<NAME>\f[R] is provided without \f[C]--<source-url>\f[R], the package source from your NuGet configuration files with the same name is added to the trusted list.
|
|
+If \f[C]<NAME>\f[R] already exists in the configuration, the package source is appended to it.
|
|
+.RE
|
|
+.SS Options:
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--owners <LIST>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Semicolon-separated list of trusted owners to further restrict the trust of a repository.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--source-url\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+If a \f[C]source-url\f[R] is provided, it must be a v3 package source URL (like \f[C]https://api.nuget.org/v3/index.json\f[R]).
|
|
+Other package source types are not supported.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+List trusted signers:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust list
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Trust source \f[I]NuGet\f[R] in specified \f[I]nuget.config\f[R] file:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust source NuGet --configfile ..\[rs]nuget.config
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Trust an author from signed nupkg package file \f[I]foo.nupkg\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust author PackageAuthor .\[rs]foo.nupkg
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Trust a repository from signed nupkg package file \f[I]foo.nupkg\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget trust repository PackageRepository .\[rs]foo.nupkg
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Trust a package signing certificate using its SHA256 fingerprint:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+ dotnet nuget trust certificate MyCert F99EC8CDCE5642B380296A19E22FA8EB3AEF1C70079541A2B3D6E4A93F5E1AFD --algorithm SHA256
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Trust owners \f[I]Nuget\f[R] and \f[I]Microsoft\f[R] from the repository \f[C]https://api.nuget.org/v3/index.json\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+ dotnet nuget trust source NuGetTrust https://api.nuget.org/v3/index.json --owners \[dq]Nuget;Microsoft\[dq]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Remove trusted signer named \f[I]NuGet\f[R] from specified \f[I]nuget.config\f[R] file:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+ dotnet nuget trust remove NuGet --configfile ..\[rs]nuget.config
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-update-source.1 b/documentation/manpages/sdk/dotnet-nuget-update-source.1
|
|
new file mode 100644
|
|
index 0000000000..893207f325
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-update-source.1
|
|
@@ -0,0 +1,89 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet nuget update source
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1.200 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet nuget update source\f[R] - Update a NuGet source.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget update source <NAME> [--source <SOURCE>] [--username <USER>]
|
|
+ [--password <PASSWORD>] [--store-password-in-clear-text]
|
|
+ [--valid-authentication-types <TYPES>] [--configfile <FILE>]
|
|
+
|
|
+dotnet nuget update source -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet nuget update source\f[R] command updates an existing source in your NuGet configuration files.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Name of the source.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-p|--password <PASSWORD>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Password to be used when connecting to an authenticated source.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-s|--source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Path to the package source.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--store-password-in-clear-text\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Enables storing portable package source credentials by disabling password encryption.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-u|--username <USER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Username to be used when connecting to an authenticated source.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--valid-authentication-types <TYPES>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Comma-separated list of valid authentication types for this source.
|
|
+Set this to \f[C]basic\f[R] if the server advertises NTLM or Negotiate and your credentials must be sent using the Basic mechanism, for instance when using a PAT with on-premises Azure DevOps Server.
|
|
+Other valid values include \f[C]negotiate\f[R], \f[C]kerberos\f[R], \f[C]ntlm\f[R], and \f[C]digest\f[R], but these values are unlikely to be useful.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Update a source with name of \f[C]mySource\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget update source mySource --source c:\[rs]packages
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+Package source sections in NuGet.config files
|
|
+.IP \[bu] 2
|
|
+sources command (nuget.exe)
|
|
diff --git a/documentation/manpages/sdk/dotnet-nuget-verify.1 b/documentation/manpages/sdk/dotnet-nuget-verify.1
|
|
new file mode 100644
|
|
index 0000000000..578398cd49
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-nuget-verify.1
|
|
@@ -0,0 +1,341 @@
|
|
+'\" t
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet nuget verify
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 5.0.100-rc.2.x SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet nuget verify\f[R] - Verifies a signed NuGet package.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget verify [<package-path(s)>]
|
|
+ [--all]
|
|
+ [--certificate-fingerprint <FINGERPRINT>]
|
|
+ [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet nuget verify -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet nuget verify\f[R] command verifies a signed NuGet package.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]package-path(s)\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the file path to the package(s) to be verified.
|
|
+Multiple position arguments can be passed in to verify multiple packages.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--all\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies that all verifications possible should be performed on the package(s).
|
|
+By default, only \f[C]signatures\f[R] are verified.
|
|
+.RE
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] This command currently supports only \f[C]signature\f[R] verification.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--certificate-fingerprint <FINGERPRINT>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Verify that the signer certificate matches with one of the specified \f[C]SHA256\f[R] fingerprints.
|
|
+This option can be supplied multiple times to provide multiple fingerprints.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.PP
|
|
+The following table shows what is displayed for each verbosity level.
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l l l l l.
|
|
+T{
|
|
+\[u200B]
|
|
+T}@T{
|
|
+\f[C]q[uiet]\f[R]
|
|
+T}@T{
|
|
+\f[C]m[inimal]\f[R]
|
|
+T}@T{
|
|
+\f[C]n[ormal]\f[R]
|
|
+T}@T{
|
|
+\f[C]d[etailed]\f[R]
|
|
+T}@T{
|
|
+\f[C]diag[nostic]\f[R]
|
|
+T}
|
|
+_
|
|
+T{
|
|
+\f[C]Certificate chain Information\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Path to package being verified\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Hashing algorithm used for signature\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Author/Repository Certificate -> SHA1 hash\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Author/Repository Certificate -> Issued By\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Timestamp Certificate -> Issued By\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Timestamp Certificate -> SHA-256 hash\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Timestamp Certificate -> Validity period\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Timestamp Certificate -> SHA1 hash\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Timestamp Certificate -> Subject name\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Author/Repository Certificate -> Subject name\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Author/Repository Certificate -> SHA-256 hash\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Author/Repository Certificate -> Validity period\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Author/Repository Certificate -> Service index URL (If applicable)\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Package name being verified\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+T{
|
|
+\f[C]Type of signature (author or repository)\f[R]
|
|
+T}@T{
|
|
+\[u274C]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}@T{
|
|
+\[u2714]\[uFE0F]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+\[u274C] indicates details that are \f[B]not\f[R] displayed.
|
|
+\[u2714]\[uFE0F] indicates details that are displayed.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Verify \f[I]foo.nupkg\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget verify foo.nupkg
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Verify multiple NuGet packages - \f[I]foo.nupkg\f[R] and \f[I]all .nupkg files in the directory specified\f[R]:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget verify foo.nupkg c:\[rs]mydir\[rs]*.nupkg
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Verify \f[I]foo.nupkg\f[R] signature matches with the specified certificate fingerprint:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget verify foo.nupkg --certificate-fingerprint CE40881FF5F0AD3E58965DA20A9F571EF1651A56933748E1BF1C99E537C4E039
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Verify \f[I]foo.nupkg\f[R] signature matches with one of the specified certificate fingerprints:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet nuget verify foo.nupkg --certificate-fingerprint CE40881FF5F0AD3E58965DA20A9F571EF1651A56933748E1BF1C99E537C4E039 --certificate-fingerprint EC10992GG5F0AD3E58965DA20A9F571EF1651A56933748E1BF1C99E537C4E027
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-pack.1 b/documentation/manpages/sdk/dotnet-pack.1
|
|
index 14f617aa93..0967ed5afc 100644
|
|
--- a/documentation/manpages/sdk/dotnet-pack.1
|
|
+++ b/documentation/manpages/sdk/dotnet-pack.1
|
|
@@ -1,10 +1,11 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+'\" t
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet pack command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet pack
|
|
.PP
|
|
-\f[B]This topic applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet pack\f[R] - Packs the code into a NuGet package.
|
|
@@ -12,10 +13,14 @@
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet pack [<PROJECT>|<SOLUTION>] [-c|--configuration] [--force] [--include-source] [--include-symbols] [--interactive]
|
|
- [--no-build] [--no-dependencies] [--no-restore] [--nologo] [-o|--output] [--runtime] [-s|--serviceable]
|
|
- [-v|--verbosity] [--version-suffix]
|
|
-dotnet pack [-h|--help]
|
|
+dotnet pack [<PROJECT>|<SOLUTION>] [-c|--configuration <CONFIGURATION>]
|
|
+ [--force] [--include-source] [--include-symbols] [--interactive]
|
|
+ [--no-build] [--no-dependencies] [--no-restore] [--nologo]
|
|
+ [-o|--output <OUTPUT_DIRECTORY>] [--runtime <RUNTIME_IDENTIFIER>]
|
|
+ [-s|--serviceable] [-v|--verbosity <LEVEL>]
|
|
+ [--version-suffix <VERSION_SUFFIX>]
|
|
+
|
|
+dotnet pack -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
@@ -30,16 +35,22 @@ If you want to generate a package that contains the debug symbols, you have two
|
|
\f[C]--include-source\f[R] - it creates the symbols package with a \f[C]src\f[R] folder inside containing the source files.
|
|
.PP
|
|
NuGet dependencies of the packed project are added to the \f[I].nuspec\f[R] file, so they\[cq]re properly resolved when the package is installed.
|
|
-Project-to-project references aren\[cq]t packaged inside the project.
|
|
+If the packed project has references to other projects, the other projects are not included in the package.
|
|
Currently, you must have a package per project if you have project-to-project dependencies.
|
|
.PP
|
|
By default, \f[C]dotnet pack\f[R] builds the project first.
|
|
If you wish to avoid this behavior, pass the \f[C]--no-build\f[R] option.
|
|
This option is often useful in Continuous Integration (CI) build scenarios where you know the code was previously built.
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] In some cases, the implicit build cannot be performed.
|
|
+This can occur when \f[C]GeneratePackageOnBuild\f[R] is set, to avoid a cyclic dependency between build and pack targets.
|
|
+The build can also fail if there is a locked file or other issue.
|
|
+.RE
|
|
.PP
|
|
You can provide MSBuild properties to the \f[C]dotnet pack\f[R] command for the packing process.
|
|
-For more information, see NuGet metadata properties and the MSBuild Command-Line Reference.
|
|
-The Examples section shows how to use the MSBuild -p switch for a couple of different scenarios.
|
|
+For more information, see NuGet pack target properties and the MSBuild Command-Line Reference.
|
|
+The Examples section shows how to use the MSBuild \f[C]-p\f[R] switch for a couple of different scenarios.
|
|
.PP
|
|
Web projects aren\[cq]t packable by default.
|
|
To override the default behavior, add the following property to your \f[I].csproj\f[R] file:
|
|
@@ -51,21 +62,36 @@ To override the default behavior, add the following property to your \f[I].cspro
|
|
</PropertyGroup>
|
|
\f[R]
|
|
.fi
|
|
+.SS Implicit restore
|
|
+.PP
|
|
+You don\[cq]t have to run \f[C]dotnet restore\f[R] because it\[cq]s run implicitly by all commands that require a restore to occur, such as \f[C]dotnet new\f[R], \f[C]dotnet build\f[R], \f[C]dotnet run\f[R], \f[C]dotnet test\f[R], \f[C]dotnet publish\f[R], and \f[C]dotnet pack\f[R].
|
|
+To disable implicit restore, use the \f[C]--no-restore\f[R] option.
|
|
+.PP
|
|
+The \f[C]dotnet restore\f[R] command is still useful in certain scenarios where explicitly restoring makes sense, such as continuous integration builds in Azure DevOps Services or in build systems that need to explicitly control when the restore occurs.
|
|
+.PP
|
|
+For information about how to manage NuGet feeds, see the \f[C]dotnet restore\f[R] documentation.
|
|
+.PP
|
|
+This command supports the \f[C]dotnet restore\f[R] options when passed in the long form (for example, \f[C]--source\f[R]).
|
|
+Short form options, such as \f[C]-s\f[R], are not supported.
|
|
+.SS Workload manifest downloads
|
|
.PP
|
|
+When you run this command, it initiates an asynchronous background download of advertising manifests for workloads.
|
|
+If the download is still running when this command finishes, the download is stopped.
|
|
+For more information, see Advertising manifests.
|
|
.SS Arguments
|
|
.PP
|
|
\f[C]PROJECT | SOLUTION\f[R]
|
|
.PP
|
|
The project or solution to pack.
|
|
-It\[cq]s either a path to a csproj file, a solution file, or to a directory.
|
|
+It\[cq]s either a path to a csproj, vbproj, or fsproj file, or to a solution file or directory.
|
|
If not specified, the command searches the current directory for a project or solution file.
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-c|--configuration {Debug|Release}\f[B]\f[R]
|
|
+\f[B]\f[CB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Defines the build configuration.
|
|
-The default value is \f[C]Debug\f[R].
|
|
+The default for most projects is \f[C]Debug\f[R], but you can override the build configuration settings in your project.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--force\f[B]\f[R]
|
|
@@ -73,13 +99,12 @@ The default value is \f[C]Debug\f[R].
|
|
.PP
|
|
Forces all dependencies to be resolved even if the last restore was successful.
|
|
Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
|
|
-Option available since .NET Core 2.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--include-source\f[B]\f[R]
|
|
@@ -98,7 +123,8 @@ Includes the debug symbols NuGet packages in addition to the regular NuGet packa
|
|
\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Allows the command to stop and wait for user input or action (for example, to complete authentication).
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
Available since .NET Core 3.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
@@ -113,14 +139,12 @@ It also implicitly sets the \f[C]--no-restore\f[R] flag.
|
|
.RS 2
|
|
.PP
|
|
Ignores project-to-project references and only restores the root project.
|
|
-Option available since .NET Core 2.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Doesn\[cq]t execute an implicit restore when running the command.
|
|
-Option available since .NET Core 2.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--nologo\f[B]\f[R]
|
|
@@ -141,27 +165,69 @@ Places the built packages in the directory specified.
|
|
.PP
|
|
Specifies the target runtime to restore packages for.
|
|
For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
-Option available since .NET Core 2.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]-s|--serviceable\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Sets the serviceable flag in the package.
|
|
-For more information, see .NET Blog: .NET 4.5.1 Supports Microsoft Security Updates for .NET NuGet Libraries.
|
|
+For more information, see .NET Blog: .NET Framework 4.5.1 Supports Microsoft Security Updates for .NET NuGet Libraries (https://aka.ms/nupkgservicing).
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]--version-suffix <VERSION_SUFFIX>\f[B]\f[R]
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Defines the value for the \f[C]$(VersionSuffix)\f[R] MSBuild property in the project.
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+\f[B]\f[CB]--version-suffix <VERSION_SUFFIX>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+Defines the value for the \f[C]VersionSuffix\f[R] MSBuild property.
|
|
+The effect of this property on the package version depends on the values of the \f[C]Version\f[R] and \f[C]VersionPrefix\f[R] properties, as shown in the following table:
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
+T{
|
|
+Properties with values
|
|
+T}@T{
|
|
+Package version
|
|
+T}
|
|
+_
|
|
+T{
|
|
+None
|
|
+T}@T{
|
|
+\f[C]1.0.0\f[R]
|
|
+T}
|
|
+T{
|
|
+\f[C]Version\f[R]
|
|
+T}@T{
|
|
+\f[C]$(Version)\f[R]
|
|
+T}
|
|
+T{
|
|
+\f[C]VersionPrefix\f[R] only
|
|
+T}@T{
|
|
+\f[C]$(VersionPrefix)\f[R]
|
|
+T}
|
|
+T{
|
|
+\f[C]VersionSuffix\f[R] only
|
|
+T}@T{
|
|
+\f[C]1.0.0-$(VersionSuffix)\f[R]
|
|
+T}
|
|
+T{
|
|
+\f[C]VersionPrefix\f[R] and \f[C]VersionSuffix\f[R]
|
|
+T}@T{
|
|
+\f[C]$(VersionPrefix)-$(VersionSuffix)\f[R]
|
|
+T}
|
|
+.TE
|
|
+.PP
|
|
+If you want to use \f[C]--version-suffix\f[R], specify \f[C]VersionPrefix\f[R] and not \f[C]Version\f[R] in the project file.
|
|
+For example, if \f[C]VersionPrefix\f[R] is \f[C]0.1.2\f[R] and you pass \f[C]--version-suffix rc.1\f[R] to \f[C]dotnet pack\f[R], the package version will be \f[C]0.1.2-rc.1\f[R].
|
|
+.PP
|
|
+If \f[C]Version\f[R] has a value and you pass \f[C]--version-suffix\f[R] to \f[C]dotnet pack\f[R], the value specified for \f[C]--version-suffix\f[R] is ignored.
|
|
.RE
|
|
.SH EXAMPLES
|
|
.IP \[bu] 2
|
|
@@ -235,7 +301,7 @@ dotnet pack -p:TargetFrameworks=net45
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Pack the project and use a specific runtime (Windows 10) for the restore operation (.NET Core SDK 2.0 and later versions):
|
|
+Pack the project and use a specific runtime (Windows 10) for the restore operation:
|
|
.RS 2
|
|
.IP
|
|
.nf
|
|
@@ -245,7 +311,7 @@ dotnet pack --runtime win10-x64
|
|
.fi
|
|
.RE
|
|
.IP \[bu] 2
|
|
-Pack the project using a .nuspec file:
|
|
+Pack the project using a \f[I].nuspec\f[R] file:
|
|
.RS 2
|
|
.IP
|
|
.nf
|
|
@@ -253,4 +319,12 @@ Pack the project using a .nuspec file:
|
|
dotnet pack \[ti]/projects/app1/project.csproj -p:NuspecFile=\[ti]/projects/app1/project.nuspec -p:NuspecBasePath=\[ti]/projects/app1/nuget
|
|
\f[R]
|
|
.fi
|
|
+.PP
|
|
+For information about how to use \f[C]NuspecFile\f[R], \f[C]NuspecBasePath\f[R], and \f[C]NuspecProperties\f[R], see the following resources:
|
|
+.IP \[bu] 2
|
|
+Packing using a .nuspec
|
|
+.IP \[bu] 2
|
|
+Advanced extension points to create customized package
|
|
+.IP \[bu] 2
|
|
+Global properties
|
|
.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-publish.1 b/documentation/manpages/sdk/dotnet-publish.1
|
|
index 0781225951..d991731e50 100644
|
|
--- a/documentation/manpages/sdk/dotnet-publish.1
|
|
+++ b/documentation/manpages/sdk/dotnet-publish.1
|
|
@@ -1,42 +1,30 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet publish command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet publish
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet publish\f[R] - Packs the application and its dependencies into a folder for deployment to a hosting system.
|
|
+\f[C]dotnet publish\f[R] - Publishes the application and its dependencies to a folder for deployment to a hosting system.
|
|
.SH SYNOPSIS
|
|
-.SS .NET Core 2.1
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet publish [<PROJECT>] [-c|--configuration] [-f|--framework] [--force] [--manifest] [--no-build] [--no-dependencies]
|
|
- [--no-restore] [-o|--output] [-r|--runtime] [--self-contained] [-v|--verbosity] [--version-suffix]
|
|
-dotnet publish [-h|--help]
|
|
+dotnet publish [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
|
|
+ [-c|--configuration <CONFIGURATION>]
|
|
+ [-f|--framework <FRAMEWORK>] [--force] [--interactive]
|
|
+ [--manifest <PATH_TO_MANIFEST_FILE>] [--no-build] [--no-dependencies]
|
|
+ [--no-restore] [--nologo] [-o|--output <OUTPUT_DIRECTORY>]
|
|
+ [--os <OS>] [-r|--runtime <RUNTIME_IDENTIFIER>]
|
|
+ [--self-contained [true|false]]
|
|
+ [--no-self-contained] [-v|--verbosity <LEVEL>]
|
|
+ [--version-suffix <VERSION_SUFFIX>]
|
|
+
|
|
+dotnet publish -h|--help
|
|
\f[R]
|
|
.fi
|
|
-.SS .NET Core 2.0
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet publish [<PROJECT>] [-c|--configuration] [-f|--framework] [--force] [--manifest] [--no-dependencies]
|
|
- [--no-restore] [-o|--output] [-r|--runtime] [--self-contained] [-v|--verbosity] [--version-suffix]
|
|
-dotnet publish [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.SS .NET Core 1.x
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet publish [<PROJECT>] [-c|--configuration] [-f|--framework] [-o|--output] [-r|--runtime] [-v|--verbosity]
|
|
- [--version-suffix]
|
|
-dotnet publish [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.PP
|
|
- * * * * *
|
|
.SH DESCRIPTION
|
|
.PP
|
|
\f[C]dotnet publish\f[R] compiles the application, reads through its dependencies specified in the project file, and publishes the resulting set of files to a directory.
|
|
@@ -44,226 +32,367 @@ The output includes the following assets:
|
|
.IP \[bu] 2
|
|
Intermediate Language (IL) code in an assembly with a \f[I]dll\f[R] extension.
|
|
.IP \[bu] 2
|
|
-\f[I].deps.json\f[R] file that includes all of the dependencies of the project.
|
|
+A \f[I].deps.json\f[R] file that includes all of the dependencies of the project.
|
|
.IP \[bu] 2
|
|
-\f[I].runtimeconfig.json\f[R] file that specifies the shared runtime that the application expects, as well as other configuration options for the runtime (for example, garbage collection type).
|
|
+A \f[I].runtimeconfig.json\f[R] file that specifies the shared runtime that the application expects, as well as other configuration options for the runtime (for example, garbage collection type).
|
|
.IP \[bu] 2
|
|
The application\[cq]s dependencies, which are copied from the NuGet cache into the output folder.
|
|
.PP
|
|
The \f[C]dotnet publish\f[R] command\[cq]s output is ready for deployment to a hosting system (for example, a server, PC, Mac, laptop) for execution.
|
|
It\[cq]s the only officially supported way to prepare the application for deployment.
|
|
-Depending on the type of deployment that the project specifies, the hosting system may or may not have the .NET Core shared runtime installed on it.
|
|
-For more information, see .NET Core Application Deployment.
|
|
-For the directory structure of a published application, see Directory structure.
|
|
-.PP
|
|
-.SS Arguments
|
|
-.PP
|
|
-\f[C]PROJECT\f[R]
|
|
-.PP
|
|
-The project to publish.
|
|
-It\[cq]s either the path and filename of a C#, F#, or Visual Basic project file, or the path to a directory that contains a C#, F#, or Visual Basic project file.
|
|
-If not specified, it defaults to the current directory.
|
|
-.SH OPTIONS
|
|
-.SS .NET Core 2.1
|
|
-.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
-.PP
|
|
-Defines the build configuration.
|
|
-The default value is \f[C]Debug\f[R].
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
-.PP
|
|
-Publishes the application for the specified target framework.
|
|
-You must specify the target framework in the project file.
|
|
+Depending on the type of deployment that the project specifies, the hosting system may or may not have the .NET shared runtime installed on it.
|
|
+For more information, see Publish .NET apps with the .NET CLI.
|
|
+.SS Implicit restore
|
|
.PP
|
|
-\f[C]--force\f[R]
|
|
+You don\[cq]t have to run \f[C]dotnet restore\f[R] because it\[cq]s run implicitly by all commands that require a restore to occur, such as \f[C]dotnet new\f[R], \f[C]dotnet build\f[R], \f[C]dotnet run\f[R], \f[C]dotnet test\f[R], \f[C]dotnet publish\f[R], and \f[C]dotnet pack\f[R].
|
|
+To disable implicit restore, use the \f[C]--no-restore\f[R] option.
|
|
.PP
|
|
-Forces all dependencies to be resolved even if the last restore was successful.
|
|
-Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
|
|
+The \f[C]dotnet restore\f[R] command is still useful in certain scenarios where explicitly restoring makes sense, such as continuous integration builds in Azure DevOps Services or in build systems that need to explicitly control when the restore occurs.
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
+For information about how to manage NuGet feeds, see the \f[C]dotnet restore\f[R] documentation.
|
|
+.SS MSBuild
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+The \f[C]dotnet publish\f[R] command calls MSBuild, which invokes the \f[C]Publish\f[R] target.
|
|
+If the \f[C]IsPublishable\f[R] property is set to \f[C]false\f[R] for a particular project, the \f[C]Publish\f[R] target can\[cq]t be invoked, and the \f[C]dotnet publish\f[R] command only runs the implicit dotnet restore on the project.
|
|
.PP
|
|
-\f[C]--manifest <PATH_TO_MANIFEST_FILE>\f[R]
|
|
+Any parameters passed to \f[C]dotnet publish\f[R] are passed to MSBuild.
|
|
+The \f[C]-c\f[R] and \f[C]-o\f[R] parameters map to MSBuild\[cq]s \f[C]Configuration\f[R] and \f[C]PublishDir\f[R] properties, respectively.
|
|
.PP
|
|
-Specifies one or several target manifests to use to trim the set of packages published with the app.
|
|
-The manifest file is part of the output of the \f[C]dotnet store\f[R] command.
|
|
-To specify multiple manifests, add a \f[C]--manifest\f[R] option for each manifest.
|
|
-This option is available starting with .NET Core 2.0 SDK.
|
|
-.PP
|
|
-\f[C]--no-build\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t build the project before publishing.
|
|
-It also implicitly sets the \f[C]--no-restore\f[R] flag.
|
|
+The \f[C]dotnet publish\f[R] command accepts MSBuild options, such as \f[C]-p\f[R] for setting properties and \f[C]-l\f[R] to define a logger.
|
|
+For example, you can set an MSBuild property by using the format: \f[C]-p:<NAME>=<VALUE>\f[R].
|
|
.PP
|
|
-\f[C]--no-dependencies\f[R]
|
|
-.PP
|
|
-Ignores project-to-project references and only restores the root project.
|
|
+You can also set publish-related properties by referring to a \f[I].pubxml\f[R] file (available since .NET Core 3.1 SDK).
|
|
+For example:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet publish -p:PublishProfile=FolderProfile
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
-\f[C]--no-restore\f[R]
|
|
+The preceding example uses the \f[I]FolderProfile.pubxml\f[R] file that is found in the \f[I]<project_folder>/Properties/PublishProfiles\f[R] folder.
|
|
+If you specify a path and file extension when setting the \f[C]PublishProfile\f[R] property, they are ignored.
|
|
+MSBuild by default looks in the \f[I]Properties/PublishProfiles\f[R] folder and assumes the \f[I]pubxml\f[R] file extension.
|
|
+To specify the path and filename including extension, set the \f[C]PublishProfileFullPath\f[R] property instead of the \f[C]PublishProfile\f[R] property.
|
|
.PP
|
|
-Doesn\[cq]t execute an implicit restore when running the command.
|
|
+The following MSBuild properties change the output of \f[C]dotnet publish\f[R].
|
|
+.IP \[bu] 2
|
|
+\f[C]PublishReadyToRun\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
+Compiles application assemblies as ReadyToRun (R2R) format.
|
|
+R2R is a form of ahead-of-time (AOT) compilation.
|
|
+For more information, see ReadyToRun images.
|
|
+Available since .NET Core 3.0 SDK.
|
|
.PP
|
|
-Specifies the path for the output directory.
|
|
-If not specified, it defaults to \f[I]./bin/[configuration]/[framework]/publish/\f[R] for a framework-dependent deployment or \f[I]./bin/[configuration]/[framework]/[runtime]/publish/\f[R] for a self-contained deployment.
|
|
-If the path is relative, the output directory generated is relative to the project file location, not to the current working directory.
|
|
+To see warnings about missing dependencies that could cause runtime failures, use \f[C]PublishReadyToRunShowWarnings=true\f[R].
|
|
.PP
|
|
-\f[C]--self-contained\f[R]
|
|
+We recommend that you specify \f[C]PublishReadyToRun\f[R] in a publish profile rather than on the command line.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[C]PublishSingleFile\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Publishes the .NET Core runtime with your application so the runtime doesn\[cq]t need to be installed on the target machine.
|
|
-If a runtime identifier is specified, its default value is \f[C]true\f[R].
|
|
-For more information about the different deployment types, see .NET Core application deployment.
|
|
+Packages the app into a platform-specific single-file executable.
|
|
+For more information about single-file publishing, see the single-file bundler design document (https://github.com/dotnet/designs/blob/main/accepted/2020/single-file/design.md).
|
|
+Available since .NET Core 3.0 SDK.
|
|
.PP
|
|
-\f[C]-r|--runtime <RUNTIME_IDENTIFIER>\f[R]
|
|
+We recommend that you specify this option in the project file rather than on the command line.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[C]PublishTrimmed\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Publishes the application for a given runtime.
|
|
-This is used when creating a self-contained deployment (SCD).
|
|
-For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
-Default is to publish a framework-dependent deployment (FDD).
|
|
+Trims unused libraries to reduce the deployment size of an app when publishing a self-contained executable.
|
|
+For more information, see Trim self-contained deployments and executables.
|
|
+Available since .NET Core 3.0 SDK as a preview feature.
|
|
.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
+We recommend that you specify this option in the project file rather than on the command line.
|
|
+.RE
|
|
.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-.PP
|
|
-\f[C]--version-suffix <VERSION_SUFFIX>\f[R]
|
|
+For more information, see the following resources:
|
|
+.IP \[bu] 2
|
|
+MSBuild command-line reference
|
|
+.IP \[bu] 2
|
|
+Visual Studio publish profiles (.pubxml) for ASP.NET Core app deployment
|
|
+.IP \[bu] 2
|
|
+dotnet msbuild
|
|
+.SS Workload manifest downloads
|
|
.PP
|
|
-Defines the version suffix to replace the asterisk (\f[C]*\f[R]) in the version field of the project file.
|
|
-.SS .NET Core 2.0
|
|
+When you run this command, it initiates an asynchronous background download of advertising manifests for workloads.
|
|
+If the download is still running when this command finishes, the download is stopped.
|
|
+For more information, see Advertising manifests.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]PROJECT|SOLUTION\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
+The project or solution to publish.
|
|
+.IP \[bu] 2
|
|
+\f[C]PROJECT\f[R] is the path and filename of a C#, F#, or Visual Basic project file, or the path to a directory that contains a C#, F#, or Visual Basic project file.
|
|
+If the directory is not specified, it defaults to the current directory.
|
|
+.IP \[bu] 2
|
|
+\f[C]SOLUTION\f[R] is the path and filename of a solution file (\f[I].sln\f[R] extension), or the path to a directory that contains a solution file.
|
|
+If the directory is not specified, it defaults to the current directory.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-a|--arch <ARCHITECTURE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the target architecture.
|
|
+This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
|
|
+For example, on a \f[C]win-x64\f[R] machine, specifying \f[C]--arch x86\f[R] sets the RID to \f[C]win-x86\f[R].
|
|
+If you use this option, don\[cq]t use the \f[C]-r|--runtime\f[R] option.
|
|
+Available since .NET 6 Preview 7.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Defines the build configuration.
|
|
-The default value is \f[C]Debug\f[R].
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
+The default for most projects is \f[C]Debug\f[R], but you can override the build configuration settings in your project.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Publishes the application for the specified target framework.
|
|
You must specify the target framework in the project file.
|
|
-.PP
|
|
-\f[C]--force\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--force\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Forces all dependencies to be resolved even if the last restore was successful.
|
|
Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--manifest <PATH_TO_MANIFEST_FILE>\f[R]
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--manifest <PATH_TO_MANIFEST_FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies one or several target manifests to use to trim the set of packages published with the app.
|
|
The manifest file is part of the output of the \f[C]dotnet store\f[R] command.
|
|
To specify multiple manifests, add a \f[C]--manifest\f[R] option for each manifest.
|
|
-This option is available starting with .NET Core 2.0 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-build\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--no-dependencies\f[R]
|
|
+Doesn\[cq]t build the project before publishing.
|
|
+It also implicitly sets the \f[C]--no-restore\f[R] flag.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-dependencies\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Ignores project-to-project references and only restores the root project.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--nologo\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--no-restore\f[R]
|
|
+Doesn\[cq]t display the startup banner or the copyright message.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Doesn\[cq]t execute an implicit restore when running the command.
|
|
-.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-o|--output <OUTPUT_DIRECTORY>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies the path for the output directory.
|
|
-If not specified, it defaults to \f[I]./bin/[configuration]/[framework]/publish/\f[R] for a framework-dependent deployment or \f[I]./bin/[configuration]/[framework]/[runtime]/publish/\f[R] for a self-contained deployment.
|
|
-If the path is relative, the output directory generated is relative to the project file location, not to the current working directory.
|
|
-.PP
|
|
-\f[C]--self-contained\f[R]
|
|
-.PP
|
|
-Publishes the .NET Core runtime with your application so the runtime doesn\[cq]t need to be installed on the target machine.
|
|
-If a runtime identifier is specified, its default value is \f[C]true\f[R].
|
|
-For more information about the different deployment types, see .NET Core application deployment.
|
|
.PP
|
|
-\f[C]-r|--runtime <RUNTIME_IDENTIFIER>\f[R]
|
|
+If not specified, it defaults to \f[I][project_file_folder]/bin/[configuration]/[framework]/publish/\f[R] for a framework-dependent executable and cross-platform binaries.
|
|
+It defaults to \f[I][project_file_folder]/bin/[configuration]/[framework]/[runtime]/publish/\f[R] for a self-contained executable.
|
|
.PP
|
|
-Publishes the application for a given runtime.
|
|
-This is used when creating a self-contained deployment (SCD).
|
|
-For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
-Default is to publish a framework-dependent deployment (FDD).
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
-.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-.PP
|
|
-\f[C]--version-suffix <VERSION_SUFFIX>\f[R]
|
|
-.PP
|
|
-Defines the version suffix to replace the asterisk (\f[C]*\f[R]) in the version field of the project file.
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
-.PP
|
|
-Defines the build configuration.
|
|
-The default value is \f[C]Debug\f[R].
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
-.PP
|
|
-Publishes the application for the specified target framework.
|
|
-You must specify the target framework in the project file.
|
|
+In a web project, if the output folder is in the project folder, successive \f[C]dotnet publish\f[R] commands result in nested output folders.
|
|
+For example, if the project folder is \f[I]myproject\f[R], and the publish output folder is \f[I]myproject/publish\f[R], and you run \f[C]dotnet publish\f[R] twice, the second run puts content files such as \f[I].config\f[R] and \f[I].json\f[R] files in \f[I]myproject/publish/publish\f[R].
|
|
+To avoid nesting publish folders, specify a publish folder that is not \f[B]directly\f[R] under the project folder, or exclude the publish folder from the project.
|
|
+To exclude a publish folder named \f[I]publishoutput\f[R], add the following element to a \f[C]PropertyGroup\f[R] element in the \f[I].csproj\f[R] file:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+<DefaultItemExcludes>$(DefaultItemExcludes);publishoutput**</DefaultItemExcludes>
|
|
+\f[R]
|
|
+.fi
|
|
+.IP \[bu] 2
|
|
+\&.NET Core 3.x SDK and later
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
+If you specify a relative path when publishing a project, the generated output directory is relative to the current working directory, not to the project file location.
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+If you specify a relative path when publishing a solution, all output for all projects goes into the specified folder relative to the current working directory.
|
|
+To make publish output go to separate folders for each project, specify a relative path by using the msbuild \f[C]PublishDir\f[R] property instead of the \f[C]--output\f[R] option.
|
|
+For example, \f[C]dotnet publish -p:PublishDir=.\[rs]publish\f[R] sends publish output for each project to a \f[C]publish\f[R] folder under the folder that contains the project file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\&.NET Core 2.x SDK
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--manifest <PATH_TO_MANIFEST_FILE>\f[R]
|
|
+If you specify a relative path when publishing a project, the generated output directory is relative to the project file location, not to the current working directory.
|
|
.PP
|
|
-Specifies one or several target manifests to use to trim the set of packages published with the app.
|
|
-The manifest file is part of the output of the \f[C]dotnet store\f[R] command.
|
|
-To specify multiple manifests, add a \f[C]--manifest\f[R] option for each manifest.
|
|
-This option is available starting with .NET Core 2.0 SDK.
|
|
+If you specify a relative path when publishing a solution, each project\[cq]s output goes into a separate folder relative to the project file location.
|
|
+If you specify an absolute path when publishing a solution, all publish output for all projects goes into the specified folder.
|
|
+.RE
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--os <OS>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the target operating system (OS).
|
|
+This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
|
|
+For example, on a \f[C]win-x64\f[R] machine, specifying \f[C]--os os\f[R] sets the RID to \f[C]os-x64\f[R].
|
|
+If you use this option, don\[cq]t use the \f[C]-r|--runtime\f[R] option.
|
|
+Available since .NET 6 Preview 7.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--self-contained [true|false]\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
+Publishes the .NET runtime with your application so the runtime doesn\[cq]t need to be installed on the target machine.
|
|
+Default is \f[C]true\f[R] if a runtime identifier is specified and the project is an executable project (not a library project).
|
|
+For more information, see .NET application publishing and Publish .NET apps with the .NET CLI.
|
|
.PP
|
|
-Specifies the path for the output directory.
|
|
-If not specified, it defaults to \f[I]./bin/[configuration]/[framework]/publish/\f[R] for a framework-dependent deployment or \f[I]./bin/[configuration]/[framework]/[runtime]/publish/\f[R] for a self-contained deployment.
|
|
-If the path is relative, the output directory generated is relative to the project file location, not to the current working directory.
|
|
+If this option is used without specifying \f[C]true\f[R] or \f[C]false\f[R], the default is \f[C]true\f[R].
|
|
+In that case, don\[cq]t put the solution or project argument immediately after \f[C]--self-contained\f[R], because \f[C]true\f[R] or \f[C]false\f[R] is expected in that position.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-self-contained\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-r|--runtime <RUNTIME_IDENTIFIER>\f[R]
|
|
+Equivalent to \f[C]--self-contained false\f[R].
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-r|--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Publishes the application for a given runtime.
|
|
-This is used when creating a self-contained deployment (SCD).
|
|
For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
-Default is to publish a framework-dependent deployment (FDD).
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
+For more information, see .NET application publishing and Publish .NET apps with the .NET CLI.
|
|
+If you use this option, use \f[C]--self-contained\f[R] or \f[C]--no-self-contained\f[R] also.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Sets the verbosity level of the command.
|
|
Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-.PP
|
|
-\f[C]--version-suffix <VERSION_SUFFIX>\f[R]
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--version-suffix <VERSION_SUFFIX>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Defines the version suffix to replace the asterisk (\f[C]*\f[R]) in the version field of the project file.
|
|
-.PP
|
|
- * * * * *
|
|
+.RE
|
|
.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Create a framework-dependent cross-platform binary for the project in the current directory:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet publish
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
-Publish the project in the current directory:
|
|
-.PP
|
|
-\f[C]dotnet publish\f[R]
|
|
-.PP
|
|
-Publish the application using the specified project file:
|
|
-.PP
|
|
-\f[C]dotnet publish \[ti]/projects/app1/app1.csproj\f[R]
|
|
-.PP
|
|
-Publish the project in the current directory using the \f[C]netcoreapp1.1\f[R] framework:
|
|
-.PP
|
|
-\f[C]dotnet publish --framework netcoreapp1.1\f[R]
|
|
-.PP
|
|
-Publish the current application using the \f[C]netcoreapp1.1\f[R] framework and the runtime for \f[C]OS X 10.10\f[R] (you must list this RID in the project file).
|
|
-.PP
|
|
-\f[C]dotnet publish --framework netcoreapp1.1 --runtime osx.10.11-x64\f[R]
|
|
+Starting with .NET Core 3.0 SDK, this example also creates a framework-dependent executable for the current platform.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Create a self-contained executable for the project in the current directory, for a specific runtime:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet publish --runtime osx.10.11-x64
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
-Publish the current application but don\[cq]t restore project-to-project (P2P) references, just the root project during the restore operation (.NET Core SDK 2.0 and later versions):
|
|
+The RID must be in the project file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Create a framework-dependent executable for the project in the current directory, for a specific platform:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet publish --runtime osx.10.11-x64 --self-contained false
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
-\f[C]dotnet publish --no-dependencies\f[R]
|
|
+The RID must be in the project file.
|
|
+This example applies to .NET Core 3.0 SDK and later versions.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Publish the project in the current directory, for a specific runtime and target framework:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet publish --framework netcoreapp3.1 --runtime osx.10.11-x64
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Publish the specified project file:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet publish \[ti]/projects/app1/app1.csproj
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Publish the current application but don\[cq]t restore project-to-project (P2P) references, just the root project during the restore operation:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet publish --no-dependencies
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
.SS See also
|
|
.IP \[bu] 2
|
|
+\&.NET application publishing overview
|
|
+.IP \[bu] 2
|
|
+Publish .NET apps with the .NET CLI
|
|
+.IP \[bu] 2
|
|
Target frameworks
|
|
.IP \[bu] 2
|
|
-Runtime IDentifier (RID) catalog
|
|
+Runtime Identifier (RID) catalog
|
|
+.IP \[bu] 2
|
|
+Working with macOS Catalina Notarization
|
|
+.IP \[bu] 2
|
|
+Directory structure of a published application
|
|
+.IP \[bu] 2
|
|
+MSBuild command-line reference
|
|
+.IP \[bu] 2
|
|
+Visual Studio publish profiles (.pubxml) for ASP.NET Core app deployment
|
|
+.IP \[bu] 2
|
|
+dotnet msbuild
|
|
+.IP \[bu] 2
|
|
+ILLInk.Tasks
|
|
diff --git a/documentation/manpages/sdk/dotnet-remove-package.1 b/documentation/manpages/sdk/dotnet-remove-package.1
|
|
index 8e49cbc581..1fa6097ee9 100644
|
|
--- a/documentation/manpages/sdk/dotnet-remove-package.1
|
|
+++ b/documentation/manpages/sdk/dotnet-remove-package.1
|
|
@@ -1,15 +1,22 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet remove package command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet remove package
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet remove package\f[R] - Removes package reference from a project file.
|
|
.SH SYNOPSIS
|
|
-.PP
|
|
-\f[C]dotnet remove [<PROJECT>] package <PACKAGE_NAME> [-h|--help]\f[R]
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet remove [<PROJECT>] package <PACKAGE_NAME>
|
|
+
|
|
+dotnet remove package -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet remove package\f[R] command provides a convenient option to remove a NuGet package reference from a project.
|
|
@@ -24,12 +31,20 @@ If not specified, the command searches the current directory for one.
|
|
.PP
|
|
The package reference to remove.
|
|
.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
.SH EXAMPLES
|
|
-.PP
|
|
-Removes \f[C]Newtonsoft.Json\f[R] NuGet package from a project in the current directory:
|
|
-.PP
|
|
-\f[C]dotnet remove package Newtonsoft.Json\f[R]
|
|
+.IP \[bu] 2
|
|
+Remove \f[C]Newtonsoft.Json\f[R] NuGet package from a project in the current directory:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet remove package Newtonsoft.Json
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-remove-reference.1 b/documentation/manpages/sdk/dotnet-remove-reference.1
|
|
index 57a8c0cb17..f7b4688542 100644
|
|
--- a/documentation/manpages/sdk/dotnet-remove-reference.1
|
|
+++ b/documentation/manpages/sdk/dotnet-remove-reference.1
|
|
@@ -1,15 +1,23 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet remove reference command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet remove reference
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet remove reference\f[R] - Removes project-to-project references.
|
|
+\f[C]dotnet remove reference\f[R] - Removes project-to-project (P2P) references.
|
|
.SH SYNOPSIS
|
|
-.PP
|
|
-\f[C]dotnet remove [<PROJECT>] reference [-f|--framework] <PROJECT_REFERENCES> [-h|--help]\f[R]
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet remove [<PROJECT>] reference [-f|--framework <FRAMEWORK>]
|
|
+ <PROJECT_REFERENCES>
|
|
+
|
|
+dotnet remove reference -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet remove reference\f[R] command provides a convenient option to remove project references from a project.
|
|
@@ -24,26 +32,48 @@ If not specified, the command searches the current directory for one.
|
|
.PP
|
|
Project-to-project (P2P) references to remove.
|
|
You can specify one or multiple projects.
|
|
-Glob patterns are supported on Unix/Linux based terminals.
|
|
+Glob patterns (https://en.wikipedia.org/wiki/Glob_(programming)) are supported on Unix/Linux based terminals.
|
|
.SH OPTIONS
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
-.PP
|
|
-Removes the reference only when targeting a specific framework.
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Removes the reference only when targeting a specific framework using the TFM format.
|
|
+.RE
|
|
.SH EXAMPLES
|
|
-.PP
|
|
+.IP \[bu] 2
|
|
Remove a project reference from the specified project:
|
|
-.PP
|
|
-\f[C]dotnet remove app/app.csproj reference lib/lib.csproj\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet remove app/app.csproj reference lib/lib.csproj
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Remove multiple project references from the project in the current directory:
|
|
-.PP
|
|
-\f[C]dotnet remove reference lib1/lib1.csproj lib2/lib2.csproj\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet remove reference lib1/lib1.csproj lib2/lib2.csproj
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Remove multiple project references using a glob pattern on Unix/Linux:
|
|
-.PP
|
|
-\f[C]dotnet remove app/app.csproj reference **/*.csproj\f[R]
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet remove app/app.csproj reference **/*.csproj\[ga]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-restore.1 b/documentation/manpages/sdk/dotnet-restore.1
|
|
index ed895eb096..f40f4cd0ba 100644
|
|
--- a/documentation/manpages/sdk/dotnet-restore.1
|
|
+++ b/documentation/manpages/sdk/dotnet-restore.1
|
|
@@ -1,48 +1,70 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet restore command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet restore
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet restore\f[R] - Restores the dependencies and tools of a project.
|
|
.SH SYNOPSIS
|
|
-.SS .NET Core 2.x
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet restore [<ROOT>] [--configfile] [--disable-parallel] [--force] [--ignore-failed-sources] [--no-cache]
|
|
- [--no-dependencies] [--packages] [-r|--runtime] [-s|--source] [-v|--verbosity] [--interactive]
|
|
-dotnet restore [-h|--help]
|
|
+dotnet restore [<ROOT>] [--configfile <FILE>] [--disable-parallel]
|
|
+ [-f|--force] [--force-evaluate] [--ignore-failed-sources]
|
|
+ [--interactive] [--lock-file-path <LOCK_FILE_PATH>] [--locked-mode]
|
|
+ [--no-cache] [--no-dependencies] [--packages <PACKAGES_DIRECTORY>]
|
|
+ [-r|--runtime <RUNTIME_IDENTIFIER>] [-s|--source <SOURCE>]
|
|
+ [--use-lock-file] [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet restore -h|--help
|
|
\f[R]
|
|
.fi
|
|
-.SS .NET Core 1.x
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet restore [<ROOT>] [--configfile] [--disable-parallel] [--ignore-failed-sources] [--no-cache]
|
|
- [--no-dependencies] [--packages] [-r|--runtime] [-s|--source] [-v|--verbosity]
|
|
-dotnet restore [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.PP
|
|
- * * * * *
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet restore\f[R] command uses NuGet to restore dependencies as well as project-specific tools that are specified in the project file.
|
|
-By default, the restoration of dependencies and tools are executed in parallel.
|
|
+In most cases, you don\[cq]t need to explicitly use the \f[C]dotnet restore\f[R] command, since a NuGet restore is run implicitly if necessary when you run the following commands:
|
|
+.IP \[bu] 2
|
|
+\f[C]dotnet new\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[C]dotnet build\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[C]dotnet build-server\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[C]dotnet run\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[C]dotnet test\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[C]dotnet publish\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[C]dotnet pack\f[R]
|
|
.PP
|
|
+Sometimes, it might be inconvenient to run the implicit NuGet restore with these commands.
|
|
+For example, some automated systems, such as build systems, need to call \f[C]dotnet restore\f[R] explicitly to control when the restore occurs so that they can control network usage.
|
|
+To prevent the implicit NuGet restore, you can use the \f[C]--no-restore\f[R] flag with any of these commands to disable implicit restore.
|
|
+.SS Specify feeds
|
|
.PP
|
|
To restore the dependencies, NuGet needs the feeds where the packages are located.
|
|
Feeds are usually provided via the \f[I]nuget.config\f[R] configuration file.
|
|
-A default configuration file is provided when the CLI tools are installed.
|
|
-You specify additional feeds by creating your own \f[I]nuget.config\f[R] file in the project directory.
|
|
-You also specify additional feeds per invocation at a command prompt.
|
|
+A default configuration file is provided when the .NET SDK is installed.
|
|
+To specify additional feeds, do one of the following:
|
|
+.IP \[bu] 2
|
|
+Create your own \f[I]nuget.config\f[R] file in the project directory.
|
|
+For more information, see Common NuGet configurations and nuget.config differences later in this article.
|
|
+.IP \[bu] 2
|
|
+Use \f[C]dotnet nuget\f[R] commands such as \f[C]dotnet nuget add source\f[R].
|
|
+.PP
|
|
+You can override the \f[I]nuget.config\f[R] feeds with the \f[C]-s\f[R] option.
|
|
.PP
|
|
-For dependencies, you specify where the restored packages are placed during the restore operation using the \f[C]--packages\f[R] argument.
|
|
+For information about how to use authenticated feeds, see Consuming packages from authenticated feeds.
|
|
+.SS Global packages folder
|
|
+.PP
|
|
+For dependencies, you can specify where the restored packages are placed during the restore operation using the \f[C]--packages\f[R] argument.
|
|
If not specified, the default NuGet package cache is used, which is found in the \f[C].nuget/packages\f[R] directory in the user\[cq]s home directory on all operating systems.
|
|
-For example, \f[I]/home/user1\f[R] on Linux or \f[I]C:1\f[R] on Windows.
|
|
+For example, \f[I]/home/user1\f[R] on Linux or \f[I]C:\f[R] on Windows.
|
|
+.SS Project-specific tooling
|
|
.PP
|
|
For project-specific tooling, \f[C]dotnet restore\f[R] first restores the package in which the tool is packed, and then proceeds to restore the tool\[cq]s dependencies as specified in its project file.
|
|
.SS nuget.config differences
|
|
@@ -57,176 +79,192 @@ There are three specific settings that \f[C]dotnet restore\f[R] ignores:
|
|
bindingRedirects
|
|
.RS 2
|
|
.PP
|
|
-Binding redirects don\[cq]t work with \f[C]<PackageReference>\f[R] elements and .NET Core only supports \f[C]<PackageReference>\f[R] elements for NuGet packages.
|
|
+Binding redirects don\[cq]t work with \f[C]<PackageReference>\f[R] elements and .NET only supports \f[C]<PackageReference>\f[R] elements for NuGet packages.
|
|
.RE
|
|
.IP \[bu] 2
|
|
solution
|
|
.RS 2
|
|
.PP
|
|
-This setting is Visual Studio specific and doesn\[cq]t apply to .NET Core.
|
|
-\&.NET Core doesn\[cq]t use a \f[C]packages.config\f[R] file and instead uses \f[C]<PackageReference>\f[R] elements for NuGet packages.
|
|
+This setting is Visual Studio specific and doesn\[cq]t apply to .NET.
|
|
+\&.NET doesn\[cq]t use a \f[C]packages.config\f[R] file and instead uses \f[C]<PackageReference>\f[R] elements for NuGet packages.
|
|
.RE
|
|
.IP \[bu] 2
|
|
trustedSigners
|
|
.RS 2
|
|
.PP
|
|
-This setting isn\[cq]t applicable as NuGet doesn\[cq]t yet support cross-platform verification of trusted packages.
|
|
+Support for cross-platform package signature verification was added in the .NET 5.0.100 SDK.
|
|
.RE
|
|
-.SS Implicit \f[C]dotnet restore\f[R]
|
|
+.SS Workload manifest downloads
|
|
.PP
|
|
-Starting with .NET Core 2.0, \f[C]dotnet restore\f[R] is run implicitly if necessary when you issue the following commands:
|
|
-.IP \[bu] 2
|
|
-\f[C]dotnet new\f[R]
|
|
-.IP \[bu] 2
|
|
-\f[C]dotnet build\f[R]
|
|
-.IP \[bu] 2
|
|
-\f[C]dotnet build-server\f[R]
|
|
-.IP \[bu] 2
|
|
-\f[C]dotnet run\f[R]
|
|
-.IP \[bu] 2
|
|
-\f[C]dotnet test\f[R]
|
|
-.IP \[bu] 2
|
|
-\f[C]dotnet publish\f[R]
|
|
-.IP \[bu] 2
|
|
-\f[C]dotnet pack\f[R]
|
|
-.PP
|
|
-In most cases, you no longer need to explicitly use the \f[C]dotnet restore\f[R] command.
|
|
-.PP
|
|
-Sometimes, it might be inconvenient to run \f[C]dotnet restore\f[R] implicitly.
|
|
-For example, some automated systems, such as build systems, need to call \f[C]dotnet restore\f[R] explicitly to control when the restore occurs so that they can control network usage.
|
|
-To prevent \f[C]dotnet restore\f[R] from running implicitly, you can use the \f[C]--no-restore\f[R] flag with any of these commands to disable implicit restore.
|
|
+When you run this command, it initiates an asynchronous background download of advertising manifests for workloads.
|
|
+If the download is still running when this command finishes, the download is stopped.
|
|
+For more information, see Advertising manifests.
|
|
.SS Arguments
|
|
-.PP
|
|
-\f[C]ROOT\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]ROOT\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Optional path to the project file to restore.
|
|
+.RE
|
|
.SH OPTIONS
|
|
-.SS .NET Core 2.x
|
|
-.PP
|
|
-\f[C]--configfile <FILE>\f[R]
|
|
-.PP
|
|
-The NuGet configuration file (\f[I]nuget.config\f[R]) to use for the restore operation.
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--disable-parallel\f[R]
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--disable-parallel\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Disables restoring multiple projects in parallel.
|
|
-.PP
|
|
-\f[C]--force\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--force\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Forces all dependencies to be resolved even if the last restore was successful.
|
|
Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--force-evaluate\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
+Forces restore to reevaluate all dependencies even if a lock file already exists.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--ignore-failed-sources\f[R]
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ignore-failed-sources\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Only warn about failed sources if there are packages meeting the version requirement.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--no-cache\f[R]
|
|
-.PP
|
|
-Specifies to not cache packages and HTTP requests.
|
|
-.PP
|
|
-\f[C]--no-dependencies\f[R]
|
|
-.PP
|
|
-When restoring a project with project-to-project (P2P) references, restores the root project and not the references.
|
|
-.PP
|
|
-\f[C]--packages <PACKAGES_DIRECTORY>\f[R]
|
|
-.PP
|
|
-Specifies the directory for restored packages.
|
|
-.PP
|
|
-\f[C]-r|--runtime <RUNTIME_IDENTIFIER>\f[R]
|
|
-.PP
|
|
-Specifies a runtime for the package restore.
|
|
-This is used to restore packages for runtimes not explicitly listed in the \f[C]<RuntimeIdentifiers>\f[R] tag in the \f[I].csproj\f[R] file.
|
|
-For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
-Provide multiple RIDs by specifying this option multiple times.
|
|
-.PP
|
|
-\f[C]-s|--source <SOURCE>\f[R]
|
|
-.PP
|
|
-Specifies a NuGet package source to use during the restore operation.
|
|
-This setting overrides all of the sources specified in the \f[I]nuget.config\f[R] files.
|
|
-Multiple sources can be provided by specifying this option multiple times.
|
|
-.PP
|
|
-\f[C]--verbosity <LEVEL>\f[R]
|
|
-.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-Default value is \f[C]minimal\f[R].
|
|
-.PP
|
|
-\f[C]--interactive\f[R]
|
|
-.PP
|
|
-Allows the command to stop and wait for user input or action (for example to complete authentication).
|
|
-Since .NET Core 2.1.400.
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-\f[C]--configfile <FILE>\f[R]
|
|
-.PP
|
|
-The NuGet configuration file (\f[I]nuget.config\f[R]) to use for the restore operation.
|
|
-.PP
|
|
-\f[C]--disable-parallel\f[R]
|
|
-.PP
|
|
-Disables restoring multiple projects in parallel.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
-.PP
|
|
-\f[C]--ignore-failed-sources\f[R]
|
|
-.PP
|
|
-Only warn about failed sources if there are packages meeting the version requirement.
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--lock-file-path <LOCK_FILE_PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--no-cache\f[R]
|
|
+Output location where project lock file is written.
|
|
+By default, this is \f[I]PROJECT_ROOT.lock.json\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--locked-mode\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Specifies to not cache packages and HTTP requests.
|
|
+Don\[cq]t allow updating project lock file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-cache\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--no-dependencies\f[R]
|
|
+Specifies to not cache HTTP requests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-dependencies\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
When restoring a project with project-to-project (P2P) references, restores the root project and not the references.
|
|
-.PP
|
|
-\f[C]--packages <PACKAGES_DIRECTORY>\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--packages <PACKAGES_DIRECTORY>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies the directory for restored packages.
|
|
-.PP
|
|
-\f[C]-r|--runtime <RUNTIME_IDENTIFIER>\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-r|--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies a runtime for the package restore.
|
|
This is used to restore packages for runtimes not explicitly listed in the \f[C]<RuntimeIdentifiers>\f[R] tag in the \f[I].csproj\f[R] file.
|
|
For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
Provide multiple RIDs by specifying this option multiple times.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-s|--source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-s|--source <SOURCE>\f[R]
|
|
-.PP
|
|
-Specifies a NuGet package source to use during the restore operation.
|
|
-This overrides all of the sources specified in the \f[I]nuget.config\f[R] files, effectively reading the \f[I]nuget.config\f[R] file as if the \f[C]<packageSource>\f[R] element was not there.
|
|
+Specifies the URI of the NuGet package source to use during the restore operation.
|
|
+This setting overrides all of the sources specified in the \f[I]nuget.config\f[R] files.
|
|
Multiple sources can be provided by specifying this option multiple times.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--use-lock-file\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--verbosity <LEVEL>\f[R]
|
|
+Enables project lock file to be generated and used with restore.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Sets the verbosity level of the command.
|
|
Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
The default is \f[C]minimal\f[R].
|
|
-.PP
|
|
- * * * * *
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
.SH EXAMPLES
|
|
-.PP
|
|
+.IP \[bu] 2
|
|
Restore dependencies and tools for the project in the current directory:
|
|
-.PP
|
|
-\f[C]dotnet restore\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet restore
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Restore dependencies and tools for the \f[C]app1\f[R] project found in the given path:
|
|
-.PP
|
|
-\f[C]dotnet restore \[ti]/projects/app1/app1.csproj\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet restore ./projects/app1/app1.csproj
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Restore the dependencies and tools for the project in the current directory using the file path provided as the source:
|
|
-.PP
|
|
-\f[C]dotnet restore -s c:\[rs]packages\[rs]mypackages\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet restore -s c:\[rs]packages\[rs]mypackages
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Restore the dependencies and tools for the project in the current directory using the two file paths provided as sources:
|
|
-.PP
|
|
-\f[C]dotnet restore -s c:\[rs]packages\[rs]mypackages -s c:\[rs]packages\[rs]myotherpackages\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet restore -s c:\[rs]packages\[rs]mypackages -s c:\[rs]packages\[rs]myotherpackages
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Restore dependencies and tools for the project in the current directory showing detailed output:
|
|
-.PP
|
|
-\f[C]dotnet restore --verbosity detailed\f[R]
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet restore --verbosity detailed
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-run.1 b/documentation/manpages/sdk/dotnet-run.1
|
|
index 6a27c5b83c..f1a42117ae 100644
|
|
--- a/documentation/manpages/sdk/dotnet-run.1
|
|
+++ b/documentation/manpages/sdk/dotnet-run.1
|
|
@@ -1,57 +1,37 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet run command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet run
|
|
.PP
|
|
-\f[B]This article applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet run\f[R] - Runs source code without any explicit compile or launch commands.
|
|
.SH SYNOPSIS
|
|
-.SS .NET Core 3.0
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet run [-c|--configuration] [-f|--framework] [--force] [--interactive] [--launch-profile] [--no-build] [--no-dependencies]
|
|
- [--no-launch-profile] [--no-restore] [-p|--project] [-r|--runtime] [-v|--verbosity] [[--] [application arguments]]
|
|
-dotnet run [-h|--help]
|
|
+dotnet run [-a|--arch <ARCHITECTURE>] [-c|--configuration <CONFIGURATION>]
|
|
+ [-f|--framework <FRAMEWORK>] [--force] [--interactive]
|
|
+ [--launch-profile <NAME>] [--no-build]
|
|
+ [--no-dependencies] [--no-launch-profile] [--no-restore]
|
|
+ [--os <OS>] [--project <PATH>] [-r|--runtime <RUNTIME_IDENTIFIER>]
|
|
+ [-v|--verbosity <LEVEL>] [[--] [application arguments]]
|
|
+
|
|
+dotnet run -h|--help
|
|
\f[R]
|
|
.fi
|
|
-.SS .NET Core 2.1
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet run [-c|--configuration] [-f|--framework] [--force] [--launch-profile] [--no-build] [--no-dependencies]
|
|
- [--no-launch-profile] [--no-restore] [-p|--project] [--runtime] [-v|--verbosity] [[--] [application arguments]]
|
|
-dotnet run [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.SS .NET Core 2.0
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet run [-c|--configuration] [-f|--framework] [--force] [--launch-profile] [--no-build] [--no-dependencies]
|
|
- [--no-launch-profile] [--no-restore] [-p|--project] [--runtime] [[--] [application arguments]]
|
|
-dotnet run [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.SS .NET Core 1.x
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet run [-c|--configuration] [-f|--framework] [-p|--project] [[--] [application arguments]]
|
|
-dotnet run [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.PP
|
|
- * * * * *
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet run\f[R] command provides a convenient option to run your application from the source code with one command.
|
|
It\[cq]s useful for fast iterative development from the command line.
|
|
The command depends on the \f[C]dotnet build\f[R] command to build the code.
|
|
Any requirements for the build, such as that the project must be restored first, apply to \f[C]dotnet run\f[R] as well.
|
|
+.RS
|
|
+.PP
|
|
+[!NOTE] \f[C]dotnet run\f[R] doesn\[cq]t respect arguments like \f[C]/property:property=value\f[R], which are respected by \f[C]dotnet build\f[R].
|
|
+.RE
|
|
.PP
|
|
Output files are written into the default location, which is \f[C]bin/<configuration>/<target>\f[R].
|
|
For example if you have a \f[C]netcoreapp2.1\f[R] application and you run \f[C]dotnet run\f[R], the output is placed in \f[C]bin/Debug/netcoreapp2.1\f[R].
|
|
@@ -70,248 +50,227 @@ dotnet myapp.dll
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
-For more information on the \f[C]dotnet\f[R] driver, see the .NET Core Command Line Tools (CLI) topic.
|
|
+For more information on the \f[C]dotnet\f[R] driver, see the .NET Command Line Tools (CLI) topic.
|
|
.PP
|
|
To run the application, the \f[C]dotnet run\f[R] command resolves the dependencies of the application that are outside of the shared runtime from the NuGet cache.
|
|
Because it uses cached dependencies, it\[cq]s not recommended to use \f[C]dotnet run\f[R] to run applications in production.
|
|
Instead, create a deployment using the \f[C]dotnet publish\f[R] command and deploy the published output.
|
|
+.SS Implicit restore
|
|
.PP
|
|
-.SH OPTIONS
|
|
-.SS .NET Core 3.0
|
|
-.PP
|
|
-\f[C]--\f[R]
|
|
-.PP
|
|
-Delimits arguments to \f[C]dotnet run\f[R] from arguments for the application being run.
|
|
-All arguments after this delimiter are passed to the application run.
|
|
-.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
-.PP
|
|
-Defines the build configuration.
|
|
-The default value for most projects is \f[C]Debug\f[R].
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
-.PP
|
|
-Builds and runs the app using the specified framework.
|
|
-The framework must be specified in the project file.
|
|
-.PP
|
|
-\f[C]--force\f[R]
|
|
-.PP
|
|
-Forces all dependencies to be resolved even if the last restore was successful.
|
|
-Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
-.PP
|
|
-\f[C]--interactive\f[R]
|
|
-.PP
|
|
-Allows the command to stop and wait for user input or action (for example, to complete authentication).
|
|
-.PP
|
|
-\f[C]--launch-profile <NAME>\f[R]
|
|
-.PP
|
|
-The name of the launch profile (if any) to use when launching the application.
|
|
-Launch profiles are defined in the \f[I]launchSettings.json\f[R] file and are typically called \f[C]Development\f[R], \f[C]Staging\f[R], and \f[C]Production\f[R].
|
|
-For more information, see Working with multiple environments.
|
|
-.PP
|
|
-\f[C]--no-build\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t build the project before running.
|
|
-It also implicit sets the \f[C]--no-restore\f[R] flag.
|
|
-.PP
|
|
-\f[C]--no-dependencies\f[R]
|
|
-.PP
|
|
-When restoring a project with project-to-project (P2P) references, restores the root project and not the references.
|
|
-.PP
|
|
-\f[C]--no-launch-profile\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t try to use \f[I]launchSettings.json\f[R] to configure the application.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t execute an implicit restore when running the command.
|
|
-.PP
|
|
-\f[C]-p|--project <PATH>\f[R]
|
|
+You don\[cq]t have to run \f[C]dotnet restore\f[R] because it\[cq]s run implicitly by all commands that require a restore to occur, such as \f[C]dotnet new\f[R], \f[C]dotnet build\f[R], \f[C]dotnet run\f[R], \f[C]dotnet test\f[R], \f[C]dotnet publish\f[R], and \f[C]dotnet pack\f[R].
|
|
+To disable implicit restore, use the \f[C]--no-restore\f[R] option.
|
|
.PP
|
|
-Specifies the path of the project file to run (folder name or full path).
|
|
-If not specified, it defaults to the current directory.
|
|
-.PP
|
|
-\f[C]--runtime <RUNTIME_IDENTIFIER>\f[R]
|
|
-.PP
|
|
-Specifies the target runtime to restore packages for.
|
|
-For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
+The \f[C]dotnet restore\f[R] command is still useful in certain scenarios where explicitly restoring makes sense, such as continuous integration builds in Azure DevOps Services or in build systems that need to explicitly control when the restore occurs.
|
|
.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
+For information about how to manage NuGet feeds, see the \f[C]dotnet restore\f[R] documentation.
|
|
.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-.SS .NET Core 2.1
|
|
+This command supports the \f[C]dotnet restore\f[R] options when passed in the long form (for example, \f[C]--source\f[R]).
|
|
+Short form options, such as \f[C]-s\f[R], are not supported.
|
|
+.SS Workload manifest downloads
|
|
.PP
|
|
-\f[C]--\f[R]
|
|
+When you run this command, it initiates an asynchronous background download of advertising manifests for workloads.
|
|
+If the download is still running when this command finishes, the download is stopped.
|
|
+For more information, see Advertising manifests.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Delimits arguments to \f[C]dotnet run\f[R] from arguments for the application being run.
|
|
All arguments after this delimiter are passed to the application run.
|
|
-.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-a|--arch <ARCHITECTURE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the target architecture.
|
|
+This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
|
|
+For example, on a \f[C]win-x64\f[R] machine, specifying \f[C]--arch x86\f[R] sets the RID to \f[C]win-x86\f[R].
|
|
+If you use this option, don\[cq]t use the \f[C]-r|--runtime\f[R] option.
|
|
+Available since .NET 6 Preview 7.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Defines the build configuration.
|
|
-The default value for most projects is \f[C]Debug\f[R].
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
+The default for most projects is \f[C]Debug\f[R], but you can override the build configuration settings in your project.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Builds and runs the app using the specified framework.
|
|
The framework must be specified in the project file.
|
|
-.PP
|
|
-\f[C]--force\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--force\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Forces all dependencies to be resolved even if the last restore was successful.
|
|
Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--launch-profile <NAME>\f[R]
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--launch-profile <NAME>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
The name of the launch profile (if any) to use when launching the application.
|
|
Launch profiles are defined in the \f[I]launchSettings.json\f[R] file and are typically called \f[C]Development\f[R], \f[C]Staging\f[R], and \f[C]Production\f[R].
|
|
For more information, see Working with multiple environments.
|
|
-.PP
|
|
-\f[C]--no-build\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-build\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Doesn\[cq]t build the project before running.
|
|
It also implicit sets the \f[C]--no-restore\f[R] flag.
|
|
-.PP
|
|
-\f[C]--no-dependencies\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-dependencies\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
When restoring a project with project-to-project (P2P) references, restores the root project and not the references.
|
|
-.PP
|
|
-\f[C]--no-launch-profile\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-launch-profile\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Doesn\[cq]t try to use \f[I]launchSettings.json\f[R] to configure the application.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Doesn\[cq]t execute an implicit restore when running the command.
|
|
-.PP
|
|
-\f[C]-p|--project <PATH>\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--os <OS>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the target operating system (OS).
|
|
+This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
|
|
+For example, on a \f[C]win-x64\f[R] machine, specifying \f[C]--os os\f[R] sets the RID to \f[C]os-x64\f[R].
|
|
+If you use this option, don\[cq]t use the \f[C]-r|--runtime\f[R] option.
|
|
+Available since .NET 6 Preview 7.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--project <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies the path of the project file to run (folder name or full path).
|
|
If not specified, it defaults to the current directory.
|
|
.PP
|
|
-\f[C]--runtime <RUNTIME_IDENTIFIER>\f[R]
|
|
-.PP
|
|
-Specifies the target runtime to restore packages for.
|
|
-For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
-.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-.SS .NET Core 2.0
|
|
-.PP
|
|
-\f[C]--\f[R]
|
|
-.PP
|
|
-Delimits arguments to \f[C]dotnet run\f[R] from arguments for the application being run.
|
|
-All arguments after this delimiter are passed to the application run.
|
|
-.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
-.PP
|
|
-Defines the build configuration.
|
|
-The default for most projects value is \f[C]Debug\f[R].
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
-.PP
|
|
-Builds and runs the app using the specified framework.
|
|
-The framework must be specified in the project file.
|
|
-.PP
|
|
-\f[C]--force\f[R]
|
|
-.PP
|
|
-Forces all dependencies to be resolved even if the last restore was successful.
|
|
-Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
-.PP
|
|
-\f[C]--launch-profile <NAME>\f[R]
|
|
-.PP
|
|
-The name of the launch profile (if any) to use when launching the application.
|
|
-Launch profiles are defined in the \f[I]launchSettings.json\f[R] file and are typically called \f[C]Development\f[R], \f[C]Staging\f[R], and \f[C]Production\f[R].
|
|
-For more information, see Working with multiple environments.
|
|
-.PP
|
|
-\f[C]--no-build\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t build the project before running.
|
|
-It also implicit sets the \f[C]--no-restore\f[R] flag.
|
|
-.PP
|
|
-\f[C]--no-dependencies\f[R]
|
|
-.PP
|
|
-When restoring a project with project-to-project (P2P) references, restores the root project and not the references.
|
|
-.PP
|
|
-\f[C]--no-launch-profile\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t try to use \f[I]launchSettings.json\f[R] to configure the application.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t execute an implicit restore when running the command.
|
|
+The \f[C]-p\f[R] abbreviation for \f[C]--project\f[R] is deprecated starting in .NET 6 Preview SDK.
|
|
+For a limited time starting in .NET 6 RC1 SDK, \f[C]-p\f[R] can still be used for \f[C]--project\f[R] despite the deprecation warning.
|
|
+If the argument provided for the option doesn\[cq]t contain \f[C]=\f[R], the command accepts \f[C]-p\f[R] as short for \f[C]--project\f[R].
|
|
+Otherwise, the command assumes that \f[C]-p\f[R] is short for \f[C]--property\f[R].
|
|
+This flexible use of \f[C]-p\f[R] for \f[C]--project\f[R] will be phased out in .NET 7.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--property:<NAME>=<VALUE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-p|--project <PATH>\f[R]
|
|
+Sets one or more MSBuild properties.
|
|
+Specify multiple properties delimited by semicolons or by repeating the option:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+--property:<NAME1>=<VALUE1>;<NAME2>=<VALUE2>
|
|
+--property:<NAME1>=<VALUE1> --property:<NAME2>=<VALUE2>
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
-Specifies the path of the project file to run (folder name or full path).
|
|
-If not specified, it defaults to the current directory.
|
|
+The short form \f[C]-p\f[R] can be used for \f[C]--property\f[R].
|
|
+If the argument provided for the option contains \f[C]=\f[R], \f[C]-p\f[R] is accepted as short for \f[C]--property\f[R].
|
|
+Otherwise, the command assumes that \f[C]-p\f[R] is short for \f[C]--project\f[R].
|
|
.PP
|
|
-\f[C]--runtime <RUNTIME_IDENTIFIER>\f[R]
|
|
+To pass \f[C]--property\f[R] to the application rather than set an MSBuild property, provide the option after the \f[C]--\f[R] syntax separator, for example:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet run -- --property name=value
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-r|--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies the target runtime to restore packages for.
|
|
For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-\f[C]--\f[R]
|
|
-.PP
|
|
-Delimits arguments to \f[C]dotnet run\f[R] from arguments for the application being run.
|
|
-All arguments after this delimiter are passed to the application run.
|
|
-.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
-.PP
|
|
-Defines the build configuration.
|
|
-The default value for most projects is \f[C]Debug\f[R].
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
-.PP
|
|
-Builds and runs the app using the specified framework.
|
|
-The framework must be specified in the project file.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
-.PP
|
|
-\f[C]-p|--project <PATH/PROJECT.csproj>\f[R]
|
|
-.PP
|
|
-Specifies the path and name of the project file.
|
|
-(See the NOTE.) If not specified, it defaults to the current directory.
|
|
-.RS
|
|
-.PP
|
|
-[!NOTE] Use the path and name of the project file with the \f[C]-p|--project\f[R] option.
|
|
-A regression in the CLI prevents providing a folder path with .NET Core SDK 1.x.
|
|
-For more information about this issue, see dotnet run -p, can not start a project (dotnet/cli #5992).
|
|
+\f[C]-r\f[R] short option available since .NET Core 3.0 SDK.
|
|
.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
- * * * * *
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
.SH EXAMPLES
|
|
-.PP
|
|
+.IP \[bu] 2
|
|
Run the project in the current directory:
|
|
-.PP
|
|
-\f[C]dotnet run\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet run
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Run the specified project:
|
|
-.PP
|
|
-\f[C]dotnet run --project ./projects/proj1/proj1.csproj\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet run --project ./projects/proj1/proj1.csproj
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Run the project in the current directory, specifying Release configuration:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet run --property:Configuration=Release
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Run the project in the current directory (the \f[C]--help\f[R] argument in this example is passed to the application, since the blank \f[C]--\f[R] option is used):
|
|
-.PP
|
|
-\f[C]dotnet run --configuration Release -- --help\f[R]
|
|
-.PP
|
|
-Restore dependencies and tools for the project in the current directory only showing minimal output and then run the project: (.NET Core SDK 2.0 and later versions):
|
|
-.PP
|
|
-\f[C]dotnet run --verbosity m\f[R]
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet run --configuration Release -- --help
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Restore dependencies and tools for the project in the current directory only showing minimal output and then run the project:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet run --verbosity m
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-sdk-check.1 b/documentation/manpages/sdk/dotnet-sdk-check.1
|
|
new file mode 100644
|
|
index 0000000000..b1371b2804
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-sdk-check.1
|
|
@@ -0,0 +1,76 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet sdk check
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 (preview) and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet sdk check\f[R] - Lists the latest available version of the .NET SDK and .NET Runtime, for each feature band.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet sdk check
|
|
+
|
|
+dotnet sdk check -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet sdk check\f[R] command makes it easier to track when new versions of the SDK and Runtimes are available.
|
|
+Within each feature band it tells you:
|
|
+.IP \[bu] 2
|
|
+The latest available version of the .NET SDK and .NET Runtime.
|
|
+.IP \[bu] 2
|
|
+Whether your installed versions are up-to-date or out of support.
|
|
+.PP
|
|
+Here\[cq]s an example of output from the command:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+\&.NET SDKs:
|
|
+Version Status
|
|
+-----------------------------------------------------------
|
|
+2.1.816 Up to date.
|
|
+2.2.401 .NET 2.2 is out of support.
|
|
+3.1.410 Up to date.
|
|
+5.0.204 Up to date.
|
|
+5.0.301 Up to date.
|
|
+
|
|
+\&.NET Runtimes:
|
|
+Name Version Status
|
|
+-------------------------------------------------------------------------------------------
|
|
+Microsoft.AspNetCore.All 2.1.28 Up to date.
|
|
+Microsoft.AspNetCore.App 2.1.28 Up to date.
|
|
+Microsoft.NETCore.App 2.1.28 Up to date.
|
|
+Microsoft.AspNetCore.All 2.2.6 .NET 2.2 is out of support.
|
|
+Microsoft.AspNetCore.App 2.2.6 .NET 2.2 is out of support.
|
|
+Microsoft.NETCore.App 2.2.6 .NET 2.2 is out of support.
|
|
+Microsoft.AspNetCore.App 3.1.16 Up to date.
|
|
+Microsoft.NETCore.App 3.1.16 Up to date.
|
|
+Microsoft.WindowsDesktop.App 3.1.16 Up to date.
|
|
+Microsoft.AspNetCore.App 5.0.7 Up to date.
|
|
+Microsoft.NETCore.App 5.0.7 Up to date.
|
|
+Microsoft.WindowsDesktop.App 5.0.7 Up to date.
|
|
+\f[R]
|
|
+.fi
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Show up-to-date status of installed .NET SDKs and .NET Runtimes.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet sdk check
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-sln.1 b/documentation/manpages/sdk/dotnet-sln.1
|
|
index 43479d67a9..72e4fafacf 100644
|
|
--- a/documentation/manpages/sdk/dotnet-sln.1
|
|
+++ b/documentation/manpages/sdk/dotnet-sln.1
|
|
@@ -1,26 +1,28 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet sln command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet sln
|
|
.PP
|
|
-\f[B]This article applies to: \[OK]\f[R] .NET Core 1.x SDK and later versions
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet sln\f[R] - Modifies a .NET Core solution file.
|
|
+\f[C]dotnet sln\f[R] - Lists or modifies the projects in a .NET solution file.
|
|
.SH SYNOPSIS
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet sln [<SOLUTION_FILE>] [command] [-h|--help]
|
|
+dotnet sln [<SOLUTION_FILE>] [command]
|
|
+
|
|
+dotnet sln [command] -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet sln\f[R] command provides a convenient way to add, remove, and list projects in a solution file.
|
|
+The \f[C]dotnet sln\f[R] command provides a convenient way to list and modify projects in a solution file.
|
|
.PP
|
|
To use the \f[C]dotnet sln\f[R] command, the solution file must already exist.
|
|
-If you need to create one, use the dotnet new command, like in the following example:
|
|
+If you need to create one, use the dotnet new command, as in the following example:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
@@ -33,25 +35,51 @@ dotnet new sln
|
|
.RS 2
|
|
.PP
|
|
The solution file to use.
|
|
-If not specified, the command searches the current directory for one.
|
|
-If there are multiple solution files in the directory, one must be specified.
|
|
+If this argument is omitted, the command searches the current directory for one.
|
|
+If it finds no solution file or multiple solution files, the command fails.
|
|
.RE
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.SS Commands
|
|
+.SS \f[C]list\f[R]
|
|
+.PP
|
|
+Lists all projects in a solution file.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet sln list [-h|--help]
|
|
+\f[R]
|
|
+.fi
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]SOLUTION_FILE\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The solution file to use.
|
|
+If this argument is omitted, the command searches the current directory for one.
|
|
+If it finds no solution file or multiple solution files, the command fails.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
.SS \f[C]add\f[R]
|
|
.PP
|
|
-Adds a project or multiple projects to the solution file.
|
|
+Adds one or more projects to the solution file.
|
|
.SH SYNOPSIS
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet sln [<SOLUTION_FILE>] add [--in-root] [-s|--solution-folder] <PROJECT_PATH>
|
|
+dotnet sln [<SOLUTION_FILE>] add [--in-root] [-s|--solution-folder <PATH>] <PROJECT_PATH> [<PROJECT_PATH>...]
|
|
dotnet sln add [-h|--help]
|
|
\f[R]
|
|
.fi
|
|
@@ -61,36 +89,49 @@ dotnet sln add [-h|--help]
|
|
.RS 2
|
|
.PP
|
|
The solution file to use.
|
|
-If not specified, the command searches the current directory for one.
|
|
-If there are multiple solution files in the directory, one must be specified.
|
|
+If it is unspecified, the command searches the current directory for one and fails if there are multiple solution files.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]PROJECT_PATH\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-The path to the project to add to the solution.
|
|
-Add multiple projects by adding one after the other separated by spaces.
|
|
-Unix/Linux shell globbing pattern expansions are processed correctly by the \f[C]dotnet sln\f[R] command.
|
|
+The path to the project or projects to add to the solution.
|
|
+Unix/Linux shell globbing pattern (https://en.wikipedia.org/wiki/Glob_(programming)) expansions are processed correctly by the \f[C]dotnet sln\f[R] command.
|
|
+.PP
|
|
+If \f[C]PROJECT_PATH\f[R] includes folders that contain the project folder, that portion of the path is used to create solution folders.
|
|
+For example, the following commands create a solution with \f[C]myapp\f[R] in solution folder \f[C]folder1/folder2\f[R]:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new sln
|
|
+dotnet new console --output folder1/folder2/myapp
|
|
+dotnet sln add folder1/folder2/myapp
|
|
+\f[R]
|
|
+.fi
|
|
+.PP
|
|
+You can override this default behavior by using the \f[C]--in-root\f[R] or the \f[C]-s|--solution-folder <PATH>\f[R] option.
|
|
.RE
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]--in-root\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
Places the projects in the root of the solution, rather than creating a solution folder.
|
|
+Can\[cq]t be used with \f[C]-s|--solution-folder\f[R].
|
|
Available since .NET Core 3.0 SDK.
|
|
.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-s|--solution-folder\f[B]\f[R]
|
|
+\f[B]\f[CB]-s|--solution-folder <PATH>\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
The destination solution folder path to add the projects to.
|
|
+Can\[cq]t be used with \f[C]--in-root\f[R].
|
|
Available since .NET Core 3.0 SDK.
|
|
.RE
|
|
.SS \f[C]remove\f[R]
|
|
@@ -100,7 +141,7 @@ Removes a project or multiple projects from the solution file.
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet sln [<SOLUTION_FILE>] remove <PROJECT_PATH>
|
|
+dotnet sln [<SOLUTION_FILE>] remove <PROJECT_PATH> [<PROJECT_PATH>...]
|
|
dotnet sln [<SOLUTION_FILE>] remove [-h|--help]
|
|
\f[R]
|
|
.fi
|
|
@@ -110,96 +151,144 @@ dotnet sln [<SOLUTION_FILE>] remove [-h|--help]
|
|
.RS 2
|
|
.PP
|
|
The solution file to use.
|
|
-If not specified, the command searches the current directory for one.
|
|
-If there are multiple solution files in the directory, one must be specified.
|
|
+If is left unspecified, the command searches the current directory for one and fails if there are multiple solution files.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]\f[CB]PROJECT_PATH\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-The path to the project to remove from the solution.
|
|
-Remove multiple projects by adding one after the other separated by spaces.
|
|
-Unix/Linux shell globbing pattern expansions are processed correctly by the \f[C]dotnet sln\f[R] command.
|
|
+The path to the project or projects to remove from the solution.
|
|
+Unix/Linux shell globbing pattern (https://en.wikipedia.org/wiki/Glob_(programming)) expansions are processed correctly by the \f[C]dotnet sln\f[R] command.
|
|
.RE
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
.RE
|
|
-.SS \f[C]list\f[R]
|
|
-.PP
|
|
-Lists all projects in a solution file.
|
|
-.SH SYNOPSIS
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+List the projects in a solution:
|
|
+.RS 2
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet sln list [-h|--help]
|
|
+dotnet sln todo.sln list
|
|
\f[R]
|
|
.fi
|
|
-.SS Arguments
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]SOLUTION_FILE\f[B]\f[R]
|
|
+Add a C# project to a solution:
|
|
.RS 2
|
|
-.PP
|
|
-The solution file to use.
|
|
-If not specified, the command searches the current directory for one.
|
|
-If there are multiple solution files in the directory, one must be specified.
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet sln add todo-app/todo-app.csproj
|
|
+\f[R]
|
|
+.fi
|
|
.RE
|
|
-.SH OPTIONS
|
|
.IP \[bu] 2
|
|
-\f[B]\f[CB]-h|--help\f[B]\f[R]
|
|
+Remove a C# project from a solution:
|
|
.RS 2
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
-.RE
|
|
-.SH EXAMPLES
|
|
-.PP
|
|
-Add a C# project to a solution:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet sln todo.sln add todo-app/todo-app.csproj
|
|
+dotnet sln remove todo-app/todo-app.csproj
|
|
\f[R]
|
|
.fi
|
|
-.PP
|
|
-Remove a C# project from a solution:
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Add multiple C# projects to the root of a solution:
|
|
+.RS 2
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet sln todo.sln remove todo-app/todo-app.csproj
|
|
+dotnet sln todo.sln add todo-app/todo-app.csproj back-end/back-end.csproj --in-root
|
|
\f[R]
|
|
.fi
|
|
-.PP
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Add multiple C# projects to a solution:
|
|
+.RS 2
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
dotnet sln todo.sln add todo-app/todo-app.csproj back-end/back-end.csproj
|
|
\f[R]
|
|
.fi
|
|
-.PP
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Remove multiple C# projects from a solution:
|
|
+.RS 2
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
dotnet sln todo.sln remove todo-app/todo-app.csproj back-end/back-end.csproj
|
|
\f[R]
|
|
.fi
|
|
-.PP
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Add multiple C# projects to a solution using a globbing pattern (Unix/Linux only):
|
|
+.RS 2
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
dotnet sln todo.sln add **/*.csproj
|
|
\f[R]
|
|
.fi
|
|
-.PP
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Add multiple C# projects to a solution using a globbing pattern (Windows PowerShell only):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet sln todo.sln add (ls -r **/*.csproj)
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Remove multiple C# projects from a solution using a globbing pattern (Unix/Linux only):
|
|
+.RS 2
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
dotnet sln todo.sln remove **/*.csproj
|
|
\f[R]
|
|
.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Remove multiple C# projects from a solution using a globbing pattern (Windows PowerShell only):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet sln todo.sln remove (ls -r **/*.csproj)
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Create a solution, a console app, and two class libraries.
|
|
+Add the projects to the solution, and use the \f[C]--solution-folder\f[R] option of \f[C]dotnet sln\f[R] to organize the class libraries into a solution folder.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new sln -n mysolution
|
|
+dotnet new console -o myapp
|
|
+dotnet new classlib -o mylib1
|
|
+dotnet new classlib -o mylib2
|
|
+dotnet sln mysolution.sln add myapp\[rs]myapp.csproj
|
|
+dotnet sln mysolution.sln add mylib1\[rs]mylib1.csproj --solution-folder mylibs
|
|
+dotnet sln mysolution.sln add mylib2\[rs]mylib2.csproj --solution-folder mylibs
|
|
+\f[R]
|
|
+.fi
|
|
+.PP
|
|
+The following screenshot shows the result in Visual Studio 2019 \f[B]Solution Explorer\f[R]:
|
|
+.PP
|
|
+:::image type=\[lq]content\[rq] source=\[lq]media/dotnet-sln/dotnet-sln-solution-folder.png\[rq] alt-text=\[lq]Solution Explorer showing class library projects grouped into a solution folder.\[rq]:::
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+dotnet/sdk GitHub repo (https://github.com/dotnet/sdk) (.NET CLI source)
|
|
diff --git a/documentation/manpages/sdk/dotnet-store.1 b/documentation/manpages/sdk/dotnet-store.1
|
|
index fae60ac05c..896ce7573d 100644
|
|
--- a/documentation/manpages/sdk/dotnet-store.1
|
|
+++ b/documentation/manpages/sdk/dotnet-store.1
|
|
@@ -1,82 +1,125 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet store command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet store
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet store\f[R] - Stores the specified assemblies in the runtime package store.
|
|
.SH SYNOPSIS
|
|
-.PP
|
|
-\f[C]dotnet store -m|--manifest -f|--framework -r|--runtime [--framework-version] [-h|--help] [--output] [--skip-optimization] [--skip-symbols] [-v|--verbosity] [--working-dir]\f[R]
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet store -m|--manifest <PATH_TO_MANIFEST_FILE>
|
|
+ -f|--framework <FRAMEWORK_VERSION> -r|--runtime <RUNTIME_IDENTIFIER>
|
|
+ [--framework-version <FRAMEWORK_VERSION>] [--output <OUTPUT_DIRECTORY>]
|
|
+ [--skip-optimization] [--skip-symbols] [-v|--verbosity <LEVEL>]
|
|
+ [--working-dir <WORKING_DIRECTORY>]
|
|
+
|
|
+dotnet store -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
\f[C]dotnet store\f[R] stores the specified assemblies in the runtime package store.
|
|
By default, assemblies are optimized for the target runtime and framework.
|
|
For more information, see the runtime package store topic.
|
|
.SS Required options
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies the target framework.
|
|
-.PP
|
|
-\f[C]-m|--manifest <PATH_TO_MANIFEST_FILE>\f[R]
|
|
+The target framework has to be specified in the project file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-m|--manifest <PATH_TO_MANIFEST_FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
The \f[I]package store manifest file\f[R] is an XML file that contains the list of packages to store.
|
|
The format of the manifest file is compatible with the SDK-style project format.
|
|
So, a project file that references the desired packages can be used with the \f[C]-m|--manifest\f[R] option to store assemblies in the runtime package store.
|
|
To specify multiple manifest files, repeat the option and path for each file.
|
|
For example: \f[C]--manifest packages1.csproj --manifest packages2.csproj\f[R].
|
|
-.PP
|
|
-\f[C]-r|--runtime <RUNTIME_IDENTIFIER>\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-r|--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
The runtime identifier to target.
|
|
+.RE
|
|
.SS Optional options
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--framework-version <FRAMEWORK_VERSION>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--framework-version <FRAMEWORK_VERSION>\f[R]
|
|
-.PP
|
|
-Specifies the .NET Core SDK version.
|
|
+Specifies the .NET SDK version.
|
|
This option enables you to select a specific framework version beyond the framework specified by the \f[C]-f|--framework\f[R] option.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Shows help information.
|
|
-.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-o|--output <OUTPUT_DIRECTORY>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies the path to the runtime package store.
|
|
-If not specified, it defaults to the \f[I]store\f[R] subdirectory of the user profile .NET Core installation directory.
|
|
-.PP
|
|
-\f[C]--skip-optimization\f[R]
|
|
+If not specified, it defaults to the \f[I]store\f[R] subdirectory of the user profile .NET installation directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--skip-optimization\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Skips the optimization phase.
|
|
-.PP
|
|
-\f[C]--skip-symbols\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--skip-symbols\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Skips symbol generation.
|
|
Currently, you can only generate symbols on Windows and Linux.
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Sets the verbosity level of the command.
|
|
Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-.PP
|
|
-\f[C]-w|--working-dir <INTERMEDIATE_WORKING_DIRECTORY>\f[R]
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-w|--working-dir <WORKING_DIRECTORY>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
The working directory used by the command.
|
|
If not specified, it uses the \f[I]obj\f[R] subdirectory of the current directory.
|
|
+.RE
|
|
.SH EXAMPLES
|
|
-.PP
|
|
+.IP \[bu] 2
|
|
Store the packages specified in the \f[I]packages.csproj\f[R] project file for .NET Core 2.0.0:
|
|
-.PP
|
|
-\f[C]dotnet store --manifest packages.csproj --framework-version 2.0.0\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet store --manifest packages.csproj --framework-version 2.0.0
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Store the packages specified in the \f[I]packages.csproj\f[R] without optimization:
|
|
-.PP
|
|
-\f[C]dotnet store --manifest packages.csproj --skip-optimization\f[R]
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet store --manifest packages.csproj --skip-optimization
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
.SS See also
|
|
.IP \[bu] 2
|
|
Runtime package store
|
|
-.SH AUTHORS
|
|
-bleroy.
|
|
diff --git a/documentation/manpages/sdk/dotnet-test.1 b/documentation/manpages/sdk/dotnet-test.1
|
|
index e3ef50e5b0..f75e6d445d 100644
|
|
--- a/documentation/manpages/sdk/dotnet-test.1
|
|
+++ b/documentation/manpages/sdk/dotnet-test.1
|
|
@@ -1,287 +1,408 @@
|
|
-.\"t
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+'\" t
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet test command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet test
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
\f[C]dotnet test\f[R] - .NET test driver used to execute unit tests.
|
|
.SH SYNOPSIS
|
|
-.SS .NET Core 2.1
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet test [<PROJECT>] [-a|--test-adapter-path] [--blame] [-c|--configuration] [--collect] [-d|--diag] [-f|--framework] [--filter]
|
|
- [-l|--logger] [--no-build] [--no-restore] [-o|--output] [-r|--results-directory] [-s|--settings] [-t|--list-tests]
|
|
- [-v|--verbosity] [-- <RunSettings arguments>]
|
|
+dotnet test [<PROJECT> | <SOLUTION> | <DIRECTORY> | <DLL>]
|
|
+ [-a|--test-adapter-path <ADAPTER_PATH>] [--arch <ARCHITECTURE>]
|
|
+ [--blame] [--blame-crash]
|
|
+ [--blame-crash-dump-type <DUMP_TYPE>] [--blame-crash-collect-always]
|
|
+ [--blame-hang] [--blame-hang-dump-type <DUMP_TYPE>]
|
|
+ [--blame-hang-timeout <TIMESPAN>]
|
|
+ [-c|--configuration <CONFIGURATION>]
|
|
+ [--collect <DATA_COLLECTOR_NAME>]
|
|
+ [-d|--diag <LOG_FILE>] [-f|--framework <FRAMEWORK>]
|
|
+ [--filter <EXPRESSION>] [--interactive]
|
|
+ [-l|--logger <LOGGER>] [--no-build]
|
|
+ [--nologo] [--no-restore] [-o|--output <OUTPUT_DIRECTORY>] [--os <OS>]
|
|
+ [-r|--results-directory <RESULTS_DIR>] [--runtime <RUNTIME_IDENTIFIER>]
|
|
+ [-s|--settings <SETTINGS_FILE>] [-t|--list-tests]
|
|
+ [-v|--verbosity <LEVEL>] [[--] <RunSettings arguments>]
|
|
|
|
-dotnet test [-h|--help]
|
|
+dotnet test -h|--help
|
|
\f[R]
|
|
.fi
|
|
-.SS .NET Core 2.0
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet test [<PROJECT>] [-a|--test-adapter-path] [-c|--configuration] [--collect] [-d|--diag] [-f|--framework] [--filter]
|
|
- [-l|--logger] [--no-build] [--no-restore] [-o|--output] [-r|--results-directory] [-s|--settings] [-t|--list-tests] [-v|--verbosity]
|
|
-
|
|
-dotnet test [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.SS .NET Core 1.x
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet test [<PROJECT>] [-a|--test-adapter-path] [-c|--configuration] [-d|--diag] [-f|--framework] [--filter] [-l|--logger] [--no-build] [-o|--output] [-s|--settings] [-t|--list-tests] [-v|--verbosity]
|
|
-
|
|
-dotnet test [-h|--help]
|
|
-\f[R]
|
|
-.fi
|
|
-.PP
|
|
- * * * * *
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet test\f[R] command is used to execute unit tests in a given project.
|
|
-The \f[C]dotnet test\f[R] command launches the test runner console application specified for a project.
|
|
-The test runner executes the tests defined for a unit test framework (for example, MSTest, NUnit, or xUnit) and reports the success or failure of each test.
|
|
+The \f[C]dotnet test\f[R] command is used to execute unit tests in a given solution.
|
|
+The \f[C]dotnet test\f[R] command builds the solution and runs a test host application for each test project in the solution.
|
|
+The test host executes tests in the given project using a test framework, for example: MSTest, NUnit, or xUnit, and reports the success or failure of each test.
|
|
If all tests are successful, the test runner returns 0 as an exit code; otherwise if any test fails, it returns 1.
|
|
-The test runner and the unit test library are packaged as NuGet packages and are restored as ordinary dependencies for the project.
|
|
+.PP
|
|
+For multi-targeted projects, tests are run for each targeted framework.
|
|
+The test host and the unit test framework are packaged as NuGet packages and are restored as ordinary dependencies for the project.
|
|
.PP
|
|
Test projects specify the test runner using an ordinary \f[C]<PackageReference>\f[R] element, as seen in the following sample project file:
|
|
.PP
|
|
[!code-xmlXUnit Basic Template]
|
|
-.SS Arguments
|
|
-.PP
|
|
-\f[C]PROJECT\f[R]
|
|
-.PP
|
|
-Path to the test project.
|
|
-If not specified, it defaults to current directory.
|
|
-.SH OPTIONS
|
|
-.SS .NET Core 2.1
|
|
-.PP
|
|
-\f[C]-a|--test-adapter-path <PATH_TO_ADAPTER>\f[R]
|
|
-.PP
|
|
-Use the custom test adapters from the specified path in the test run.
|
|
-.PP
|
|
-\f[C]--blame\f[R]
|
|
-.PP
|
|
-Runs the tests in blame mode.
|
|
-This option is helpful in isolating the problematic tests causing test host to crash.
|
|
-It creates an output file in the current directory as \f[I]Sequence.xml\f[R] that captures the order of tests execution before the crash.
|
|
-.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
-.PP
|
|
-Defines the build configuration.
|
|
-The default value is \f[C]Debug\f[R], but your project\[cq]s configuration could override this default SDK setting.
|
|
.PP
|
|
-\f[C]--collect <DATA_COLLECTOR_FRIENDLY_NAME>\f[R]
|
|
+Where \f[C]Microsoft.NET.Test.Sdk\f[R] is the test host, \f[C]xunit\f[R] is the test framework.
|
|
+And \f[C]xunit.runner.visualstudio\f[R] is a test adapter, which allows the xUnit framework to work with the test host.
|
|
+.SS Implicit restore
|
|
.PP
|
|
-Enables data collector for the test run.
|
|
-For more information, see Monitor and analyze test run.
|
|
-.PP
|
|
-\f[C]-d|--diag <PATH_TO_DIAGNOSTICS_FILE>\f[R]
|
|
-.PP
|
|
-Enables diagnostic mode for the test platform and write diagnostic messages to the specified file.
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
-.PP
|
|
-Looks for test binaries for a specific framework.
|
|
-.PP
|
|
-\f[C]--filter <EXPRESSION>\f[R]
|
|
-.PP
|
|
-Filters out tests in the current project using the given expression.
|
|
-For more information, see the Filter option details section.
|
|
-For more information and examples on how to use selective unit test filtering, see Running selective unit tests.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
-.PP
|
|
-\f[C]-l|--logger <LoggerUri/FriendlyName>\f[R]
|
|
+You don\[cq]t have to run \f[C]dotnet restore\f[R] because it\[cq]s run implicitly by all commands that require a restore to occur, such as \f[C]dotnet new\f[R], \f[C]dotnet build\f[R], \f[C]dotnet run\f[R], \f[C]dotnet test\f[R], \f[C]dotnet publish\f[R], and \f[C]dotnet pack\f[R].
|
|
+To disable implicit restore, use the \f[C]--no-restore\f[R] option.
|
|
.PP
|
|
-Specifies a logger for test results.
|
|
-.PP
|
|
-\f[C]--no-build\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t build the test project before running it.
|
|
-It also implicit sets the \f[C]--no-restore\f[R] flag.
|
|
-.PP
|
|
-\f[C]--no-restore\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t execute an implicit restore when running the command.
|
|
-.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
-.PP
|
|
-Directory in which to find the binaries to run.
|
|
-.PP
|
|
-\f[C]-r|--results-directory <PATH>\f[R]
|
|
-.PP
|
|
-The directory where the test results are going to be placed.
|
|
-If the specified directory doesn\[cq]t exist, it\[cq]s created.
|
|
+The \f[C]dotnet restore\f[R] command is still useful in certain scenarios where explicitly restoring makes sense, such as continuous integration builds in Azure DevOps Services or in build systems that need to explicitly control when the restore occurs.
|
|
.PP
|
|
-\f[C]-s|--settings <SETTINGS_FILE>\f[R]
|
|
+For information about how to manage NuGet feeds, see the \f[C]dotnet restore\f[R] documentation.
|
|
+.SS Workload manifest downloads
|
|
.PP
|
|
-The \f[C].runsettings\f[R] file to use for running the tests.
|
|
-Configure unit tests by using a \f[C].runsettings\f[R] file.
|
|
+When you run this command, it initiates an asynchronous background download of advertising manifests for workloads.
|
|
+If the download is still running when this command finishes, the download is stopped.
|
|
+For more information, see Advertising manifests.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]PROJECT | SOLUTION | DIRECTORY | DLL\f[B]\f[R]
|
|
+.RS 2
|
|
+.IP \[bu] 2
|
|
+Path to the test project.
|
|
+.IP \[bu] 2
|
|
+Path to the solution.
|
|
+.IP \[bu] 2
|
|
+Path to a directory that contains a project or a solution.
|
|
+.IP \[bu] 2
|
|
+Path to a test project \f[I].dll\f[R] file.
|
|
.PP
|
|
-\f[C]-t|--list-tests\f[R]
|
|
+If not specified, it searches for a project or a solution in the current directory.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-a|--test-adapter-path <ADAPTER_PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-List all of the discovered tests in the current project.
|
|
+Path to a directory to be searched for additional test adapters.
|
|
+Only \f[I].dll\f[R] files with suffix \f[C].TestAdapter.dll\f[R] are inspected.
|
|
+If not specified, the directory of the test \f[I].dll\f[R] is searched.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--arch <ARCHITECTURE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the target architecture.
|
|
+This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
|
|
+For example, on a \f[C]win-x64\f[R] machine, specifying \f[C]--arch x86\f[R] sets the RID to \f[C]win-x86\f[R].
|
|
+If you use this option, don\[cq]t use the \f[C]-r|--runtime\f[R] option.
|
|
+Available since .NET 6 Preview 7.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--blame\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
+Runs the tests in blame mode.
|
|
+This option is helpful in isolating problematic tests that cause the test host to crash.
|
|
+When a crash is detected, it creates a sequence file in \f[C]TestResults/<Guid>/<Guid>_Sequence.xml\f[R] that captures the order of tests that were run before the crash.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--blame-crash\f[B]\f[R] (Available since .NET 5.0 preview SDK)
|
|
+.RS 2
|
|
.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+Runs the tests in blame mode and collects a crash dump when the test host exits unexpectedly.
|
|
+This option depends on the version of .NET used, the type of error, and the operating system.
|
|
.PP
|
|
-\f[C]RunSettings arguments\f[R]
|
|
+For exceptions in managed code, a dump will be automatically collected on .NET 5.0 and later versions.
|
|
+It will generate a dump for testhost or any child process that also ran on .NET 5.0 and crashed.
|
|
+Crashes in native code will not generate a dump.
|
|
+This option works on Windows, macOS, and Linux.
|
|
.PP
|
|
-Arguments passed as RunSettings configurations for the test.
|
|
-Arguments are specified as \f[C][name]=[value]\f[R] pairs after \[lq]\[en]\[rq] (note the space after \[en]).
|
|
-A space is used to separate multiple \f[C][name]=[value]\f[R] pairs.
|
|
+Crash dumps in native code, or when using .NET Core 3.1 or earlier versions, can only be collected on Windows, by using Procdump.
|
|
+A directory that contains \f[I]procdump.exe\f[R] and \f[I]procdump64.exe\f[R] must be in the PATH or PROCDUMP_PATH environment variable.
|
|
+Download the tools.
|
|
+Implies \f[C]--blame\f[R].
|
|
.PP
|
|
-Example: \f[C]dotnet test -- MSTest.DeploymentEnabled=false MSTest.MapInconclusiveToFailed=True\f[R]
|
|
+To collect a crash dump from a native application running on .NET 5.0 or later, the usage of Procdump can be forced by setting the \f[C]VSTEST_DUMP_FORCEPROCDUMP\f[R] environment variable to \f[C]1\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--blame-crash-dump-type <DUMP_TYPE>\f[B]\f[R] (Available since .NET 5.0 preview SDK)
|
|
+.RS 2
|
|
.PP
|
|
-For more information about RunSettings, see vstest.console.exe: Passing RunSettings args.
|
|
-.SS .NET Core 2.0
|
|
+The type of crash dump to be collected.
|
|
+Implies \f[C]--blame-crash\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--blame-crash-collect-always\f[B]\f[R] (Available since .NET 5.0 preview SDK)
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-a|--test-adapter-path <PATH_TO_ADAPTER>\f[R]
|
|
+Collects a crash dump on expected as well as unexpected test host exit.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--blame-hang\f[B]\f[R] (Available since .NET 5.0 preview SDK)
|
|
+.RS 2
|
|
.PP
|
|
-Use the custom test adapters from the specified path in the test run.
|
|
+Run the tests in blame mode and collects a hang dump when a test exceeds the given timeout.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--blame-hang-dump-type <DUMP_TYPE>\f[B]\f[R] (Available since .NET 5.0 preview SDK)
|
|
+.RS 2
|
|
+.PP
|
|
+The type of crash dump to be collected.
|
|
+It should be \f[C]full\f[R], \f[C]mini\f[R], or \f[C]none\f[R].
|
|
+When \f[C]none\f[R] is specified, test host is terminated on timeout, but no dump is collected.
|
|
+Implies \f[C]--blame-hang\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--blame-hang-timeout <TIMESPAN>\f[B]\f[R] (Available since .NET 5.0 preview SDK)
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
+Per-test timeout, after which a hang dump is triggered and the test host process and all of its child processes are dumped and terminated.
|
|
+The timeout value is specified in one of the following formats:
|
|
+.IP \[bu] 2
|
|
+1.5h, 1.5hour, 1.5hours
|
|
+.IP \[bu] 2
|
|
+90m, 90min, 90minute, 90minutes
|
|
+.IP \[bu] 2
|
|
+5400s, 5400sec, 5400second, 5400seconds
|
|
+.IP \[bu] 2
|
|
+5400000ms, 5400000mil, 5400000millisecond, 5400000milliseconds
|
|
+.PP
|
|
+When no unit is used (for example, 5400000), the value is assumed to be in milliseconds.
|
|
+When used together with data driven tests, the timeout behavior depends on the test adapter used.
|
|
+For xUnit and NUnit the timeout is renewed after every test case.
|
|
+For MSTest, the timeout is used for all test cases.
|
|
+This option is supported on Windows with netcoreapp2.1 and later, on Linux with netcoreapp3.1 and later, and on macOS with net5.0 or later.
|
|
+Implies \f[C]--blame\f[R] and \f[C]--blame-hang\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Defines the build configuration.
|
|
-The default value is \f[C]Debug\f[R], but your project\[cq]s configuration could override this default SDK setting.
|
|
-.PP
|
|
-\f[C]--collect <DATA_COLLECTOR_FRIENDLY_NAME>\f[R]
|
|
+The default for most projects is \f[C]Debug\f[R], but you can override the build configuration settings in your project.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--collect <DATA_COLLECTOR_NAME>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Enables data collector for the test run.
|
|
-For more information, see Monitor and analyze test run.
|
|
-.PP
|
|
-\f[C]-d|--diag <PATH_TO_DIAGNOSTICS_FILE>\f[R]
|
|
-.PP
|
|
-Enables diagnostic mode for the test platform and write diagnostic messages to the specified file.
|
|
+For more information, see Monitor and analyze test run (https://aka.ms/vstest-collect).
|
|
.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
+To collect code coverage on any platform that is supported by .NET Core, install Coverlet (https://github.com/coverlet-coverage/coverlet/blob/master/README.md) and use the \f[C]--collect:\[dq]XPlat Code Coverage\[dq]\f[R] option.
|
|
.PP
|
|
-Looks for test binaries for a specific framework.
|
|
+On Windows, you can collect code coverage by using the \f[C]--collect \[dq]Code Coverage\[dq]\f[R] option.
|
|
+This option generates a \f[I].coverage\f[R] file, which can be opened in Visual Studio 2019 Enterprise.
|
|
+For more information, see Use code coverage and Customize code coverage analysis.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-d|--diag <LOG_FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--filter <EXPRESSION>\f[R]
|
|
+Enables diagnostic mode for the test platform and writes diagnostic messages to the specified file and to files next to it.
|
|
+The process that is logging the messages determines which files are created, such as \f[C]*.host_<date>.txt\f[R] for test host log, and \f[C]*.datacollector_<date>.txt\f[R] for data collector log.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-f|--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Forces the use of \f[C]dotnet\f[R] or .NET Framework test host for the test binaries.
|
|
+This option only determines which type of host to use.
|
|
+The actual framework version to be used is determined by the \f[I]runtimeconfig.json\f[R] of the test project.
|
|
+When not specified, the TargetFramework assembly attribute is used to determine the type of host.
|
|
+When that attribute is stripped from the \f[I].dll\f[R], the .NET Framework host is used.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--filter <EXPRESSION>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Filters out tests in the current project using the given expression.
|
|
For more information, see the Filter option details section.
|
|
For more information and examples on how to use selective unit test filtering, see Running selective unit tests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-l|--logger <LoggerUri/FriendlyName>\f[R]
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-l|--logger <LOGGER>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies a logger for test results.
|
|
-.PP
|
|
-\f[C]--no-build\f[R]
|
|
+Unlike MSBuild, dotnet test doesn\[cq]t accept abbreviations: instead of \f[C]-l \[dq]console;v=d\[dq]\f[R] use \f[C]-l \[dq]console;verbosity=detailed\[dq]\f[R].
|
|
+Specify the parameter multiple times to enable multiple loggers.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-build\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Doesn\[cq]t build the test project before running it.
|
|
-It also implicit sets the \f[C]--no-restore\f[R] flag.
|
|
+It also implicitly sets the - \f[C]--no-restore\f[R] flag.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--nologo\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--no-restore\f[R]
|
|
+Run tests without displaying the Microsoft TestPlatform banner.
|
|
+Available since .NET Core 3.0 SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-restore\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Doesn\[cq]t execute an implicit restore when running the command.
|
|
-.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-o|--output <OUTPUT_DIRECTORY>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Directory in which to find the binaries to run.
|
|
-.PP
|
|
-\f[C]-r|--results-directory <PATH>\f[R]
|
|
+If not specified, the default path is \f[C]./bin/<configuration>/<framework>/\f[R].
|
|
+For projects with multiple target frameworks (via the \f[C]TargetFrameworks\f[R] property), you also need to define \f[C]--framework\f[R] when you specify this option.
|
|
+\f[C]dotnet test\f[R] always runs tests from the output directory.
|
|
+You can use <xref:System.AppDomain.BaseDirectory%2A?displayProperty=nameWithType> to consume test assets in the output directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--os <OS>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the target operating system (OS).
|
|
+This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
|
|
+For example, on a \f[C]win-x64\f[R] machine, specifying \f[C]--os os\f[R] sets the RID to \f[C]os-x64\f[R].
|
|
+If you use this option, don\[cq]t use the \f[C]-r|--runtime\f[R] option.
|
|
+Available since .NET 6 Preview 7.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-r|--results-directory <RESULTS_DIR>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
The directory where the test results are going to be placed.
|
|
If the specified directory doesn\[cq]t exist, it\[cq]s created.
|
|
+The default is \f[C]TestResults\f[R] in the directory that contains the project file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-s|--settings <SETTINGS_FILE>\f[R]
|
|
+The target runtime to test for.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-s|--settings <SETTINGS_FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
The \f[C].runsettings\f[R] file to use for running the tests.
|
|
+The \f[C]TargetPlatform\f[R] element (x86|x64) has no effect for \f[C]dotnet test\f[R].
|
|
+To run tests that target x86, install the x86 version of .NET Core.
|
|
+The bitness of the \f[I]dotnet.exe\f[R] that is on the path is what will be used for running tests.
|
|
+For more information, see the following resources:
|
|
+.IP \[bu] 2
|
|
Configure unit tests by using a \f[C].runsettings\f[R] file.
|
|
+.IP \[bu] 2
|
|
+Configure a test run (https://github.com/Microsoft/vstest-docs/blob/master/docs/configure.md)
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-t|--list-tests\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-t|--list-tests\f[R]
|
|
-.PP
|
|
-List all of the discovered tests in the current project.
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
+List the discovered tests instead of running the tests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Sets the verbosity level of the command.
|
|
Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-\f[C]-a|--test-adapter-path <PATH_TO_ADAPTER>\f[R]
|
|
-.PP
|
|
-Use the custom test adapters from the specified path in the test run.
|
|
-.PP
|
|
-\f[C]-c|--configuration {Debug|Release}\f[R]
|
|
-.PP
|
|
-Defines the build configuration.
|
|
-The default value is \f[C]Debug\f[R], but your project\[cq]s configuration could override this default SDK setting.
|
|
-.PP
|
|
-\f[C]-d|--diag <PATH_TO_DIAGNOSTICS_FILE>\f[R]
|
|
-.PP
|
|
-Enables diagnostic mode for the test platform and write diagnostic messages to the specified file.
|
|
-.PP
|
|
-\f[C]-f|--framework <FRAMEWORK>\f[R]
|
|
-.PP
|
|
-Looks for test binaries for a specific framework.
|
|
-.PP
|
|
-\f[C]--filter <EXPRESSION>\f[R]
|
|
-.PP
|
|
-Filters out tests in the current project using the given expression.
|
|
-For more information, see the Filter option details section.
|
|
-For more information and examples on how to use selective unit test filtering, see Running selective unit tests.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
-.PP
|
|
-\f[C]-l|--logger <LoggerUri/FriendlyName>\f[R]
|
|
-.PP
|
|
-Specifies a logger for test results.
|
|
-.PP
|
|
-\f[C]--no-build\f[R]
|
|
-.PP
|
|
-Doesn\[cq]t build the test project before running it.
|
|
-.PP
|
|
-\f[C]-o|--output <OUTPUT_DIRECTORY>\f[R]
|
|
-.PP
|
|
-Directory in which to find the binaries to run.
|
|
-.PP
|
|
-\f[C]-s|--settings <SETTINGS_FILE>\f[R]
|
|
-.PP
|
|
-The \f[C].runsettings\f[R] file to use for running the tests.
|
|
-Configure unit tests by using a \f[C].runsettings\f[R] file.
|
|
-.PP
|
|
-\f[C]-t|--list-tests\f[R]
|
|
-.PP
|
|
-List all of the discovered tests in the current project.
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]RunSettings\f[B]\f[R] arguments
|
|
.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
+Inline \f[C]RunSettings\f[R] are passed as the last arguments on the command line after \[lq]\[en]\[rq] (note the space after \[en]).
|
|
+Inline \f[C]RunSettings\f[R] are specified as \f[C][name]=[value]\f[R] pairs.
|
|
+A space is used to separate multiple \f[C][name]=[value]\f[R] pairs.
|
|
.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+Example: \f[C]dotnet test -- MSTest.DeploymentEnabled=false MSTest.MapInconclusiveToFailed=True\f[R]
|
|
.PP
|
|
- * * * * *
|
|
+For more information, see Passing RunSettings arguments through command line (https://github.com/Microsoft/vstest-docs/blob/master/docs/RunSettingsArguments.md).
|
|
.SH EXAMPLES
|
|
-.PP
|
|
+.IP \[bu] 2
|
|
Run the tests in the project in the current directory:
|
|
-.PP
|
|
-\f[C]dotnet test\f[R]
|
|
-.PP
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet test
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
Run the tests in the \f[C]test1\f[R] project:
|
|
-.PP
|
|
-\f[C]dotnet test \[ti]/projects/test1/test1.csproj\f[R]
|
|
-.PP
|
|
-Run the tests in the project in the current directory and generate a test results file in the trx format:
|
|
-.PP
|
|
-\f[C]dotnet test --logger trx\f[R]
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet test \[ti]/projects/test1/test1.csproj
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Run the tests in the project in the current directory, and generate a test results file in the trx format:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet test --logger trx
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Run the tests in the project in the current directory, and generate a code coverage file (after installing Coverlet (https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/VSTestIntegration.md) collectors integration):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet test --collect:\[dq]XPlat Code Coverage\[dq]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Run the tests in the project in the current directory, and generate a code coverage file (Windows only):
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet test --collect \[dq]Code Coverage\[dq]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Run the tests in the project in the current directory, and log with detailed verbosity to the console:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet test --logger \[dq]console;verbosity=detailed\[dq]
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Run the tests in the project in the current directory, and report tests that were in progress when the test host crashed:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet test --blame
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
.SS Filter option details
|
|
.PP
|
|
\f[C]--filter <EXPRESSION>\f[R]
|
|
@@ -300,23 +421,19 @@ T}@T{
|
|
Supported properties
|
|
T}
|
|
_
|
|
+T{
|
|
+MSTest
|
|
+T}@T{
|
|
+T}
|
|
+T{
|
|
+xUnit
|
|
+T}@T{
|
|
+T}
|
|
+T{
|
|
+NUnit
|
|
+T}@T{
|
|
+T}
|
|
.TE
|
|
-| MSTest |
|
|
-FullyQualifiedName
|
|
-Name
|
|
-ClassName
|
|
-Priority
|
|
-TestCategory
|
|
-| | xUnit |
|
|
-FullyQualifiedName
|
|
-DisplayName
|
|
-Traits
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
- |
|
|
-\f[R]
|
|
-.fi
|
|
.PP
|
|
The \f[C]<operator>\f[R] describes the relationship between the property and the value:
|
|
.PP
|
|
@@ -344,6 +461,11 @@ T{
|
|
T}@T{
|
|
Contains
|
|
T}
|
|
+T{
|
|
+\f[C]!\[ti]\f[R]
|
|
+T}@T{
|
|
+Not contains
|
|
+T}
|
|
.TE
|
|
.PP
|
|
\f[C]<value>\f[R] is a string.
|
|
@@ -381,4 +503,6 @@ For more information and examples on how to use selective unit test filtering, s
|
|
.IP \[bu] 2
|
|
Frameworks and Targets
|
|
.IP \[bu] 2
|
|
-\&.NET Core Runtime IDentifier (RID) catalog
|
|
+\&.NET Runtime Identifier (RID) catalog
|
|
+.IP \[bu] 2
|
|
+Passing runsettings arguments through commandline (https://github.com/Microsoft/vstest-docs/blob/master/docs/RunSettingsArguments.md)
|
|
diff --git a/documentation/manpages/sdk/dotnet-tool-install.1 b/documentation/manpages/sdk/dotnet-tool-install.1
|
|
index 3725f3ed7a..190b86765c 100644
|
|
--- a/documentation/manpages/sdk/dotnet-tool-install.1
|
|
+++ b/documentation/manpages/sdk/dotnet-tool-install.1
|
|
@@ -1,28 +1,53 @@
|
|
-.\"t
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+'\" t
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet tool install command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet tool install
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet tool install\f[R] - Installs the specified .NET Core Global Tool on your machine.
|
|
+\f[C]dotnet tool install\f[R] - Installs the specified .NET 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>
|
|
+dotnet tool install <PACKAGE_NAME> -g|--global
|
|
+ [--add-source <SOURCE>] [--configfile <FILE>] [--disable-parallel]
|
|
+ [--framework <FRAMEWORK>] [--ignore-failed-sources] [--interactive]
|
|
+ [--no-cache] [--tool-manifest <PATH>] [-v|--verbosity <LEVEL>]
|
|
+ [--version <VERSION_NUMBER>]
|
|
+
|
|
+dotnet tool install <PACKAGE_NAME> --tool-path <PATH>
|
|
+ [--add-source <SOURCE>] [--configfile <FILE>] [--disable-parallel]
|
|
+ [--framework <FRAMEWORK>] [--ignore-failed-sources] [--interactive]
|
|
+ [--no-cache] [--tool-manifest <PATH>] [-v|--verbosity <LEVEL>]
|
|
+ [--version <VERSION_NUMBER>]
|
|
+
|
|
+dotnet tool install <PACKAGE_NAME> [--local]
|
|
+ [--add-source <SOURCE>] [--configfile <FILE>] [--disable-parallel]
|
|
+ [--framework <FRAMEWORK>] [--ignore-failed-sources] [--interactive]
|
|
+ [--no-cache] [--tool-manifest <PATH>] [-v|--verbosity <LEVEL>]
|
|
+ [--version <VERSION_NUMBER>]
|
|
+
|
|
+dotnet tool install -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet tool install\f[R] 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[R] option or you specify a path to install it using the \f[C]--tool-path\f[R] option.
|
|
+The \f[C]dotnet tool install\f[R] command provides a way for you to install .NET tools on your machine.
|
|
+To use the command, you specify one of the following installation options:
|
|
+.IP \[bu] 2
|
|
+To install a global tool in the default location, use the \f[C]--global\f[R] option.
|
|
+.IP \[bu] 2
|
|
+To install a global tool in a custom location, use the \f[C]--tool-path\f[R] option.
|
|
+.IP \[bu] 2
|
|
+To install a local tool, omit the \f[C]--global\f[R] and \f[C]--tool-path\f[R] options.
|
|
.PP
|
|
-Global Tools are installed in the following directories by default when you specify the \f[C]-g\f[R] (or \f[C]--global\f[R]) option:
|
|
+\f[B]Local tools are available starting with .NET Core SDK 3.0.\f[R]
|
|
+.PP
|
|
+Global tools are installed in the following directories by default when you specify the \f[C]-g\f[R] or \f[C]--global\f[R] option:
|
|
.PP
|
|
.TS
|
|
tab(@);
|
|
@@ -44,71 +69,162 @@ T}@T{
|
|
\f[C]%USERPROFILE%\[rs].dotnet\[rs]tools\f[R]
|
|
T}
|
|
.TE
|
|
-.SS Arguments
|
|
.PP
|
|
-\f[C]PACKAGE_NAME\f[R]
|
|
+Local tools are added to a \f[I]dotnet-tools.json\f[R] file in a \f[I].config\f[R] directory under the current directory.
|
|
+If a manifest file doesn\[cq]t exist yet, create it by running the following command:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new tool-manifest
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
-Name/ID of the NuGet package that contains the .NET Core Global Tool to install.
|
|
-.SH OPTIONS
|
|
+For more information, see Install a local tool.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]PACKAGE_NAME\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--add-source <SOURCE>\f[R]
|
|
+Name/ID of the NuGet package that contains the .NET tool to install.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--add-source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Adds an additional NuGet package source to use during installation.
|
|
+Feeds are accessed in parallel, not sequentially in some order of precedence.
|
|
+If the same package and version is in multiple feeds, the fastest feed wins.
|
|
+For more information, see What happens when a NuGet package is installed?.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--disable-parallel\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--configfile <FILE>\f[R]
|
|
-.PP
|
|
-The NuGet configuration (\f[I]nuget.config\f[R]) file to use.
|
|
-.PP
|
|
-\f[C]--framework <FRAMEWORK>\f[R]
|
|
+Prevent restoring multiple projects in parallel.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
.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[R]
|
|
+By default, the .NET SDK tries to choose the most appropriate target framework.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-g|--global\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies that the installation is user wide.
|
|
Can\[cq]t be combined with the \f[C]--tool-path\f[R] option.
|
|
-If you don\[cq]t specify this option, you must specify the \f[C]--tool-path\f[R] option.
|
|
+Omitting both \f[C]--global\f[R] and \f[C]--tool-path\f[R] specifies a local tool installation.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ignore-failed-sources\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Treat package source failures as warnings.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--local\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Update the tool and the local tool manifest.
|
|
+Can\[cq]t be combined with the \f[C]--global\f[R] option or the \f[C]--tool-path\f[R] option.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-cache\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Do not cache packages and HTTP requests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tool-manifest <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--tool-path <PATH>\f[R]
|
|
+Path to the manifest file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tool-path <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies the location where to install the Global Tool.
|
|
PATH can be absolute or relative.
|
|
If PATH doesn\[cq]t exist, the command tries to create it.
|
|
-Can\[cq]t be combined with the \f[C]--global\f[R] option.
|
|
-If you don\[cq]t specify this option, you must specify the \f[C]--global\f[R] option.
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
+Omitting both \f[C]--global\f[R] and \f[C]--tool-path\f[R] specifies a local tool installation.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Sets the verbosity level of the command.
|
|
Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-.PP
|
|
-\f[C]--version <VERSION_NUMBER>\f[R]
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--version <VERSION_NUMBER>\f[B]\f[R]
|
|
+.RS 2
|
|
.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.
|
|
+.RE
|
|
.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool install -g dotnetsay\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Installs the dotnetsay Global Tool in the default location:
|
|
-.PP
|
|
-\f[C]dotnet tool install -g dotnetsay\f[R]
|
|
-.PP
|
|
-Installs the dotnetsay Global Tool on a specific Windows folder:
|
|
-.PP
|
|
-\f[C]dotnet tool install dotnetsay --tool-path c:\[rs]global-tools\f[R]
|
|
+Installs dotnetsay (https://www.nuget.org/packages/dotnetsay/) as a global tool in the default location.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool install dotnetsay --tool-path c:\[rs]global-tools\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Installs the dotnetsay Global Tool on a specific Linux/macOS folder:
|
|
+Installs dotnetsay (https://www.nuget.org/packages/dotnetsay/) as a global tool in a specific Windows directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool install dotnetsay --tool-path \[ti]/bin\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet tool install dotnetsay --tool-path \[ti]/bin\f[R]
|
|
+Installs dotnetsay (https://www.nuget.org/packages/dotnetsay/) as a global tool in a specific Linux/macOS directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool install -g dotnetsay --version 2.0.0\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Installs version 2.0.0 of the dotnetsay Global Tool:
|
|
+Installs version 2.0.0 of dotnetsay (https://www.nuget.org/packages/dotnetsay/) as a global tool.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool install dotnetsay\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet tool install -g dotnetsay --version 2.0.0\f[R]
|
|
+Installs dotnetsay (https://www.nuget.org/packages/dotnetsay/) as a local tool for the current directory.
|
|
+.RE
|
|
.SS See also
|
|
.IP \[bu] 2
|
|
-\&.NET Core Global Tools
|
|
+\&.NET tools
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET global tool using the .NET CLI
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET local tool using the .NET CLI
|
|
diff --git a/documentation/manpages/sdk/dotnet-tool-list.1 b/documentation/manpages/sdk/dotnet-tool-list.1
|
|
index a2f2534d77..7ae8c785d3 100644
|
|
--- a/documentation/manpages/sdk/dotnet-tool-list.1
|
|
+++ b/documentation/manpages/sdk/dotnet-tool-list.1
|
|
@@ -1,57 +1,102 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet tool list command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet tool list
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet tool list\f[R] - Lists all .NET Core Global Tools currently installed in the default directory on your machine or in the specified path.
|
|
+\f[C]dotnet tool list\f[R] - Lists all .NET tools of the specified type currently installed on your machine.
|
|
.SH SYNOPSIS
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet tool list <-g|--global>
|
|
-dotnet tool list <--tool-path>
|
|
-dotnet tool list <-h|--help>
|
|
+dotnet tool list -g|--global
|
|
+
|
|
+dotnet tool list --tool-path <PATH>
|
|
+
|
|
+dotnet tool list --local
|
|
+
|
|
+dotnet tool list
|
|
+
|
|
+dotnet tool list -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet tool list\f[R] 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[R] option or specify a custom path using the \f[C]--tool-path\f[R] option.
|
|
-.SH OPTIONS
|
|
+The \f[C]dotnet tool list\f[R] command provides a way for you to list all .NET global, tool-path, or local tools installed on your machine.
|
|
+The command lists the package name, version installed, and the tool command.
|
|
+To use the command, you specify one of the following:
|
|
+.IP \[bu] 2
|
|
+To list global tools installed in the default location, use the \f[C]--global\f[R] option
|
|
+.IP \[bu] 2
|
|
+To list global tools installed in a custom location, use the \f[C]--tool-path\f[R] option.
|
|
+.IP \[bu] 2
|
|
+To list local tools, use the \f[C]--local\f[R] option or omit the \f[C]--global\f[R], \f[C]--tool-path\f[R], and \f[C]--local\f[R] options.
|
|
.PP
|
|
-\f[C]-g|--global\f[R]
|
|
+\f[B]Local tools are available starting with .NET Core SDK 3.0.\f[R]
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-g|--global\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Lists user-wide Global Tools.
|
|
+Lists user-wide global tools.
|
|
Can\[cq]t be combined with the \f[C]--tool-path\f[R] option.
|
|
-If you don\[cq]t specify this option, you must specify the \f[C]--tool-path\f[R] option.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
+Omitting both \f[C]--global\f[R] and \f[C]--tool-path\f[R] lists local tools.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--local\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--tool-path <PATH>\f[R]
|
|
+Lists local tools for the current directory.
|
|
+Can\[cq]t be combined with the \f[C]--global\f[R] or \f[C]--tool-path\f[R] options.
|
|
+Omitting both \f[C]--global\f[R] and \f[C]--tool-path\f[R] lists local tools even if \f[C]--local\f[R] is not specified.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tool-path <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Specifies a custom location where to find Global Tools.
|
|
+Specifies a custom location where to find global tools.
|
|
PATH can be absolute or relative.
|
|
Can\[cq]t be combined with the \f[C]--global\f[R] option.
|
|
-If you don\[cq]t specify this option, you must specify the \f[C]--global\f[R] option.
|
|
+Omitting both \f[C]--global\f[R] and \f[C]--tool-path\f[R] lists local tools.
|
|
+.RE
|
|
.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool list -g\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Lists all Global Tools installed user-wide on your machine (current user profile):
|
|
-.PP
|
|
-\f[C]dotnet tool list -g\f[R]
|
|
-.PP
|
|
-Lists the Global Tools from a specific Windows folder:
|
|
+Lists all global tools installed user-wide on your machine (current user profile).
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool list --tool-path c:\[rs]global-tools\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet tool list --tool-path c:\[rs]global-tools\f[R]
|
|
+Lists the global tools from a specific Windows directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool list --tool-path \[ti]/bin\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Lists the Global Tools from a specific Linux/macOS folder:
|
|
+Lists the global tools from a specific Linux/macOS directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool list\f[B]\f[R] or \f[B]\f[CB]dotnet tool list --local\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet tool list --tool-path \[ti]/bin\f[R]
|
|
+Lists all local tools available in the current directory.
|
|
+.RE
|
|
.SS See also
|
|
.IP \[bu] 2
|
|
-\&.NET Core Global Tools
|
|
+\&.NET tools
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET global tool using the .NET CLI
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET local tool using the .NET CLI
|
|
diff --git a/documentation/manpages/sdk/dotnet-tool-restore.1 b/documentation/manpages/sdk/dotnet-tool-restore.1
|
|
new file mode 100644
|
|
index 0000000000..9d25fd82cc
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-tool-restore.1
|
|
@@ -0,0 +1,103 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet tool restore
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.0 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet tool restore\f[R] - Installs the .NET local tools that are in scope for the current directory.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet tool restore
|
|
+ [--configfile <FILE>] [--add-source <SOURCE>]
|
|
+ [--tool-manifest <PATH_TO_MANIFEST_FILE>] [--disable-parallel]
|
|
+ [--ignore-failed-sources] [--no-cache] [--interactive]
|
|
+ [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet tool restore -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet tool restore\f[R] command finds the tool manifest file that is in scope for the current directory and installs the tools that are listed in it.
|
|
+For information about manifest files, see Install a local tool and Invoke a local tool.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--add-source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Adds an additional NuGet package source to use during installation.
|
|
+Feeds are accessed in parallel, not sequentially in some order of precedence.
|
|
+If the same package and version is in multiple feeds, the fastest feed wins.
|
|
+For more information, see What happens when a NuGet package is installed?.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tool-manifest <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Path to the manifest file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--disable-parallel\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prevent restoring multiple projects in parallel.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ignore-failed-sources\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Treat package source failures as warnings.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-cache\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Do not cache packages and http requests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SS Example
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool restore\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Restores local tools for the current directory.
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+\&.NET tools
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET local tool using the .NET CLI
|
|
diff --git a/documentation/manpages/sdk/dotnet-tool-run.1 b/documentation/manpages/sdk/dotnet-tool-run.1
|
|
new file mode 100644
|
|
index 0000000000..2b3ff10392
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-tool-run.1
|
|
@@ -0,0 +1,50 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet tool run
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.0 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet tool run\f[R] - Invokes a local tool.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet tool run <COMMAND NAME>
|
|
+
|
|
+dotnet tool run -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet tool run\f[R] command searches tool manifest files that are in scope for the current directory.
|
|
+When it finds a reference to the specified tool, it runs the tool.
|
|
+For more information, see Invoke a local tool.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]COMMAND_NAME\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The command name of the tool to run.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.SS Example
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool run dotnetsay\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Runs the \f[C]dotnetsay\f[R] local tool.
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+\&.NET tools
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET local tool using the .NET CLI
|
|
diff --git a/documentation/manpages/sdk/dotnet-tool-search.1 b/documentation/manpages/sdk/dotnet-tool-search.1
|
|
new file mode 100644
|
|
index 0000000000..84647ad4de
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-tool-search.1
|
|
@@ -0,0 +1,122 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet tool search
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 5.0 SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet tool search\f[R] - Searches all .NET tools that are published to NuGet.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet tool search [--detail] [--prerelease]
|
|
+ [--skip <NUMBER>] [--take <NUMBER>] <SEARCH TERM>
|
|
+
|
|
+dotnet tool search -h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet tool search\f[R] command provides a way for you to search NuGet for tools that can be used as .NET global, tool-path, or local tools.
|
|
+The command searches the tool names and metadata such as titles, descriptions, and tags.
|
|
+.PP
|
|
+The command uses the NuGet Search API.
|
|
+It filters on \f[C]packageType=dotnettool\f[R] to select only .NET tool packages.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--detail\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Shows detailed results from the query.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--prerelease\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Includes pre-release packages.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--skip <NUMBER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the number of query results to skip.
|
|
+Used for pagination.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--take <NUMBER>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the number of query results to show.
|
|
+Used for pagination.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Search NuGet.org for .NET tools that have \[lq]format\[rq] in their package name or description:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet tool search format
|
|
+\f[R]
|
|
+.fi
|
|
+.PP
|
|
+The output looks like the following example:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+Package ID Latest Version Authors Downloads Verified
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------
|
|
+dotnet-format 4.1.131201 Microsoft 496746
|
|
+bsoa.generator 1.0.0 Microsoft 533
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Search NuGet.org for .NET tools that have \[lq]format\[rq] in their package name or metadata, show only the first result, and show a detailed view.
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet tool search format --take 1 --detail
|
|
+\f[R]
|
|
+.fi
|
|
+.PP
|
|
+The output looks like the following example:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+----------------
|
|
+dotnet-format
|
|
+Latest Version: 4.1.131201
|
|
+Authors: Microsoft
|
|
+Tags:
|
|
+Downloads: 496746
|
|
+Verified: False
|
|
+Description: Command line tool for formatting C# and Visual Basic code files based on .editorconfig settings.
|
|
+Versions:
|
|
+ 3.0.2 Downloads: 1973
|
|
+ 3.0.4 Downloads: 9064
|
|
+ 3.1.37601 Downloads: 114730
|
|
+ 3.2.107702 Downloads: 13423
|
|
+ 3.3.111304 Downloads: 131195
|
|
+ 4.0.130203 Downloads: 78610
|
|
+ 4.1.131201 Downloads: 145927
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+\&.NET tools
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET global tool using the .NET CLI
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET local tool using the .NET CLI
|
|
diff --git a/documentation/manpages/sdk/dotnet-tool-uninstall.1 b/documentation/manpages/sdk/dotnet-tool-uninstall.1
|
|
index d2a1da44e1..9b2ac7bae1 100644
|
|
--- a/documentation/manpages/sdk/dotnet-tool-uninstall.1
|
|
+++ b/documentation/manpages/sdk/dotnet-tool-uninstall.1
|
|
@@ -1,62 +1,99 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet tool uninstall command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet tool uninstall
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet tool uninstall\f[R] - Uninstalls the specified .NET Core Global Tool from your machine.
|
|
+\f[C]dotnet tool uninstall\f[R] - Uninstalls the specified .NET 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>
|
|
+dotnet tool uninstall <PACKAGE_NAME> -g|--global
|
|
+
|
|
+dotnet tool uninstall <PACKAGE_NAME> --tool-path <PATH>
|
|
+
|
|
+dotnet tool uninstall <PACKAGE_NAME>
|
|
+
|
|
+dotnet tool uninstall -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet tool uninstall\f[R] 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[R] option or specify a path to where the tool is installed using the \f[C]--tool-path\f[R] option.
|
|
-.SS Arguments
|
|
+The \f[C]dotnet tool uninstall\f[R] command provides a way for you to uninstall .NET tools from your machine.
|
|
+To use the command, you specify one of the following options:
|
|
+.IP \[bu] 2
|
|
+To uninstall a global tool that was installed in the default location, use the \f[C]--global\f[R] option.
|
|
+.IP \[bu] 2
|
|
+To uninstall a global tool that was installed in a custom location, use the \f[C]--tool-path\f[R] option.
|
|
+.IP \[bu] 2
|
|
+To uninstall a local tool, omit the \f[C]--global\f[R] and \f[C]--tool-path\f[R] options.
|
|
.PP
|
|
-\f[C]PACKAGE_NAME\f[R]
|
|
+\f[B]Local tools are available starting with .NET Core SDK 3.0.\f[R]
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]PACKAGE_NAME\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Name/ID of the NuGet package that contains the .NET Core Global Tool to uninstall.
|
|
+Name/ID of the NuGet package that contains the .NET tool to uninstall.
|
|
You can find the package name using the dotnet tool list command.
|
|
+.RE
|
|
.SH OPTIONS
|
|
-.PP
|
|
-\f[C]-g|--global\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-g|--global\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies that the tool to be removed is from a user-wide installation.
|
|
Can\[cq]t be combined with the \f[C]--tool-path\f[R] option.
|
|
-If you don\[cq]t specify this option, you must specify the \f[C]--tool-path\f[R] option.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
+Omitting both \f[C]--global\f[R] and \f[C]--tool-path\f[R] specifies that the tool to be removed is a local tool.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--tool-path <PATH>\f[R]
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tool-path <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Specifies the location where to uninstall the Global Tool.
|
|
+Specifies the location where to uninstall the tool.
|
|
PATH can be absolute or relative.
|
|
Can\[cq]t be combined with the \f[C]--global\f[R] option.
|
|
-If you don\[cq]t specify this option, you must specify the \f[C]--global\f[R] option.
|
|
+Omitting both \f[C]--global\f[R] and \f[C]--tool-path\f[R] specifies that the tool to be removed is a local tool.
|
|
+.RE
|
|
.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool uninstall -g dotnetsay\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Uninstalls the dotnetsay Global Tool:
|
|
-.PP
|
|
-\f[C]dotnet tool uninstall -g dotnetsay\f[R]
|
|
-.PP
|
|
-Uninstalls the dotnetsay Global Tool from a specific Windows folder:
|
|
+Uninstalls the dotnetsay (https://www.nuget.org/packages/dotnetsay/) global tool.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool uninstall dotnetsay --tool-path c:\[rs]global-tools\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet tool uninstall dotnetsay --tool-path c:\[rs]global-tools\f[R]
|
|
+Uninstalls the dotnetsay (https://www.nuget.org/packages/dotnetsay/) global tool from a specific Windows directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool uninstall dotnetsay --tool-path \[ti]/bin\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Uninstalls the dotnetsay Global Tool from a specific Linux/macOS folder:
|
|
+Uninstalls the dotnetsay (https://www.nuget.org/packages/dotnetsay/) global tool from a specific Linux/macOS directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool uninstall dotnetsay\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet tool uninstall dotnetsay --tool-path \[ti]/bin\f[R]
|
|
+Uninstalls the dotnetsay (https://www.nuget.org/packages/dotnetsay/) local tool from the current directory.
|
|
+.RE
|
|
.SS See also
|
|
.IP \[bu] 2
|
|
-\&.NET Core Global Tools
|
|
+\&.NET tools
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET global tool using the .NET CLI
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET local tool using the .NET CLI
|
|
diff --git a/documentation/manpages/sdk/dotnet-tool-update.1 b/documentation/manpages/sdk/dotnet-tool-update.1
|
|
index dc7e79611d..f8316eb8bb 100644
|
|
--- a/documentation/manpages/sdk/dotnet-tool-update.1
|
|
+++ b/documentation/manpages/sdk/dotnet-tool-update.1
|
|
@@ -1,80 +1,205 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet tool update command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet tool update
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet tool update\f[R] - Updates the specified .NET Core Global Tool on your machine.
|
|
+\f[C]dotnet tool update\f[R] - Updates the specified .NET 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>
|
|
+dotnet tool update <PACKAGE_ID> -g|--global
|
|
+ [--add-source <SOURCE>] [--configfile <FILE>]
|
|
+ [--disable-parallel] [--framework <FRAMEWORK>]
|
|
+ [--ignore-failed-sources] [--interactive] [--no-cache]
|
|
+ [-v|--verbosity <LEVEL>] [--version <VERSION>]
|
|
+
|
|
+dotnet tool update <PACKAGE_ID> --tool-path <PATH>
|
|
+ [--add-source <SOURCE>] [--configfile <FILE>]
|
|
+ [--disable-parallel] [--framework <FRAMEWORK>]
|
|
+ [--ignore-failed-sources] [--interactive] [--no-cache]
|
|
+ [-v|--verbosity <LEVEL>] [--version <VERSION>]
|
|
+
|
|
+dotnet tool update <PACKAGE_ID> --local
|
|
+ [--add-source <SOURCE>] [--configfile <FILE>]
|
|
+ [--disable-parallel] [--framework <FRAMEWORK>]
|
|
+ [--ignore-failed-sources] [--interactive] [--no-cache]
|
|
+ [--tool-manifest <PATH>]
|
|
+ [-v|--verbosity <LEVEL>] [--version <VERSION>]
|
|
+
|
|
+dotnet tool update -h|--help
|
|
\f[R]
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-The \f[C]dotnet tool update\f[R] command provides a way for you to update .NET Core Global Tools on your machine to the latest stable version of the package.
|
|
+The \f[C]dotnet tool update\f[R] command provides a way for you to update .NET 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[R] option or specify a path to where the tool is installed using the \f[C]--tool-path\f[R] option.
|
|
-.SS Arguments
|
|
+To use the command, you specify one of the following options:
|
|
+.IP \[bu] 2
|
|
+To update a global tool that was installed in the default location, use the \f[C]--global\f[R] option
|
|
+.IP \[bu] 2
|
|
+To update a global tool that was installed in a custom location, use the \f[C]--tool-path\f[R] option.
|
|
+.IP \[bu] 2
|
|
+To update a local tool, use the \f[C]--local\f[R] option.
|
|
.PP
|
|
-\f[C]PACKAGE_NAME\f[R]
|
|
+\f[B]Local tools are available starting with .NET Core SDK 3.0.\f[R]
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]PACKAGE_ID\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Name/ID of the NuGet package that contains the .NET Core Global Tool to update.
|
|
+Name/ID of the NuGet package that contains the .NET global tool to update.
|
|
You can find the package name using the dotnet tool list command.
|
|
+.RE
|
|
.SH OPTIONS
|
|
-.PP
|
|
-\f[C]--add-source <SOURCE>\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--add-source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Adds an additional NuGet package source to use during installation.
|
|
+Feeds are accessed in parallel, not sequentially in some order of precedence.
|
|
+If the same package and version is in multiple feeds, the fastest feed wins.
|
|
+For more information, see What happens when a NuGet package is installed?.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--disable-parallel\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--configfile <FILE>\f[R]
|
|
-.PP
|
|
-The NuGet configuration (\f[I]nuget.config\f[R]) file to use.
|
|
-.PP
|
|
-\f[C]--framework <FRAMEWORK>\f[R]
|
|
+Prevent restoring multiple projects in parallel.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies the target framework to update the tool for.
|
|
-.PP
|
|
-\f[C]-g|--global\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-g|--global\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies that the update is for a user-wide tool.
|
|
Can\[cq]t be combined with the \f[C]--tool-path\f[R] option.
|
|
-If you don\[cq]t specify this option, you must specify the \f[C]--tool-path\f[R] option.
|
|
+Omitting both \f[C]--global\f[R] and \f[C]--tool-path\f[R] specifies that the tool to be updated is a local tool.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ignore-failed-sources\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Treat package source failures as warnings.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--local\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Prints out a short help for the command.
|
|
+Update the tool and the local tool manifest.
|
|
+Can\[cq]t be combined with the \f[C]--global\f[R] option or the \f[C]--tool-path\f[R] option.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-cache\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Do not cache packages and HTTP requests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tool-manifest <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--tool-path <PATH>\f[R]
|
|
+Path to the manifest file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--tool-path <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Specifies the location where the Global Tool is installed.
|
|
+Specifies the location where the global tool is installed.
|
|
PATH can be absolute or relative.
|
|
Can\[cq]t be combined with the \f[C]--global\f[R] option.
|
|
-If you don\[cq]t specify this option, you must specify the \f[C]--global\f[R] option.
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
+Omitting both \f[C]--global\f[R] and \f[C]--tool-path\f[R] specifies that the tool to be updated is a local tool.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Sets the verbosity level of the command.
|
|
Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--version <VERSION>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The version range of the tool package to update to.
|
|
+This cannot be used to downgrade versions, you must \f[C]uninstall\f[R] newer versions first.
|
|
+.RE
|
|
.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool update -g dotnetsay\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Updates the dotnetsay Global Tool:
|
|
+Updates the dotnetsay (https://www.nuget.org/packages/dotnetsay/) global tool.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool update dotnetsay --tool-path c:\[rs]global-tools\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet tool update -g dotnetsay\f[R]
|
|
+Updates the dotnetsay (https://www.nuget.org/packages/dotnetsay/) global tool located in a specific Windows directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool update dotnetsay --tool-path \[ti]/bin\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Updates the dotnetsay Global Tool located on a specific Windows folder:
|
|
+Updates the dotnetsay (https://www.nuget.org/packages/dotnetsay/) global tool located in a specific Linux/macOS directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool update dotnetsay\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet tool update dotnetsay --tool-path c:\[rs]global-tools\f[R]
|
|
+Updates the dotnetsay (https://www.nuget.org/packages/dotnetsay/) local tool installed for the current directory.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool update -g dotnetsay --version 2.0.*\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Updates the dotnetsay Global Tool located on a specific Linux/macOS folder:
|
|
+Updates the dotnetsay (https://www.nuget.org/packages/dotnetsay/) global tool to the latest patch version, with a major version of \f[C]2\f[R], and a minor version of \f[C]0\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]dotnet tool update -g dotnetsay --version (2.0.*,2.1.4)\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet tool update dotnetsay --tool-path \[ti]/bin\f[R]
|
|
+Updates the dotnetsay (https://www.nuget.org/packages/dotnetsay/) global tool to the lowest version within the specified range \f[C](> 2.0.0 && < 2.1.4)\f[R], version \f[C]2.1.0\f[R] would be installed.
|
|
+For more information on semantic versioning ranges, see NuGet packaging version ranges.
|
|
+.RE
|
|
.SS See also
|
|
.IP \[bu] 2
|
|
-\&.NET Core Global Tools
|
|
+\&.NET tools
|
|
+.IP \[bu] 2
|
|
+Semantic versioning (https://semver.org)
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET global tool using the .NET CLI
|
|
+.IP \[bu] 2
|
|
+Tutorial: Install and use a .NET local tool using the .NET CLI
|
|
diff --git a/documentation/manpages/sdk/dotnet-vstest.1 b/documentation/manpages/sdk/dotnet-vstest.1
|
|
index 0e61fa8643..565f487c47 100644
|
|
--- a/documentation/manpages/sdk/dotnet-vstest.1
|
|
+++ b/documentation/manpages/sdk/dotnet-vstest.1
|
|
@@ -1,97 +1,85 @@
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet vstest command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet vstest
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
+.RS
|
|
+.PP
|
|
+[!IMPORTANT] The \f[C]dotnet vstest\f[R] command is superseded by \f[C]dotnet test\f[R], which can now be used to run assemblies.
|
|
+See \f[C]dotnet test\f[R].
|
|
+.RE
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet-vstest\f[R] - Runs tests from the specified files.
|
|
+\f[C]dotnet-vstest\f[R] - Runs tests from the specified assemblies.
|
|
.SH SYNOPSIS
|
|
-.SS .NET Core 2.1
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet vstest [<TEST_FILE_NAMES>] [--Settings|/Settings] [--Tests|/Tests] [--TestAdapterPath|/TestAdapterPath]
|
|
- [--Platform|/Platform] [--Framework|/Framework] [--Parallel|/Parallel] [--TestCaseFilter|/TestCaseFilter] [--logger|/logger]
|
|
- [-lt|--ListTests|/lt|/ListTests] [--ParentProcessId|/ParentProcessId] [--Port|/Port] [--Diag|/Diag] [--Blame|/Blame] [--InIsolation|/InIsolation]
|
|
- [[--] <args>...]] [-?|--Help|/?|/Help]
|
|
-\f[R]
|
|
-.fi
|
|
-.SS .NET Core 2.0
|
|
-.IP
|
|
-.nf
|
|
-\f[C]
|
|
-dotnet vstest [<TEST_FILE_NAMES>] [--Settings|/Settings] [--Tests|/Tests] [--TestAdapterPath|/TestAdapterPath]
|
|
- [--Platform|/Platform] [--Framework|/Framework] [--Parallel|/Parallel] [--TestCaseFilter|/TestCaseFilter] [--logger|/logger]
|
|
- [-lt|--ListTests|/lt|/ListTests] [--ParentProcessId|/ParentProcessId] [--Port|/Port] [--Diag|/Diag] [[--] <args>...]] [-?|--Help|/?|/Help]
|
|
-\f[R]
|
|
-.fi
|
|
-.SS .NET Core 1.x
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet vstest [<TEST_FILE_NAMES>] [--Settings|/Settings] [--Tests|/Tests] [--TestAdapterPath|/TestAdapterPath]
|
|
- [--Platform|/Platform] [--Framework|/Framework] [--Parallel|/Parallel] [--TestCaseFilter|/TestCaseFilter] [--logger|/logger]
|
|
- [-lt|--ListTests|/lt|/ListTests] [--ParentProcessId|/ParentProcessId] [--Port|/Port] [--Diag|/Diag] [[--] <args>...]] [-?|--Help|/?|/Help]
|
|
+dotnet vstest [<TEST_FILE_NAMES>] [--Blame] [--Diag <PATH_TO_LOG_FILE>]
|
|
+ [--Framework <FRAMEWORK>] [--InIsolation] [-lt|--ListTests <FILE_NAME>]
|
|
+ [--logger <LOGGER_URI/FRIENDLY_NAME>] [--Parallel]
|
|
+ [--ParentProcessId <PROCESS_ID>] [--Platform] <PLATFORM_TYPE>
|
|
+ [--Port <PORT>] [--ResultsDirectory<PATH>] [--Settings <SETTINGS_FILE>]
|
|
+ [--TestAdapterPath <PATH>] [--TestCaseFilter <EXPRESSION>]
|
|
+ [--Tests <TEST_NAMES>] [[--] <args>...]]
|
|
+
|
|
+dotnet vstest -?|--Help
|
|
\f[R]
|
|
.fi
|
|
-.PP
|
|
- * * * * *
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \f[C]dotnet-vstest\f[R] command runs the \f[C]VSTest.Console\f[R] command-line application to run automated unit tests.
|
|
.SS Arguments
|
|
-.PP
|
|
-\f[C]TEST_FILE_NAMES\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]TEST_FILE_NAMES\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Run tests from the specified assemblies.
|
|
Separate multiple test assembly names with spaces.
|
|
+Wildcards are supported.
|
|
+.RE
|
|
.SH OPTIONS
|
|
-.SS .NET Core 2.1
|
|
-.PP
|
|
-\f[C]--Settings|/Settings:<Settings File>\f[R]
|
|
-.PP
|
|
-Settings to use when running tests.
|
|
-.PP
|
|
-\f[C]--Tests|/Tests:<Test Names>\f[R]
|
|
-.PP
|
|
-Run tests with names that match the provided values.
|
|
-Separate multiple values with commas.
|
|
-.PP
|
|
-\f[C]--TestAdapterPath|/TestAdapterPath\f[R]
|
|
-.PP
|
|
-Use custom test adapters from a given path (if any) in the test run.
|
|
-.PP
|
|
-\f[C]--Platform|/Platform:<Platform type>\f[R]
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--Blame\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Target platform architecture used for test execution.
|
|
-Valid values are \f[C]x86\f[R], \f[C]x64\f[R], and \f[C]ARM\f[R].
|
|
+Runs the tests in blame mode.
|
|
+This option is helpful in isolating the problematic tests causing test host to crash.
|
|
+It creates an output file in the current directory as \f[I]Sequence.xml\f[R] that captures the order of tests execution before the crash.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--Diag <PATH_TO_LOG_FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--Framework|/Framework:<Framework Version>\f[R]
|
|
+Enables verbose logs for the test platform.
|
|
+Logs are written to the provided file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--Framework <FRAMEWORK>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Target .NET Framework version used for test execution.
|
|
Examples of valid values are \f[C].NETFramework,Version=v4.6\f[R] or \f[C].NETCoreApp,Version=v1.0\f[R].
|
|
Other supported values are \f[C]Framework40\f[R], \f[C]Framework45\f[R], \f[C]FrameworkCore10\f[R], and \f[C]FrameworkUap10\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--InIsolation\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--Parallel|/Parallel\f[R]
|
|
-.PP
|
|
-Execute tests in parallel.
|
|
-By default, all available cores on the machine are available for use.
|
|
-Specify an explicit number of cores by setting the MaxCpuCount property under the RunConfiguration node in the runsettings file.
|
|
-.PP
|
|
-\f[C]--TestCaseFilter|/TestCaseFilter:<Expression>\f[R]
|
|
-.PP
|
|
-Run tests that match the given expression.
|
|
-\f[C]<Expression>\f[R] is of the format \f[C]<property>Operator<value>[|&<Expression>]\f[R], where Operator is one of \f[C]=\f[R], \f[C]!=\f[R], or \f[C]\[ti]\f[R].
|
|
-Operator \f[C]\[ti]\f[R] has `contains' semantics and is applicable for string properties like \f[C]DisplayName\f[R].
|
|
-Parenthesis \f[C]()\f[R] are used to group sub-expressions.
|
|
-.PP
|
|
-\f[C]-?|--Help|/?|/Help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
+Runs the tests in an isolated process.
|
|
+This makes \f[I]vstest.console.exe\f[R] process less likely to be stopped on an error in the tests, but tests may run slower.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-lt|--ListTests <FILE_NAME>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--logger|/logger:<Logger Uri/FriendlyName>\f[R]
|
|
+Lists all discovered tests from the given test container.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--logger <LOGGER_URI/FRIENDLY_NAME>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specify a logger for test results.
|
|
.IP \[bu] 2
|
|
@@ -122,260 +110,130 @@ If \f[C]LogFileName\f[R] isn\[cq]t provided, a unique file name is created to ho
|
|
\f[R]
|
|
.fi
|
|
.RE
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--Parallel\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-lt|--ListTests|/lt|/ListTests:<File Name>\f[R]
|
|
-.PP
|
|
-Lists all discovered tests from the given test container.
|
|
-.PP
|
|
-\f[C]--ParentProcessId|/ParentProcessId:<ParentProcessId>\f[R]
|
|
+Run tests in parallel.
|
|
+By default, all available cores on the machine are available for use.
|
|
+Specify an explicit number of cores by setting the \f[C]MaxCpuCount\f[R] property under the \f[C]RunConfiguration\f[R] node in the \f[I]runsettings\f[R] file.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ParentProcessId <PROCESS_ID>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Process ID of the parent process responsible for launching the current process.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--Platform <PLATFORM_TYPE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--Port|/Port:<Port>\f[R]
|
|
+Target platform architecture used for test execution.
|
|
+Valid values are \f[C]x86\f[R], \f[C]x64\f[R], and \f[C]ARM\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--Port <PORT>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Specifies the port for the socket connection and receiving the event messages.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ResultsDirectory:<PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--Diag|/Diag:<Path to log file>\f[R]
|
|
-.PP
|
|
-Enables verbose logs for the test platform.
|
|
-Logs are written to the provided file.
|
|
-.PP
|
|
-\f[C]--Blame|/Blame\f[R]
|
|
-.PP
|
|
-Runs the tests in blame mode.
|
|
-This option is helpful in isolating the problematic tests causing test host to crash.
|
|
-It creates an output file in the current directory as \f[I]Sequence.xml\f[R] that captures the order of tests execution before the crash.
|
|
-.PP
|
|
-\f[C]--InIsolation|/InIsolation\f[R]
|
|
-.PP
|
|
-Runs the tests in an isolated process.
|
|
-This makes \f[I]vstest.console.exe\f[R] process less likely to be stopped on an error in the tests, but tests may run slower.
|
|
-.PP
|
|
-\f[C]\[at]<file>\f[R]
|
|
-.PP
|
|
-Reads response file for more options.
|
|
-.PP
|
|
-\f[C]args\f[R]
|
|
-.PP
|
|
-Specifies extra arguments to pass to the adapter.
|
|
-Arguments are specified as name-value pairs of the form \f[C]<n>=<v>\f[R], where \f[C]<n>\f[R] is the argument name and \f[C]<v>\f[R] is the argument value.
|
|
-Use a space to separate multiple arguments.
|
|
-.SS .NET Core 2.0
|
|
-.PP
|
|
-\f[C]--Settings|/Settings:<Settings File>\f[R]
|
|
+Test results directory will be created in specified path if not exists.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--Settings <SETTINGS_FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Settings to use when running tests.
|
|
-.PP
|
|
-\f[C]--Tests|/Tests:<Test Names>\f[R]
|
|
-.PP
|
|
-Run tests with names that match the provided values.
|
|
-Separate multiple values with commas.
|
|
-.PP
|
|
-\f[C]--TestAdapterPath|/TestAdapterPath\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--TestAdapterPath <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Use custom test adapters from a given path (if any) in the test run.
|
|
-.PP
|
|
-\f[C]--Platform|/Platform:<Platform type>\f[R]
|
|
-.PP
|
|
-Target platform architecture used for test execution.
|
|
-Valid values are \f[C]x86\f[R], \f[C]x64\f[R], and \f[C]ARM\f[R].
|
|
-.PP
|
|
-\f[C]--Framework|/Framework:<Framework Version>\f[R]
|
|
-.PP
|
|
-Target .NET Framework version used for test execution.
|
|
-Examples of valid values are \f[C].NETFramework,Version=v4.6\f[R] or \f[C].NETCoreApp,Version=v1.0\f[R].
|
|
-Other supported values are \f[C]Framework40\f[R], \f[C]Framework45\f[R], and \f[C]FrameworkCore10\f[R].
|
|
-.PP
|
|
-\f[C]--Parallel|/Parallel\f[R]
|
|
-.PP
|
|
-Execute tests in parallel.
|
|
-By default, all available cores on the machine are available for use.
|
|
-Specify an explicit number of cores by setting the MaxCpuCount property under the RunConfiguration node in the runsettings file.
|
|
-.PP
|
|
-\f[C]--TestCaseFilter|/TestCaseFilter:<Expression>\f[R]
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--TestCaseFilter <EXPRESSION>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Run tests that match the given expression.
|
|
-\f[C]<Expression>\f[R] is of the format \f[C]<property>Operator<value>[|&<Expression>]\f[R], where Operator is one of \f[C]=\f[R], \f[C]!=\f[R], or \f[C]\[ti]\f[R].
|
|
+\f[C]<EXPRESSION>\f[R] is of the format \f[C]<property>Operator<value>[|&<EXPRESSION>]\f[R], where Operator is one of \f[C]=\f[R], \f[C]!=\f[R], or \f[C]\[ti]\f[R].
|
|
Operator \f[C]\[ti]\f[R] has `contains' semantics and is applicable for string properties like \f[C]DisplayName\f[R].
|
|
-Parenthesis \f[C]()\f[R] are used to group sub-expressions.
|
|
+Parentheses \f[C]()\f[R] are used to group subexpressions.
|
|
+For more information, see TestCase filter (https://github.com/Microsoft/vstest-docs/blob/master/docs/filter.md).
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--Tests <TEST_NAMES>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-?|--Help|/?|/Help\f[R]
|
|
+Run tests with names that match the provided values.
|
|
+Separate multiple values with commas.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|--Help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Prints out a short help for the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]\[at]<file>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--logger|/logger:<Logger Uri/FriendlyName>\f[R]
|
|
-.PP
|
|
-Specify a logger for test results.
|
|
+Reads response file for more options.
|
|
+.RE
|
|
.IP \[bu] 2
|
|
-To publish test results to Team Foundation Server, use the \f[C]TfsPublisher\f[R] logger provider:
|
|
+\f[B]\f[CB]args\f[B]\f[R]
|
|
.RS 2
|
|
+.PP
|
|
+Specifies extra arguments to pass to the adapter.
|
|
+Arguments are specified as name-value pairs of the form \f[C]<n>=<v>\f[R], where \f[C]<n>\f[R] is the argument name and \f[C]<v>\f[R] is the argument value.
|
|
+Use a space to separate multiple arguments.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.PP
|
|
+Run tests in \f[I]mytestproject.dll\f[R]:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-/logger:TfsPublisher;
|
|
- Collection=<team project collection url>;
|
|
- BuildName=<build name>;
|
|
- TeamProject=<team project name>
|
|
- [;Platform=<Defaults to \[dq]Any CPU\[dq]>]
|
|
- [;Flavor=<Defaults to \[dq]Debug\[dq]>]
|
|
- [;RunTitle=<title>]
|
|
+dotnet vstest mytestproject.dll
|
|
\f[R]
|
|
.fi
|
|
-.RE
|
|
-.IP \[bu] 2
|
|
-To log results to a Visual Studio Test Results File (TRX), use the \f[C]trx\f[R] logger provider.
|
|
-This switch creates a file in the test results directory with given log file name.
|
|
-If \f[C]LogFileName\f[R] isn\[cq]t provided, a unique file name is created to hold the test results.
|
|
-.RS 2
|
|
+.PP
|
|
+Run tests in \f[I]mytestproject.dll\f[R], exporting to custom folder with custom name:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-/logger:trx [;LogFileName=<Defaults to unique file name>]
|
|
+dotnet vstest mytestproject.dll --logger:\[dq]trx;LogFileName=custom_file_name.trx\[dq] --ResultsDirectory:custom/file/path
|
|
\f[R]
|
|
.fi
|
|
-.RE
|
|
-.PP
|
|
-\f[C]-lt|--ListTests|/lt|/ListTests:<File Name>\f[R]
|
|
-.PP
|
|
-Lists all discovered tests from the given test container.
|
|
-.PP
|
|
-\f[C]--ParentProcessId|/ParentProcessId:<ParentProcessId>\f[R]
|
|
-.PP
|
|
-Process ID of the parent process responsible for launching the current process.
|
|
-.PP
|
|
-\f[C]--Port|/Port:<Port>\f[R]
|
|
-.PP
|
|
-Specifies the port for the socket connection and receiving the event messages.
|
|
-.PP
|
|
-\f[C]--Diag|/Diag:<Path to log file>\f[R]
|
|
-.PP
|
|
-Enables verbose logs for the test platform.
|
|
-Logs are written to the provided file.
|
|
-.PP
|
|
-\f[C]args\f[R]
|
|
-.PP
|
|
-Specifies extra arguments to pass to the adapter.
|
|
-Arguments are specified as name-value pairs of the form \f[C]<n>=<v>\f[R], where \f[C]<n>\f[R] is the argument name and \f[C]<v>\f[R] is the argument value.
|
|
-Use a space to separate multiple arguments.
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-\f[C]--Settings|/Settings:<Settings File>\f[R]
|
|
-.PP
|
|
-Settings to use when running tests.
|
|
-.PP
|
|
-\f[C]--Tests|/Tests:<Test Names>\f[R]
|
|
-.PP
|
|
-Run tests with names that match the provided values.
|
|
-Separate multiple values with commas.
|
|
-.PP
|
|
-\f[C]--TestAdapterPath|/TestAdapterPath\f[R]
|
|
-.PP
|
|
-Use custom test adapters from a given path (if any) in the test run.
|
|
-.PP
|
|
-\f[C]--Platform|/Platform:<Platform type>\f[R]
|
|
-.PP
|
|
-Target platform architecture used for test execution.
|
|
-Valid values are \f[C]x86\f[R], \f[C]x64\f[R], and \f[C]ARM\f[R].
|
|
-.PP
|
|
-\f[C]--Framework|/Framework:<Framework Version>\f[R]
|
|
-.PP
|
|
-Target .NET Framework version used for test execution.
|
|
-Examples of valid values are \f[C].NETFramework,Version=v4.6\f[R] or \f[C].NETCoreApp,Version=v1.0\f[R].
|
|
-Other supported values are \f[C]Framework40\f[R], \f[C]Framework45\f[R], and \f[C]FrameworkCore10\f[R].
|
|
.PP
|
|
-\f[C]--Parallel|/Parallel\f[R]
|
|
-.PP
|
|
-Execute tests in parallel.
|
|
-By default, all available cores on the machine are available for use.
|
|
-Specify an explicit number of cores by setting the MaxCpuCount property under the RunConfiguration node in the runsettings file.
|
|
-.PP
|
|
-\f[C]--TestCaseFilter|/TestCaseFilter:<Expression>\f[R]
|
|
-.PP
|
|
-Run tests that match the given expression.
|
|
-\f[C]<Expression>\f[R] is of the format \f[C]<property>Operator<value>[|&<Expression>]\f[R], where Operator is one of \f[C]=\f[R], \f[C]!=\f[R], or \f[C]\[ti]\f[R].
|
|
-Operator \f[C]\[ti]\f[R] has `contains' semantics and is applicable for string properties like \f[C]DisplayName\f[R].
|
|
-Parenthesis \f[C]()\f[R] are used to group sub-expressions.
|
|
-.PP
|
|
-\f[C]-?|--Help|/?|/Help\f[R]
|
|
-.PP
|
|
-Prints out a short help for the command.
|
|
-.PP
|
|
-\f[C]--logger|/logger:<Logger Uri/FriendlyName>\f[R]
|
|
-.PP
|
|
-Specify a logger for test results.
|
|
-.IP \[bu] 2
|
|
-To publish test results to Team Foundation Server, use the \f[C]TfsPublisher\f[R] logger provider:
|
|
-.RS 2
|
|
+Run tests in \f[I]mytestproject.dll\f[R] and \f[I]myothertestproject.exe\f[R]:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-/logger:TfsPublisher;
|
|
- Collection=<team project collection url>;
|
|
- BuildName=<build name>;
|
|
- TeamProject=<team project name>
|
|
- [;Platform=<Defaults to \[dq]Any CPU\[dq]>]
|
|
- [;Flavor=<Defaults to \[dq]Debug\[dq]>]
|
|
- [;RunTitle=<title>]
|
|
+dotnet vstest mytestproject.dll myothertestproject.exe
|
|
\f[R]
|
|
.fi
|
|
-.RE
|
|
-.IP \[bu] 2
|
|
-To log results to a Visual Studio Test Results File (TRX), use the \f[C]trx\f[R] logger provider.
|
|
-This switch creates a file in the test results directory with given log file name.
|
|
-If \f[C]LogFileName\f[R] isn\[cq]t provided, a unique file name is created to hold the test results.
|
|
-.RS 2
|
|
+.PP
|
|
+Run \f[C]TestMethod1\f[R] tests:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-/logger:trx [;LogFileName=<Defaults to unique file name>]
|
|
+dotnet vstest /Tests:TestMethod1
|
|
\f[R]
|
|
.fi
|
|
-.RE
|
|
-.PP
|
|
-\f[C]-lt|--ListTests|/lt|/ListTests:<File Name>\f[R]
|
|
-.PP
|
|
-Lists all discovered tests from the given test container.
|
|
-.PP
|
|
-\f[C]--ParentProcessId|/ParentProcessId:<ParentProcessId>\f[R]
|
|
-.PP
|
|
-Process ID of the parent process responsible for launching the current process.
|
|
-.PP
|
|
-\f[C]--Port|/Port:<Port>\f[R]
|
|
-.PP
|
|
-Specifies the port for the socket connection and receiving the event messages.
|
|
-.PP
|
|
-\f[C]--Diag|/Diag:<Path to log file>\f[R]
|
|
-.PP
|
|
-Enables verbose logs for the test platform.
|
|
-Logs are written to the provided file.
|
|
-.PP
|
|
-\f[C]args\f[R]
|
|
-.PP
|
|
-Specifies extra arguments to pass to the adapter.
|
|
-Arguments are specified as name-value pairs of the form \f[C]<n>=<v>\f[R], where \f[C]<n>\f[R] is the argument name and \f[C]<v>\f[R] is the argument value.
|
|
-Use a space to separate multiple arguments.
|
|
-.PP
|
|
- * * * * *
|
|
-.SH EXAMPLES
|
|
-.PP
|
|
-Run tests in \f[C]mytestproject.dll\f[R]:
|
|
-.PP
|
|
-\f[C]dotnet vstest mytestproject.dll\f[R]
|
|
-.PP
|
|
-Run tests in \f[C]mytestproject.dll\f[R], exporting to custom folder with custom name:
|
|
-.PP
|
|
-\f[C]dotnet vstest mytestproject.dll --logger:\[dq]trx;LogFileName=custom_file_name.trx\[dq] --ResultsDirectory:custom/file/path\f[R]
|
|
-.PP
|
|
-Run tests in \f[C]mytestproject.dll\f[R] and \f[C]myothertestproject.exe\f[R]:
|
|
-.PP
|
|
-\f[C]dotnet vstest mytestproject.dll myothertestproject.exe\f[R]
|
|
-.PP
|
|
-Run \f[C]TestMethod1\f[R] tests:
|
|
-.PP
|
|
-\f[C]dotnet vstest /Tests:TestMethod1\f[R]
|
|
.PP
|
|
Run \f[C]TestMethod1\f[R] and \f[C]TestMethod2\f[R] tests:
|
|
-.PP
|
|
-\f[C]dotnet vstest /Tests:TestMethod1,TestMethod2\f[R]
|
|
-.SH AUTHORS
|
|
-mairaw.
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet vstest /Tests:TestMethod1,TestMethod2
|
|
+\f[R]
|
|
+.fi
|
|
+.SS See also
|
|
+.IP \[bu] 2
|
|
+VSTest.Console.exe command-line options
|
|
diff --git a/documentation/manpages/sdk/dotnet-workload-install.1 b/documentation/manpages/sdk/dotnet-workload-install.1
|
|
new file mode 100644
|
|
index 0000000000..faa1b06aff
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-workload-install.1
|
|
@@ -0,0 +1,196 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet workload install
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 Preview SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet workload install\f[R] - Installs optional workloads.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload install <WORKLOAD_ID>...
|
|
+ [--configfile <FILE>] [--disable-parallel]
|
|
+ [--ignore-failed-sources] [--include-previews] [--interactive]
|
|
+ [--no-cache] [--skip-manifest-update]
|
|
+ [--source <SOURCE>] [--temp-dir <PATH>] [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet workload install -?|-h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet workload install\f[R] command installs one or more \f[I]optional workloads\f[R].
|
|
+Optional workloads can be installed on top of the .NET SDK to provide support for various application types, such as .NET MAUI and Blazor WebAssembly AOT (https://devblogs.microsoft.com/aspnet/asp-net-core-updates-in-net-6-preview-4/#blazor-webassembly-ahead-of-time-aot-compilation).
|
|
+.PP
|
|
+Use dotnet workload search to learn what workloads are available to install.
|
|
+.SS When to run elevated
|
|
+.PP
|
|
+For macOS and Linux SDK installations that are installed to a protected directory, the command needs to run elevated (use the \f[C]sudo\f[R] command).
|
|
+On Windows, the command doesn\[cq]t need to run elevated even if the SDK is installed to the \f[I]Program Files\f[R] directory.
|
|
+For Windows, the command uses MSI installers for that location.
|
|
+.SS Results vary by SDK version
|
|
+.PP
|
|
+The \f[C]dotnet workload\f[R] commands operate in the context of specific SDK versions.
|
|
+Suppose you have both .NET 6.0.100 SDK and .NET 6.0.200 SDK installed.
|
|
+The \f[C]dotnet workload\f[R] commands will give different results depending on which SDK version you select.
|
|
+This behavior applies to major and minor version and feature band differences, not to patch version differences.
|
|
+For example, .NET SDK 6.0.101 and 6.0.102 give the same results, whereas 6.0.100 and 6.0.200 give different results.
|
|
+You can specify the SDK version by using the \f[I]global.json\f[R] file or the \f[C]--sdk-version\f[R] option of the \f[C]dotnet workload\f[R] commands.
|
|
+.SS Advertising manifests
|
|
+.PP
|
|
+The names and versions of the assets that a workload installation requires are maintained in \f[I]manifests\f[R].
|
|
+By default, the \f[C]dotnet workload install\f[R] command downloads the latest available manifests before it installs a workload.
|
|
+The local copy of a manifest then provides the information needed to find and download the assets for a workload.
|
|
+.PP
|
|
+The \f[C]dotnet workload list\f[R] command compares the versions of installed workloads with the currently available versions.
|
|
+When it finds that a version newer than the installed version is available, it advertises that fact in the command output.
|
|
+These newer-version notifications in \f[C]dotnet workload list\f[R] are available starting in .NET 6 Preview 7.
|
|
+.PP
|
|
+To enable these notifications, the latest available versions of the manifests are downloaded and stored as \f[I]advertising manifests\f[R].
|
|
+These downloads happen asynchronously in the background when any of the following commands are run.
|
|
+.IP \[bu] 2
|
|
+dotnet build
|
|
+.IP \[bu] 2
|
|
+dotnet pack
|
|
+.IP \[bu] 2
|
|
+dotnet publish
|
|
+.IP \[bu] 2
|
|
+dotnet restore
|
|
+.IP \[bu] 2
|
|
+dotnet run
|
|
+.IP \[bu] 2
|
|
+dotnet test
|
|
+.PP
|
|
+If a command finishes before the manifest download finishes, the download is stopped.
|
|
+The download is tried again the next time one of these commands is run.
|
|
+You can set environment variables to disable these background downloads or control their frequency.
|
|
+By default, they don\[cq]t happen more than once a day.
|
|
+.PP
|
|
+You can prevent the \f[C]dotnet workload install\f[R] command from doing manifest downloads by using the \f[C]--skip-manifest-update\f[R] option.
|
|
+.PP
|
|
+The \f[C]dotnet workload update\f[R] command also downloads advertising manifests.
|
|
+The downloads are required to learn if an update is available, so there is no option to prevent them from running.
|
|
+However, you can use the \f[C]--advertising-manifests-only\f[R] option to skip workload updates and only do the manifest downloads.
|
|
+This option is available starting in .NET 6 Preview 7.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]WORKLOAD_ID\f[B]\&...\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The workload ID or multiple IDs to install.
|
|
+Use dotnet workload search to learn what workloads are available.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--disable-parallel\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prevents restoring multiple projects in parallel.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ignore-failed-sources\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Treats package source failures as warnings.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--include-previews\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows prerelease workload manifests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-cache\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prevents caching of packages and http requests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--skip-manifest-update\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Skip updating the workload manifests.
|
|
+The workload manifests define what assets and versions need to be installed for each workload.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-s|--source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the URI of the NuGet package source to use.
|
|
+This setting overrides all of the sources specified in the \f[I]nuget.config\f[R] files.
|
|
+Multiple sources can be provided by specifying this option multiple times.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--temp-dir <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specify the temporary directory used to download and extract NuGet packages (must be secure).
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+If you specify specify \f[C]detailed\f[R] or \f[C]diagnostic\f[R] verbosity, the command displays information about the Nuget packages that it downloads.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Install the \f[C]maui\f[R] workload:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload install maui
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Install the \f[C]maui-android\f[R] and \f[C]maui-ios\f[R] workloads:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload install maui-android maui-ios
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Download assets needed for the \f[C]maui\f[R] workload to a cache located in the \f[I]workload-cache\f[R] directory under the current directory.
|
|
+Then install it from the same cache location:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload install maui --download-to-cache ./workload-cache
|
|
+dotnet workload install maui --from-cache ./workload-cache
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-workload-list.1 b/documentation/manpages/sdk/dotnet-workload-list.1
|
|
new file mode 100644
|
|
index 0000000000..07be8927c6
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-workload-list.1
|
|
@@ -0,0 +1,51 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet workload list
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 Preview SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet workload list\f[R] - Lists installed workloads.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload list [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet workload list [-?|-h|--help]
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet workload list\f[R] command lists all installed workloads.
|
|
+.PP
|
|
+For more information about the \f[C]dotnet workload\f[R] commands, see the dotnet workload install command.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+List the installed workloads:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload list
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-workload-repair.1 b/documentation/manpages/sdk/dotnet-workload-repair.1
|
|
new file mode 100644
|
|
index 0000000000..40f22f8a2b
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-workload-repair.1
|
|
@@ -0,0 +1,118 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet workload repair
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 Preview SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet workload repair\f[R] - Repairs workloads installations.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload repair
|
|
+ [--configfile] [--disable-parallel] [--ignore-failed-sources]
|
|
+ [--interactive] [--no-cache]
|
|
+ [-s|--source <SOURCE>] [--temp-dir <PATH>]
|
|
+ [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet workload repair -?|-h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet workload repair\f[R] command reinstalls all installed workloads.
|
|
+Workloads are made up of multiple workload packs and it\[cq]s possible to get into a state where some installed successfully but others didn\[cq]t.
|
|
+For example, a \f[C]dotnet workload install\f[R] command might not finish installing because of a dropped internet connection.
|
|
+.PP
|
|
+For more information about the \f[C]dotnet workload\f[R] commands, see the dotnet workload install command.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]WORKLOAD_ID\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The workload ID of the workload to repair.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--disable-parallel\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prevents restoring multiple projects in parallel.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ignore-failed-sources\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Treats package source failures as warnings.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--include-previews\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows prerelease workload manifests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-cache\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prevents caching of packages and http requests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-s|--source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the URI of the NuGet package source to use.
|
|
+This setting overrides all of the sources specified in the \f[I]nuget.config\f[R] files.
|
|
+Multiple sources can be provided by specifying this option multiple times.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--temp-dir <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specify the temporary directory used to download and extract NuGet packages (must be secure).
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Repair all installed workloads:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload repair
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-workload-restore.1 b/documentation/manpages/sdk/dotnet-workload-restore.1
|
|
new file mode 100644
|
|
index 0000000000..0281407a5c
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-workload-restore.1
|
|
@@ -0,0 +1,124 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet workload restore
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 Preview SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet workload restore\f[R] - Installs workloads needed for a project or a solution.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload restore [<PROJECT | SOLUTION>]
|
|
+ [--configfile <FILE>] [--disable-parallel]
|
|
+ [--ignore-failed-sources] [--include-previews] [--interactive]
|
|
+ [--no-cache] [--skip-manifest-update]
|
|
+ [-s|--source <SOURCE>] [--temp-dir <PATH>] [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet workload restore -?|-h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet workload restore\f[R] command analyzes a project or solution to determine which workloads it needs, then installs any workloads that are missing.
|
|
+.PP
|
|
+For more information about the \f[C]dotnet workload\f[R] commands, see the dotnet workload install command.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]PROJECT | SOLUTION\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The project or solution file to install workloads for.
|
|
+If a file is not specified, the command searches the current directory for one.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--disable-parallel\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prevents restoring multiple projects in parallel.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ignore-failed-sources\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Treats package source failures as warnings.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--include-previews\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows prerelease workload manifests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-cache\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prevents caching of packages and http requests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--skip-manifest-update\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Skip updating the workload manifests.
|
|
+The workload manifests define what assets and versions need to be installed for each workload.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-s|--source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the URI of the NuGet package source to use.
|
|
+This setting overrides all of the sources specified in the \f[I]nuget.config\f[R] files.
|
|
+Multiple sources can be provided by specifying this option multiple times.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--temp-dir <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specify the temporary directory used to download and extract NuGet packages (must be secure).
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SS Example
|
|
+.IP \[bu] 2
|
|
+Restore workloads needed by MyApp.csproj:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload restore MyApp.csproj
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-workload-search.1 b/documentation/manpages/sdk/dotnet-workload-search.1
|
|
new file mode 100644
|
|
index 0000000000..ff9ffc840d
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-workload-search.1
|
|
@@ -0,0 +1,70 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet workload search
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 Preview SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet workload search\f[R] - Searches for optional workloads.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload search [<SEARCH_STRING>] [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet workload search -?|-h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet workload search\f[R] command lists available workloads.
|
|
+You can filter the list by specifying all or part of the workload ID you\[cq]re looking for.
|
|
+.PP
|
|
+For more information about the \f[C]dotnet workload\f[R] commands, see the dotnet workload install command.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]SEARCH_STRING\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The workload ID to search for, or part of it.
|
|
+For example, if you specify \f[C]maui\f[R], the command lists all of the workload IDs that have \f[C]maui\f[R] in their workload ID.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+List all available workloads:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload search
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+List all available workloads that have \[lq]maui\[rq] in their workload ID:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload search maui
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-workload-uninstall.1 b/documentation/manpages/sdk/dotnet-workload-uninstall.1
|
|
new file mode 100644
|
|
index 0000000000..1bbbfcf98e
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-workload-uninstall.1
|
|
@@ -0,0 +1,59 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet workload uninstall
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 Preview SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet workload uninstall\f[R] - Uninstalls a specified workload.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload uninstall <WORKLOAD_ID...>
|
|
+
|
|
+dotnet workload uninstall -?|-h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet workload uninstall\f[R] command uninstalls one or more workloads.
|
|
+.PP
|
|
+For more information about the \f[C]dotnet workload\f[R] commands, see the dotnet workload install command.
|
|
+.SS Arguments
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]WORKLOAD_ID...\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The workload ID or multiple IDs to uninstall.
|
|
+.RE
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Uninstall the \f[C]maui\f[R] workload:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload uninstall maui
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Uninstall the \f[C]maui-android\f[R] and \f[C]maui-ios\f[R] workloads:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload uninstall maui-android maui-ios
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet-workload-update.1 b/documentation/manpages/sdk/dotnet-workload-update.1
|
|
new file mode 100644
|
|
index 0000000000..7a31e5ee9e
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/sdk/dotnet-workload-update.1
|
|
@@ -0,0 +1,137 @@
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
+.\"
|
|
+.TH "" "1" "" "" ".NET"
|
|
+.hy
|
|
+.SH dotnet workload update
|
|
+.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 Preview SDK and later versions
|
|
+.SH NAME
|
|
+.PP
|
|
+\f[C]dotnet workload update\f[R] - Updates installed workloads.
|
|
+.SH SYNOPSIS
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload update
|
|
+ [--advertising-manifests-only]
|
|
+ [--configfile <FILE>] [--disable-parallel]
|
|
+ [--from-previous-sdk] [--ignore-failed-sources]
|
|
+ [--include-previews] [--interactive] [--no-cache]
|
|
+ [-s|--source <SOURCE>] [--temp-dir <PATH>]
|
|
+ [-v|--verbosity <LEVEL>]
|
|
+
|
|
+dotnet workload update -?|-h|--help
|
|
+\f[R]
|
|
+.fi
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+The \f[C]dotnet workload update\f[R] command updates all installed workloads to the newest available versions.
|
|
+It queries Nuget.org for updated workload manifests.
|
|
+It then updates local manifests, downloads new versions of the installed workloads, and removes all old versions of each workload.
|
|
+.PP
|
|
+For more information about the \f[C]dotnet workload\f[R] commands, see the dotnet workload install command.
|
|
+.SH OPTIONS
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--advertising-manifests-only\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Downloads advertising manifests but doesn\[cq]t update any workloads.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--configfile <FILE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+The NuGet configuration file (\f[I]nuget.config\f[R]) to use.
|
|
+If specified, only the settings from this file will be used.
|
|
+If not specified, the hierarchy of configuration files from the current directory will be used.
|
|
+For more information, see Common NuGet Configurations.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--disable-parallel\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prevents restoring multiple projects in parallel.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--from-previous-sdk\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Include workloads installed with previous SDK versions in the update.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prints out a description of how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--ignore-failed-sources\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Treats package source failures as warnings.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--include-previews\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows prerelease workload manifests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--interactive\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Allows the command to stop and wait for user input or action.
|
|
+For example, to complete authentication.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--no-cache\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Prevents caching of packages and http requests.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-s|--source <SOURCE>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specifies the URI of the NuGet package source to use.
|
|
+This setting overrides all of the sources specified in the \f[I]nuget.config\f[R] files.
|
|
+Multiple sources can be provided by specifying this option multiple times.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--temp-dir <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Specify the temporary directory used to download and extract NuGet packages (must be secure).
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
+.PP
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+The default is \f[C]minimal\f[R].
|
|
+If you specify specify \f[C]detailed\f[R] or \f[C]diagnostic\f[R] verbosity, the command displays information about the Nuget packages that it downloads.
|
|
+.RE
|
|
+.SH EXAMPLES
|
|
+.IP \[bu] 2
|
|
+Update the installed workloads:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload update
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+Download the assets needed for updating installed workloads to a cache located in the \f[I]workload-cache\f[R] directory under the current directory.
|
|
+Then update installed workloads from that cache location:
|
|
+.RS 2
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet workload update --download-to-cache ./workload-cache
|
|
+dotnet workload update --from-cache ./workload-cache
|
|
+\f[R]
|
|
+.fi
|
|
+.RE
|
|
diff --git a/documentation/manpages/sdk/dotnet.1 b/documentation/manpages/sdk/dotnet.1
|
|
index 117e040c03..4fca2df5b1 100644
|
|
--- a/documentation/manpages/sdk/dotnet.1
|
|
+++ b/documentation/manpages/sdk/dotnet.1
|
|
@@ -1,94 +1,211 @@
|
|
-.\"t
|
|
-.\" Automatically generated by Pandoc 2.7.2
|
|
+'\" t
|
|
+.\" Automatically generated by Pandoc 2.14.1
|
|
.\"
|
|
-.TH "dotnet command" "1" "" "" ".NET Core"
|
|
+.TH "" "1" "" "" ".NET"
|
|
.hy
|
|
.SH dotnet command
|
|
.PP
|
|
+\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.1 SDK and later versions
|
|
.SH NAME
|
|
.PP
|
|
-\f[C]dotnet\f[R] - A tool for managing .NET source code and binaries.
|
|
+\f[C]dotnet\f[R] - The generic driver for the .NET CLI.
|
|
.SH SYNOPSIS
|
|
-.SS .NET Core 2.1
|
|
+.PP
|
|
+To get information about the available commands and the environment:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet [command] [arguments] [--additional-deps] [--additionalprobingpath] [--depsfile]
|
|
- [-d|--diagnostics] [--fx-version] [-h|--help] [--info] [--list-runtimes] [--list-sdks] [--roll-forward-on-no-candidate-fx] [--runtimeconfig] [-v|--verbosity] [--version]
|
|
+dotnet [--version] [--info] [--list-runtimes] [--list-sdks]
|
|
+
|
|
+dotnet -h|--help
|
|
\f[R]
|
|
.fi
|
|
-.SS .NET Core 2.0
|
|
+.PP
|
|
+To run a command (requires SDK installation):
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet [command] [arguments] [--additional-deps] [--additionalprobingpath] [--depsfile]
|
|
- [-d|--diagnostics] [--fx-version] [-h|--help] [--info] [--roll-forward-on-no-candidate-fx]
|
|
- [--runtimeconfig] [-v|--verbosity] [--version]
|
|
+dotnet <COMMAND> [-d|--diagnostics] [-h|--help] [--verbosity <LEVEL>]
|
|
+ [command-options] [arguments]
|
|
\f[R]
|
|
.fi
|
|
-.SS .NET Core 1.x
|
|
+.PP
|
|
+To run an application:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
-dotnet [command] [arguments] [--additionalprobingpath] [--depsfile] [-d|--diagnostics]
|
|
- [--fx-version] [-h|--help] [--info] [--runtimeconfig] [-v|--verbosity] [--version]
|
|
+dotnet [--additionalprobingpath <PATH>] [--additional-deps <PATH>]
|
|
+ [--fx-version <VERSION>] [--roll-forward <SETTING>]
|
|
+ <PATH_TO_APPLICATION> [arguments]
|
|
+
|
|
+dotnet exec [--additionalprobingpath] [--additional-deps <PATH>]
|
|
+ [--fx-version <VERSION>] [--roll-forward <SETTING>]
|
|
+ <PATH_TO_APPLICATION> [arguments]
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
- * * * * *
|
|
+\f[C]--roll-forward\f[R] is available since .NET Core 3.x.
|
|
+Use \f[C]--roll-forward-on-no-candidate-fx\f[R] for .NET Core 2.x.
|
|
.SH DESCRIPTION
|
|
.PP
|
|
-\f[C]dotnet\f[R] is a tool for managing .NET source code and binaries.
|
|
-It exposes commands that perform specific tasks, such as \f[C]dotnet build\f[R] and \f[C]dotnet run\f[R].
|
|
-Each command defines its own arguments.
|
|
-Type \f[C]--help\f[R] after each command to access brief help documentation.
|
|
+The \f[C]dotnet\f[R] command has two functions:
|
|
+.IP \[bu] 2
|
|
+It provides commands for working with .NET projects.
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]dotnet\f[R] can be used to run applications, by specifying an application DLL, such as \f[C]dotnet myapp.dll\f[R].
|
|
-See .NET Core application deployment for to learn about deployment options.
|
|
+For example, \f[C]dotnet build\f[R] builds a project.
|
|
+Each command defines its own options and arguments.
|
|
+All commands support the \f[C]--help\f[R] option for printing out brief documentation about how to use the command.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+It runs .NET applications.
|
|
+.RS 2
|
|
+.PP
|
|
+You specify the path to an application \f[C].dll\f[R] file to run the application.
|
|
+To run the application means to find and execute the entry point, which in the case of console apps is the \f[C]Main\f[R] method.
|
|
+For example, \f[C]dotnet myapp.dll\f[R] runs the \f[C]myapp\f[R] application.
|
|
+See .NET application deployment to learn about deployment options.
|
|
+.RE
|
|
.SH OPTIONS
|
|
-.SS .NET Core 2.1
|
|
.PP
|
|
-\f[C]--additional-deps <PATH>\f[R]
|
|
+Different options are available for \f[C]dotnet\f[R] by itself, for running a command, and for running an application.
|
|
+.SS Options for dotnet by itself
|
|
.PP
|
|
-Path to an additional \f[I].deps.json\f[R] file.
|
|
+The following options are for \f[C]dotnet\f[R] by itself.
|
|
+For example, \f[C]dotnet --info\f[R].
|
|
+They print out information about the environment.
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--info\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--additionalprobingpath <PATH>\f[R]
|
|
+Prints out detailed information about a .NET installation and the machine environment, such as the current operating system, and commit SHA of the .NET version.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--version\f[B]\f[R]
|
|
.PP
|
|
-Path containing probing policy and assemblies to probe.
|
|
+Prints out the version of the .NET SDK used by dotnet commands.
|
|
+Includes the effects of any global.json
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--list-runtimes\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--depsfile\f[R]
|
|
+Prints out a list of the installed .NET runtimes.
|
|
+An x86 version of the SDK lists only x86 runtimes, and an x64 version of the SDK lists only x64 runtimes.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--list-sdks\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Path to a \f[I]deps.json\f[R] file.
|
|
+Prints out a list of the installed .NET SDKs.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-A \f[I]deps.json\f[R] file contains a list of dependencies, compilation dependencies and version information used to address assembly conflicts.
|
|
-For more information about this file, see Runtime Configuration Files on GitHub.
|
|
+Prints out a list of available commands.
|
|
+.RE
|
|
+.SS SDK options for running a command
|
|
.PP
|
|
-\f[C]-d|--diagnostics\f[R]
|
|
+The following options are for \f[C]dotnet\f[R] with a command.
|
|
+For example, \f[C]dotnet build --help\f[R].
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-d|--diagnostics\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Enables diagnostic output.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-v|--verbosity <LEVEL>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--fx-version <VERSION>\f[R]
|
|
+Sets the verbosity level of the command.
|
|
+Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
+Not supported in every command.
|
|
+See specific command page to determine if this option is available.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]-?|-h|--help\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Version of the .NET Core runtime to use to run the application.
|
|
+Prints out documentation for a given command, such as \f[C]dotnet build --help\f[R].
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]command options\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]-h|--help\f[R]
|
|
+Each command defines options specific to that command.
|
|
+See specific command page for a list of available options.
|
|
+.RE
|
|
+.SS Runtime options
|
|
.PP
|
|
-Prints out documentation for a given command, such as \f[C]dotnet build --help\f[R].
|
|
-\f[C]dotnet --help\f[R] prints a list of available commands.
|
|
+The following options are available when \f[C]dotnet\f[R] runs an application.
|
|
+For example, \f[C]dotnet myapp.dll --roll-forward Major\f[R].
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--additionalprobingpath <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--info\f[R]
|
|
+Path containing probing policy and assemblies to probe.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--additional-deps <PATH>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Prints out detailed information about a .NET Core installation and the machine environment, such as the current operating system, and commit SHA of the .NET Core version.
|
|
+Path to an additional \f[I].deps.json\f[R] file.
|
|
+A \f[I]deps.json\f[R] file contains a list of dependencies, compilation dependencies, and version information used to address assembly conflicts.
|
|
+For more information, see Runtime Configuration Files (https://github.com/dotnet/sdk/blob/main/documentation/specs/runtime-configuration-file.md) on GitHub.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--depsfile <PATH_TO_DEPSFILE>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--list-runtimes\f[R]
|
|
+Path to the \f[I]deps.json\f[R] file.
|
|
+A \f[I]deps.json\f[R] file is a configuration file that contains information about dependencies necessary to run the application.
|
|
+This file is generated by the .NET SDK.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--runtimeconfig\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Displays the installed .NET Core runtimes.
|
|
+Path to a \f[I]runtimeconfig.json\f[R] file.
|
|
+A \f[I]runtimeconfig.json\f[R] file is a configuration file that contains run-time settings.
|
|
+For more information, see .NET runtime configuration settings.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--roll-forward <SETTING>\f[B]\f[R] \f[B]Available starting with .NET Core SDK 3.0.\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-\f[C]--list-sdks\f[R]
|
|
+Controls how roll forward is applied to the app.
|
|
+The \f[C]SETTING\f[R] can be one of the following values.
|
|
+If not specified, \f[C]Minor\f[R] is the default.
|
|
+.IP \[bu] 2
|
|
+\f[C]LatestPatch\f[R] - Roll forward to the highest patch version.
|
|
+This disables minor version roll forward.
|
|
+.IP \[bu] 2
|
|
+\f[C]Minor\f[R] - Roll forward to the lowest higher minor version, if requested minor version is missing.
|
|
+If the requested minor version is present, then the LatestPatch policy is used.
|
|
+.IP \[bu] 2
|
|
+\f[C]Major\f[R] - Roll forward to lowest higher major version, and lowest minor version, if requested major version is missing.
|
|
+If the requested major version is present, then the Minor policy is used.
|
|
+.IP \[bu] 2
|
|
+\f[C]LatestMinor\f[R] - Roll forward to highest minor version, even if requested minor version is present.
|
|
+Intended for component hosting scenarios.
|
|
+.IP \[bu] 2
|
|
+\f[C]LatestMajor\f[R] - Roll forward to highest major and highest minor version, even if requested major is present.
|
|
+Intended for component hosting scenarios.
|
|
+.IP \[bu] 2
|
|
+\f[C]Disable\f[R] - Don\[cq]t roll forward.
|
|
+Only bind to specified version.
|
|
+This policy isn\[cq]t recommended for general use because it disables the ability to roll forward to the latest patches.
|
|
+This value is only recommended for testing.
|
|
.PP
|
|
-Displays the installed .NET Core SDKs.
|
|
+With the exception of \f[C]Disable\f[R], all settings will use the highest available patch version.
|
|
.PP
|
|
-\f[C]--roll-forward-on-no-candidate-fx <N>\f[R]
|
|
+Roll forward behavior can also be configured in a project file property, a runtime configuration file property, and an environment variable.
|
|
+For more information, see Major-version runtime roll forward.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--roll-forward-on-no-candidate-fx <N>\f[B]\f[R] \f[B]Available in .NET Core 2.x SDK.\f[R]
|
|
+.RS 2
|
|
.PP
|
|
Defines behavior when the required shared framework is not available.
|
|
\f[C]N\f[R] can be:
|
|
@@ -102,128 +219,20 @@ This is the default behavior.
|
|
.PP
|
|
For more information, see Roll forward.
|
|
.PP
|
|
-\f[C]--runtimeconfig\f[R]
|
|
-.PP
|
|
-Path to a \f[I]runtimeconfig.json\f[R] file.
|
|
-.PP
|
|
-A \f[I]runtimeconfig.json\f[R] file is a configuration file containing runtime configuration settings.
|
|
-For more information, see Runtime Configuration Files on GitHub.
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
-.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-Not supported in every command; see specific command page to determine if this option is available.
|
|
-.PP
|
|
-\f[C]--version\f[R]
|
|
-.PP
|
|
-Prints out the version of the .NET Core SDK in use.
|
|
-.SS .NET Core 2.0
|
|
-.PP
|
|
-\f[C]--additional-deps <PATH>\f[R]
|
|
-.PP
|
|
-Path to an additional \f[I].deps.json\f[R] file.
|
|
-.PP
|
|
-\f[C]--additionalprobingpath <PATH>\f[R]
|
|
-.PP
|
|
-Path containing probing policy and assemblies to probe.
|
|
-.PP
|
|
-\f[C]--depsfile\f[R]
|
|
-.PP
|
|
-Path to a \f[I]deps.json\f[R] file.
|
|
-.PP
|
|
-A \f[I]deps.json\f[R] file contains a list of dependencies, compilation dependencies and version information used to address assembly conflicts.
|
|
-For more details on this file, see Runtime Configuration Files on GitHub.
|
|
-.PP
|
|
-\f[C]-d|--diagnostics\f[R]
|
|
-.PP
|
|
-Enables diagnostic output.
|
|
-.PP
|
|
-\f[C]--fx-version <VERSION>\f[R]
|
|
-.PP
|
|
-Version of the .NET Core runtime to use to run the application.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out documentation for a given command, such as \f[C]dotnet build --help\f[R].
|
|
-\f[C]dotnet --help\f[R] prints a list of available commands.
|
|
-.PP
|
|
-\f[C]--info\f[R]
|
|
-.PP
|
|
-Prints out detailed information about a .NET Core installation and the machine environment, such as the current operating system, and commit SHA of the .NET Core version.
|
|
-.PP
|
|
-\f[C]--roll-forward-on-no-candidate-fx\f[R]
|
|
-.PP
|
|
-Disables minor version roll forward, if set to \f[C]0\f[R].
|
|
-For more information, see Roll forward.
|
|
-.PP
|
|
-\f[C]--runtimeconfig\f[R]
|
|
-.PP
|
|
-Path to a \f[I]runtimeconfig.json\f[R] file.
|
|
-.PP
|
|
-A \f[I]runtimeconfig.json\f[R] file is a configuration file containing runtime configuration settings.
|
|
-For more details, see Runtime Configuration Files on GitHub.
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
-.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-Not supported in every command; see specific command page to determine if this option is available.
|
|
-.PP
|
|
-\f[C]--version\f[R]
|
|
-.PP
|
|
-Prints out the version of the .NET Core SDK in use.
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-\f[C]--additionalprobingpath <PATH>\f[R]
|
|
-.PP
|
|
-Path containing probing policy and assemblies to probe.
|
|
-.PP
|
|
-\f[C]--depsfile\f[R]
|
|
-.PP
|
|
-Path to a \f[I]deps.json\f[R] file.
|
|
-.PP
|
|
-A \f[I]deps.json\f[R] file contains a list of dependencies, compilation dependencies and version information used to address assembly conflicts.
|
|
-For more details on this file, see Runtime Configuration Files on GitHub.
|
|
-.PP
|
|
-\f[C]-d|--diagnostics\f[R]
|
|
-.PP
|
|
-Enables diagnostic output.
|
|
-.PP
|
|
-\f[C]--fx-version <VERSION>\f[R]
|
|
-.PP
|
|
-Version of the .NET Core runtime to use to run the application.
|
|
-.PP
|
|
-\f[C]-h|--help\f[R]
|
|
-.PP
|
|
-Prints out documentation for a given command, such as \f[C]dotnet build --help\f[R].
|
|
-\f[C]dotnet --help\f[R] prints a list of available commands.
|
|
-.PP
|
|
-\f[C]--info\f[R]
|
|
-.PP
|
|
-Prints out detailed information about a .NET Core installation and the machine environment, such as the current operating system, and commit SHA of the .NET Core version.
|
|
-.PP
|
|
-\f[C]--runtimeconfig\f[R]
|
|
-.PP
|
|
-Path to a \f[I]runtimeconfig.json\f[R] file.
|
|
-.PP
|
|
-A \f[I]runtimeconfig.json\f[R] file is a configuration file containing runtime configuration settings.
|
|
-For more details, see Runtime Configuration Files on GitHub.
|
|
-.PP
|
|
-\f[C]-v|--verbosity <LEVEL>\f[R]
|
|
-.PP
|
|
-Sets the verbosity level of the command.
|
|
-Allowed values are \f[C]q[uiet]\f[R], \f[C]m[inimal]\f[R], \f[C]n[ormal]\f[R], \f[C]d[etailed]\f[R], and \f[C]diag[nostic]\f[R].
|
|
-Not supported in every command; see specific command page to determine if this option is available.
|
|
-.PP
|
|
-\f[C]--version\f[R]
|
|
+Starting with .NET Core 3.0, this option is superseded by \f[C]--roll-forward\f[R], and that option should be used instead.
|
|
+.RE
|
|
+.IP \[bu] 2
|
|
+\f[B]\f[CB]--fx-version <VERSION>\f[B]\f[R]
|
|
+.RS 2
|
|
.PP
|
|
-Prints out the version of the .NET Core SDK in use.
|
|
+Version of the .NET runtime to use to run the application.
|
|
.PP
|
|
- * * * * *
|
|
+This option overrides the version of the first framework reference in the application\[cq]s \f[C].runtimeconfig.json\f[R] file.
|
|
+This means it only works as expected if there\[cq]s just one framework reference.
|
|
+If the application has more than one framework reference, using this option may cause errors.
|
|
+.RE
|
|
.SS dotnet commands
|
|
.SS General
|
|
-.SS .NET Core 2.1
|
|
.PP
|
|
.TS
|
|
tab(@);
|
|
@@ -237,7 +246,7 @@ _
|
|
T{
|
|
dotnet build
|
|
T}@T{
|
|
-Builds a .NET Core application.
|
|
+Builds a .NET application.
|
|
T}
|
|
T{
|
|
dotnet build-server
|
|
@@ -290,6 +299,11 @@ T}@T{
|
|
Runs the application from source.
|
|
T}
|
|
T{
|
|
+dotnet sdk check
|
|
+T}@T{
|
|
+Shows up-to-date status of installed SDK and Runtime versions.
|
|
+T}
|
|
+T{
|
|
dotnet sln
|
|
T}@T{
|
|
Options to add, remove, and list projects in a solution file.
|
|
@@ -305,7 +319,7 @@ T}@T{
|
|
Runs tests using a test runner.
|
|
T}
|
|
.TE
|
|
-.SS .NET Core 2.0
|
|
+.SS Project references
|
|
.PP
|
|
.TS
|
|
tab(@);
|
|
@@ -317,72 +331,22 @@ Function
|
|
T}
|
|
_
|
|
T{
|
|
-dotnet build
|
|
-T}@T{
|
|
-Builds a .NET Core application.
|
|
-T}
|
|
-T{
|
|
-dotnet clean
|
|
-T}@T{
|
|
-Clean build outputs.
|
|
-T}
|
|
-T{
|
|
-dotnet help
|
|
-T}@T{
|
|
-Shows more detailed documentation online for the command.
|
|
-T}
|
|
-T{
|
|
-dotnet migrate
|
|
-T}@T{
|
|
-Migrates a valid Preview 2 project to a .NET Core SDK 1.0 project.
|
|
-T}
|
|
-T{
|
|
-dotnet msbuild
|
|
-T}@T{
|
|
-Provides access to the MSBuild command line.
|
|
-T}
|
|
-T{
|
|
-dotnet new
|
|
-T}@T{
|
|
-Initializes a C# or F# project for a given template.
|
|
-T}
|
|
-T{
|
|
-dotnet pack
|
|
-T}@T{
|
|
-Creates a NuGet package of your code.
|
|
-T}
|
|
-T{
|
|
-dotnet publish
|
|
-T}@T{
|
|
-Publishes a .NET framework-dependent or self-contained application.
|
|
-T}
|
|
-T{
|
|
-dotnet restore
|
|
-T}@T{
|
|
-Restores the dependencies for a given application.
|
|
-T}
|
|
-T{
|
|
-dotnet run
|
|
-T}@T{
|
|
-Runs the application from source.
|
|
-T}
|
|
-T{
|
|
-dotnet sln
|
|
+dotnet add reference
|
|
T}@T{
|
|
-Options to add, remove, and list projects in a solution file.
|
|
+Adds a project reference.
|
|
T}
|
|
T{
|
|
-dotnet store
|
|
+dotnet list reference
|
|
T}@T{
|
|
-Stores assemblies in the runtime package store.
|
|
+Lists project references.
|
|
T}
|
|
T{
|
|
-dotnet test
|
|
+dotnet remove reference
|
|
T}@T{
|
|
-Runs tests using a test runner.
|
|
+Removes a project reference.
|
|
T}
|
|
.TE
|
|
-.SS .NET Core 1.x
|
|
+.SS NuGet packages
|
|
.PP
|
|
.TS
|
|
tab(@);
|
|
@@ -394,91 +358,74 @@ Function
|
|
T}
|
|
_
|
|
T{
|
|
-dotnet build
|
|
-T}@T{
|
|
-Builds a .NET Core application.
|
|
-T}
|
|
-T{
|
|
-dotnet clean
|
|
-T}@T{
|
|
-Clean build outputs.
|
|
-T}
|
|
-T{
|
|
-dotnet migrate
|
|
+dotnet add package
|
|
T}@T{
|
|
-Migrates a valid Preview 2 project to a .NET Core SDK 1.0 project.
|
|
+Adds a NuGet package.
|
|
T}
|
|
T{
|
|
-dotnet msbuild
|
|
+dotnet remove package
|
|
T}@T{
|
|
-Provides access to the MSBuild command line.
|
|
+Removes a NuGet package.
|
|
T}
|
|
+.TE
|
|
+.SS NuGet commands
|
|
+.PP
|
|
+.TS
|
|
+tab(@);
|
|
+l l.
|
|
T{
|
|
-dotnet new
|
|
+Command
|
|
T}@T{
|
|
-Initializes a C# or F# project for a given template.
|
|
+Function
|
|
T}
|
|
+_
|
|
T{
|
|
-dotnet pack
|
|
+dotnet nuget delete
|
|
T}@T{
|
|
-Creates a NuGet package of your code.
|
|
+Deletes or unlists a package from the server.
|
|
T}
|
|
T{
|
|
-dotnet publish
|
|
+dotnet nuget push
|
|
T}@T{
|
|
-Publishes a .NET framework-dependent or self-contained application.
|
|
+Pushes a package to the server and publishes it.
|
|
T}
|
|
T{
|
|
-dotnet restore
|
|
+dotnet nuget locals
|
|
T}@T{
|
|
-Restores the dependencies for a given application.
|
|
+Clears or lists local NuGet resources such as http-request cache, temporary cache, or machine-wide global packages folder.
|
|
T}
|
|
T{
|
|
-dotnet run
|
|
+dotnet nuget add source
|
|
T}@T{
|
|
-Runs the application from source.
|
|
+Adds a NuGet source.
|
|
T}
|
|
T{
|
|
-dotnet sln
|
|
+dotnet nuget disable source
|
|
T}@T{
|
|
-Options to add, remove, and list projects in a solution file.
|
|
+Disables a NuGet source.
|
|
T}
|
|
T{
|
|
-dotnet test
|
|
+dotnet nuget enable source
|
|
T}@T{
|
|
-Runs tests using a test runner.
|
|
+Enables a NuGet source.
|
|
T}
|
|
-.TE
|
|
-.PP
|
|
- * * * * *
|
|
-.SS Project references
|
|
-.PP
|
|
-.TS
|
|
-tab(@);
|
|
-l l.
|
|
T{
|
|
-Command
|
|
+dotnet nuget list source
|
|
T}@T{
|
|
-Function
|
|
+Lists all configured NuGet sources.
|
|
T}
|
|
-_
|
|
T{
|
|
-dotnet add reference
|
|
+dotnet nuget remove source
|
|
T}@T{
|
|
-Adds a project reference.
|
|
+Removes a NuGet source.
|
|
T}
|
|
T{
|
|
-dotnet list reference
|
|
+dotnet nuget update source
|
|
T}@T{
|
|
-Lists project references.
|
|
-T}
|
|
-T{
|
|
-dotnet remove reference
|
|
-T}@T{
|
|
-Removes a project reference.
|
|
+Updates a NuGet source.
|
|
T}
|
|
.TE
|
|
-.SS NuGet packages
|
|
+.SS Workload commands
|
|
.PP
|
|
.TS
|
|
tab(@);
|
|
@@ -490,46 +437,44 @@ Function
|
|
T}
|
|
_
|
|
T{
|
|
-dotnet add package
|
|
+dotnet workload install
|
|
T}@T{
|
|
-Adds a NuGet package.
|
|
+Installs an optional workload.
|
|
T}
|
|
T{
|
|
-dotnet remove package
|
|
+dotnet workload list
|
|
T}@T{
|
|
-Removes a NuGet package.
|
|
+Lists all installed workloads.
|
|
T}
|
|
-.TE
|
|
-.SS NuGet commands
|
|
-.PP
|
|
-.TS
|
|
-tab(@);
|
|
-l l.
|
|
T{
|
|
-Command
|
|
+dotnet workload repair
|
|
T}@T{
|
|
-Function
|
|
+Repairs all installed workloads.
|
|
T}
|
|
-_
|
|
T{
|
|
-dotnet nuget delete
|
|
+dotnet workload search
|
|
T}@T{
|
|
-Deletes or unlists a package from the server.
|
|
+List selected workloads or all available workloads.
|
|
T}
|
|
T{
|
|
-dotnet nuget locals
|
|
+dotnet workload uninstall
|
|
T}@T{
|
|
-Clears or lists local NuGet resources such as http-request cache, temporary cache, or machine-wide global packages folder.
|
|
+Uninstalls a workload.
|
|
T}
|
|
T{
|
|
-dotnet nuget push
|
|
+dotnet workload update
|
|
T}@T{
|
|
-Pushes a package to the server and publishes it.
|
|
+Reinstalls all installed workloads.
|
|
T}
|
|
.TE
|
|
-.SS Global Tools commands
|
|
+.SS Global, tool-path, and local tools commands
|
|
.PP
|
|
-\&.NET Core Global Tools are available starting with .NET Core SDK 2.1.300:
|
|
+Tools are console applications that are installed from NuGet packages and are invoked from the command prompt.
|
|
+You can write tools yourself or install tools written by third parties.
|
|
+Tools are also known as global tools, tool-path tools, and local tools.
|
|
+For more information, see .NET tools overview.
|
|
+Global and tool-path tools are available starting with .NET Core SDK 2.1.
|
|
+Local tools are available starting with .NET Core SDK 3.0.
|
|
.PP
|
|
.TS
|
|
tab(@);
|
|
@@ -543,27 +488,32 @@ _
|
|
T{
|
|
dotnet tool install
|
|
T}@T{
|
|
-Installs a Global Tool on your machine.
|
|
+Installs a tool on your machine.
|
|
T}
|
|
T{
|
|
dotnet tool list
|
|
T}@T{
|
|
-Lists all Global Tools currently installed in the default directory on your machine or in the specified path.
|
|
+Lists all global, tool-path, or local tools currently installed on your machine.
|
|
+T}
|
|
+T{
|
|
+dotnet tool search
|
|
+T}@T{
|
|
+Searches NuGet.org for tools that have the specified search term in their name or metadata.
|
|
T}
|
|
T{
|
|
dotnet tool uninstall
|
|
T}@T{
|
|
-Uninstalls a Global Tool from your machine.
|
|
+Uninstalls a tool from your machine.
|
|
T}
|
|
T{
|
|
dotnet tool update
|
|
T}@T{
|
|
-Updates a Global Tool on your machine.
|
|
+Updates a tool that is installed on your machine.
|
|
T}
|
|
.TE
|
|
.SS Additional tools
|
|
.PP
|
|
-Starting with .NET Core SDK 2.1.300, a number of tools that were available only on a per project basis using \f[C]DotnetCliToolReference\f[R] are now available as part of the .NET Core SDK.
|
|
+Starting with .NET Core SDK 2.1.300, a number of tools that were available only on a per project basis using \f[C]DotnetCliToolReference\f[R] are now available as part of the .NET SDK.
|
|
These tools are listed in the following table:
|
|
.PP
|
|
.TS
|
|
@@ -605,95 +555,33 @@ T}
|
|
For more information about each tool, type \f[C]dotnet <tool-name> --help\f[R].
|
|
.SH EXAMPLES
|
|
.PP
|
|
-Creates a new .NET Core console application:
|
|
-.PP
|
|
-\f[C]dotnet new console\f[R]
|
|
-.PP
|
|
-Restore dependencies for a given application:
|
|
-.PP
|
|
-\f[C]dotnet restore\f[R]
|
|
-.PP
|
|
+Create a new .NET console application:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet new console
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
Build a project and its dependencies in a given directory:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet build
|
|
+\f[R]
|
|
+.fi
|
|
.PP
|
|
-\f[C]dotnet build\f[R]
|
|
-.PP
|
|
-Run an application DLL, such as \f[C]myapp.dll\f[R]:
|
|
-.PP
|
|
-\f[C]dotnet myapp.dll\f[R]
|
|
-.SH ENVIRONMENT VARIABLES
|
|
-.SS .NET Core 2.1
|
|
-.PP
|
|
-\f[C]DOTNET_PACKAGES\f[R]
|
|
-.PP
|
|
-The global packages folder.
|
|
-If not set, it defaults to \f[C]\[ti]/.nuget/packages\f[R] on Unix or \f[C]%userprofile%\[rs].nuget\[rs]packages\f[R] on Windows.
|
|
-.PP
|
|
-\f[C]DOTNET_SERVICING\f[R]
|
|
-.PP
|
|
-Specifies the location of the servicing index to use by the shared host when loading the runtime.
|
|
-.PP
|
|
-\f[C]DOTNET_CLI_TELEMETRY_OPTOUT\f[R]
|
|
-.PP
|
|
-Specifies whether data about the .NET Core tools usage is collected and sent to Microsoft.
|
|
-Set to \f[C]true\f[R] to opt-out of the telemetry feature (values \f[C]true\f[R], \f[C]1\f[R], or \f[C]yes\f[R] accepted).
|
|
-Otherwise, set to \f[C]false\f[R] to opt into the telemetry features (values \f[C]false\f[R], \f[C]0\f[R], or \f[C]no\f[R] accepted).
|
|
-If not set, the default is \f[C]false\f[R] and the telemetry feature is active.
|
|
-.PP
|
|
-\f[C]DOTNET_MULTILEVEL_LOOKUP\f[R]
|
|
-.PP
|
|
-Specifies whether .NET Core runtime, shared framework, or SDK are resolved from the global location.
|
|
-If not set, it defaults to \f[C]true\f[R].
|
|
-Set to \f[C]false\f[R] to not resolve from the global location and have isolated .NET Core installations (values \f[C]0\f[R] or \f[C]false\f[R] are accepted).
|
|
-For more information about multi-level lookup, see Multi-level SharedFX Lookup.
|
|
-.PP
|
|
-\f[C]DOTNET_ROLL_FORWARD_ON_NO_CANDIDATE_FX\f[R]
|
|
-.PP
|
|
-Disables minor version roll forward, if set to \f[C]0\f[R].
|
|
-For more information, see Roll forward.
|
|
-.SS .NET Core 2.0
|
|
-.PP
|
|
-\f[C]DOTNET_PACKAGES\f[R]
|
|
-.PP
|
|
-The primary package cache.
|
|
-If not set, it defaults to \f[C]$HOME/.nuget/packages\f[R] on Unix or \f[C]%userprofile%\[rs].nuget\[rs]packages\f[R] on Windows.
|
|
-.PP
|
|
-\f[C]DOTNET_SERVICING\f[R]
|
|
-.PP
|
|
-Specifies the location of the servicing index to use by the shared host when loading the runtime.
|
|
-.PP
|
|
-\f[C]DOTNET_CLI_TELEMETRY_OPTOUT\f[R]
|
|
-.PP
|
|
-Specifies whether data about the .NET Core tools usage is collected and sent to Microsoft.
|
|
-Set to \f[C]true\f[R] to opt-out of the telemetry feature (values \f[C]true\f[R], \f[C]1\f[R], or \f[C]yes\f[R] accepted).
|
|
-Otherwise, set to \f[C]false\f[R] to opt into the telemetry features (values \f[C]false\f[R], \f[C]0\f[R], or \f[C]no\f[R] accepted).
|
|
-If not set, the default is \f[C]false\f[R] and the telemetry feature is active.
|
|
-.PP
|
|
-\f[C]DOTNET_MULTILEVEL_LOOKUP\f[R]
|
|
-.PP
|
|
-Specifies whether .NET Core runtime, shared framework, or SDK are resolved from the global location.
|
|
-If not set, it defaults to \f[C]true\f[R].
|
|
-Set to \f[C]false\f[R] to not resolve from the global location and have isolated .NET Core installations (values \f[C]0\f[R] or \f[C]false\f[R] are accepted).
|
|
-For more information about multi-level lookup, see Multi-level SharedFX Lookup.
|
|
-.SS .NET Core 1.x
|
|
-.PP
|
|
-\f[C]DOTNET_PACKAGES\f[R]
|
|
-.PP
|
|
-The primary package cache.
|
|
-If not set, it defaults to \f[C]$HOME/.nuget/packages\f[R] on Unix or \f[C]%userprofile%\[rs].nuget\[rs]packages\f[R] on Windows.
|
|
-.PP
|
|
-\f[C]DOTNET_SERVICING\f[R]
|
|
-.PP
|
|
-Specifies the location of the servicing index to use by the shared host when loading the runtime.
|
|
-.PP
|
|
-\f[C]DOTNET_CLI_TELEMETRY_OPTOUT\f[R]
|
|
-.PP
|
|
-Specifies whether data about the .NET Core tools usage is collected and sent to Microsoft.
|
|
-Set to \f[C]true\f[R] to opt-out of the telemetry feature (values \f[C]true\f[R], \f[C]1\f[R], or \f[C]yes\f[R] accepted).
|
|
-Otherwise, set to \f[C]false\f[R] to opt into the telemetry features (values \f[C]false\f[R], \f[C]0\f[R], or \f[C]no\f[R] accepted).
|
|
-If not set, the default is \f[C]false\f[R] and the telemetry feature is active.
|
|
-.PP
|
|
- * * * * *
|
|
+Run an application:
|
|
+.IP
|
|
+.nf
|
|
+\f[C]
|
|
+dotnet myapp.dll
|
|
+\f[R]
|
|
+.fi
|
|
.SS See also
|
|
.IP \[bu] 2
|
|
-Runtime Configuration Files
|
|
+Environment variables used by .NET SDK, .NET CLI, and .NET runtime
|
|
+.IP \[bu] 2
|
|
+Runtime Configuration Files (https://github.com/dotnet/sdk/blob/main/documentation/specs/runtime-configuration-file.md)
|
|
+.IP \[bu] 2
|
|
+\&.NET runtime configuration settings
|
|
diff --git a/documentation/manpages/tool/Dockerfile b/documentation/manpages/tool/Dockerfile
|
|
index 37f37771d6..44777d621e 100644
|
|
--- a/documentation/manpages/tool/Dockerfile
|
|
+++ b/documentation/manpages/tool/Dockerfile
|
|
@@ -1,7 +1,7 @@
|
|
-FROM pandoc/core:2.7.2
|
|
+FROM pandoc/core:2.14.1
|
|
|
|
ENTRYPOINT ["/usr/bin/env"]
|
|
|
|
-RUN apk add git py-pip && python -m pip install pandocfilters
|
|
+RUN apk add git py3-pip && python3 -m pip install pandocfilters
|
|
|
|
CMD /manpages/tool/update-man-pages.sh
|
|
diff --git a/documentation/manpages/tool/man-pandoc-filter.py b/documentation/manpages/tool/man-pandoc-filter.py
|
|
old mode 100644
|
|
new mode 100755
|
|
index 20740bf083..fed4bebf6e
|
|
--- a/documentation/manpages/tool/man-pandoc-filter.py
|
|
+++ b/documentation/manpages/tool/man-pandoc-filter.py
|
|
@@ -1,4 +1,4 @@
|
|
-#!/usr/bin/env python
|
|
+#!/usr/bin/env python3
|
|
#
|
|
# Copyright (c) .NET Foundation and contributors. All rights reserved.
|
|
# Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
@@ -7,10 +7,9 @@
|
|
import copy
|
|
from pandocfilters import toJSONFilters, Para, Str, Header, Space
|
|
|
|
-def remove_includes(key, value, format, meta):
|
|
+def fail_on_includes(key, value, format, meta):
|
|
if key == 'Para' and value[0]['c'] == '[!INCLUDE':
|
|
- return Para([Str("")])
|
|
- return None
|
|
+ assert False, 'Found an unexpected [!INCLUDE'
|
|
|
|
def promote_and_capitalize_sections(key, value, format, meta):
|
|
if key == 'Header':
|
|
@@ -34,18 +33,11 @@ def demote_net_core_1_2(key, value, format, meta):
|
|
return value
|
|
return None
|
|
|
|
-def remove_references(key, value, format, meta):
|
|
- if key == 'Link':
|
|
- pass
|
|
- return value[1]
|
|
- return None
|
|
-
|
|
def main():
|
|
toJSONFilters([
|
|
- remove_includes,
|
|
+ fail_on_includes,
|
|
promote_and_capitalize_sections,
|
|
demote_net_core_1_2,
|
|
- remove_references,
|
|
])
|
|
|
|
if __name__ == '__main__':
|
|
diff --git a/documentation/manpages/tool/remove-metadata-and-embed-includes.py b/documentation/manpages/tool/remove-metadata-and-embed-includes.py
|
|
new file mode 100755
|
|
index 0000000000..11c9bf2411
|
|
--- /dev/null
|
|
+++ b/documentation/manpages/tool/remove-metadata-and-embed-includes.py
|
|
@@ -0,0 +1,67 @@
|
|
+#!/usr/bin/env python3
|
|
+#
|
|
+# Copyright (c) .NET Foundation and contributors. All rights reserved.
|
|
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
+#
|
|
+
|
|
+import re
|
|
+import os
|
|
+import os.path
|
|
+import sys
|
|
+
|
|
+def git_root(file):
|
|
+ dirname = os.path.dirname(file)
|
|
+ while True:
|
|
+ if os.path.isdir(os.path.join(dirname, '.git')):
|
|
+ return dirname
|
|
+ dirname = os.path.abspath(os.path.join(dirname, '..'))
|
|
+ if dirname == '/':
|
|
+ assert False, 'at root directory now'
|
|
+
|
|
+def read_lines_document_file(this_file, original_lines):
|
|
+ result = []
|
|
+
|
|
+ lines = original_lines
|
|
+
|
|
+ # metadata section is optional
|
|
+ if lines[0] == '---' + os.linesep:
|
|
+ # remove first ---
|
|
+ lines = lines[1:]
|
|
+
|
|
+ # find index of second --- and remove that and everything before it
|
|
+ for i in range(len(lines)):
|
|
+ if lines[i] == '---' + os.linesep:
|
|
+ lines = lines[i+1:]
|
|
+ break
|
|
+
|
|
+ for line in lines:
|
|
+ if '[!INCLUDE' in line:
|
|
+ match = re.search(r'\[!INCLUDE *\[[^\]]+\] *\(([^)]+)\)', line)
|
|
+ if match:
|
|
+ relative_path = match.groups()[0]
|
|
+ if relative_path.startswith('~/'):
|
|
+ git_repo_root = git_root(this_file) + '/'
|
|
+ file_to_include = os.path.join(git_repo_root, relative_path[2:])
|
|
+ else:
|
|
+ file_to_include = os.path.join(os.path.dirname(this_file), relative_path)
|
|
+ with open(file_to_include) as f:
|
|
+ lines_to_include = f.readlines()
|
|
+ result.extend(read_lines_document_file(file_to_include, lines_to_include))
|
|
+ else:
|
|
+ assert False, 'Unable to parse: ' + line
|
|
+ else:
|
|
+ result.append(line)
|
|
+ return result
|
|
+
|
|
+def main(args):
|
|
+ filename = args[1]
|
|
+ with open(filename) as original:
|
|
+ lines = read_lines_document_file(filename, original.readlines())
|
|
+ with open(filename + '.tmp', 'w') as output:
|
|
+ for line in lines:
|
|
+ output.write(line)
|
|
+
|
|
+ os.replace(filename + '.tmp', filename)
|
|
+
|
|
+if __name__ == '__main__':
|
|
+ sys.exit(main(sys.argv))
|
|
diff --git a/documentation/manpages/tool/run_docker.sh b/documentation/manpages/tool/run_docker.sh
|
|
old mode 100644
|
|
new mode 100755
|
|
index c5e2a3cf56..6717892a53
|
|
--- a/documentation/manpages/tool/run_docker.sh
|
|
+++ b/documentation/manpages/tool/run_docker.sh
|
|
@@ -8,4 +8,4 @@ MANPAGE_TOOL_DIR=$(cd "$(dirname "$0")" || exit; pwd)
|
|
|
|
docker build -t dotnet-cli-manpage-tool "$MANPAGE_TOOL_DIR"
|
|
|
|
-docker run --volume="$MANPAGE_TOOL_DIR"/..:/manpages dotnet-cli-manpage-tool
|
|
+docker run --volume="$MANPAGE_TOOL_DIR"/..:/manpages:Z dotnet-cli-manpage-tool
|
|
diff --git a/documentation/manpages/tool/update-man-pages.sh b/documentation/manpages/tool/update-man-pages.sh
|
|
old mode 100644
|
|
new mode 100755
|
|
index cf2ac7cfd3..c3c389f28b
|
|
--- a/documentation/manpages/tool/update-man-pages.sh
|
|
+++ b/documentation/manpages/tool/update-man-pages.sh
|
|
@@ -4,6 +4,8 @@
|
|
# Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
#
|
|
|
|
+set -euo pipefail
|
|
+
|
|
MANPAGE_TOOL_DIR=$(cd "$(dirname "$0")" || exit; pwd)
|
|
|
|
cd "$MANPAGE_TOOL_DIR"/../sdk || exit
|
|
@@ -24,7 +26,8 @@ fi
|
|
ls docs-main/docs/core/tools/dotnet*.md | while read -r line;
|
|
do
|
|
echo "Working on $line"
|
|
- pandoc -s -t man -V section=1 -V header=".NET Core" --column=500 --filter "$MANPAGE_TOOL_DIR"/man-pandoc-filter.py "$line" -o "$(basename "${line%.md}".1)"
|
|
+ "$MANPAGE_TOOL_DIR"/remove-metadata-and-embed-includes.py "$line"
|
|
+ pandoc -s -t man -V section=1 -V header=".NET" --column=500 --filter "$MANPAGE_TOOL_DIR"/man-pandoc-filter.py "$line" -o "$(basename "${line%.md}".1)"
|
|
done
|
|
|
|
rm -rf docs-main
|
|
--
|
|
2.33.1
|
|
|