diff --git a/NuGet.config b/NuGet.config index 0815f41ac8a4..c9ce85ce0ea4 100644 --- a/NuGet.config +++ b/NuGet.config @@ -6,6 +6,7 @@ + diff --git a/documentation/manpages/sdk/dotnet-add-package.1 b/documentation/manpages/sdk/dotnet-add-package.1 index d9f7108b8a38..8dd9f4cc931b 100644 --- a/documentation/manpages/sdk/dotnet-add-package.1 +++ b/documentation/manpages/sdk/dotnet-add-package.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-add-package" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-add-package" "1" "2022-10-10" "" ".NET Documentation" .hy .SH dotnet add package .PP diff --git a/documentation/manpages/sdk/dotnet-add-reference.1 b/documentation/manpages/sdk/dotnet-add-reference.1 index 258c82842081..f104749c4d79 100644 --- a/documentation/manpages/sdk/dotnet-add-reference.1 +++ b/documentation/manpages/sdk/dotnet-add-reference.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-add-reference" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-add-reference" "1" "2022-10-10" "" ".NET Documentation" .hy .SH dotnet add reference .PP diff --git a/documentation/manpages/sdk/dotnet-build-server.1 b/documentation/manpages/sdk/dotnet-build-server.1 index 52fd466840e8..323c2855a2ff 100644 --- a/documentation/manpages/sdk/dotnet-build-server.1 +++ b/documentation/manpages/sdk/dotnet-build-server.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-build-server" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-build-server" "1" "2022-10-10" "" ".NET Documentation" .hy .SH dotnet build-server .PP diff --git a/documentation/manpages/sdk/dotnet-build.1 b/documentation/manpages/sdk/dotnet-build.1 index 1d2056f0106c..20ad8124e925 100644 --- a/documentation/manpages/sdk/dotnet-build.1 +++ b/documentation/manpages/sdk/dotnet-build.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-build" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-build" "1" "2022-10-21" "" ".NET Documentation" .hy .SH dotnet build .PP @@ -31,7 +31,7 @@ dotnet build [|] [-a|--arch ] [--force] [--interactive] [--no-dependencies] [--no-incremental] [--no-restore] [--nologo] [--no-self-contained] [--os ] [-o|--output ] [-r|--runtime ] - [--self-contained [true|false]] [--source ] + [--self-contained [true|false]] [--source ] [--use-current-runtime, --ucr [true|false]] [-v|--verbosity ] [--version-suffix ] dotnet build -h|--help @@ -140,6 +140,7 @@ The default for most projects is \f[V]Debug\f[R], but you can override the build .PP Compiles for a specific framework. The framework must be defined in the project file. +Examples: \f[V]net7.0\f[R], \f[V]net462\f[R]. .RE .IP \[bu] 2 \f[B]\f[VB]--force\f[B]\f[R] @@ -220,6 +221,7 @@ Available since .NET 6. Specifies the target runtime. For a list of Runtime Identifiers (RIDs), see the RID catalog. If you use this option with .NET 6 SDK, use \f[V]--self-contained\f[R] or \f[V]--no-self-contained\f[R] also. +If not specified, the default is to build for the current OS and architecture. .RE .IP \[bu] 2 \f[B]\f[VB]--self-contained [true|false]\f[B]\f[R] @@ -245,6 +247,14 @@ The default is \f[V]minimal\f[R]. For more information, see . .RE .IP \[bu] 2 +\f[B]\f[VB]--use-current-runtime, --ucr [true|false]\f[B]\f[R] +.RS 2 +.PP +Sets the \f[V]RuntimeIdentifier\f[R] to a platform portable \f[V]RuntimeIdentifier\f[R] based on the one of your machine. +This happens implicitly with properties that require a \f[V]RuntimeIdentifier\f[R], such as \f[V]SelfContained\f[R], \f[V]PublishAot\f[R], \f[V]PublishSelfContained\f[R], \f[V]PublishSingleFile\f[R], and \f[V]PublishReadyToRun\f[R]. +If the property is set to false, that implicit resolution will no longer occur. +.RE +.IP \[bu] 2 \f[B]\f[VB]--version-suffix \f[B]\f[R] .RS 2 .PP diff --git a/documentation/manpages/sdk/dotnet-clean.1 b/documentation/manpages/sdk/dotnet-clean.1 index 74ace385b2c6..cc1000e3a901 100644 --- a/documentation/manpages/sdk/dotnet-clean.1 +++ b/documentation/manpages/sdk/dotnet-clean.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-clean" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-clean" "1" "2022-10-10" "" ".NET Documentation" .hy .SH dotnet clean .PP diff --git a/documentation/manpages/sdk/dotnet-dev-certs.1 b/documentation/manpages/sdk/dotnet-dev-certs.1 new file mode 100644 index 000000000000..26af672b66b3 --- /dev/null +++ b/documentation/manpages/sdk/dotnet-dev-certs.1 @@ -0,0 +1,320 @@ +'\" t +.\" Automatically generated by Pandoc 2.18 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "dotnet-dev-certs" "1" "2022-10-10" "" ".NET Documentation" +.hy +.SH dotnet dev-certs +.PP +\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions +.SH NAME +.PP +dotnet-dev-certs - Generates a self-signed certificate to enable HTTPS use in development. +.SH SYNOPSIS +.IP +.nf +\f[C] +dotnet dev-certs https + [-c|--check] [--clean] [-ep|--export-path ] + [--format] [-i|--import] [-np|--no-password] + [-p|--password] [-q|--quiet] [-t|--trust] + [-v|--verbose] [--version] + +dotnet dev-certs https -h|--help +\f[R] +.fi +.SH DESCRIPTION +.PP +The \f[V]dotnet dev-certs\f[R] command manages a self-signed certificate to enable HTTPS use in local web app development. +Its main functions are: +.IP \[bu] 2 +Generating a certificate for use with HTTPS endpoints during development. +.IP \[bu] 2 +Trusting the generated certificate on the local machine. +.IP \[bu] 2 +Removing the generated certificate from the local machine. +.IP \[bu] 2 +Exporting a certificate in various formats so that it can be used by other tools. +.IP \[bu] 2 +Importing an existing certificate generated by the tool into the local machine. +.SS Commands +.IP \[bu] 2 +\f[B]\f[VB]https\f[B]\f[R] +.RS 2 +.PP +\f[V]dotnet dev-certs\f[R] has only one command: \f[V]https\f[R]. +The \f[V]dotnet dev-certs https\f[R] command with no options checks if a development certificate is present in the current user\[cq]s certificate store on the machine. +If the command finds a development certificate, it displays a message like the following example: +.IP +.nf +\f[C] +A valid HTTPS certificate is already present. +\f[R] +.fi +.PP +If the command doesn\[cq]t find a development certificate, it creates one in the current user\[cq]s certificate store, the store named \f[V]My\f[R] in the location \f[V]CurrentUser\f[R]. +The physical location of the certificate is an implementation detail of the .NET runtime that could change at any time. +On macOS in .NET 7.0, the certificate is stored in the user key chain and as a PFX file: \f[I]\[ti]/.aspnet/https-aspnetcore-localhost-.pfx\f[R]. +.PP +After creating a certificate, the command displays a message like the following example: +.IP +.nf +\f[C] +The HTTPS developer certificate was generated successfully. +\f[R] +.fi +.PP +By default, the newly created certificate is not trusted. +To trust the certificate, use the \f[V]--trust\f[R] option. +.PP +To create a file that you can use with other tools, use the \f[V]--export-path\f[R] option. +.RE +.SH OPTIONS +.IP \[bu] 2 +\f[B]\f[VB]-c|--check\f[B]\f[R] +.RS 2 +.PP +Checks for the existence of the development certificate but doesn\[cq]t perform any action. +Use this option with the \f[V]--trust\f[R] option to check if the certificate is not only valid but also trusted. +.RE +.IP \[bu] 2 +\f[B]\f[VB]--clean\f[B]\f[R] +.RS 2 +.PP +Removes all HTTPS development certificates from the certificate store by using the .NET certificate store API. +Doesn\[cq]t remove any physical files that were created by using the \f[V]--export-path\f[R] option. +On macOS in .NET 7.0, the \f[V]dotnet dev-certs\f[R] command creates the certificate on a path on disk, and the clean operation removes that certificate file. +.PP +If there\[cq]s at least one certificate in the certificate store, the command displays a message like the following example: +.IP +.nf +\f[C] +Cleaning HTTPS development certificates +from the machine. +A prompt might get displayed to confirm +the removal of some of the certificates. + +HTTPS development certificates +successfully removed from the machine. +\f[R] +.fi +.PP +.RE +.IP \[bu] 2 +\f[B]\f[VB]-ep|--export-path \f[B]\f[R] +.RS 2 +.PP +Exports the certificate to a file so that it can be used by other tools. +Specify the full path to the exported certificate file, including the file name. +The type of certificate files that are created depends on which options are used with \f[V]--export-path\f[R]: +.PP +.TS +tab(@); +l l. +T{ +Options +T}@T{ +What is exported +T} +_ +T{ +\f[V]--export-path\f[R] +T}@T{ +The public part of the certificate as a PFX file. +T} +T{ +\f[V]--export-path --format PEM\f[R] +T}@T{ +The public part of the certificate in PEM format. +No separate \f[I].key\f[R] file is created. +T} +T{ +\f[V]--export-path --password\f[R] +T}@T{ +The public and private parts of the certificate as a PFX file. +T} +T{ +\f[V]--export-path --password --format PEM\f[R] +T}@T{ +The public and private parts of the certificate as a pair of files in PEM format. +The key file has the \f[I].key\f[R] extension and is protected by the given password. +T} +T{ +\f[V]--export-path --no-password --format PEM\f[R] +T}@T{ +The public and private parts of the certificate as a pair of files in PEM format. +The key file has the \f[I].key\f[R] extension and is exported in plain text. +The \f[V]--no-password\f[R] option is intended for internal testing use only. +T} +.TE +.IP \[bu] 2 +\f[B]\f[VB]--format\f[B]\f[R] +.PP +When used with \f[V]--export-path\f[R], specifies the format of the exported certificate file. +Valid values are \f[V]PFX\f[R] and \f[V]PEM\f[R], case-insensitive. +\f[V]PFX\f[R] is the default. +.PP +The file format is independent of the file name extension. +For example, if you specify \f[V]--format pfx\f[R] and \f[V]--export-path ./cert.pem\f[R], you\[cq]ll get a file named \f[I]cert.pem\f[R] in \f[V]PFX\f[R] format. +.PP +For information about the effect of this option when used with \f[V]--password\f[R], \f[V]--no-password\f[R], or without either of those options, see \[en]export-path earlier in this article. +.IP \[bu] 2 +\f[B]\f[VB]-i|--import \f[B]\f[R] +.PP +Imports the provided HTTPS development certificate into the local machine. +Requires that you also specify the \f[V]--clean\f[R] option, which clears out any existing HTTPS developer certificates. +.PP +\f[V]PATH\f[R] specifies a path to a PFX certificate file. +Provide the password with the \f[V]--password\f[R] option. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-np|--no-password\f[B]\f[R] +.RS 2 +.PP +Doesn\[cq]t use a password for the key when exporting a certificate to PEM format files. +The key file is exported in plain text. +This option is not applicable to PFX files and is intended for internal testing use only. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-p|--password\f[B]\f[R] +.RS 2 +.PP +Specifies the password to use: +.IP \[bu] 2 +When exporting the development certificate to a PFX or PEM file. +.IP \[bu] 2 +When importing a PFX file. +.PP +When exporting with \f[V]--format PEM\f[R], the public and private parts of the certificate are exported as a pair of files in PEM format. +The key file has the \f[I].key\f[R] extension and is protected by the given password. +In addition to the file name specified for the \f[V]--export-path\f[R] option, the command creates another file in the same directory with the same name but a \f[I].key\f[R] extension. +For example, the following command will generate a file named \f[I]localhost.pem\f[R] and a file named \f[I]localhost.key\f[R] in the \f[I]/home/user\f[R] directory: +.IP +.nf +\f[C] +dotnet dev-certs https --format pem -ep /home/user/localhost.pem -p $CREDENTIAL_PLACEHOLDER$ +\f[R] +.fi +.PP +In the example, \f[V]$CREDENTIAL_PLACEHOLDER$\f[R] represents a password. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-q|--quiet\f[B]\f[R] +.RS 2 +.PP +Display warnings and errors only. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-t|--trust\f[B]\f[R] +.RS 2 +.PP +Trusts the certificate on the local machine. +.PP +If this option isn\[cq]t specified, the certificate is added to the certificate store but not to a trusted list. +.PP +When combined with the \f[V]--check\f[R] option, validates that the certificate is trusted. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-v|--verbose\f[B]\f[R] +.RS 2 +.PP +Display debug information. +.RE +.SH EXAMPLES +.IP \[bu] 2 +Check for the presence of a development certificate, and create one in the default certificate store if one doesn\[cq]t exist yet. +But don\[cq]t trust the certificate. +.RS 2 +.IP +.nf +\f[C] +dotnet dev-certs https +\f[R] +.fi +.RE +.IP \[bu] 2 +Remove any development certificates that already exist on the local machine. +.RS 2 +.IP +.nf +\f[C] +dotnet dev-certs https --clean +\f[R] +.fi +.RE +.IP \[bu] 2 +Import a PFX file. +.RS 2 +.IP +.nf +\f[C] +dotnet dev-certs https --clean --import ./certificate.pfx -p $CREDENTIAL_PLACEHOLDER$ +\f[R] +.fi +.PP +In the preceding example, \f[V]$CREDENTIAL_PLACEHOLDER$\f[R] represents a password. +.RE +.IP \[bu] 2 +Check if a trusted development certificate is present on the local machine. +.RS 2 +.IP +.nf +\f[C] +dotnet dev-certs https --check --trust +\f[R] +.fi +.RE +.IP \[bu] 2 +Create a certificate, trust it, and export it to a PFX file. +.RS 2 +.IP +.nf +\f[C] +dotnet dev-certs https -ep ./certificate.pfx -p $CREDENTIAL_PLACEHOLDER$ --trust +\f[R] +.fi +.RE +.IP \[bu] 2 +Create a certificate, trust it, and export it to a PEM file. +.RS 2 +.IP +.nf +\f[C] +dotnet dev-certs https -ep ./certificate.crt --trust --format PEM +\f[R] +.fi +.RE +.IP \[bu] 2 +Create a certificate, trust it, and export it to a PEM file including the private key: +.RS 2 +.IP +.nf +\f[C] +dotnet dev-certs https -ep ./certificate.crt -p $CREDENTIAL_PLACEHOLDER$ --trust --format PEM +\f[R] +.fi +.RE +.SH SEE ALSO +.IP \[bu] 2 +Generate self-signed certificates with the .NET CLI +.IP \[bu] 2 +Enforce HTTPS in ASP.NET Core +.IP \[bu] 2 +Troubleshoot certificate problems such as certificate not trusted +.IP \[bu] 2 +Hosting ASP.NET Core images with Docker over HTTPS +.IP \[bu] 2 +Hosting ASP.NET Core images with Docker Compose over HTTPS diff --git a/documentation/manpages/sdk/dotnet-environment-variables.7 b/documentation/manpages/sdk/dotnet-environment-variables.7 index 172451e860ca..36d82d36ec8e 100644 --- a/documentation/manpages/sdk/dotnet-environment-variables.7 +++ b/documentation/manpages/sdk/dotnet-environment-variables.7 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-environment-variables" "7" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-environment-variables" "7" "2022-09-19" "" ".NET Documentation" .hy .SH NAME .PP @@ -139,7 +139,7 @@ This setting can make performance worse if there is expensive work that will end Test to make sure this setting helps performance. .RE .PP -Using TechEmpower benchmarks that generate a lot of small socket reads and writes under a very high load, a single socket engine is capable of keeping busy up to thirty x64 and eight ARM64 CPU cores. +Using TechEmpower benchmarks that generate a lot of small socket reads and writes under a very high load, a single socket engine is capable of keeping busy up to thirty x64 and eight Arm64 CPU cores. The vast majority of real-life scenarios will never generate such a huge load (hundreds of thousands of requests per second), and having a single producer is almost always enough. However, to be sure that extreme loads can be handled, you can use \f[V]DOTNET_SYSTEM_NET_SOCKETS_THREAD_COUNT\f[R] to override the calculated value. When not overridden, the following value is used: @@ -149,7 +149,7 @@ When \f[V]DOTNET_SYSTEM_NET_SOCKETS_INLINE_COMPLETIONS\f[R] is \f[V]1\f[R], the When \f[V]DOTNET_SYSTEM_NET_SOCKETS_INLINE_COMPLETIONS\f[R] is not \f[V]1\f[R], is evaluated: .RS 2 .IP \[bu] 2 -When ARM or ARM64 the cores per engine value is set to \f[V]8\f[R], otherwise \f[V]30\f[R]. +When Arm or Arm64 the cores per engine value is set to \f[V]8\f[R], otherwise \f[V]30\f[R]. .RE .IP \[bu] 2 Using the determined cores per engine, the maximum value of either \f[V]1\f[R] or over the cores per engine. @@ -211,7 +211,7 @@ GC Hole Stress can be enabled using the \f[V]DOTNET_GCStress\f[R] environment va For more information, see Investigating JIT and GC Hole stress (https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/jit/investigate-stress.md). .SS JIT memory barriers .PP -The code generator for ARM64 allows all \f[V]MemoryBarriers\f[R] instructions to be removed by setting \f[V]DOTNET_JitNoMemoryBarriers\f[R] to \f[V]1\f[R]. +The code generator for Arm64 allows all \f[V]MemoryBarriers\f[R] instructions to be removed by setting \f[V]DOTNET_JitNoMemoryBarriers\f[R] to \f[V]1\f[R]. .SS \f[V]DOTNET_RUNNING_IN_CONTAINER\f[R] and \f[V]DOTNET_RUNNING_IN_CONTAINERS\f[R] .PP The official .NET images (Windows and Linux) set the well-known environment variables: @@ -257,7 +257,7 @@ By default trace information is accumulated in a circular buffer and the content .PP Specifies the location of the .NET runtimes, if they are not installed in the default location. The default location on Windows is \f[V]C:\[rs]Program Files\[rs]dotnet\f[R]. -The default location on Linux and macOS is \f[V]/usr/share/dotnet\f[R]. +The default location on Linux and macOS is \f[V]/usr/local/share/dotnet\f[R]. This environment variable is used only when running apps via generated executables (apphosts). \f[V]DOTNET_ROOT(x86)\f[R] is used instead when running a 32-bit executable on a 64-bit OS. .SS \f[V]NUGET_PACKAGES\f[R] @@ -285,7 +285,7 @@ The default value is \f[V]true\f[R], but this can be overridden by setting this .SS \f[V]DOTNET_ADD_GLOBAL_TOOLS_TO_PATH\f[R] .PP Specifies whether to add global tools to the \f[V]PATH\f[R] environment variable. -the default is \f[V]true\f[R]. +The default is \f[V]true\f[R]. To not add global tools to the path, set to \f[V]0\f[R], \f[V]false\f[R], or \f[V]no\f[R]. .SS \f[V]DOTNET_CLI_TELEMETRY_OPTOUT\f[R] .PP @@ -311,18 +311,16 @@ For more information, see Multi-level lookup is disabled. .SS \f[V]DOTNET_ROLL_FORWARD\f[R] .PP Determines roll forward behavior. -For more information, see the \f[V]--roll-forward\f[R] option earlier in this article. +For more information, see the \f[V]--roll-forward\f[R] option for the \f[V]dotnet\f[R] command. .SS \f[V]DOTNET_ROLL_FORWARD_TO_PRERELEASE\f[R] .PP If set to \f[V]1\f[R] (enabled), enables rolling forward to a pre-release version from a release version. By default (\f[V]0\f[R] - disabled), when a release version of .NET runtime is requested, roll-forward will only consider installed release versions. .PP -For more information, see Roll forward. +For more information, see the \f[V]--roll-forward\f[R] option for the \f[V]dotnet\f[R] command .SS \f[V]DOTNET_ROLL_FORWARD_ON_NO_CANDIDATE_FX\f[R] .PP Disables minor version roll forward, if set to \f[V]0\f[R]. -For more information, see Roll forward. -.PP This setting is superseded in .NET Core 3.0 by \f[V]DOTNET_ROLL_FORWARD\f[R]. The new settings should be used instead. .SS \f[V]DOTNET_CLI_UI_LANGUAGE\f[R] diff --git a/documentation/manpages/sdk/dotnet-format.1 b/documentation/manpages/sdk/dotnet-format.1 index 798a28e8671a..07ea3aba8528 100644 --- a/documentation/manpages/sdk/dotnet-format.1 +++ b/documentation/manpages/sdk/dotnet-format.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-format" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-format" "1" "2022-06-20" "" ".NET Documentation" .hy .SH dotnet format .PP @@ -128,7 +128,7 @@ Shows help and usage information .SH DESCRIPTION .PP The \f[V]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 C# formatting rules. +For a complete list of possible formatting options that you can specify in your \f[I].editorconfig\f[R] file, see the C# formatting options. .SH OPTIONS .IP \[bu] 2 \f[B]\f[VB]--folder\f[B]\f[R] diff --git a/documentation/manpages/sdk/dotnet-help.1 b/documentation/manpages/sdk/dotnet-help.1 index 532ee9135f95..96c60c5083ad 100644 --- a/documentation/manpages/sdk/dotnet-help.1 +++ b/documentation/manpages/sdk/dotnet-help.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-help" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-help" "1" "2022-10-10" "" ".NET Documentation" .hy .SH dotnet help reference .PP @@ -31,7 +31,7 @@ dotnet help [-h|--help] .fi .SH DESCRIPTION .PP -The \f[V]dotnet help\f[R] command opens up the reference page for more detailed information about the specified command at docs.microsoft.com. +The \f[V]dotnet help\f[R] command opens up the reference page for more detailed information about the specified command. .SH ARGUMENTS .IP \[bu] 2 \f[B]\f[VB]COMMAND_NAME\f[B]\f[R] diff --git a/documentation/manpages/sdk/dotnet-list-package.1 b/documentation/manpages/sdk/dotnet-list-package.1 index ca62a497908a..efa252919cfb 100644 --- a/documentation/manpages/sdk/dotnet-list-package.1 +++ b/documentation/manpages/sdk/dotnet-list-package.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-list-package" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-list-package" "1" "2022-10-10" "" ".NET Documentation" .hy .SH dotnet list package .PP diff --git a/documentation/manpages/sdk/dotnet-list-reference.1 b/documentation/manpages/sdk/dotnet-list-reference.1 index 43bca5fc66e6..1130f7b4ec92 100644 --- a/documentation/manpages/sdk/dotnet-list-reference.1 +++ b/documentation/manpages/sdk/dotnet-list-reference.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-list-reference" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-list-reference" "1" "2022-10-10" "" ".NET Documentation" .hy .SH dotnet list reference .PP diff --git a/documentation/manpages/sdk/dotnet-new-install.1 b/documentation/manpages/sdk/dotnet-new-install.1 index bff566091c89..0f902b6d9ae6 100644 --- a/documentation/manpages/sdk/dotnet-new-install.1 +++ b/documentation/manpages/sdk/dotnet-new-install.1 @@ -14,24 +14,25 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-install" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-new-install" "1" "2022-11-08" "" ".NET Documentation" .hy .SH dotnet new install .PP \f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions .SH NAME .PP -dotnet-new---install - installs a template package. +dotnet-new-install - installs a template package. .SH SYNOPSIS .IP .nf \f[C] -dotnet new --install [--interactive] [--nuget-source ] +dotnet new install [--interactive] [--add-source|--nuget-source ] [--force] + [-d|--diagnostics] [--verbosity ] [-h|--help] \f[R] .fi .SH DESCRIPTION .PP -The \f[V]dotnet new --install\f[R] command installs a template package from the \f[V]PATH\f[R] or \f[V]NUGET_ID\f[R] provided. +The \f[V]dotnet new install\f[R] command installs a template package from the \f[V]PATH\f[R] or \f[V]NUGET_ID\f[R] provided. If you want to install a specific version or prerelease version of a template package, specify the version in the format \f[V]::\f[R]. By default, \f[V]dotnet new\f[R] passes * for the version, which represents the latest stable package version. For more information, see the Examples section. @@ -48,40 +49,41 @@ Templates from the package won\[cq]t be available in other .NET SDK versions ins Starting with .NET SDK 6.0.100, installed template packages are available in later .NET SDK versions installed on your machine. A template package installed in .NET SDK 6.0.100 will also be available in .NET SDK 6.0.101, .NET SDK 6.0.200, and so on. However, these template packages won\[cq]t be available in .NET SDK versions prior to .NET SDK 6.0.100. -To use a template package installed in .NET SDK 6.0.100 or later in earlier .NET SDK versions, you need to install it using \f[V]dotnet new --install\f[R] in that .NET SDK version. +To use a template package installed in .NET SDK 6.0.100 or later in earlier .NET SDK versions, you need to install it using \f[V]dotnet new install\f[R] in that .NET SDK version. .RS .PP .RE .PP -Starting with .NET SDK 7.0.100 Preview 2, the \f[V]dotnet new\f[R] syntax has changed: +Starting with the .NET 7 SDK, the \f[V]dotnet new\f[R] syntax has changed: .IP \[bu] 2 The \f[V]--list\f[R], \f[V]--search\f[R], \f[V]--install\f[R], and \f[V]--uninstall\f[R] options became \f[V]list\f[R], \f[V]search\f[R], \f[V]install\f[R] and \f[V]uninstall\f[R] subcommands. .IP \[bu] 2 The \f[V]--update-apply\f[R] option became the \f[V]update\f[R] subcommand. .IP \[bu] 2 -to use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check\f[R] option. +To use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check-only\f[R] option. .PP Other options that were available before are still available to use with their respective subcommands. Separate help for each subcommand is available via the \f[V]-h\f[R] or \f[V]--help\f[R] option: \f[V]dotnet new --help\f[R] lists all supported options for the subcommand. .PP Additionally, tab completion is now available for \f[V]dotnet new\f[R]. -It supports completion for installed template names, as well as completion for the options a selected template provides. +It supports completion for installed template names and for the options a selected template provides. To activate tab completion for the .NET SDK, see Enable tab completion. -> > Examples of new syntax: > > - Show help for \f[V]install\f[R] subcommand > > \f[V]dotnetcli > dotnet new install --help >\f[R] > > - Install the latest version of Azure web jobs project template package: > > \f[V]dotnetcli > dotnet new install Microsoft.Azure.WebJobs.ProjectTemplates >\f[R] -.SH OPTIONS +> > Examples of old syntax: > > - Install the latest version of Azure web jobs project template package: > > \f[V]dotnetcli > dotnet new --install Microsoft.Azure.WebJobs.ProjectTemplates >\f[R] +.SH ARGUMENTS .IP \[bu] 2 -\f[B]\f[VB]--interactive\f[B]\f[R] +\f[B]\f[VB]\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. +The folder on the file system or the NuGet package identifier to install the template package from. +\f[V]dotnet new\f[R] attempts to install the NuGet package from the NuGet sources available for the current working directory and the sources specified via the \f[V]--add-source\f[R] option. +If you want to install a specific version or prerelease version of a template package from NuGet source, specify the version in the format \f[V]::\f[R]. .RE +.SH OPTIONS .IP \[bu] 2 -\f[B]\f[VB]--nuget-source \f[B]\f[R] +\f[B]\f[VB]--add-source|--nuget-source \f[B]\f[R] .RS 2 .PP -By default, \f[V]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. +By default, \f[V]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[V]--nuget-source\f[R] is specified, the source will be added to the list of sources to be checked. .PD 0 .P @@ -89,6 +91,43 @@ If \f[V]--nuget-source\f[R] is specified, the source will be added to the list o To check the configured sources for the current directory use \f[V]dotnet nuget list source\f[R]. For more information, see Common NuGet Configurations .RE +.IP \[bu] 2 +\f[B]\f[VB]-d|--diagnostics\f[B]\f[R] +.RS 2 +.PP +Enables diagnostic output. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]--force\f[B]\f[R] +.RS 2 +.PP +Allows installing template packages from the specified sources even if they would override a template package from another source. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-h|--help\f[B]\f[R] +.RS 2 +.PP +Prints out help for the install command. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]--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[VB]-v|--verbosity \f[B]\f[R] +.RS 2 +.PP +Sets the verbosity level of the command. +Allowed values are \f[V]q[uiet]\f[R], \f[V]m[inimal]\f[R], \f[V]n[ormal]\f[R], and \f[V]diag[nostic]\f[R]. +Available since .NET SDK 7.0.100. +.RE .SH EXAMPLES .IP \[bu] 2 Install the latest version of SPA templates for ASP.NET Core: @@ -96,7 +135,7 @@ Install the latest version of SPA templates for ASP.NET Core: .IP .nf \f[C] -dotnet new --install Microsoft.DotNet.Web.Spa.ProjectTemplates +dotnet new install Microsoft.DotNet.Web.Spa.ProjectTemplates \f[R] .fi .RE @@ -106,7 +145,7 @@ Install version 2.0 of the SPA templates for ASP.NET Core: .IP .nf \f[C] -dotnet new --install Microsoft.DotNet.Web.Spa.ProjectTemplates::2.0.0 +dotnet new install Microsoft.DotNet.Web.Spa.ProjectTemplates::2.0.0 \f[R] .fi .RE @@ -116,7 +155,7 @@ Install version 2.0 of the SPA templates for ASP.NET Core from a custom NuGet so .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 +dotnet new --install Microsoft.DotNet.Web.Spa.ProjectTemplates::2.0.0 --add-source \[dq]https://api.my-custom-nuget.com/v3/index.json\[dq] --interactive \f[R] .fi .RE @@ -124,6 +163,6 @@ dotnet new --install Microsoft.DotNet.Web.Spa.ProjectTemplates::2.0.0 --nuget-so .IP \[bu] 2 \f[V]dotnet new\f[R] command .IP \[bu] 2 -\f[V]dotnet new --search\f[R] option +\f[V]dotnet new search\f[R] command .IP \[bu] 2 Custom templates for \f[V]dotnet new\f[R] diff --git a/documentation/manpages/sdk/dotnet-new-list.1 b/documentation/manpages/sdk/dotnet-new-list.1 index 066b77696ce4..160b094b775b 100644 --- a/documentation/manpages/sdk/dotnet-new-list.1 +++ b/documentation/manpages/sdk/dotnet-new-list.1 @@ -14,60 +14,59 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-list" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-new-list" "1" "2022-11-08" "" ".NET Documentation" .hy .SH dotnet new list .PP \f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions .SH NAME .PP -dotnet-new---list - Lists available templates to be run using dotnet-new. +dotnet-new-list - Lists available templates to be run using dotnet-new. .SH SYNOPSIS .IP .nf \f[C] -dotnet new [] -l|--list [--author ] [-lang|--language {\[dq]C#\[dq]|\[dq]F#\[dq]|VB}] +dotnet new list [] [--author ] [-lang|--language {\[dq]C#\[dq]|\[dq]F#\[dq]|VB}] [--tag ] [--type ] [--columns ] [--columns-all] + [-o|--output ] [--project ] [--ignore-constraints] + [-d|--diagnostics] [--verbosity ] [-h|--help] \f[R] .fi .SH DESCRIPTION .PP -The \f[V]dotnet new --list\f[R] option lists available templates to use with \f[V]dotnet new\f[R]. +The \f[V]dotnet new list\f[R] command lists available templates to use with \f[V]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[V]--search\f[R] option. +To find templates in NuGet that you can install locally, use the \f[V]search\f[R] command. +.PP +Starting with .NET SDK 7.0.100, the \f[V]list\f[R] command might not show all the templates installed on the machine. +It takes the result of template constraints into account, and the templates that can\[cq]t be used won\[cq]t be shown. +To force show all the templates, use the \f[V]--ignore-constraints\f[R] option. .RS .PP .RE .PP -Starting with .NET SDK 7.0.100 Preview 2, the \f[V]dotnet new\f[R] syntax has changed: +Starting with the .NET 7 SDK, the \f[V]dotnet new\f[R] syntax has changed: .IP \[bu] 2 The \f[V]--list\f[R], \f[V]--search\f[R], \f[V]--install\f[R], and \f[V]--uninstall\f[R] options became \f[V]list\f[R], \f[V]search\f[R], \f[V]install\f[R] and \f[V]uninstall\f[R] subcommands. .IP \[bu] 2 The \f[V]--update-apply\f[R] option became the \f[V]update\f[R] subcommand. .IP \[bu] 2 -to use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check\f[R] option. +To use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check-only\f[R] option. .PP Other options that were available before are still available to use with their respective subcommands. Separate help for each subcommand is available via the \f[V]-h\f[R] or \f[V]--help\f[R] option: \f[V]dotnet new --help\f[R] lists all supported options for the subcommand. .PP Additionally, tab completion is now available for \f[V]dotnet new\f[R]. -It supports completion for installed template names, as well as completion for the options a selected template provides. +It supports completion for installed template names and for the options a selected template provides. To activate tab completion for the .NET SDK, see Enable tab completion. -> > Examples of the new syntax: > > - Show help for \f[V]list\f[R] subcommand > > \f[V]dotnetcli > dotnet new list --help >\f[R] > > - List all templates matching the we substring that support the F# language. -> > \f[V]dotnetcli > dotnet new list we --language \[dq]F#\[dq] >\f[R] +> > Examples of the old syntax: > > - List all Single Page Application (SPA) templates: > - since .NET SDK 6.0.100 > > \f[V]dotnetcli > dotnet new --list spa >\f[R] > > - before .NET SDK 6.0.100 > > \f[V]dotnetcli > dotnet new spa --list >\f[R] .SH ARGUMENTS .IP \[bu] 2 \f[B]\f[VB]TEMPLATE_NAME\f[B]\f[R] .RS 2 .PP If the argument is specified, only the templates containing \f[V]\f[R] in template name or short name will be shown. -.RS -.PP -Starting with .NET SDK 6.0.100, you can put the \f[V]\f[R] argument after the \f[V]--list\f[R] option. -For example, \f[V]dotnet new --list web\f[R] provides the same result as \f[V]dotnet new web --list\f[R]. -Using more than one argument is not allowed. -.RE .RE .SH OPTIONS .IP \[bu] 2 @@ -76,7 +75,7 @@ Using more than one argument is not allowed. .PP Filters templates based on template author. Partial match is supported. -Available since .NET Core 5.0.300 SDK. +Available since .NET SDK 5.0.300. .RE .IP \[bu] 2 \f[B]\f[VB]--columns \f[B]\f[R] @@ -96,14 +95,35 @@ The supported columns are: 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[V]--columns=language,tags\f[R]. -Available since .NET Core 5.0.300 SDK. +Available since .NET SDK 5.0.300. .RE .IP \[bu] 2 \f[B]\f[VB]--columns-all\f[B]\f[R] .RS 2 .PP Displays all columns in the output. -Available since .NET Core 5.0.300 SDK. +Available since .NET SDK 5.0.300. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-d|--diagnostics\f[B]\f[R] +.RS 2 +.PP +Enables diagnostic output. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-h|--help\f[B]\f[R] +.RS 2 +.PP +Prints out help for the list command. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]--ignore-constraints\f[B]\f[R] +.RS 2 +.PP +Disables checking if the template meets the constraints to be run. +Available since .NET SDK 7.0.100. .RE .IP \[bu] 2 \f[B]\f[VB]-lang|--language {C#|F#|VB}\f[B]\f[R] @@ -120,12 +140,29 @@ For example, \f[V]dotnet new --list --language \[dq]F#\[dq]\f[R]. .RE .RE .IP \[bu] 2 +\f[B]\f[VB]-o|--output \f[B]\f[R] +.RS 2 +.PP +Location to place the generated output. +The default is the current directory. +For the list command, it might be necessary to specify the output directory to correctly evaluate constraints for the template. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]--project \f[B]\f[R] +.RS 2 +.PP +The project that the template is added to. +For the list command, it might be needed to specify the project the template is being added to to correctly evaluate constraints for the template. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 \f[B]\f[VB]--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. +Available since .NET SDK 5.0.300. .RE .IP \[bu] 2 \f[B]\f[VB]--type \f[B]\f[R] @@ -134,6 +171,14 @@ Available since .NET Core 5.0.300 SDK. Filters templates based on template type. Predefined values are \f[V]project\f[R], \f[V]item\f[R], and \f[V]solution\f[R]. .RE +.IP \[bu] 2 +\f[B]\f[VB]-v|--verbosity \f[B]\f[R] +.RS 2 +.PP +Sets the verbosity level of the command. +Allowed values are \f[V]q[uiet]\f[R], \f[V]m[inimal]\f[R], \f[V]n[ormal]\f[R], and \f[V]diag[nostic]\f[R]. +Available since .NET SDK 7.0.100. +.RE .SH EXAMPLES .IP \[bu] 2 List all templates @@ -141,47 +186,27 @@ List all templates .IP .nf \f[C] -dotnet new --list +dotnet new list \f[R] .fi .RE .IP \[bu] 2 List all Single Page Application (SPA) templates: .RS 2 -.IP \[bu] 2 -since .NET SDK 6.0.100 .IP .nf \f[C] -dotnet new --list spa -\f[R] -.fi -.IP \[bu] 2 -before .NET SDK 6.0.100 -.IP -.nf -\f[C] -dotnet new spa --list +dotnet new list spa \f[R] .fi .RE .IP \[bu] 2 List all templates matching the \f[I]we\f[R] substring. .RS 2 -.IP \[bu] 2 -since .NET SDK 6.0.100 -.IP -.nf -\f[C] -dotnet new --list we -\f[R] -.fi -.IP \[bu] 2 -before .NET SDK 6.0.100 .IP .nf \f[C] -dotnet new we --list +dotnet new list we \f[R] .fi .RE @@ -191,7 +216,7 @@ List all templates matching the \f[I]we\f[R] substring that support the F# langu .IP .nf \f[C] -dotnet new --list we --language \[dq]F#\[dq] +dotnet new list we --language \[dq]F#\[dq] \f[R] .fi .RE @@ -201,7 +226,7 @@ List all item templates. .IP .nf \f[C] -dotnet new --list --type item +dotnet new list --type item \f[R] .fi .RE @@ -211,7 +236,7 @@ List all C# templates, showing the author and the type in the output. .IP .nf \f[C] -dotnet new --list --language \[dq]C#\[dq] --columns \[dq]author,type\[dq] +dotnet new list --language \[dq]C#\[dq] --columns \[dq]author,type\[dq] \f[R] .fi .RE @@ -219,6 +244,6 @@ dotnet new --list --language \[dq]C#\[dq] --columns \[dq]author,type\[dq] .IP \[bu] 2 dotnet new command .IP \[bu] 2 -dotnet new \[en]search option +dotnet new search command .IP \[bu] 2 Custom templates for dotnet new diff --git a/documentation/manpages/sdk/dotnet-new-sdk-templates.7 b/documentation/manpages/sdk/dotnet-new-sdk-templates.7 index ef1c352d2244..f8bf3b08c82c 100644 --- a/documentation/manpages/sdk/dotnet-new-sdk-templates.7 +++ b/documentation/manpages/sdk/dotnet-new-sdk-templates.7 @@ -15,7 +15,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-sdk-templates" "7" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-new-sdk-templates" "7" "2022-11-08" "" ".NET Documentation" .hy .SH NAME .PP @@ -23,11 +23,11 @@ dotnet-new-sdk-templates - .NET default templates for dotnet new .SH DESCRIPTION .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[V]dotnet new\f[R] command with the \f[V]-l|--list\f[R] option: +To list the built-in templates, run the \f[V]dotnet new list\f[R] command: .IP .nf \f[C] -dotnet new --list +dotnet new list \f[R] .fi .PP @@ -249,6 +249,17 @@ T}@T{ 3.0 T} T{ +Blazor Server App Empty +T}@T{ +\f[V]blazorserver-empty\f[R] +T}@T{ +[C#] +T}@T{ +Web/Blazor +T}@T{ +7.0 +T} +T{ Blazor WebAssembly App T}@T{ \f[V]blazorwasm\f[R] @@ -260,6 +271,17 @@ T}@T{ 3.1.300 T} T{ +Blazor WebAssembly App Empty +T}@T{ +\f[V]blazorwasm-empty\f[R] +T}@T{ +[C#] +T}@T{ +Web/Blazor/WebAssembly +T}@T{ +7.0 +T} +T{ ASP.NET Core Empty T}@T{ \f[V]web\f[R] @@ -442,7 +464,10 @@ T} .SS Template options .PP Each template may have additional options available. -The core templates have the following additional options: +To show the additional options available for the template use the \f[V]--help\f[R] option with the template name argument, for example: \f[V]dotnet new console --help\f[R]. +In case the template supports multiple languages, this command will show help for the template in the default language. +By combining it with the \f[V]--language\f[R] option, you can see the help for other languages: \f[V]dotnet new console --help --language F#\f[R]. +The templates that ship with the .NET SDK have the following additional options: .SS \f[V]console\f[R] .IP \[bu] 2 \f[B]\f[VB]-f|--framework \f[B]\f[R] @@ -451,7 +476,7 @@ The core templates have the following additional options: 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: +The following table lists the default values according to the SDK version you\[cq]re using: .PP .TS tab(@); @@ -463,14 +488,14 @@ Default value T} _ T{ -6.0 +7.0 T}@T{ -\f[V]net6.0\f[R] +\f[V]net7.0\f[R] T} T{ -5.0 +6.0 T}@T{ -\f[V]net5.0\f[R] +\f[V]net6.0\f[R] T} T{ 3.1 @@ -480,14 +505,14 @@ 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 the .NET 6 SDK installed, then the only value available for \f[V]--framework\f[R] is \f[V]net6.0\f[R]. -If you install the .NET 5 SDK, the value \f[V]net5.0\f[R] becomes available for \f[V]--framework\f[R]. +For example, if you have only the .NET 7 SDK installed, then the only value available for \f[V]--framework\f[R] is \f[V]net7.0\f[R]. +If you install the .NET 6 SDK the value \f[V]net6.0\f[R] becomes available for \f[V]--framework\f[R]. If you install the .NET Core 3.1 SDK, \f[V]netcoreapp3.1\f[R] becomes available, and so on. So by specifying \f[V]--framework netcoreapp3.1\f[R] you can target .NET Core 3.1 even while running \f[V]dotnet new\f[R] in the .NET 6 SDK. .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[V]console\f[R] project that targets \f[V]netcoreapp1.0\f[R], run \f[V]dotnet new --install\f[R] on \f[V]Microsoft.DotNet.Common.ProjectTemplates.1.x\f[R]. +For example, to create a \f[V]console\f[R] project that targets \f[V]netcoreapp1.0\f[R], run \f[V]dotnet new install\f[R] on \f[V]Microsoft.DotNet.Common.ProjectTemplates.1.x\f[R]. .RE .IP \[bu] 2 \f[B]\f[VB]--langVersion \f[B]\f[R] @@ -514,6 +539,7 @@ Available since .NET Core 2.2 SDK. If specified, an explicit \f[V]Program\f[R] class and \f[V]Main\f[R] method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: \f[V]false\f[R]. +Available only for C#. .RE .PP * * * * * @@ -523,8 +549,8 @@ Default value: \f[V]false\f[R]. .RS 2 .PP Specifies the framework to target. -Values: \f[V]net6.0\f[R], \f[V]net5.0\f[R], or \f[V]netcoreapp3.1\f[R] to create a .NET Class Library or \f[V]netstandard\f[R] to create a .NET Standard Class Library. -The default value for .NET 6 SDK is \f[V]net6.0\f[R]. +Values: \f[V]net7.0\f[R], \f[V]net6.0\f[R], or \f[V]netcoreapp3.1\f[R] to create a .NET Class Library or \f[V]netstandard2.1\f[R] or \f[V]netstandard2.0\f[R] to create a .NET Standard Class Library. +The default value for .NET SDK 7.0.x is \f[V]net7.0\f[R]. .PP To create a project that targets a framework earlier than the SDK that you\[cq]re using, see \f[V]--framework\f[R] for \f[V]console\f[R] projects earlier in this article. .RE @@ -597,7 +623,7 @@ Doesn\[cq]t execute an implicit restore during project creation. .RS 2 .PP Specifies the framework to target. -The default value is \f[V]netcoreapp3.1\f[R]. +The default value for .NET 7 SDK is \f[V]net7.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[V]--framework\f[R] for \f[V]console\f[R] projects earlier in this article. @@ -925,6 +951,11 @@ Default value T} _ T{ +7.0 +T}@T{ +\f[V]net7.0\f[R] +T} +T{ 6.0 T}@T{ \f[V]net6.0\f[R] @@ -1806,7 +1837,7 @@ Creates an empty \f[I].editorconfig\f[R] instead of the defaults for .NET. .IP \[bu] 2 dotnet new command .IP \[bu] 2 -dotnet new \[en]list option +dotnet new list command .IP \[bu] 2 Custom templates for dotnet new .IP \[bu] 2 diff --git a/documentation/manpages/sdk/dotnet-new-search.1 b/documentation/manpages/sdk/dotnet-new-search.1 index ce7bfecdb9f9..8e80011a0f2d 100644 --- a/documentation/manpages/sdk/dotnet-new-search.1 +++ b/documentation/manpages/sdk/dotnet-new-search.1 @@ -14,49 +14,49 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-search" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-new-search" "1" "2022-11-08" "" ".NET Documentation" .hy .SH dotnet new search .PP \f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 5.0.300 SDK and later versions .SH NAME .PP -dotnet-new---search - searches for the templates supported by dotnet-new on NuGet.org. +dotnet-new-search - searches for the templates supported by dotnet-new on NuGet.org. .SH SYNOPSIS .IP .nf \f[C] -dotnet new --search +dotnet new search -dotnet new [] --search [--author ] [-lang|--language {\[dq]C#\[dq]|\[dq]F#\[dq]|VB}] +dotnet new search [] [--author ] [-lang|--language {\[dq]C#\[dq]|\[dq]F#\[dq]|VB}] [--package ] [--tag ] [--type ] [--columns ] [--columns-all] + [-d|--diagnostics] [--verbosity ] [-h|--help] \f[R] .fi .SH DESCRIPTION .PP -The \f[V]dotnet new --search\f[R] option searches for templates supported by \f[V]dotnet new\f[R] on NuGet.org. +The \f[V]dotnet new search\f[R] command searches for templates supported by \f[V]dotnet new\f[R] on NuGet.org. When the is specified, searches for templates containing the specified name. .RS .PP .RE .PP -Starting with .NET SDK 7.0.100 Preview 2, the \f[V]dotnet new\f[R] syntax has changed: +Starting with the .NET 7 SDK, the \f[V]dotnet new\f[R] syntax has changed: .IP \[bu] 2 The \f[V]--list\f[R], \f[V]--search\f[R], \f[V]--install\f[R], and \f[V]--uninstall\f[R] options became \f[V]list\f[R], \f[V]search\f[R], \f[V]install\f[R] and \f[V]uninstall\f[R] subcommands. .IP \[bu] 2 The \f[V]--update-apply\f[R] option became the \f[V]update\f[R] subcommand. .IP \[bu] 2 -to use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check\f[R] option. +To use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check-only\f[R] option. .PP Other options that were available before are still available to use with their respective subcommands. Separate help for each subcommand is available via the \f[V]-h\f[R] or \f[V]--help\f[R] option: \f[V]dotnet new --help\f[R] lists all supported options for the subcommand. .PP Additionally, tab completion is now available for \f[V]dotnet new\f[R]. -It supports completion for installed template names, as well as completion for the options a selected template provides. +It supports completion for installed template names and for the options a selected template provides. To activate tab completion for the .NET SDK, see Enable tab completion. -> > Examples of the new syntax: > > - Show help for the \f[V]search\f[R] subcommand. -> > \f[V]dotnetcli > dotnet new search --help >\f[R] > > - Search for all templates available on NuGet.org matching the \[lq]we\[rq] substring and supporting the F# language > > \f[V]dotnetcli > dotnet new search we --language \[dq]F#\[dq] >\f[R] +> > Examples of the old syntax: > > - Search for all templates available on NuGet.org matching the \[lq]we\[rq] substring and supporting the F# language > > \f[V]dotnetcli > dotnet new we --search --language \[dq]F#\[dq] >\f[R] .SH ARGUMENTS .IP \[bu] 2 \f[B]\f[VB]TEMPLATE_NAME\f[B]\f[R] @@ -105,6 +105,20 @@ This list is equivalent to specifying \f[V]--columns=author,language\f[R]. Displays all columns in the output. .RE .IP \[bu] 2 +\f[B]\f[VB]-d|--diagnostics\f[B]\f[R] +.RS 2 +.PP +Enables diagnostic output. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-h|--help\f[B]\f[R] +.RS 2 +.PP +Prints out help for the search command. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 \f[B]\f[VB]-lang|--language {C#|F#|VB}\f[B]\f[R] .RS 2 .PP @@ -138,49 +152,37 @@ To be selected, a template must have at least one tag that exactly matches the c .PP Filters templates based on template type. Predefined values are \f[V]project\f[R], \f[V]item\f[R], and \f[V]solution\f[R]. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-v|--verbosity \f[B]\f[R] +.RS 2 +.PP +Sets the verbosity level of the command. +Allowed values are \f[V]q[uiet]\f[R], \f[V]m[inimal]\f[R], \f[V]n[ormal]\f[R], and \f[V]diag[nostic]\f[R]. +Available since .NET SDK 7.0.100. +.RE .RS .PP To ensure that the template package appears in \f[V]dotnet new --search\f[R] result, set the NuGet package type to \f[V]Template\f[R]. .RE -.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 \[bu] 2 -since .NET SDK 6.0.100 -.IP -.nf -\f[C] -dotnet new --search spa -\f[R] -.fi -.IP \[bu] 2 -before .NET SDK 6.0.100 .IP .nf \f[C] -dotnet new spa --search +dotnet new search spa \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 \[bu] 2 -since .NET SDK 6.0.100 -.IP -.nf -\f[C] -dotnet new --search we --language \[dq]F#\[dq] -\f[R] -.fi -.IP \[bu] 2 -before .NET SDK 6.0.100 .IP .nf \f[C] -dotnet new we --search --language \[dq]F#\[dq] +dotnet new search we --language \[dq]F#\[dq] \f[R] .fi .RE @@ -190,7 +192,7 @@ Search for item templates. .IP .nf \f[C] -dotnet new --search --type item +dotnet new search --type item \f[R] .fi .RE @@ -200,7 +202,7 @@ Search for all C# templates, showing the type and tags in the output. .IP .nf \f[C] -dotnet new --search --language \[dq]C#\[dq] --columns \[dq]type,tags\[dq] +dotnet new search --language \[dq]C#\[dq] --columns \[dq]type,tags\[dq] \f[R] .fi .RE @@ -208,6 +210,6 @@ dotnet new --search --language \[dq]C#\[dq] --columns \[dq]type,tags\[dq] .IP \[bu] 2 dotnet new command .IP \[bu] 2 -dotnet new \[en]list option +dotnet new list command .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 index 21600b959233..a8f52bc57a8b 100644 --- a/documentation/manpages/sdk/dotnet-new-uninstall.1 +++ b/documentation/manpages/sdk/dotnet-new-uninstall.1 @@ -14,46 +14,77 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-uninstall" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-new-uninstall" "1" "2022-11-08" "" ".NET Documentation" .hy .SH dotnet new uninstall .PP \f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions .SH NAME .PP -dotnet-new---uninstall - uninstalls a template package. +dotnet-new-uninstall - uninstalls a template package. .SH SYNOPSIS .IP .nf \f[C] -dotnet new --uninstall +dotnet new uninstall + [-d|--diagnostics] [--verbosity ] [-h|--help] \f[R] .fi .SH DESCRIPTION .PP -The \f[V]dotnet new --uninstall\f[R] command uninstalls a template package at the \f[V]PATH\f[R] or \f[V]NUGET_ID\f[R] provided. +The \f[V]dotnet new uninstall\f[R] command uninstalls a template package at the \f[V]PATH\f[R] or \f[V]NUGET_ID\f[R] provided. When the \f[V]\f[R] value isn\[cq]t specified, all currently installed template packages and their associated templates are displayed. When specifying \f[V]NUGET_ID\f[R], don\[cq]t include the version number. .RS .PP .RE .PP -Starting with .NET SDK 7.0.100 Preview 2, the \f[V]dotnet new\f[R] syntax has changed: +Starting with the .NET 7 SDK, the \f[V]dotnet new\f[R] syntax has changed: .IP \[bu] 2 The \f[V]--list\f[R], \f[V]--search\f[R], \f[V]--install\f[R], and \f[V]--uninstall\f[R] options became \f[V]list\f[R], \f[V]search\f[R], \f[V]install\f[R] and \f[V]uninstall\f[R] subcommands. .IP \[bu] 2 The \f[V]--update-apply\f[R] option became the \f[V]update\f[R] subcommand. .IP \[bu] 2 -to use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check\f[R] option. +To use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check-only\f[R] option. .PP Other options that were available before are still available to use with their respective subcommands. Separate help for each subcommand is available via the \f[V]-h\f[R] or \f[V]--help\f[R] option: \f[V]dotnet new --help\f[R] lists all supported options for the subcommand. .PP Additionally, tab completion is now available for \f[V]dotnet new\f[R]. -It supports completion for installed template names, as well as completion for the options a selected template provides. +It supports completion for installed template names and for the options a selected template provides. To activate tab completion for the .NET SDK, see Enable tab completion. -> > Examples of the new syntax: > > - Show help for the \f[V]uninstall\f[R] subcommand. -> > \f[V]dotnetcli > dotnet new uninstall --help >\f[R] > > - List the installed templates and details about them, including how to uninstall them: > > \f[V]dotnetcli > dotnet new uninstall >\f[R] > > - Uninstall the Azure web jobs project template package: > > \f[V]dotnetcli > dotnet new uninstall Microsoft.Azure.WebJobs.ProjectTemplates >\f[R] +> > Examples of the old syntax: > > - List the installed templates and details about them, including how to uninstall them: > > \f[V]dotnetcli > dotnet new --uninstall >\f[R] > > - Uninstall the Azure web jobs project template package: > > \f[V]dotnetcli > dotnet new --uninstall Microsoft.Azure.WebJobs.ProjectTemplates >\f[R] +.SH ARGUMENTS +.IP \[bu] 2 +\f[B]\f[VB]\f[B]\f[R] +.RS 2 +.PP +The folder on the file system or the NuGet package identifier the package was installed from. +Note that the version for the NuGet package should not be specified. +.RE +.SH OPTIONS +.IP \[bu] 2 +\f[B]\f[VB]-d|--diagnostics\f[B]\f[R] +.RS 2 +.PP +Enables diagnostic output. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-h|--help\f[B]\f[R] +.RS 2 +.PP +Prints out help for the uninstall command. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-v|--verbosity \f[B]\f[R] +.RS 2 +.PP +Sets the verbosity level of the command. +Allowed values are \f[V]q[uiet]\f[R], \f[V]m[inimal]\f[R], \f[V]n[ormal]\f[R], and \f[V]diag[nostic]\f[R]. +Available since .NET SDK 7.0.100. +.RE .SH EXAMPLES .IP \[bu] 2 List the installed templates and details about them, including how to uninstall them: @@ -61,7 +92,7 @@ List the installed templates and details about them, including how to uninstall .IP .nf \f[C] -dotnet new --uninstall +dotnet new uninstall \f[R] .fi .RE @@ -71,7 +102,7 @@ Uninstall the SPA templates for ASP.NET Core: .IP .nf \f[C] -dotnet new --uninstall Microsoft.DotNet.Web.Spa.ProjectTemplates +dotnet new uninstall Microsoft.DotNet.Web.Spa.ProjectTemplates \f[R] .fi .RE @@ -79,8 +110,8 @@ dotnet new --uninstall Microsoft.DotNet.Web.Spa.ProjectTemplates .IP \[bu] 2 dotnet new command .IP \[bu] 2 -dotnet new \[en]list option +dotnet new list command .IP \[bu] 2 -dotnet new \[en]search option +dotnet new search command .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 index bd28b9eb7369..0f87e86e9861 100644 --- a/documentation/manpages/sdk/dotnet-new-update.1 +++ b/documentation/manpages/sdk/dotnet-new-update.1 @@ -14,55 +14,120 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-update" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-new-update" "1" "2022-11-08" "" ".NET Documentation" .hy .SH dotnet new update .PP \f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions .SH NAME .PP -dotnet-new---update-check - Checks for available updates for installed template packages. -.PP -dotnet-new---update-apply - Applies updates to installed template packages. +dotnet-new-update - updates installed template packages. .SH SYNOPSIS .IP .nf \f[C] -dotnet new --update-check +dotnet new update [--interactive] [--add-source|--nuget-source ] + [-d|--diagnostics] [--verbosity ] [-h|--help] -dotnet new --update-apply +dotnet new update --check-only|--dry-run [--interactive] [--add-source|--nuget-source ] + [-d|--diagnostics] [--verbosity ] [-h|--help] \f[R] .fi .SH DESCRIPTION .PP -The \f[V]dotnet new --update-check\f[R] option checks if there are updates available for the template packages that are currently installed. -The \f[V]dotnet new --update-apply\f[R] option checks if there are updates available for the template packages that are currently installed and installs them. +The \f[V]dotnet new update\f[R] command updates installed template packages. +The \f[V]dotnet new update\f[R] command with \f[V]--check-only\f[R] option checks for available updates for installed template packages without applying them. .RS .PP .RE .PP -Starting with .NET SDK 7.0.100 Preview 2, the \f[V]dotnet new\f[R] syntax has changed: +Starting with the .NET 7 SDK, the \f[V]dotnet new\f[R] syntax has changed: .IP \[bu] 2 The \f[V]--list\f[R], \f[V]--search\f[R], \f[V]--install\f[R], and \f[V]--uninstall\f[R] options became \f[V]list\f[R], \f[V]search\f[R], \f[V]install\f[R] and \f[V]uninstall\f[R] subcommands. .IP \[bu] 2 The \f[V]--update-apply\f[R] option became the \f[V]update\f[R] subcommand. .IP \[bu] 2 -to use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check\f[R] option. +To use \f[V]--update-check\f[R], use the \f[V]update\f[R] subcommand with the \f[V]--check-only\f[R] option. .PP Other options that were available before are still available to use with their respective subcommands. Separate help for each subcommand is available via the \f[V]-h\f[R] or \f[V]--help\f[R] option: \f[V]dotnet new --help\f[R] lists all supported options for the subcommand. .PP Additionally, tab completion is now available for \f[V]dotnet new\f[R]. -It supports completion for installed template names, as well as completion for the options a selected template provides. +It supports completion for installed template names and for the options a selected template provides. To activate tab completion for the .NET SDK, see Enable tab completion. -> > Examples of the new syntax: > > - Show help for the \f[V]update\f[R] subcommand. -> > \f[V]dotnetcli > dotnet new update --help >\f[R] > > - Check for updates for installed template packages: > > \f[V]dotnetcli > dotnet new update --check >\f[R] > > - Update installed template packages: > > \f[V]dotnetcli > dotnet new update >\f[R] +> > Examples of the old syntax: > > - Show help for the \f[V]update\f[R] subcommand. +> > - Check for updates for installed template packages: > > \f[V]dotnetcli > dotnet new --update-check >\f[R] > > - Update installed template packages: > > \f[V]dotnetcli > dotnet new --update-apply >\f[R] +.SH OPTIONS +.IP \[bu] 2 +\f[B]\f[VB]--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[VB]--add-source|nuget-source \f[B]\f[R] +.RS 2 +.PP +By default, \f[V]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[V]--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[V]dotnet nuget list source\f[R]. +For more information, see Common NuGet Configurations. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-d|--diagnostics\f[B]\f[R] +.RS 2 +.PP +Enables diagnostic output. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-h|--help\f[B]\f[R] +.RS 2 +.PP +Prints out help for the update command. +Available since .NET SDK 7.0.100. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-v|--verbosity \f[B]\f[R] +.RS 2 +.PP +Sets the verbosity level of the command. +Allowed values are \f[V]q[uiet]\f[R], \f[V]m[inimal]\f[R], \f[V]n[ormal]\f[R], and \f[V]diag[nostic]\f[R]. +Available since .NET SDK 7.0.100. +.RE +.SH EXAMPLES +.IP \[bu] 2 +Updates the installed template packages using NuGet configuration for the current directory: +.RS 2 +.IP +.nf +\f[C] +dotnet new update +\f[R] +.fi +.RE +.IP \[bu] 2 +Updates the installed template packages also checking a custom NuGet source using interactive mode: +.RS 2 +.IP +.nf +\f[C] +dotnet new update --add-source \[dq]https://api.my-custom-nuget.com/v3/index.json\[dq] --interactive +\f[R] +.fi +.RE .SH SEE ALSO .IP \[bu] 2 dotnet new command .IP \[bu] 2 -dotnet new \[en]search option +dotnet new search command .IP \[bu] 2 -dotnet new \[en]install option +dotnet new install command .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 19dbcc2d81b8..014d4ff7aa77 100644 --- a/documentation/manpages/sdk/dotnet-new.1 +++ b/documentation/manpages/sdk/dotnet-new.1 @@ -15,7 +15,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new" "1" "2022-06-03" "" ".NET Documentation" +.TH "dotnet-new" "1" "2022-11-08" "" ".NET Documentation" .hy .SH dotnet new