Skip to content
Merged
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
6 changes: 2 additions & 4 deletions documentation/manpages/sdk/dotnet-build-server.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-build-server" "1" "2025-10-30" "" ".NET Documentation"
.TH "dotnet-build-server" "1" "2026-08-28" "" ".NET Documentation"
.hy
.SH dotnet build-server
.PP
Expand Down Expand Up @@ -42,12 +42,10 @@ Shuts down build servers that are started from dotnet.
By default, all servers are shut down.
.RE
.SH OPTIONS
.IP \[bu] 2
.PP
\f[B]\f[VB]-?|-h|--help\f[B]\f[R]
.RS 2
.PP
Prints out a description of how to use the command.
.RE
.IP \[bu] 2
\f[B]\f[VB]--msbuild\f[B]\f[R]
.RS 2
Expand Down
113 changes: 73 additions & 40 deletions documentation/manpages/sdk/dotnet-build.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-build" "1" "2025-10-30" "" ".NET Documentation"
.TH "dotnet-build" "1" "2026-08-28" "" ".NET Documentation"
.hy
.SH dotnet build
.PP
Expand All @@ -27,13 +27,13 @@ dotnet-build - Builds a project, solution, or file-based app and all of its depe
.nf
\f[C]
dotnet build [<PROJECT>|<SOLUTION>|<FILE>] [-a|--arch <ARCHITECTURE>]
[--artifacts-path <ARTIFACTS_DIR>]
[--artifacts-path <ARTIFACTS_DIR>] [-bl|--binaryLogger:<FILE>]
[-c|--configuration <CONFIGURATION>] [--disable-build-servers]
[-f|--framework <FRAMEWORK>] [--force] [--interactive]
[--no-dependencies] [--no-incremental] [--no-restore] [--nologo]
[--no-self-contained] [-o|--output <OUTPUT_DIRECTORY>] [--os <OS>]
[-p|--property:<PROPERTYNAME>=<VALUE>] [-r|--runtime <RUNTIME_IDENTIFIER>]
[--sc|--self-contained] [--source <SOURCE>]
[--sc|--self-contained] [--source <SOURCE>] [-t|--target:<TARGET>]
[--tl:[auto|on|off]] [ --ucr|--use-current-runtime]
[-v|--verbosity <LEVEL>] [--version-suffix <VERSION_SUFFIX>]

