Skip to content

Commit 040608c

Browse files
committed
Update manpages for 8.0
1 parent abb8afb commit 040608c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+810
-188
lines changed

documentation/manpages/sdk/dotnet-add-package.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-add-package" "1" "2022-10-10" "" ".NET Documentation"
17+
.TH "dotnet-add-package" "1" "2023-10-25" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet add package
2020
.PP

documentation/manpages/sdk/dotnet-add-reference.1

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-add-reference" "1" "2022-10-10" "" ".NET Documentation"
17+
.TH "dotnet-add-reference" "1" "2023-10-25" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet add reference
2020
.PP
@@ -46,6 +46,20 @@ After running the command, the \f[V]<ProjectReference>\f[R] elements are added t
4646
</ItemGroup>
4747
\f[R]
4848
.fi
49+
.SS Add a reference to an assembly that isn\[cq]t in a project
50+
.PP
51+
There\[cq]s no CLI command to add a reference to an assembly that isn\[cq]t in a project or a package.
52+
But you can do that by editing your \f[I].csproj\f[R] file and adding markup similar to the following example:
53+
.IP
54+
.nf
55+
\f[C]
56+
<ItemGroup>
57+
<Reference Include=\[dq]MyAssembly\[dq]>
58+
<HintPath>\[dq].\[rs]MyDLLFolder\[rs]MyAssembly.dll</HintPath>
59+
</Reference>
60+
</ItemGroup>
61+
\f[R]
62+
.fi
4963
.SH ARGUMENTS
5064
.IP \[bu] 2
5165
\f[B]\f[VB]PROJECT\f[B]\f[R]

documentation/manpages/sdk/dotnet-build-server.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-build-server" "1" "2022-10-10" "" ".NET Documentation"
17+
.TH "dotnet-build-server" "1" "2023-10-25" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet build-server
2020
.PP

documentation/manpages/sdk/dotnet-build.1

