Skip to content

Commit 3fc23d1

Browse files
am11am11
committed
Update manpages for 9
1 parent 646e1d9 commit 3fc23d1

Some content is hidden

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

69 files changed

+2111
-355
lines changed

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

+1-1
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" "2023-10-25" "" ".NET Documentation"
17+
.TH "dotnet-add-package" "1" "2024-10-02" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet add package
2020
.PP

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

+2-2
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" "2023-10-25" "" ".NET Documentation"
17+
.TH "dotnet-add-reference" "1" "2024-10-02" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet add reference
2020
.PP
@@ -55,7 +55,7 @@ But you can do that by editing your \f[I].csproj\f[R] file and adding markup sim
5555
\f[C]
5656
<ItemGroup>
5757
<Reference Include=\[dq]MyAssembly\[dq]>
58-
<HintPath>\[dq].\[rs]MyDLLFolder\[rs]MyAssembly.dll</HintPath>
58+
<HintPath>.\[rs]MyDLLFolder\[rs]MyAssembly.dll</HintPath>
5959
</Reference>
6060
</ItemGroup>
6161
\f[R]

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

+1-1
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" "2023-10-25" "" ".NET Documentation"
17+
.TH "dotnet-build-server" "1" "2024-10-02" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet build-server
2020
.PP

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