Expand Down Expand Up @@ -124,40 +124,52 @@ The path and filename of a file-based app.
File-based apps are contained within a single file that is built and run without a corresponding project (\f[I].csproj\f[R]) file.
For more information, see Build file-based C# apps.
.SH OPTIONS
.IP \[bu] 2
.PP
\f[B]\f[VB]-a|--arch <ARCHITECTURE>\f[B]\f[R]
.RS 2
.PP
Specifies the target architecture.
This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
For example, on a \f[V]win-x64\f[R] machine, specifying \f[V]--arch x86\f[R] sets the RID to \f[V]win-x86\f[R].
If you use this option, don\[cq]t use the \f[V]-r|--runtime\f[R] option.
Available since .NET 6 Preview 7.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]--artifacts-path <ARTIFACTS_DIR>\f[B]\f[R]
.RS 2
.PP
All build output files from the executed command will go in subfolders under the specified path, separated by project.
For more information see Artifacts Output Layout.
This option and the value provided must be explicitly cascaded in any \f[V]dotnet\f[R] command that depends on the output of another \f[V]dotnet\f[R] command, for example, when using \f[V]dotnet build --no-restore\f[R] and \f[V]dotnet publish --no-build\f[R].
Available since .NET 8 SDK.
.RE
.IP \[bu] 2
\f[B]\f[VB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
\f[B]\f[VB]-bl|--binaryLogger:<FILE>\f[B]\f[R]
.RS 2
.PP
Enables the binary logger and optionally specifies the output file name.
.PD 0
.P
.PD
If no file name is provided, the default is \f[V]msbuild.binlog\f[R] in the current directory.
.PP
The binary log contains detailed build information and can be opened with the MSBuild Structured Log Viewer (https://msbuildlog.com).
.IP
.nf
\f[C]
dotnet build -bl
dotnet build -bl:build-log.binlog
\f[R]
.fi
.RE
.PP
\f[B]\f[VB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
.PP
Defines the build configuration.
The default for most projects is \f[V]Debug\f[R], but you can override the build configuration settings in your project.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]--disable-build-servers\f[B]\f[R]
.RS 2
.PP
Forces the command to ignore any persistent build servers.
This option provides a consistent way to disable all use of build caching, which forces a build from scratch.
A build that doesn\[cq]t rely on caches is useful when the caches might be corrupted or incorrect for some reason.
Available since .NET 7 SDK.
.RE
.IP \[bu] 2
\f[B]\f[VB]-f|--framework <FRAMEWORK>\f[B]\f[R]
.RS 2
Expand All @@ -173,14 +185,11 @@ Examples: \f[V]net7.0\f[R], \f[V]net462\f[R].
Forces all dependencies to be resolved even if the last restore was successful.
Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
.RE
.IP \[bu] 2
.PP
\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 Core 3.0 SDK.
.RE
.IP \[bu] 2
\f[B]\f[VB]--no-dependencies\f[B]\f[R]
.RS 2
Expand All @@ -206,12 +215,11 @@ Doesn\[cq]t execute an implicit restore during build.
.PP
Doesn\[cq]t display the startup banner or the copyright message.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]--no-self-contained\f[B]\f[R]
.RS 2
.PP
Equivalent to \f[V]--self-contained false\f[R].
.RE
Publish your application as a framework-dependent application.
A compatible .NET runtime must be installed on the target machine to run your application.
.IP \[bu] 2
\f[B]\f[VB]-o|--output <OUTPUT_DIRECTORY>\f[B]\f[R]
.RS 2
Expand All @@ -228,16 +236,14 @@ The \f[V]--output\f[R] option is disallowed because all outputs of all built pro
For more information, see Solution-level \f[V]--output\f[R] option no longer valid for build-related commands.
.RE
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]--os <OS>\f[B]\f[R]
.RS 2
.PP
Specifies the target operating system (OS).
This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
For example, on a \f[V]win-x64\f[R] machine, specifying \f[V]--os linux\f[R] sets the RID to \f[V]linux-x64\f[R].
If you use this option, don\[cq]t use the \f[V]-r|--runtime\f[R] option.
Available since .NET 6.
.RE
.IP \[bu] 2
\f[B]\f[VB]-p|--property:<PROPERTYNAME>=<VALUE>\f[B]\f[R]
.RS 2
Expand All @@ -261,23 +267,37 @@ 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
.PP
\f[B]\f[VB]--sc|--self-contained\f[B]\f[R]
.RS 2
.PP
Publish the .NET runtime with your application so the runtime doesn\[cq]t need to be installed on the target machine.
The default is \f[V]true\f[R].
.RE
.IP \[bu] 2
\f[B]\f[VB]--source <SOURCE>\f[B]\f[R]
.RS 2
.PP
The URI of the NuGet package source to use during the restore operation.
.RE
.IP \[bu] 2
\f[B]\f[VB]--tl:[auto|on|off]\f[B]\f[R]
\f[B]\f[VB]-t|--target:<TARGET>\f[B]\f[R]
.RS 2
.PP
Specifies one or more MSBuild targets to run during the build instead of the default target.
Specify multiple targets by separating them with a semicolon or comma, or by repeating the option for each target.
Corresponds to the MSBuild \f[V]-target\f[R] option.
Common targets include \f[V]Build\f[R] (default), \f[V]Clean\f[R], and \f[V]Rebuild\f[R].
For more information, see MSBuild Targets.
.IP
.nf
\f[C]
dotnet build -t:\[dq]Clean;RunTests\[dq]
dotnet build -t:Clean -t:GenerateApiClients
dotnet build -t:RunCodeGeneration
\f[R]
.fi
.RE
.PP
\f[B]\f[VB]--tl:[auto|on|off]\f[B]\f[R]
.PP
Specifies whether \f[I]Terminal Logger\f[R] should be used for the build output.
The default is \f[V]auto\f[R], which first verifies the environment before enabling terminal logging.
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.
Expand All @@ -301,21 +321,16 @@ The primary output of that build (which is hyperlinked).
Any diagnostics generated for that project.
.PP
This option is available starting in .NET 8.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]--ucr|--use-current-runtime\f[B]\f[R]
.RS 2
.PP
Use the current runtime as the target runtime.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]-v|--verbosity <LEVEL>\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], \f[V]d[etailed]\f[R], and \f[V]diag[nostic]\f[R].
For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
.RE
.IP \[bu] 2
\f[B]\f[VB]--version-suffix <VERSION_SUFFIX>\f[B]\f[R]
.RS 2
Expand All @@ -324,12 +339,10 @@ Sets the value of the \f[V]$(VersionSuffix)\f[R] property to use when building t
This only works if the \f[V]$(Version)\f[R] property isn\[cq]t set.
Then, \f[V]$(Version)\f[R] is set to the \f[V]$(VersionPrefix)\f[R] combined with the \f[V]$(VersionSuffix)\f[R], separated by a dash.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]-?|-h|--help\f[B]\f[R]
.RS 2
.PP
Prints out a description of how to use the command.
.RE
.SH EXAMPLES
.IP \[bu] 2
Build a project and its dependencies:
Expand Down Expand Up @@ -393,3 +406,23 @@ dotnet build -p:Version=1.2.3.4
\f[R]
.fi
.RE
.IP \[bu] 2
Run the \f[V]Clean\f[R] target to remove previous build outputs:
.RS 2
.IP
.nf
\f[C]
dotnet build -t:Clean
\f[R]
.fi
.RE
.IP \[bu] 2
Run the \f[V]Clean\f[R] target using the equivalent space-separated syntax:
.RS 2
.IP
.nf
\f[C]
dotnet build -t Clean
\f[R]
.fi
.RE
28 changes: 8 additions & 20 deletions documentation/manpages/sdk/dotnet-clean.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-clean" "1" "2025-10-30" "" ".NET Documentation"
.TH "dotnet-clean" "1" "2026-08-28" "" ".NET Documentation"
.hy
.SH dotnet clean
.PP
Expand Down Expand Up @@ -58,22 +58,19 @@ The path and filename of a file-based app.
File-based apps are contained within a single file that is built and run without a corresponding project (\f[I].csproj\f[R]) file.
For more information, see Build file-based C# apps.
.SH OPTIONS
.IP \[bu] 2
.PP
\f[B]\f[VB]--artifacts-path <ARTIFACTS_DIR>\f[B]\f[R]
.RS 2
.PP
All build output files from the executed command will go in subfolders under the specified path, separated by project.
For more information see Artifacts Output Layout.
This option and the value provided must be explicitly cascaded in any \f[V]dotnet\f[R] command that depends on the output of another \f[V]dotnet\f[R] command, for example, when using \f[V]dotnet build --no-restore\f[R] and \f[V]dotnet publish --no-build\f[R].
Available since .NET 8 SDK.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]-c|--configuration <CONFIGURATION>\f[B]\f[R]
.RS 2
.PP
Defines the build configuration.
The default for most projects is \f[V]Debug\f[R], but you can override the build configuration settings in your project.
This option is only required when cleaning if you specified it during build time.
.RE
.IP \[bu] 2
\f[B]\f[VB]-f|--framework <FRAMEWORK>\f[B]\f[R]
.RS 2
Expand All @@ -82,20 +79,15 @@ The framework that was specified at build time.
The framework must be defined in the project file.
If you specified the framework at build time, you must specify the framework when cleaning.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]-?|-h|--help\f[B]\f[R]
.RS 2
.PP
Prints out a description of how to use the command.
.RE
.IP \[bu] 2
.PP
\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 Core 3.0 SDK.
.RE
.IP \[bu] 2
\f[B]\f[VB]--nologo\f[B]\f[R]
.RS 2
Expand Down Expand Up @@ -124,9 +116,8 @@ For more information, see Solution-level \f[V]--output\f[R] option no longer val
Cleans the output folder of the specified runtime.
This is used when a self-contained deployment was created.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]--tl:[auto|on|off]\f[B]\f[R]
.RS 2
.PP
Specifies whether \f[I]Terminal Logger\f[R] should be used for the build output.
The default is \f[V]auto\f[R], which first verifies the environment before enabling terminal logging.
Expand All @@ -151,16 +142,13 @@ The primary output of that build (which is hyperlinked).
Any diagnostics generated for that project.
.PP
This option is available starting in .NET 8.
.RE
.IP \[bu] 2
.PP
\f[B]\f[VB]-v|--verbosity <LEVEL>\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], \f[V]d[etailed]\f[R], and \f[V]diag[nostic]\f[R].
The default is \f[V]normal\f[R].
For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
.RE
.SH EXAMPLES
.IP \[bu] 2
Clean a default build of the project:
Expand Down
Loading