Skip to content

[automated] Update man pages #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 43 additions & 10 deletions documentation/manpages/sdk/dotnet-environment-variables.7
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-environment-variables" "7" "2025-06-13" "" ".NET Documentation"
.TH "dotnet-environment-variables" "7" "2025-08-01" "" ".NET Documentation"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -281,9 +281,26 @@ GitHub issue dotnet/core#7699 (https://github.com/dotnet/core/issues/7699)
.IP \[bu] 2
GitHub issue dotnet/runtime#79237 (https://github.com/dotnet/runtime/issues/79237)
.PP
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.
\f[V]DOTNET_ROOT_X64\f[R] is used instead when running a 64-bit executable on an ARM64 OS.
These environment variables are used only when running apps via generated executables (apphosts).
The order in which the environment variables are considered is:
.IP "1." 3
\f[V]DOTNET_ROOT_<ARCH>\f[R], where \f[V]<ARCH>\f[R] is the architecture of the running executable (apphost).
For example:
.RS 4
.IP \[bu] 2
\f[V]DOTNET_ROOT_ARM64\f[R] is used for an Arm64 process.
.IP \[bu] 2
\f[V]DOTNET_ROOT_X64\f[R] is used for an x64 process.
This process might be running on x64 or Arm64 architecture.
.IP \[bu] 2
\f[V]DOTNET_ROOT_X86\f[R] is used for an x86 process.
This process might be running on x86 or x64 architecture.
.RE
.IP "2." 3
\f[V]DOTNET_ROOT(x86)\f[R] is used when a 32-bit process is running on 64-bit Windows.
In other cases, this environment variable is ignored.
.IP "3." 3
\f[V]DOTNET_ROOT\f[R].
.SS \f[V]DOTNET_HOST_PATH\f[R]
.PP
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.
Expand Down Expand Up @@ -508,18 +525,20 @@ For more information, see Advertising manifests.
.PP
Specifies whether .NET SDK local tools search for tool manifest files in the root folder on Windows.
The default is \f[V]false\f[R].
.SS \f[V]COREHOST_TRACE\f[R]
.SS \f[V]DOTNET_HOST_TRACE\f[R]
.PP
\f[B]This variable applies to .NET 10 and later versions.\f[R] For older versions, replace the \f[V]DOTNET_HOST_\f[R] prefix with \f[V]COREHOST_\f[R].
.PP
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].
.IP \[bu] 2
\f[V]COREHOST_TRACE=[0/1]\f[R] - default is \f[V]0\f[R] - tracing disabled.
\f[V]DOTNET_HOST_TRACE=[0/1]\f[R] - default is \f[V]0\f[R] - tracing disabled.
If set to \f[V]1\f[R], diagnostics tracing is enabled.
.IP \[bu] 2
\f[V]COREHOST_TRACEFILE=<file path>\f[R] - has an effect only if tracing is enabled by setting \f[V]COREHOST_TRACE=1\f[R].
\f[V]DOTNET_HOST_TRACEFILE=<file path>\f[R] - has an effect only if tracing is enabled by setting \f[V]DOTNET_HOST_TRACE=1\f[R].
When set, the tracing information is written to the specified file; otherwise, the trace information is written to \f[V]stderr\f[R].
.IP \[bu] 2
\f[V]COREHOST_TRACE_VERBOSITY=[1/2/3/4]\f[R] - default is \f[V]4\f[R].
The setting is used only when tracing is enabled via \f[V]COREHOST_TRACE=1\f[R].
\f[V]DOTNET_HOST_TRACE_VERBOSITY=[1/2/3/4]\f[R] - default is \f[V]4\f[R].
The setting is used only when tracing is enabled via \f[V]DOTNET_HOST_TRACE=1\f[R].
.RS 2
.IP \[bu] 2
\f[V]4\f[R] - all tracing information is written
Expand All @@ -531,8 +550,22 @@ The setting is used only when tracing is enabled via \f[V]COREHOST_TRACE=1\f[R].
\f[V]1\f[R] - only error messages are written
.RE
.PP
The typical way to get detailed trace information about application startup is to set \f[V]COREHOST_TRACE=1\f[R] and\f[V]COREHOST_TRACEFILE=host_trace.txt\f[R] and then run the application.
The typical way to get detailed trace information about application startup is to set \f[V]DOTNET_HOST_TRACE=1\f[R] and \f[V]DOTNET_HOST_TRACEFILE=host_trace.txt\f[R] and then run the application.
A new file \f[V]host_trace.txt\f[R] will be created in the current directory with the detailed information.
.SS \f[V]COREHOST_TRACE\f[R]
.PP
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].
.RS
.PP
Starting with .NET 10, use the \f[V]DOTNET_HOST_TRACE\f[R] environment variables instead.
The \f[V]COREHOST_TRACE\f[R] variables work the same as \f[V]DOTNET_HOST_TRACE\f[R] variables.
.RE
.IP \[bu] 2
\f[V]COREHOST_TRACE\f[R] - see \f[V]DOTNET_HOST_TRACE\f[R].
.IP \[bu] 2
\f[V]COREHOST_TRACEFILE\f[R] - see \f[V]DOTNET_HOST_TRACEFILE\f[R].
.IP \[bu] 2
\f[V]COREHOST_TRACE_VERBOSITY\f[R] - see \f[V]DOTNET_HOST_TRACE_VERBOSITY\f[R].
.SS \f[V]SuppressNETCoreSdkPreviewMessage\f[R]
.PP
If set to \f[V]true\f[R], invoking \f[V]dotnet\f[R] won\[cq]t produce a warning when a preview SDK is being used.
Expand Down
3 changes: 1 addition & 2 deletions documentation/manpages/sdk/dotnet-msbuild.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-msbuild" "1" "2025-06-13" "" ".NET Documentation"
.TH "dotnet-msbuild" "1" "2025-08-01" "" ".NET Documentation"
.hy
.SH dotnet msbuild
.PP
Expand All @@ -41,7 +41,6 @@ The options are all the same.
For more information about the available options, see the MSBuild command-line reference.
.PP
The dotnet build command is equivalent to \f[V]dotnet msbuild -restore\f[R].
When you don\[cq]t want to build the project and you have a specific target you want to run, use \f[V]dotnet build\f[R] or \f[V]dotnet msbuild\f[R] and specify the target.
.SH EXAMPLES
.IP \[bu] 2
Build a project and its dependencies:
Expand Down
3 changes: 2 additions & 1 deletion documentation/manpages/sdk/dotnet-nuget-verify.1
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-nuget-verify" "1" "2025-06-13" "" ".NET Documentation"
.TH "dotnet-nuget-verify" "1" "2025-08-01" "" ".NET Documentation"
.hy
.SH dotnet nuget verify
.PP
Expand All @@ -39,6 +39,7 @@ dotnet nuget verify -h|--help
.SH DESCRIPTION
.PP
The \f[V]dotnet nuget verify\f[R] command verifies a signed NuGet package.
In .NET 10 and later versions, the command also outputs the package\[cq]s content hash, which might be useful to investigate lock file validation errors.
.RS
.PP
This command requires a certificate root store that is valid for both code signing and timestamping.
Expand Down
15 changes: 9 additions & 6 deletions documentation/manpages/sdk/dotnet-nuget-why.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-nuget-why" "1" "2025-06-13" "" ".NET Documentation"
.TH "dotnet-nuget-why" "1" "2025-08-01" "" ".NET Documentation"
.hy
.SH dotnet nuget why
.PP
Expand All @@ -35,13 +35,16 @@ dotnet nuget why -h|--help
.PP
The \f[V]dotnet nuget why\f[R] command shows the dependency graph for a particular package for a given project or solution.
.PP
Starting from the .NET 9 SDK, it\[cq]s possible to pass a NuGet assets file in place of the project file, in order to use the command with projects that can\[cq]t be restored with the .NET SDK.
First, restore the project in Visual Studio, or \f[V]msbuild.exe\f[R].
By default the assets file is in the project\[cq]s \f[V]obj\[rs]\f[R] directory, but you can find the location with \f[V]msbuild.exe path\[rs]to\[rs]project.proj -getProperty:ProjectAssetsFile\f[R].
Finally, run \f[V]dotnet nuget why path\[rs]to\[rs]project.assets.json SomePackage\f[R].
.PP
Starting with version 9.0.200, the command introduces support for runtime identifier (RID) specific packages by generating separate dependency trees for each RID and framework combination.
For example, if a project targets \f[V]net9.0\f[R] with the \f[V]win-x64\f[R] RID, the command generates trees for \f[V]net9.0/win-x64\f[R] and \f[V]net9.0\f[R].
.SS Older project format
.PP
To use the command with projects that can\[cq]t be restored with the .NET SDK, you can pass a NuGet assets file in place of the project file (starting with the .NET 9 SDK):
.IP "1." 3
First, restore the project in Visual Studio or using \f[V]msbuild.exe\f[R].
By default, the assets file is in the project\[cq]s \f[V]obj\[rs]\f[R] directory, but you can find the location with \f[V]msbuild.exe path\[rs]to\[rs]project.proj -getProperty:ProjectAssetsFile\f[R].
.IP "2." 3
Run \f[V]dotnet nuget why path\[rs]to\[rs]project.assets.json SomePackage\f[R].
.SH ARGUMENTS
.IP \[bu] 2
\f[B]\f[VB]PROJECT|SOLUTION\f[B]\f[R]
Expand Down
4 changes: 2 additions & 2 deletions documentation/manpages/sdk/dotnet-tool-install.1
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-tool-install" "1" "2025-06-13" "" ".NET Documentation"
.TH "dotnet-tool-install" "1" "2025-08-01" "" ".NET Documentation"
.hy
.SH dotnet tool install
.PP
Expand Down Expand Up @@ -320,7 +320,7 @@ Installs version 2.0.0 of dotnetsay (https://www.nuget.org/packages/dotnetsay/)
Installs dotnetsay (https://www.nuget.org/packages/dotnetsay/) as a local tool for the current directory.
.RE
.IP \[bu] 2
\f[B]\f[VB]dotnet tool install -g --verbosity minimal\f[B]\f[R]
\f[B]\f[VB]dotnet tool install -g dotnetsay --verbosity minimal\f[B]\f[R]
.RS 2
.PP
Installs dotnetsay (https://www.nuget.org/packages/dotnetsay/) as a global tool with the verbosity of minimal.
Expand Down