From 5f93685491be1ccd9c3e58bcc7f424acb9146d96 Mon Sep 17 00:00:00 2001 From: kasper3 <33230602+kasper3@users.noreply.github.com> Date: Wed, 30 May 2018 15:50:26 +0000 Subject: [PATCH] Add dotnet-tool manpages and update others --- Documentation/manpages/sdk/dotnet-add-package.1 | 16 +- Documentation/manpages/sdk/dotnet-add-reference.1 | 2 +- Documentation/manpages/sdk/dotnet-build-server.1 | 43 +++ Documentation/manpages/sdk/dotnet-build.1 | 26 +- Documentation/manpages/sdk/dotnet-clean.1 | 2 +- Documentation/manpages/sdk/dotnet-help.1 | 2 +- Documentation/manpages/sdk/dotnet-install-script.1 | 2 +- Documentation/manpages/sdk/dotnet-list-reference.1 | 6 +- Documentation/manpages/sdk/dotnet-migrate.1 | 55 +-- Documentation/manpages/sdk/dotnet-msbuild.1 | 4 +- Documentation/manpages/sdk/dotnet-new.1 | 411 ++++++++++++++++++++- Documentation/manpages/sdk/dotnet-nuget-delete.1 | 92 ++++- Documentation/manpages/sdk/dotnet-nuget-locals.1 | 32 +- Documentation/manpages/sdk/dotnet-nuget-push.1 | 136 ++++++- Documentation/manpages/sdk/dotnet-pack.1 | 20 +- Documentation/manpages/sdk/dotnet-publish.1 | 114 +++++- Documentation/manpages/sdk/dotnet-remove-package.1 | 4 +- .../manpages/sdk/dotnet-remove-reference.1 | 4 +- Documentation/manpages/sdk/dotnet-restore.1 | 25 +- Documentation/manpages/sdk/dotnet-run.1 | 100 ++++- Documentation/manpages/sdk/dotnet-sln.1 | 2 +- Documentation/manpages/sdk/dotnet-store.1 | 9 +- Documentation/manpages/sdk/dotnet-test.1 | 119 +++++- Documentation/manpages/sdk/dotnet-tool-install.1 | 116 ++++++ Documentation/manpages/sdk/dotnet-tool-list.1 | 59 +++ Documentation/manpages/sdk/dotnet-tool-uninstall.1 | 64 ++++ Documentation/manpages/sdk/dotnet-tool-update.1 | 82 ++++ Documentation/manpages/sdk/dotnet-vstest.1 | 250 ++++++++++++- Documentation/manpages/sdk/dotnet.1 | 279 +++++++++++++- 29 files changed, 1878 insertions(+), 198 deletions(-) create mode 100644 Documentation/manpages/sdk/dotnet-build-server.1 create mode 100644 Documentation/manpages/sdk/dotnet-tool-install.1 create mode 100644 Documentation/manpages/sdk/dotnet-tool-list.1 create mode 100644 Documentation/manpages/sdk/dotnet-tool-uninstall.1 create mode 100644 Documentation/manpages/sdk/dotnet-tool-update.1 diff --git a/Documentation/manpages/sdk/dotnet-add-package.1 b/Documentation/manpages/sdk/dotnet-add-package.1 index 5da0a9104f..9710291b40 100644 --- a/Documentation/manpages/sdk/dotnet-add-package.1 +++ b/Documentation/manpages/sdk/dotnet-add-package.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet add package command \- .NET Core CLI" "1" "" "" ".NET Core" .hy @@ -9,7 +9,7 @@ \f[C]dotnet\ add\ package\f[] \- Adds a package reference to a project file. .SH SYNOPSIS .PP -\f[C]dotnet\ add\ []\ package\ \ [\-h|\-\-help]\ [\-v|\-\-version]\ [\-f|\-\-framework]\ [\-n|\-\-no\-restore]\ [\-s|\-\-source]\ [\-\-package\-directory]\f[] +\f[C]dotnet\ add\ []\ package\ \ [\-h|\-\-help]\ [\-f|\-\-framework]\ [\-n|\-\-no\-restore]\ [\-\-package\-directory]\ [\-s|\-\-source]\ [\-v|\-\-version]\f[] .SH DESCRIPTION .PP The \f[C]dotnet\ add\ package\f[] command provides a convenient option to add a package reference to a project file. @@ -54,10 +54,6 @@ The package reference to add. .PP Prints out a short help for the command. .PP -\f[C]\-v|\-\-version\ \f[] -.PP -Version of the package. -.PP \f[C]\-f|\-\-framework\ \f[] .PP Adds a package reference only when targeting a specific framework. @@ -66,13 +62,17 @@ Adds a package reference only when targeting a specific framework. .PP Adds a package reference without performing a restore preview and compatibility check. .PP +\f[C]\-\-package\-directory\ \f[] +.PP +Restores the package to the specified directory. +.PP \f[C]\-s|\-\-source\ \f[] .PP Uses a specific NuGet package source during the restore operation. .PP -\f[C]\-\-package\-directory\ \f[] +\f[C]\-v|\-\-version\ \f[] .PP -Restores the package to the specified directory. +Version of the package. .SH EXAMPLES .PP Add \f[C]Newtonsoft.Json\f[] NuGet package to a project: diff --git a/Documentation/manpages/sdk/dotnet-add-reference.1 b/Documentation/manpages/sdk/dotnet-add-reference.1 index b3ff3b02ef..2af1448edc 100644 --- a/Documentation/manpages/sdk/dotnet-add-reference.1 +++ b/Documentation/manpages/sdk/dotnet-add-reference.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet\-add reference command \- .NET Core CLI" "1" "" "" ".NET Core" .hy diff --git a/Documentation/manpages/sdk/dotnet-build-server.1 b/Documentation/manpages/sdk/dotnet-build-server.1 new file mode 100644 index 0000000000..e9ee54c7b0 --- /dev/null +++ b/Documentation/manpages/sdk/dotnet-build-server.1 @@ -0,0 +1,43 @@ +.\" Automatically generated by Pandoc 2.2.1 +.\" +.TH "dotnet build\-server command \- .NET Core CLI" "1" "" "" ".NET Core" +.hy +.SH dotnet\-build +.PP +.SH NAME +.PP +\f[C]dotnet\ build\-server\f[] \- Interacts with servers started by a build. +.SH SYNOPSIS +.IP +.nf +\f[C] +dotnet\ build\-server\ shutdown\ [\-\-msbuild]\ [\-\-razor]\ [\-\-vbcscompiler] +dotnet\ build\-server\ shutdown\ [\-h|\-\-help] +dotnet\ build\-server\ [\-h|\-\-help] +\f[] +.fi +.SS Commands +.PP +\f[C]shutdown\f[] +.PP +Shuts down build servers that are started from dotnet. +By default, all servers are shut down. +.SH OPTIONS +.PP +\f[C]\-h|\-\-help\f[] +.PP +Prints out a short help for the command. +.PP +\f[C]\-\-msbuild\f[] +.PP +Shuts down the MSBuild build server. +.PP +\f[C]\-\-razor\f[] +.PP +Shuts down the Razor build server. +.PP +\f[C]\-\-vbcscompiler\f[] +.PP +Shuts down the VB/C# compiler build server. +.SH AUTHORS +mairaw. diff --git a/Documentation/manpages/sdk/dotnet-build.1 b/Documentation/manpages/sdk/dotnet-build.1 index 25f1b5d099..ebdc2313e9 100644 --- a/Documentation/manpages/sdk/dotnet-build.1 +++ b/Documentation/manpages/sdk/dotnet-build.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet build command \- .NET Core CLI" "1" "" "" ".NET Core" .hy @@ -44,19 +44,19 @@ For more information, see .NET Core Application Deployment. Building requires the \f[I]project.assets.json\f[] file, which lists the dependencies of your application. The file is created when \f[C]dotnet\ restore\f[] is executed. Without the assets file in place, the tooling cannot resolve reference assemblies, which results in errors. -With .NET Core 1.x SDK, you needed to explicitily run the \f[C]dotnet\ restore\f[] before running \f[C]dotnet\ build\f[]. -Starting with .NET Core 2.0 SDK, \f[C]dotnet\ restore\f[] runs implicitily when you run \f[C]dotnet\ build\f[]. +With .NET Core 1.x SDK, you needed to explicitly run the \f[C]dotnet\ restore\f[] before running \f[C]dotnet\ build\f[]. +Starting with .NET Core 2.0 SDK, \f[C]dotnet\ restore\f[] runs implicitly when you run \f[C]dotnet\ build\f[]. If you want to disable implicit restore when running the build command, you can pass the \f[C]\-\-no\-restore\f[] option. .PP .PP -\f[C]dotnet\ build\f[] uses MSBuild to build the project; thus, it supports both parallel and incremental builds. -Refer to Incremental Builds for more information. +\f[C]dotnet\ build\f[] uses MSBuild to build the project, so it supports both parallel and incremental builds. +For more information, see Incremental Builds. .PP In addition to its options, the \f[C]dotnet\ build\f[] command accepts MSBuild options, such as \f[C]/p\f[] for setting properties or \f[C]/l\f[] to define a logger. -Learn more about these options in the MSBuild Command\-Line Reference. +For more information about these options, see the MSBuild Command\-Line Reference. .PP Whether the project is executable or not is determined by the \f[C]\f[] property in the project file. -The following example shows a project that will produce executable code: +The following example shows a project that produces executable code: .IP .nf \f[C] @@ -90,7 +90,7 @@ The framework must be defined in the project file. \f[C]\-\-force\f[] .PP Forces all dependencies to be resolved even if the last restore was successful. -This is equivalent to deleting the \f[I]project.assets.json\f[] file. +Specifying this flag is the same as deleting the \f[I]project.assets.json\f[] file. .PP \f[C]\-h|\-\-help\f[] .PP @@ -98,16 +98,16 @@ Prints out a short help for the command. .PP \f[C]\-\-no\-dependencies\f[] .PP -Ignores project\-to\-project (P2P) references and only builds the root project specified to build. +Ignores project\-to\-project (P2P) references and only builds the specified root project. .PP \f[C]\-\-no\-incremental\f[] .PP Marks the build as unsafe for incremental build. -This turns off incremental compilation and forces a clean rebuild of the project's dependency graph. +This flag turns off incremental compilation and forces a clean rebuild of the project's dependency graph. .PP \f[C]\-\-no\-restore\f[] .PP -Doesn't perform an implicit restore during build. +Doesn't execute an implicit restore during build. .PP \f[C]\-o|\-\-output\ \f[] .PP @@ -146,12 +146,12 @@ Prints out a short help for the command. .PP \f[C]\-\-no\-dependencies\f[] .PP -Ignores project\-to\-project (P2P) references and only builds the root project specified to build. +Ignores project\-to\-project (P2P) references and only builds the specified root project. .PP \f[C]\-\-no\-incremental\f[] .PP Marks the build as unsafe for incremental build. -This turns off incremental compilation and forces a clean rebuild of the project's dependency graph. +This flag turns off incremental compilation and forces a clean rebuild of the project's dependency graph. .PP \f[C]\-o|\-\-output\ \f[] .PP diff --git a/Documentation/manpages/sdk/dotnet-clean.1 b/Documentation/manpages/sdk/dotnet-clean.1 index a95fbe7b85..4789e11bf4 100644 --- a/Documentation/manpages/sdk/dotnet-clean.1 +++ b/Documentation/manpages/sdk/dotnet-clean.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet clean command \- .NET Core CLI" "1" "" "" ".NET Core" .hy diff --git a/Documentation/manpages/sdk/dotnet-help.1 b/Documentation/manpages/sdk/dotnet-help.1 index 0a1b4eb6c9..433ab81e36 100644 --- a/Documentation/manpages/sdk/dotnet-help.1 +++ b/Documentation/manpages/sdk/dotnet-help.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet help command \- .NET Core CLI" "1" "" "" ".NET Core" .hy diff --git a/Documentation/manpages/sdk/dotnet-install-script.1 b/Documentation/manpages/sdk/dotnet-install-script.1 index d7717db091..3b01fd619a 100644 --- a/Documentation/manpages/sdk/dotnet-install-script.1 +++ b/Documentation/manpages/sdk/dotnet-install-script.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet\-install scripts" "1" "" "" ".NET Core" .hy diff --git a/Documentation/manpages/sdk/dotnet-list-reference.1 b/Documentation/manpages/sdk/dotnet-list-reference.1 index 0d961002a3..849bb70a79 100644 --- a/Documentation/manpages/sdk/dotnet-list-reference.1 +++ b/Documentation/manpages/sdk/dotnet-list-reference.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet list reference command \- .NET Core CLI" "1" "" "" ".NET Core" .hy @@ -6,7 +6,7 @@ .PP .SH NAME .PP -\f[C]dotnet\ list\ reference\f[] \- Lists project to project references. +\f[C]dotnet\ list\ reference\f[] \- Lists project\-to\-project references. .SH SYNOPSIS .PP \f[C]dotnet\ list\ []\ reference\ [\-h|\-\-help]\f[] @@ -18,7 +18,7 @@ The \f[C]dotnet\ list\ reference\f[] command provides a convenient option to lis \f[C]PROJECT\f[] .PP Specifies the project file to use for listing references. -If not specified, the command will search the current directory for a project file. +If not specified, the command searches the current directory for a project file. .SH OPTIONS .PP \f[C]\-h|\-\-help\f[] diff --git a/Documentation/manpages/sdk/dotnet-migrate.1 b/Documentation/manpages/sdk/dotnet-migrate.1 index dd5de60b11..a649e6895c 100644 --- a/Documentation/manpages/sdk/dotnet-migrate.1 +++ b/Documentation/manpages/sdk/dotnet-migrate.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet migrate command \- .NET Core CLI" "1" "" "" ".NET Core" .hy @@ -8,8 +8,13 @@ .PP \f[C]dotnet\ migrate\f[] \- Migrates a Preview 2 .NET Core project to a .NET Core SDK 1.0 project. .SH SYNOPSIS -.PP -\f[C]dotnet\ migrate\ []\ [\-t|\-\-template\-file]\ [\-v|\-\-sdk\-package\-version]\ [\-x|\-\-xproj\-file]\ [\-s|\-\-skip\-project\-references]\ [\-r|\-\-report\-file]\ [\-\-format\-report\-file\-json]\ [\-\-skip\-backup]\ [\-h|\-\-help]\f[] +.IP +.nf +\f[C] +dotnet\ migrate\ []\ [\-\-format\-report\-file\-json]\ [\-r|\-\-report\-file]\ [\-s|\-\-skip\-project\-references]\ [\-\-skip\-backup]\ [\-t|\-\-template\-file]\ [\-v|\-\-sdk\-package\-version]\ [\-x|\-\-xproj\-file] +dotnet\ migrate\ [\-h|\-\-help] +\f[] +.fi .SH DESCRIPTION .PP The \f[C]dotnet\ migrate\f[] command migrates a valid Preview 2 \f[I]project.json\f[]\-based project to a valid .NET Core SDK 1.0 \f[I]csproj\f[] project. @@ -17,7 +22,7 @@ The \f[C]dotnet\ migrate\f[] command migrates a valid Preview 2 \f[I]project.jso By default, the command migrates the root project and any project references that the root project contains. This behavior is disabled using the \f[C]\-\-skip\-project\-references\f[] option at runtime. .PP -Migration is performed on the following: +Migration can be performed on the following assets: .IP \[bu] 2 A single project by specifying the \f[I]project.json\f[] file to migrate. .IP \[bu] 2 @@ -25,7 +30,7 @@ All of the directories specified in the \f[I]global.json\f[] file by passing in .IP \[bu] 2 A \f[I]solution.sln\f[] file, where it migrates the projects referenced in the solution. .IP \[bu] 2 -On all sub\-directories of the given directory recursively. +On all subdirectories of the given directory recursively. .PP The \f[C]dotnet\ migrate\f[] command keeps the migrated \f[I]project.json\f[] file inside a \f[C]backup\f[] directory, which it creates if the directory doesn't exist. This behavior is overridden using the \f[C]\-\-skip\-backup\f[] option. @@ -44,19 +49,36 @@ The path to one of the following: .IP \[bu] 2 a \f[I]project.json\f[] file to migrate. .IP \[bu] 2 -a \f[I]global.json\f[] file, it will migrate the folders specified in \f[I]global.json\f[]. +a \f[I]global.json\f[] file: the folders specified in \f[I]global.json\f[] are migrated. .IP \[bu] 2 -a \f[I]solution.sln\f[] file, it will migrate the projects referenced in the solution. +a \f[I]solution.sln\f[] file: the projects referenced in the solution are migrated. .IP \[bu] 2 -a directory to migrate, it will recursively search for \f[I]project.json\f[] files to migrate. +a directory to migrate: recursively searches for \f[I]project.json\f[] files to migrate inside the specified directory. .PP Defaults to current directory if nothing is specified. .SH OPTIONS .PP +\f[C]\-\-format\-report\-file\-json\ \f[] +.PP +Output migration report file as JSON rather than user messages. +.PP \f[C]\-h|\-\-help\f[] .PP Prints out a short help for the command. .PP +\f[C]\-r|\-\-report\-file\ \f[] +.PP +Output migration report to a file in addition to the console. +.PP +\f[C]\-s|\-\-skip\-project\-references\ [Debug|Release]\f[] +.PP +Skip migrating project references. +By default, project references are migrated recursively. +.PP +\f[C]\-\-skip\-backup\f[] +.PP +Skip moving \f[I]project.json\f[], \f[I]global.json\f[], and \f[I]*.xproj\f[] to a \f[C]backup\f[] directory after successful migration. +.PP \f[C]\-t|\-\-template\-file\ \f[] .PP Template csproj file to use for migration. @@ -71,23 +93,6 @@ The default is the version of the SDK in \f[C]dotnet\ new\f[]. .PP The path to the xproj file to use. Required when there is more than one xproj in a project directory. -.PP -\f[C]\-s|\-\-skip\-project\-references\ [Debug|Release]\f[] -.PP -Skip migrating project references. -By default, project references are migrated recursively. -.PP -\f[C]\-r|\-\-report\-file\ \f[] -.PP -Output migration report to a file in addition to the console. -.PP -\f[C]\-\-format\-report\-file\-json\ \f[] -.PP -Output migration report file as JSON rather than user messages. -.PP -\f[C]\-\-skip\-backup\f[] -.PP -Skip moving \f[I]project.json\f[], \f[I]global.json\f[], and \f[I]*.xproj\f[] to a \f[C]backup\f[] directory after successful migration. .SH EXAMPLES .PP Migrate a project in the current directory and all of its project\-to\-project dependencies: diff --git a/Documentation/manpages/sdk/dotnet-msbuild.1 b/Documentation/manpages/sdk/dotnet-msbuild.1 index 7e86576a44..ecd93ca15d 100644 --- a/Documentation/manpages/sdk/dotnet-msbuild.1 +++ b/Documentation/manpages/sdk/dotnet-msbuild.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet msbuild command \- .NET Core CLI" "1" "" "" ".NET Core" .hy @@ -16,7 +16,7 @@ The \f[C]dotnet\ msbuild\f[] command allows access to a fully functional MSBuild .PP The command has the exact same capabilities as existing MSBuild command\-line client. The options are all the same. -Use the MSBuild Command\-Line Reference to obtain information on the available options. +For more information about the available options, see the MSBuild Command\-Line Reference. .SH EXAMPLES .PP Build a project and its dependencies: diff --git a/Documentation/manpages/sdk/dotnet-new.1 b/Documentation/manpages/sdk/dotnet-new.1 index f1242f3c1c..897b6b5085 100644 --- a/Documentation/manpages/sdk/dotnet-new.1 +++ b/Documentation/manpages/sdk/dotnet-new.1 @@ -1,5 +1,5 @@ .\"t -.\" Automatically generated by Pandoc 2.1.3 +.\" Automatically generated by Pandoc 2.2.1 .\" .TH "dotnet new command \- .NET Core CLI" "1" "" "" ".NET Core" .hy @@ -9,6 +9,16 @@ .PP \f[C]dotnet\ new\f[] \- Creates a new project, configuration file, or solution based on the specified template. .SH SYNOPSIS +.SS .NET Core 2.1 +.IP +.nf +\f[C] +dotnet\ new\