Lines changed: 70 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-build" "1" "2022-10-21" "" ".NET Documentation"
17+
.TH "dotnet-build" "1" "2023-10-25" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet build
2020
.PP
@@ -28,10 +28,14 @@ dotnet-build - Builds a project and all of its dependencies.
2828
\f[C]
2929
dotnet build [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
3030
[-c|--configuration <CONFIGURATION>] [-f|--framework <FRAMEWORK>]
31+
[--disable-build-servers]
3132
[--force] [--interactive] [--no-dependencies] [--no-incremental]
3233
[--no-restore] [--nologo] [--no-self-contained] [--os <OS>]
33-
[-o|--output <OUTPUT_DIRECTORY>] [-r|--runtime <RUNTIME_IDENTIFIER>]
34-
[--self-contained [true|false]] [--source <SOURCE>] [--use-current-runtime, --ucr [true|false]]
34+
[-o|--output <OUTPUT_DIRECTORY>]
35+
[-p|--property:<PROPERTYNAME>=<VALUE>]
36+
[-r|--runtime <RUNTIME_IDENTIFIER>]
37+
[--self-contained [true|false]] [--source <SOURCE>]
38+
[--tl [auto|on|off]] [--use-current-runtime, --ucr [true|false]]
3539
[-v|--verbosity <LEVEL>] [--version-suffix <VERSION_SUFFIX>]
3640

3741
dotnet build -h|--help
@@ -135,6 +139,15 @@ Defines the build configuration.
135139
The default for most projects is \f[V]Debug\f[R], but you can override the build configuration settings in your project.
136140
.RE
137141
.IP \[bu] 2
142+
\f[B]\f[VB]--disable-build-servers\f[B]\f[R]
143+
.RS 2
144+
.PP
145+
Forces the command to ignore any persistent build servers.
146+
This option provides a consistent way to disable all use of build caching, which forces a build from scratch.
147+
A build that doesn\[cq]t rely on caches is useful when the caches might be corrupted or incorrect for some reason.
148+
Available since .NET 7 SDK.
149+
.RE
150+
.IP \[bu] 2
138151
\f[B]\f[VB]-f|--framework <FRAMEWORK>\f[B]\f[R]
139152
.RS 2
140153
.PP
@@ -203,6 +216,14 @@ Available since .NET 6 SDK.
203216
Directory in which to place the built binaries.
204217
If not specified, the default path is \f[V]./bin/<configuration>/<framework>/\f[R].
205218
For projects with multiple target frameworks (via the \f[V]TargetFrameworks\f[R] property), you also need to define \f[V]--framework\f[R] when you specify this option.
219+
.IP \[bu] 2
220+
\&.NET 7.0.200 SDK and later
221+
.RS 2
222+
.PP
223+
If you specify the \f[V]--output\f[R] option when running this command on a solution, the CLI will emit a warning (an error in 7.0.200) due to the unclear semantics of the output path.
224+
The \f[V]--output\f[R] option is disallowed because all outputs of all built projects would be copied into the specified directory, which isn\[cq]t compatible with multi-targeted projects, as well as projects that have different versions of direct and transitive dependencies.
225+
For more information, see Solution-level \f[V]--output\f[R] option no longer valid for build-related commands.
226+
.RE
206227
.RE
207228
.IP \[bu] 2
208229
\f[B]\f[VB]--os <OS>\f[B]\f[R]
@@ -215,6 +236,20 @@ If you use this option, don\[cq]t use the \f[V]-r|--runtime\f[R] option.
215236
Available since .NET 6.
216237
.RE
217238
.IP \[bu] 2
239+
\f[B]\f[VB]-p|--property:<PROPERTYNAME>=<VALUE>\f[B]\f[R]
240+
.RS 2
241+
.PP
242+
Sets one or more MSBuild properties.
243+
Specify multiple properties delimited by semicolons or by repeating the option:
244+
.IP
245+
.nf
246+
\f[C]
247+
--property:<NAME1>=<VALUE1>;<NAME2>=<VALUE2>
248+
--property:<NAME1>=<VALUE1> --property:<NAME2>=<VALUE2>
249+
\f[R]
250+
.fi
251+
.RE
252+
.IP \[bu] 2
218253
\f[B]\f[VB]-r|--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]
219254
.RS 2
220255
.PP
@@ -229,7 +264,7 @@ If not specified, the default is to build for the current OS and architecture.
229264
.PP
230265
Publishes the .NET runtime with the application so the runtime doesn\[cq]t need to be installed on the target machine.
231266
The default is \f[V]true\f[R] if a runtime identifier is specified.
232-
Available since .NET 6 SDK.
267+
Available since .NET 6.
233268
.RE
234269
.IP \[bu] 2
235270
\f[B]\f[VB]--source <SOURCE>\f[B]\f[R]
@@ -238,13 +273,43 @@ Available since .NET 6 SDK.
238273
The URI of the NuGet package source to use during the restore operation.
239274
.RE
240275
.IP \[bu] 2
276+
\f[B]\f[VB]--tl [auto|on|off]\f[B]\f[R]
277+
.RS 2
278+
.PP
279+
Specifies whether the \f[I]terminal logger\f[R] should be used for the build output.
280+
The default is \f[V]auto\f[R], which first verifies the environment before enabling terminal logging.
281+
The environment check verifies that the terminal is capable of using modern output features and isn\[cq]t using a redirected standard output before enabling the new logger.
282+
\f[V]on\f[R] skips the environment check and enables terminal logging.
283+
\f[V]off\f[R] skips the environment check and uses the default console logger.
284+
.PP
285+
The terminal logger shows you the restore phase followed by the build phase.
286+
During each phase, the currently building projects appear at the bottom of the terminal.
287+
Each project that\[cq]s building outputs both the MSBuild target currently being built and the amount of time spent on that target.
288+
You can search this information to learn more about the build.
289+
When a project is finished building, a single \[lq]build completed\[rq] section is written for that captures:
290+
.IP \[bu] 2
291+
The name of the built project
292+
.IP \[bu] 2
293+
The target framework (if multi-targeted)
294+
.IP \[bu] 2
295+
The status of that build
296+
.IP \[bu] 2
297+
The primary output of that build (which is hyperlinked)
298+
.IP \[bu] 2
299+
Any diagnostics generated for that project
300+
.PP
301+
This option is available starting in .NET 8.
302+
.RE
303+
.IP \[bu] 2
241304
\f[B]\f[VB]-v|--verbosity <LEVEL>\f[B]\f[R]
242305
.RS 2
243306
.PP
244307
Sets the verbosity level of the command.
245308
Allowed values are \f[V]q[uiet]\f[R], \f[V]m[inimal]\f[R], \f[V]n[ormal]\f[R], \f[V]d[etailed]\f[R], and \f[V]diag[nostic]\f[R].
246309
The default is \f[V]minimal\f[R].
247-
For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
310+
By default, MSBuild displays warnings and errors at all verbosity levels.
311+
To exclude warnings, use \f[V]/property:WarningLevel=0\f[R].
312+
For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity> and WarningLevel.
248313
.RE
249314
.IP \[bu] 2
250315
\f[B]\f[VB]--use-current-runtime, --ucr [true|false]\f[B]\f[R]

