Skip to content

Commit 347c68a

Browse files
authored
[automated] Update man pages (#51076)
2 parents 95d125e + 1901b78 commit 347c68a

File tree

7 files changed

+186
-69
lines changed

7 files changed

+186
-69
lines changed

documentation/manpages/sdk/dotnet-build.1

Lines changed: 35 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-build" "1" "2025-06-13" "" ".NET Documentation"
17+
.TH "dotnet-build" "1" "2025-09-30" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet build
2020
.PP
21-
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions
21+
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 and later versions
2222
.SH NAME
2323
.PP
24-
dotnet-build - Builds a project and all of its dependencies.
24+
dotnet-build - Builds a project, solution, or file-based app and all of its dependencies.
2525
.SH SYNOPSIS
2626
.IP
2727
.nf
2828
\f[C]
29-
dotnet build [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
29+
dotnet build [<PROJECT>|<SOLUTION>|<FILE>] [-a|--arch <ARCHITECTURE>]
3030
[--artifacts-path <ARTIFACTS_DIR>]
3131
[-c|--configuration <CONFIGURATION>] [-f|--framework <FRAMEWORK>]
3232
[--disable-build-servers]
@@ -35,7 +35,7 @@ dotnet build [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
3535
[-o|--output <OUTPUT_DIRECTORY>]
3636
[-p|--property:<PROPERTYNAME>=<VALUE>]
3737
[-r|--runtime <RUNTIME_IDENTIFIER>]
38-
[--self-contained [true|false]] [--source <SOURCE>]
38+
[-sc|--self-contained [true|false]] [--source <SOURCE>]
3939
[--tl:[auto|on|off]] [--use-current-runtime, --ucr [true|false]]
4040
[-v|--verbosity <LEVEL>] [--version-suffix <VERSION_SUFFIX>]
4141

@@ -44,11 +44,11 @@ dotnet build -h|--help
4444
.fi
4545
.SH DESCRIPTION
4646
.PP
47-
The \f[V]dotnet build\f[R] command builds the project and its dependencies into a set of binaries.
47+
The \f[V]dotnet build\f[R] command builds the project, solution, or file-based app and its dependencies into a set of binaries.
4848
The binaries include the project\[cq]s code in Intermediate Language (IL) files with a \f[I].dll\f[R] extension.
4949
Depending on the project type and settings, other files may be included, such as:
5050
.IP \[bu] 2
51-
An executable that can be used to run the application, if the project type is an executable targeting .NET Core 3.0 or later.
51+
An executable that can be used to run the application.
5252
.IP \[bu] 2
5353
Symbol files used for debugging with a \f[I].pdb\f[R] extension.
5454
.IP \[bu] 2
@@ -58,12 +58,6 @@ A \f[I].runtimeconfig.json\f[R] file, which specifies the shared runtime and its
5858
.IP \[bu] 2
5959
Other libraries that the project depends on (via project references or NuGet package references).
6060
.PP
61-
For executable projects targeting versions earlier than .NET Core 3.0, library dependencies from NuGet are typically NOT copied to the output folder.
62-
They\[cq]re resolved from the NuGet global packages folder at run time.
63-
With that in mind, the product of \f[V]dotnet build\f[R] isn\[cq]t ready to be transferred to another machine to run.
64-
To create a version of the application that can be deployed, you need to publish it (for example, with the dotnet publish command).
65-
For more information, see .NET Application Deployment.
66-
.PP
6761
For executable projects targeting .NET Core 3.0 and later, library dependencies are copied to the output folder.
6862
This means that if there isn\[cq]t any other publish-specific logic (such as Web projects have), the build output should be deployable.
6963
.SS Implicit restore
@@ -98,7 +92,8 @@ To produce a library, omit the \f[V]<OutputType>\f[R] property or change its val
9892
The IL DLL for a library doesn\[cq]t contain entry points and can\[cq]t be executed.
9993
.SS MSBuild
10094
.PP
101-
\f[V]dotnet build\f[R] uses MSBuild to build the project, so it supports both parallel and incremental builds.
95+
\f[V]dotnet build\f[R] uses MSBuild to build the project, solution, or file-based app.
96+
It supports both parallel and incremental builds.
10297
For more information, see Incremental Builds.
10398
.PP
10499
In addition to its options, the \f[V]dotnet build\f[R] command accepts MSBuild options, such as \f[V]-p\f[R] for setting properties or \f[V]-l\f[R] to define a logger.
@@ -117,10 +112,19 @@ If the download is still running when this command finishes, the download is sto
117112
For more information, see Advertising manifests.
118113
.SH ARGUMENTS
119114
.PP
120-
\f[V]PROJECT | SOLUTION\f[R]
115+
\f[V]PROJECT | SOLUTION | FILE\f[R]
121116
.PP
122-
The project or solution file to build.
123-
If a project or solution file isn\[cq]t specified, MSBuild searches the current working directory for a file that has a file extension that ends in either \f[I]proj\f[R] or \f[I]sln\f[R] and uses that file.
117+
The project or solution or C# (file-based app) file to operate on.
118+
If a file isn\[cq]t specified, MSBuild searches the current directory for a project or solution.
119+
.IP \[bu] 2
120+
\f[V]PROJECT\f[R] is the path and filename of a C#, F#, or Visual Basic project file, or the path to a directory that contains a C#, F#, or Visual Basic project file.
121+
.IP \[bu] 2
122+
\f[V]SOLUTION\f[R] is the path and filename of a solution file (\f[I].sln\f[R] or \f[I].slnx\f[R] extension), or the path to a directory that contains a solution file.
123+
.IP \[bu] 2
124+
\f[V]FILE\f[R] is an argument added in .NET 10.
125+
The path and filename of a file-based app.
126+
File-based apps are contained within a single file that is built and run without a corresponding project (\f[I].csproj\f[R]) file.
127+
For more information, see Build file-based C# apps.
124128
.SH OPTIONS
125129
.IP \[bu] 2
126130
\f[B]\f[VB]-a|--arch <ARCHITECTURE>\f[B]\f[R]
@@ -285,13 +289,13 @@ The URI of the NuGet package source to use during the restore operation.
285289
\f[B]\f[VB]--tl:[auto|on|off]\f[B]\f[R]
286290
.RS 2
287291
.PP
288-
Specifies whether the \f[I]terminal logger\f[R] should be used for the build output.
292+
Specifies whether \f[I]Terminal Logger\f[R] should be used for the build output.
289293
The default is \f[V]auto\f[R], which first verifies the environment before enabling terminal logging.
290294
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.
291295
\f[V]on\f[R] skips the environment check and enables terminal logging.
292296
\f[V]off\f[R] skips the environment check and uses the default console logger.
293297
.PP
294-
The terminal logger shows you the restore phase followed by the build phase.
298+
Terminal Logger shows you the restore phase followed by the build phase.
295299
During each phase, the currently building projects appear at the bottom of the terminal.
296300
Each project that\[cq]s building outputs both the MSBuild target currently being built and the amount of time spent on that target.
297301
You can search this information to learn more about the build.
@@ -348,6 +352,18 @@ dotnet build
348352
.fi
349353
.RE
350354
.IP \[bu] 2
355+
Build a file-based app:
356+
.RS 2
357+
.IP
358+
.nf
359+
\f[C]
360+
dotnet build MyProject.cs
361+
\f[R]
362+
.fi
363+
.PP
364+
File-based app support was added in .NET SDK 10.0.100.
365+
.RE
366+
.IP \[bu] 2
351367
Build a project and its dependencies using Release configuration:
352368
.RS 2
353369
.IP

documentation/manpages/sdk/dotnet-clean.1

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-clean" "1" "2025-06-13" "" ".NET Documentation"
17+
.TH "dotnet-clean" "1" "2025-09-30" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet clean
2020
.PP
21-
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions
21+
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 and later versions
2222
.SH NAME
2323
.PP
2424
dotnet-clean - Cleans the output of a project.
2525
.SH SYNOPSIS
2626
.IP
2727
.nf
2828
\f[C]
29-
dotnet clean [<PROJECT>|<SOLUTION>] [--artifacts-path <ARTIFACTS_DIR>]
29+
dotnet clean [<PROJECT>|<SOLUTION>|<FILE>] [--artifacts-path <ARTIFACTS_DIR>]
3030
[-c|--configuration <CONFIGURATION>]
3131
[-f|--framework <FRAMEWORK>] [--interactive]
3232
[--nologo] [-o|--output <OUTPUT_DIRECTORY>]
@@ -44,10 +44,19 @@ Only the outputs created during the build are cleaned.
4444
Both intermediate (\f[I]obj\f[R]) and final output (\f[I]bin\f[R]) folders are cleaned.
4545
.SH ARGUMENTS
4646
.PP
47-
\f[V]PROJECT | SOLUTION\f[R]
47+
\f[V]PROJECT | SOLUTION | FILE\f[R]
4848
.PP
49-
The MSBuild project or solution to clean.
50-
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.
49+
The project or solution or C# (file-based app) file to operate on.
50+
If a file isn\[cq]t specified, MSBuild searches the current directory for a project or solution.
51+
.IP \[bu] 2
52+
\f[V]PROJECT\f[R] is the path and filename of a C#, F#, or Visual Basic project file, or the path to a directory that contains a C#, F#, or Visual Basic project file.
53+
.IP \[bu] 2
54+
\f[V]SOLUTION\f[R] is the path and filename of a solution file (\f[I].sln\f[R] or \f[I].slnx\f[R] extension), or the path to a directory that contains a solution file.
55+
.IP \[bu] 2
56+
\f[V]FILE\f[R] is an argument added in .NET 10.
57+
The path and filename of a file-based app.
58+
File-based apps are contained within a single file that is built and run without a corresponding project (\f[I].csproj\f[R]) file.
59+
For more information, see Build file-based C# apps.
5160
.SH OPTIONS
5261
.IP \[bu] 2
5362
\f[B]\f[VB]--artifacts-path <ARTIFACTS_DIR>\f[B]\f[R]
@@ -119,13 +128,13 @@ This is used when a self-contained deployment was created.
119128
\f[B]\f[VB]--tl:[auto|on|off]\f[B]\f[R]
120129
.RS 2
121130
.PP
122-
Specifies whether the \f[I]terminal logger\f[R] should be used for the build output.
131+
Specifies whether \f[I]Terminal Logger\f[R] should be used for the build output.
123132
The default is \f[V]auto\f[R], which first verifies the environment before enabling terminal logging.
124133
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.
125134
\f[V]on\f[R] skips the environment check and enables terminal logging.
126135
\f[V]off\f[R] skips the environment check and uses the default console logger.
127136
.PP
128-
The terminal logger shows you the restore phase followed by the build phase.
137+
Terminal Logger shows you the restore phase followed by the build phase.
129138
During each phase, the currently building projects appear at the bottom of the terminal.
130139
Each project that\[cq]s building outputs both the MSBuild target currently being built and the amount of time spent on that target.
131140
You can search this information to learn more about the build.
@@ -164,6 +173,18 @@ dotnet clean
164173
.fi
165174
.RE
166175
.IP \[bu] 2
176+
Clean a file-based program:
177+
.RS 2
178+
.IP
179+
.nf
180+
\f[C]
181+
dotnet clean Program.cs.
182+
\f[R]
183+
.fi
184+
.PP
185+
File-based app support was added in .NET SDK 10.0.100.
186+
.RE
187+
.IP \[bu] 2
167188
Clean a project built using the Release configuration:
168189
.RS 2
169190
.IP

documentation/manpages/sdk/dotnet-pack.1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
. ftr VB CB
1616
. ftr VBI CBI
1717
.\}
18-
.TH "dotnet-pack" "1" "2025-06-13" "" ".NET Documentation"
18+
.TH "dotnet-pack" "1" "2025-09-30" "" ".NET Documentation"
1919
.hy
2020
.SH dotnet pack
2121
.PP
@@ -202,13 +202,13 @@ For more information, see .NET Blog: .NET Framework 4.5.1 Supports Microsoft Sec
202202
\f[B]\f[VB]--tl:[auto|on|off]\f[B]\f[R]
203203
.RS 2
204204
.PP
205-
Specifies whether the \f[I]terminal logger\f[R] should be used for the build output.
205+
Specifies whether \f[I]Terminal Logger\f[R] should be used for the build output.
206206
The default is \f[V]auto\f[R], which first verifies the environment before enabling terminal logging.
207207
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.
208208
\f[V]on\f[R] skips the environment check and enables terminal logging.
209209
\f[V]off\f[R] skips the environment check and uses the default console logger.
210210
.PP
211-
The terminal logger shows you the restore phase followed by the build phase.
211+
Terminal Logger shows you the restore phase followed by the build phase.
212212
During each phase, the currently building projects appear at the bottom of the terminal.
213213
Each project that\[cq]s building outputs both the MSBuild target currently being built and the amount of time spent on that target.
214214
You can search this information to learn more about the build.

documentation/manpages/sdk/dotnet-publish.1

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "dotnet-publish" "1" "2025-08-29" "" ".NET Documentation"
17+
.TH "dotnet-publish" "1" "2025-09-30" "" ".NET Documentation"
1818
.hy
1919
.SH dotnet publish
2020
.PP
21-
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions
21+
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 and later versions
2222
.SH NAME
2323
.PP
2424
dotnet-publish - Publishes the application and its dependencies to a folder for deployment to a hosting system.
2525
.SH SYNOPSIS
2626
.IP
2727
.nf
2828
\f[C]
29-
dotnet publish [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
29+
dotnet publish [<PROJECT>|<SOLUTION>|<FILE>] [-a|--arch <ARCHITECTURE>]
3030
[--artifacts-path <ARTIFACTS_DIR>]
3131
[-c|--configuration <CONFIGURATION>] [--disable-build-servers]
3232
[-f|--framework <FRAMEWORK>] [--force] [--interactive]
@@ -172,18 +172,20 @@ When you run this command, it initiates an asynchronous background download of a
172172
If the download is still running when this command finishes, the download is stopped.
173173
For more information, see Advertising manifests.
174174
.SH ARGUMENTS
175-
.IP \[bu] 2
176-
\f[B]\f[VB]PROJECT|SOLUTION\f[B]\f[R]
177-
.RS 2
178175
.PP
179-
The project or solution to publish.
176+
\f[V]PROJECT | SOLUTION | FILE\f[R]
177+
.PP
178+
The project or solution or C# (file-based app) file to operate on.
179+
If a file isn\[cq]t specified, MSBuild searches the current directory for a project or solution.
180180
.IP \[bu] 2
181181
\f[V]PROJECT\f[R] is the path and filename of a C#, F#, or Visual Basic project file, or the path to a directory that contains a C#, F#, or Visual Basic project file.
182-
If the directory is not specified, it defaults to the current directory.
183182
.IP \[bu] 2
184183
\f[V]SOLUTION\f[R] is the path and filename of a solution file (\f[I].sln\f[R] or \f[I].slnx\f[R] extension), or the path to a directory that contains a solution file.
185-
If the directory is not specified, it defaults to the current directory.
186-
.RE
184+
.IP \[bu] 2
185+
\f[V]FILE\f[R] is an argument added in .NET 10.
186+
The path and filename of a file-based app.
187+
File-based apps are contained within a single file that is built and run without a corresponding project (\f[I].csproj\f[R]) file.
188+
For more information, see Build file-based C# apps.
187189
.SH OPTIONS
188190
.IP \[bu] 2
189191
\f[B]\f[VB]-a|--arch <ARCHITECTURE>\f[B]\f[R]
@@ -320,15 +322,6 @@ If you specify a relative path when publishing a solution, all output for all pr
320322
To make publish output go to separate folders for each project, specify a relative path by using the msbuild \f[V]PublishDir\f[R] property instead of the \f[V]--output\f[R] option.
321323
For example, \f[V]dotnet publish -p:PublishDir=.\[rs]publish\f[R] sends publish output for each project to a \f[V]publish\f[R] folder under the folder that contains the project file.
322324
.RE
323-
.IP \[bu] 2
324-
\&.NET Core 2.x SDK
325-
.RS 2
326-
.PP
327-
If you specify a relative path when publishing a project, the generated output directory is relative to the project file location, not to the current working directory.
328-
.PP
329-
If you specify a relative path when publishing a solution, each project\[cq]s output goes into a separate folder relative to the project file location.
330-
If you specify an absolute path when publishing a solution, all publish output for all projects goes into the specified folder.
331-
.RE
332325
.RE
333326
.IP \[bu] 2
334327
\f[B]\f[VB]--os <OS>\f[B]\f[R]
@@ -376,13 +369,13 @@ If you use this option, use \f[V]--self-contained\f[R] or \f[V]--no-self-contain
376369
\f[B]\f[VB]--tl:[auto|on|off]\f[B]\f[R]
377370
.RS 2
378371
.PP
379-
Specifies whether the \f[I]terminal logger\f[R] should be used for the build output.
372+
Specifies whether \f[I]Terminal Logger\f[R] should be used for the build output.
380373
The default is \f[V]auto\f[R], which first verifies the environment before enabling terminal logging.
381374
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.
382375
\f[V]on\f[R] skips the environment check and enables terminal logging.
383376
\f[V]off\f[R] skips the environment check and uses the default console logger.
384377
.PP
385-
The terminal logger shows you the restore phase followed by the build phase.
378+
Terminal Logger shows you the restore phase followed by the build phase.
386379
During each phase, the currently building projects appear at the bottom of the terminal.
387380
Each project that\[cq]s building outputs both the MSBuild target currently being built and the amount of time spent on that target.
388381
You can search this information to learn more about the build.
@@ -491,6 +484,18 @@ dotnet publish --no-dependencies
491484
\f[R]
492485
.fi
493486
.RE
487+
.IP \[bu] 2
488+
Publish the file-based C# program \f[I]app.cs\f[R] in the current directory:
489+
.RS 2
490+
.IP
491+
.nf
492+
\f[C]
493+
dotnet publish app.cs
494+
\f[R]
495+
.fi
496+
.PP
497+
File-based program support was added in .NET SDK 10.0.100.
498+
.RE
494499
.SH SEE ALSO
495500
.IP \[bu] 2
496501
\&.NET application publishing overview

0 commit comments

Comments
 (0)