+20-11
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" "2023-10-25" "" ".NET Documentation"
17+
.TH "dotnet-build" "1" "2024-10-02" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet build
2020
.PP
@@ -27,6 +27,7 @@ dotnet-build - Builds a project and all of its dependencies.
2727
.nf
2828
\f[C]
2929
dotnet build [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
30+
[--artifacts-path <ARTIFACTS_DIR>]
3031
[-c|--configuration <CONFIGURATION>] [-f|--framework <FRAMEWORK>]
3132
[--disable-build-servers]
3233
[--force] [--interactive] [--no-dependencies] [--no-incremental]
@@ -35,7 +36,7 @@ dotnet build [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
3536
[-p|--property:<PROPERTYNAME>=<VALUE>]
3637
[-r|--runtime <RUNTIME_IDENTIFIER>]
3738
[--self-contained [true|false]] [--source <SOURCE>]
38-
[--tl [auto|on|off]] [--use-current-runtime, --ucr [true|false]]
39+
[--tl:[auto|on|off]] [--use-current-runtime, --ucr [true|false]]
3940
[-v|--verbosity <LEVEL>] [--version-suffix <VERSION_SUFFIX>]
4041

4142
dotnet build -h|--help
@@ -132,6 +133,14 @@ If you use this option, don\[cq]t use the \f[V]-r|--runtime\f[R] option.
132133
Available since .NET 6 Preview 7.
133134
.RE
134135
.IP \[bu] 2
136+
\f[B]\f[VB]--artifacts-path <ARTIFACTS_DIR>\f[B]\f[R]
137+
.RS 2
138+
.PP
139+
All build output files from the executed command will go in subfolders under the specified path, separated by project.
140+
For more information see Artifacts Output Layout.
141+
Available since .NET 8 SDK.
142+
.RE
143+
.IP \[bu] 2
135144
\f[B]\f[VB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
136145
.RS 2
137146
.PP
@@ -273,7 +282,7 @@ Available since .NET 6.
273282
The URI of the NuGet package source to use during the restore operation.
274283
.RE
275284
.IP \[bu] 2
276-
\f[B]\f[VB]--tl [auto|on|off]\f[B]\f[R]
285+
\f[B]\f[VB]--tl:[auto|on|off]\f[B]\f[R]
277286
.RS 2
278287
.PP
279288
Specifies whether the \f[I]terminal logger\f[R] should be used for the build output.
@@ -286,17 +295,17 @@ The terminal logger shows you the restore phase followed by the build phase.
286295
During each phase, the currently building projects appear at the bottom of the terminal.
287296
Each project that\[cq]s building outputs both the MSBuild target currently being built and the amount of time spent on that target.
288297
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:
298+
When a project is finished building, a single \[lq]build completed\[rq] section is written that captures:
290299
.IP \[bu] 2
291-
The name of the built project
300+
The name of the built project.
292301
.IP \[bu] 2
293-
The target framework (if multi-targeted)
302+
The target framework (if multi-targeted).
294303
.IP \[bu] 2
295-
The status of that build
304+
The status of that build.
296305
.IP \[bu] 2
297-
The primary output of that build (which is hyperlinked)
306+
The primary output of that build (which is hyperlinked).
298307
.IP \[bu] 2
299-
Any diagnostics generated for that project
308+
Any diagnostics generated for that project.
300309
.PP
301310
This option is available starting in .NET 8.
302311
.RE
@@ -349,12 +358,12 @@ dotnet build --configuration Release
349358
.fi
350359
.RE
351360
.IP \[bu] 2
352-
Build a project and its dependencies for a specific runtime (in this example, Ubuntu 18.04):
361+
Build a project and its dependencies for a specific runtime (in this example, Linux):
353362
.RS 2
354363
.IP
355364
.nf
356365
\f[C]
357-
dotnet build --runtime ubuntu.18.04-x64
366+
dotnet build --runtime linux-x64
358367
\f[R]
359368
.fi
360369
.RE

‎documentation/manpages/sdk/dotnet-clean.1

+41-3
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" "2023-10-25" "" ".NET Documentation"
17+
.TH "dotnet-clean" "1" "2024-10-02" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet clean
2020
.PP
@@ -26,10 +26,12 @@ dotnet-clean - Cleans the output of a project.
2626
.IP
2727
.nf
2828
\f[C]
29-
dotnet clean [<PROJECT>|<SOLUTION>] [-c|--configuration <CONFIGURATION>]
29+
dotnet clean [<PROJECT>|<SOLUTION>] [--artifacts-path <ARTIFACTS_DIR>]
30+
[-c|--configuration <CONFIGURATION>]
3031
[-f|--framework <FRAMEWORK>] [--interactive]
3132
[--nologo] [-o|--output <OUTPUT_DIRECTORY>]
32-
[-r|--runtime <RUNTIME_IDENTIFIER>] [-v|--verbosity <LEVEL>]
33+
[-r|--runtime <RUNTIME_IDENTIFIER>] [--tl:[auto|on|off]]
34+
[-v|--verbosity <LEVEL>]
3335

3436
dotnet clean -h|--help
3537
\f[R]
@@ -48,6 +50,14 @@ The MSBuild project or solution to clean.
4850
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.
4951
.SH OPTIONS
5052
.IP \[bu] 2
53+
\f[B]\f[VB]--artifacts-path <ARTIFACTS_DIR>\f[B]\f[R]
54+
.RS 2
55+
.PP
56+
All build output files from the executed command will go in subfolders under the specified path, separated by project.
57+
For more information see Artifacts Output Layout.
58+
Available since .NET 8 SDK.
59+
.RE
60+
.IP \[bu] 2
5161
\f[B]\f[VB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
5262
.RS 2
5363
.PP
@@ -106,6 +116,34 @@ Cleans the output folder of the specified runtime.
106116
This is used when a self-contained deployment was created.
107117
.RE
108118
.IP \[bu] 2
119+
\f[B]\f[VB]--tl:[auto|on|off]\f[B]\f[R]
120+
.RS 2
121+
.PP
122+
Specifies whether the \f[I]terminal logger\f[R] should be used for the build output.
123+
The default is \f[V]auto\f[R], which first verifies the environment before enabling terminal logging.
124+
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.
125+
\f[V]on\f[R] skips the environment check and enables terminal logging.
126+
\f[V]off\f[R] skips the environment check and uses the default console logger.
127+
.PP
128+
The terminal logger shows you the restore phase followed by the build phase.
129+
During each phase, the currently building projects appear at the bottom of the terminal.
130+
Each project that\[cq]s building outputs both the MSBuild target currently being built and the amount of time spent on that target.
131+
You can search this information to learn more about the build.
132+
When a project is finished building, a single \[lq]build completed\[rq] section is written that captures:
133+
.IP \[bu] 2
134+
The name of the built project.
135+
.IP \[bu] 2
136+
The target framework (if multi-targeted).
137+
.IP \[bu] 2
138+
The status of that build.
139+
.IP \[bu] 2
140+
The primary output of that build (which is hyperlinked).
141+
.IP \[bu] 2
142+
Any diagnostics generated for that project.
143+
.PP
144+
This option is available starting in .NET 8.
145+
.RE
146+
.IP \[bu] 2
109147
\f[B]\f[VB]-v|--verbosity <LEVEL>\f[B]\f[R]
110148
.RS 2
111149
.PP

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

+1-1
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" "2023-10-25" "" ".NET Documentation"
18+
.TH "dotnet-dev-certs" "1" "2024-10-02" "" ".NET Documentation"
1919
.hy
2020
.SH dotnet dev-certs
2121
.PP

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

+111-5
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" "2023-10-25" "" ".NET Documentation"
17+
.TH "dotnet-environment-variables" "7" "2024-10-02" "" ".NET Documentation"
1818
.hy
1919
.SH NAME
2020
.PP
@@ -240,8 +240,20 @@ Defaults to 0.
240240
See the Diagnostic Port documentation for more information.
241241
.SS \f[V]DOTNET_EnableDiagnostics\f[R]
242242
.PP
243-
When set to \f[V]1\f[R], enables debugging, profiling, and other diagnostics via the Diagnostic Port.
244-
Defaults to 1.
243+
When set to \f[V]0\f[R], disables debugging, profiling, and other diagnostics via the Diagnostic Port and can\[cq]t be overridden by other diagnostics settings.
244+
Defaults to \f[V]1\f[R].
245+
.SS \f[V]DOTNET_EnableDiagnostics_IPC\f[R]
246+
.PP
247+
Starting with .NET 8, when set to \f[V]0\f[R], disables the Diagnostic Port and can\[cq]t be overridden by other diagnostics settings.
248+
Defaults to \f[V]1\f[R].
249+
.SS \f[V]DOTNET_EnableDiagnostics_Debugger\f[R]
250+
.PP
251+
Starting with .NET 8, when set to \f[V]0\f[R], disables debugging and can\[cq]t be overridden by other diagnostics settings.
252+
Defaults to \f[V]1\f[R].
253+
.SS \f[V]DOTNET_EnableDiagnostics_Profiler\f[R]
254+
.PP
255+
Starting with .NET 8, when set to \f[V]0\f[R], disables profiling and can\[cq]t be overridden by other diagnostics settings.
256+
Defaults to \f[V]1\f[R].
245257
.SS EventPipe variables
246258
.PP
247259
See EventPipe environment variables for more information.
@@ -253,11 +265,12 @@ See EventPipe environment variables for more information.
253265
\f[V]DOTNET_EventPipeOutputStreaming\f[R]: When set to \f[V]1\f[R], enables streaming to the output file while the app is running.
254266
By default trace information is accumulated in a circular buffer and the contents are written at app shutdown.
255267
.SS .NET SDK and CLI environment variables
256-
.SS \f[V]DOTNET_ROOT\f[R], \f[V]DOTNET_ROOT(x86)\f[R]
268+
.SS \f[V]DOTNET_ROOT\f[R], \f[V]DOTNET_ROOT(x86)\f[R], \f[V]DOTNET_ROOT_X86\f[R], \f[V]DOTNET_ROOT_X64\f[R]
257269
.PP
258270
Specifies the location of the .NET runtimes, if they are not installed in the default location.
259271
The default location on Windows is \f[V]C:\[rs]Program Files\[rs]dotnet\f[R].
260272
The default location on macOS is \f[V]/usr/local/share/dotnet\f[R].
273+
The default location for the x64 runtimes on an arm64 OS is under an x64 subfolder (so \f[V]C:\[rs]Program Files\[rs]dotnet\[rs]x64\f[R] on windows and \f[V]/usr/local/share/dotnet/x64\f[R] on macOS.
261274
The default location on Linux varies depending on distro and installment method.
262275
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).
263276
For more information, see the following resources:
@@ -270,6 +283,7 @@ GitHub issue dotnet/runtime#79237 (https://github.com/dotnet/runtime/issues/7923
270283
.PP
271284
This environment variable is used only when running apps via generated executables (apphosts).
272285
\f[V]DOTNET_ROOT(x86)\f[R] is used instead when running a 32-bit executable on a 64-bit OS.
286+
\f[V]DOTNET_ROOT_X64\f[R] is used instead when running a 64-bit executable on an ARM64 OS.
273287
.SS \f[V]DOTNET_HOST_PATH\f[R]
274288
.PP
275289
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.
@@ -286,6 +300,83 @@ otherwise, rely on \f[V]dotnet\f[R] via the system\[cq]s \f[V]PATH\f[R]
286300
\f[V]DOTNET_HOST_PATH\f[R] is not a general solution for locating the \f[V]dotnet\f[R] host.
287301
It is only intended to be used by tools that are invoked by the .NET SDK.
288302
.RE
303+
.SS \f[V]DOTNET_LAUNCH_PROFILE\f[R]
304+
.PP
305+
The dotnet run command sets this variable to the selected launch profile.
306+
.PP
307+
Given the following \f[I]launchSettings.json\f[R] file:
308+
.IP
309+
.nf
310+
\f[C]
311+
{
312+
\[dq]profiles\[dq]: {
313+
\[dq]First\[dq]: {
314+
\[dq]commandName\[dq]: \[dq]Project\[dq],
315+
},
316+
\[dq]Second\[dq]: {
317+
\[dq]commandName\[dq]: \[dq]Project\[dq],
318+
}
319+
}
320+
}
321+
\f[R]
322+
.fi
323+
.PP
324+
And the following \f[I]Program.cs\f[R] file:
325+
.IP
326+
.nf
327+
\f[C]
328+
var value = Environment.GetEnvironmentVariable(\[dq]DOTNET_LAUNCH_PROFILE\[dq]);
329+
Console.WriteLine($\[dq]DOTNET_LAUNCH_PROFILE={value}\[dq]);
330+
\f[R]
331+
.fi
332+
.PP
333+
The following scenarios produce the output shown:
334+
.IP \[bu] 2
335+
Launch profile specified and exists
336+
.RS 2
337+
.IP
338+
.nf
339+
\f[C]
340+
$ dotnet run --launch-profile First
341+
DOTNET_LAUNCH_PROFILE=First
342+
\f[R]
343+
.fi
344+
.RE
345+
.IP \[bu] 2
346+
Launch profile not specified, first one selected
347+
.RS 2
348+
.IP
349+
.nf
350+
\f[C]
351+
$ dotnet run
352+
DOTNET_LAUNCH_PROFILE=First
353+
\f[R]
354+
.fi
355+
.RE
356+
.IP \[bu] 2
357+
Launch profile specified but does not exist
358+
.RS 2
359+
.IP
360+
.nf
361+
\f[C]
362+
$ dotnet run --launch-profile Third
363+
The launch profile \[dq]Third\[dq] could not be applied.
364+
A launch profile with the name \[aq]Third\[aq] doesn\[aq]t exist.
365+
DOTNET_LAUNCH_PROFILE=
366+
\f[R]
367+
.fi
368+
.RE
369+
.IP \[bu] 2
370+
Launch with no profile
371+
.RS 2
372+
.IP
373+
.nf
374+
\f[C]
375+
$ dotnet run --no-launch-profile
376+
DOTNET_LAUNCH_PROFILE=
377+
\f[R]
378+
.fi
379+
.RE
289380
.SS \f[V]NUGET_PACKAGES\f[R]
290381
.PP
291382
The global packages folder.
@@ -317,11 +408,16 @@ To not add global tools to the path, set to \f[V]0\f[R], \f[V]false\f[R], or \f[
317408
.PP
318409
Specifies whether data about the .NET tools usage is collected and sent to Microsoft.
319410
Set to \f[V]true\f[R] to opt-out of the telemetry feature (values \f[V]true\f[R], \f[V]1\f[R], or \f[V]yes\f[R] accepted).
320-
Otherwise, set to \f[V]false\f[R] to opt into the telemetry features (values \f[V]false\f[R], \f[V]0\f[R], or \f[V]no\f[R] accepted).
411+
Otherwise, set to \f[V]false\f[R] to opt in to the telemetry features (values \f[V]false\f[R], \f[V]0\f[R], or \f[V]no\f[R] accepted).
321412
If not set, the default is \f[V]false\f[R] and the telemetry feature is active.
322413
.SS \f[V]DOTNET_SKIP_FIRST_TIME_EXPERIENCE\f[R]
323414
.PP
324415
If \f[V]DOTNET_SKIP_FIRST_TIME_EXPERIENCE\f[R] is set to \f[V]true\f[R], the \f[V]NuGetFallbackFolder\f[R] won\[cq]t be expanded to disk and a shorter welcome message and telemetry notice will be shown.
416+
.RS
417+
.PP
418+
This environment variable is no longer supported in .NET Core 3.0 and later.
419+
Use \f[V]DOTNET_NOLOGO\f[R] as a replacement.
420+
.RE
325421
.SS \f[V]DOTNET_MULTILEVEL_LOOKUP\f[R]
326422
.PP
327423
Specifies whether the .NET runtime, shared framework, or SDK are resolved from the global location.
@@ -382,6 +478,16 @@ List of assemblies to load and execute startup hooks from.
382478
Specifies a directory to which a single-file application is extracted before it is executed.
383479
.PP
384480
For more information, see Single-file executables.
481+
.SS \f[V]DOTNET_CLI_HOME\f[R]
482+
.PP
483+
Specifies the location that supporting files for .NET CLI commands should be written to.
484+
For example:
485+
.IP \[bu] 2
486+
User-writable paths for workload packs, manifests, and other supporting data.
487+
.IP \[bu] 2
488+
First-run sentinel/lock files for aspects of the .NET CLI\[cq]s first-run migrations and notification experiences.
489+
.IP \[bu] 2
490+
The default .NET local tool installation location.
385491
.SS \f[V]DOTNET_CLI_CONTEXT_*\f[R]
386492
.IP \[bu] 2
387493
\f[V]DOTNET_CLI_CONTEXT_VERBOSE\f[R]: To enable a verbose context, set to \f[V]true\f[R].

0 commit comments

Comments
 (0)