documentation/manpages/sdk/dotnet-clean.1

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-clean" "1" "2022-10-10" "" ".NET Documentation"
17+
.TH "dotnet-clean" "1" "2023-10-25" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet clean
2020
.PP
@@ -89,6 +89,14 @@ Doesn\[cq]t display the startup banner or the copyright message.
8989
.PP
9090
The directory that contains the build artifacts to clean.
9191
Specify the \f[V]-f|--framework <FRAMEWORK>\f[R] switch with the output directory switch if you specified the framework when the project was built.
92+
.IP \[bu] 2
93+
\&.NET 7.0.200 SDK and later
94+
.RS 2
95+
.PP
96+
If you specify the \f[V]--output\f[R] option when running this command on a solution, the CLI will emit a warning (an error in 7.0.200) due to the unclear semantics of the output path.
97+
The \f[V]--output\f[R] option is disallowed because all outputs of all built projects would be copied into the specified directory, which isn\[cq]t compatible with multi-targeted projects, as well as projects that have different versions of direct and transitive dependencies.
98+
For more information, see Solution-level \f[V]--output\f[R] option no longer valid for build-related commands.
99+
.RE
92100
.RE
93101
.IP \[bu] 2
94102
\f[B]\f[VB]-r|--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]

documentation/manpages/sdk/dotnet-dev-certs.1

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
. ftr VB CB
1616
. ftr VBI CBI
1717
.\}
18-
.TH "dotnet-dev-certs" "1" "2022-10-10" "" ".NET Documentation"
18+
.TH "dotnet-dev-certs" "1" "2023-10-25" "" ".NET Documentation"
1919
.hy
2020
.SH dotnet dev-certs
2121
.PP
@@ -171,8 +171,10 @@ The file format is independent of the file name extension.
171171
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.
172172
.PP
173173
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.
174+
.RE
174175
.IP \[bu] 2
175176
\f[B]\f[VB]-i|--import <PATH>\f[B]\f[R]
177+
.RS 2
176178
.PP
177179
Imports the provided HTTPS development certificate into the local machine.
178180
Requires that you also specify the \f[V]--clean\f[R] option, which clears out any existing HTTPS developer certificates.

documentation/manpages/sdk/dotnet-environment-variables.7

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-environment-variables" "7" "2022-09-19" "" ".NET Documentation"
17+
.TH "dotnet-environment-variables" "7" "2023-10-25" "" ".NET Documentation"
1818
.hy
1919
.SH NAME
2020
.PP
@@ -23,9 +23,9 @@ dotnet-environment-variables - .NET environment variables
2323
.PP
2424
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions
2525
.PP
26-
In this article, you\[cq]ll learn about the environment variables used by .NET SDK, .NET CLI, and .NET runtime.
26+
In this article, you\[cq]ll learn about the environment variables used by .NET.
2727
Some environment variables are used by the .NET runtime, while others are only used by the .NET SDK and .NET CLI.
28-
Some environment variables are used by all.
28+
Some environment variables are used by all three components.
2929
.SS .NET runtime environment variables
3030
.SS \f[V]DOTNET_SYSTEM_NET_HTTP_*\f[R]
3131
.PP
@@ -257,9 +257,35 @@ By default trace information is accumulated in a circular buffer and the content
257257
.PP
258258
Specifies the location of the .NET runtimes, if they are not installed in the default location.
259259
The default location on Windows is \f[V]C:\[rs]Program Files\[rs]dotnet\f[R].
260-
The default location on Linux and macOS is \f[V]/usr/local/share/dotnet\f[R].
260+
The default location on macOS is \f[V]/usr/local/share/dotnet\f[R].
261+
The default location on Linux varies depending on distro and installment method.
262+
The default location on Ubuntu 22.04 is \f[V]/usr/share/dotnet\f[R] (when installed from \f[V]packages.microsoft.com\f[R]) or \f[V]/usr/lib/dotnet\f[R] (when installed from Jammy feed).
263+
For more information, see the following resources:
264+
.IP \[bu] 2
265+
Troubleshoot app launch failures
266+
.IP \[bu] 2
267+
GitHub issue dotnet/core#7699 (https://github.com/dotnet/core/issues/7699)
268+
.IP \[bu] 2
269+
GitHub issue dotnet/runtime#79237 (https://github.com/dotnet/runtime/issues/79237)
270+
.PP
261271
This environment variable is used only when running apps via generated executables (apphosts).
262272
\f[V]DOTNET_ROOT(x86)\f[R] is used instead when running a 32-bit executable on a 64-bit OS.
273+
.SS \f[V]DOTNET_HOST_PATH\f[R]
274+
.PP
275+
Specifies the absolute path to a \f[V]dotnet\f[R] host (\f[V]dotnet.exe\f[R] on Windows, \f[V]dotnet\f[R] on Linux and macOS) that was used to launch the currently-running \f[V]dotnet\f[R] process.
276+
This is used by the .NET SDK to help tools that run during .NET SDK commands ensure they use the same \f[V]dotnet\f[R] runtime for any child \f[V]dotnet\f[R] processes they create for the duration of the command.
277+
Tools and MSBuild Tasks within the SDK that invoke binaries via the \f[V]dotnet\f[R] host are expected to honor this environment variable to ensure a consistent experience.
278+
.PP
279+
Tools that invoke \f[V]dotnet\f[R] during an SDK command should use the following algorithm to locate it:
280+
.IP \[bu] 2
281+
if \f[V]DOTNET_HOST_PATH\f[R] is set, use that value directly
282+
.IP \[bu] 2
283+
otherwise, rely on \f[V]dotnet\f[R] via the system\[cq]s \f[V]PATH\f[R]
284+
.RS
285+
.PP
286+
\f[V]DOTNET_HOST_PATH\f[R] is not a general solution for locating the \f[V]dotnet\f[R] host.
287+
It is only intended to be used by tools that are invoked by the .NET SDK.
288+
.RE
263289
.SS \f[V]NUGET_PACKAGES\f[R]
264290
.PP
265291
The global packages folder.
@@ -323,6 +349,10 @@ For more information, see the \f[V]--roll-forward\f[R] option for the \f[V]dotne
323349
Disables minor version roll forward, if set to \f[V]0\f[R].
324350
This setting is superseded in .NET Core 3.0 by \f[V]DOTNET_ROLL_FORWARD\f[R].
325351
The new settings should be used instead.
352+
.SS \f[V]DOTNET_CLI_FORCE_UTF8_ENCODING\f[R]
353+
.PP
354+
Forces the use of UTF-8 encoding in the console, even for older versions of Windows 10 that don\[cq]t fully support UTF-8.
355+
For more information, see SDK no longer changes console encoding when finished.
326356
.SS \f[V]DOTNET_CLI_UI_LANGUAGE\f[R]
327357
.PP
328358
Sets the language of the CLI UI using a locale value such as \f[V]en-us\f[R].
@@ -366,8 +396,12 @@ For more information, see Advertising manifests.
366396
.SS \f[V]DOTNET_CLI_WORKLOAD_UPDATE_NOTIFY_INTERVAL_HOURS\f[R]
367397
.PP
368398
Specifies the minimum number of hours between background downloads of advertising manifests for workloads.
369-
Default is \f[V]24\f[R] - no more frequently than once a day.
399+
The default is \f[V]24\f[R], which is no more frequently than once a day.
370400
For more information, see Advertising manifests.
401+
.SS \f[V]DOTNET_TOOLS_ALLOW_MANIFEST_IN_ROOT\f[R]
402+
.PP
403+
Specifies whether .NET SDK local tools search for tool manifest files in the root folder on Windows.
404+
The default is \f[V]false\f[R].
371405
.SS \f[V]COREHOST_TRACE\f[R]
372406
.PP
373407
Controls diagnostics tracing from the hosting components, such as \f[V]dotnet.exe\f[R], \f[V]hostfxr\f[R], and \f[V]hostpolicy\f[R].

documentation/manpages/sdk/dotnet-format.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-format" "1" "2022-06-20" "" ".NET Documentation"
17+
.TH "dotnet-format" "1" "2023-10-25" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet format
2020
.PP

documentation/manpages/sdk/dotnet-help.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-help" "1" "2022-10-10" "" ".NET Documentation"
17+
.TH "dotnet-help" "1" "2023-10-25" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet help reference
2020
.PP

0 commit comments

Comments
 (0)