diff --git a/Documentation/manpages/sdk/dotnet-add-package.1 b/Documentation/manpages/sdk/dotnet-add-package.1 new file mode 100644 index 000000000..5da0a9104 --- /dev/null +++ b/Documentation/manpages/sdk/dotnet-add-package.1 @@ -0,0 +1,90 @@ +.\" Automatically generated by Pandoc 2.1.3 +.\" +.TH "dotnet add package command \- .NET Core CLI" "1" "" "" ".NET Core" +.hy +.SH dotnet add package +.PP +.SH NAME +.PP +\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[] +.SH DESCRIPTION +.PP +The \f[C]dotnet\ add\ package\f[] command provides a convenient option to add a package reference to a project file. +After running the command, there's a compatibility check to ensure the package is compatible with the frameworks in the project. +If the check passes, a \f[C]\f[] element is added to the project file and dotnet restore is run. +.PP +.PP +For example, adding \f[C]Newtonsoft.Json\f[] to \f[I]ToDo.csproj\f[] produces output similar to the following example: +.IP +.nf +\f[C] +\ \ Writing\ C:\\Users\\mairaw\\AppData\\Local\\Temp\\tmp95A8.tmp +info\ :\ Adding\ PackageReference\ for\ package\ \[aq]Newtonsoft.Json\[aq]\ into\ project\ \[aq]C:\\projects\\ToDo\\ToDo.csproj\[aq]. +log\ \ :\ Restoring\ packages\ for\ C:\\projects\\ToDo\\ToDo.csproj... +info\ :\ \ \ GET\ https://api.nuget.org/v3\-flatcontainer/newtonsoft.json/index.json +info\ :\ \ \ OK\ https://api.nuget.org/v3\-flatcontainer/newtonsoft.json/index.json\ 235ms +info\ :\ Package\ \[aq]Newtonsoft.Json\[aq]\ is\ compatible\ with\ all\ the\ specified\ frameworks\ in\ project\ \[aq]C:\\projects\\ToDo\\ToDo.csproj\[aq]. +info\ :\ PackageReference\ for\ package\ \[aq]Newtonsoft.Json\[aq]\ version\ \[aq]10.0.3\[aq]\ added\ to\ file\ \[aq]C:\\projects\\ToDo\\ToDo.csproj\[aq]. +\f[] +.fi +.PP +The \f[I]ToDo.csproj\f[] file now contains a \f[C]\f[] element for the referenced package. +.IP +.nf +\f[C] + +\f[] +.fi +.SS Arguments +.PP +\f[C]PROJECT\f[] +.PP +Specifies the project file. +If not specified, the command searches the current directory for one. +.PP +\f[C]PACKAGE_NAME\f[] +.PP +The package reference to add. +.SH OPTIONS +.PP +\f[C]\-h|\-\-help\f[] +.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. +.PP +\f[C]\-n|\-\-no\-restore\f[] +.PP +Adds a package reference without performing a restore preview and compatibility check. +.PP +\f[C]\-s|\-\-source\ \f[] +.PP +Uses a specific NuGet package source during the restore operation. +.PP +\f[C]\-\-package\-directory\ \f[] +.PP +Restores the package to the specified directory. +.SH EXAMPLES +.PP +Add \f[C]Newtonsoft.Json\f[] NuGet package to a project: +.PP +\f[C]dotnet\ add\ package\ Newtonsoft.Json\f[] +.PP +Add a specific version of a package to a project: +.PP +\f[C]dotnet\ add\ ToDo.csproj\ package\ Microsoft.Azure.DocumentDB.Core\ \-v\ 1.0.0\f[] +.PP +Add a package using a specific NuGet source: +.PP +\f[C]dotnet\ add\ package\ Microsoft.AspNetCore.StaticFiles\ \-s\ https://dotnet.myget.org/F/dotnet\-core/api/v3/index.json\f[] +.SH AUTHORS +mairaw. diff --git a/Documentation/manpages/sdk/dotnet-add-reference.1 b/Documentation/manpages/sdk/dotnet-add-reference.1 new file mode 100644 index 000000000..b3ff3b02e --- /dev/null +++ b/Documentation/manpages/sdk/dotnet-add-reference.1 @@ -0,0 +1,62 @@ +.\" Automatically generated by Pandoc 2.1.3 +.\" +.TH "dotnet\-add reference command \- .NET Core CLI" "1" "" "" ".NET Core" +.hy +.SH dotnet\-add reference +.PP +.SH NAME +.PP +\f[C]dotnet\ add\ reference\f[] \- Adds project\-to\-project (P2P) references. +.SH SYNOPSIS +.PP +\f[C]dotnet\ add\ []\ reference\ [\-f|\-\-framework]\ \ [\-h|\-\-help]\f[] +.SH DESCRIPTION +.PP +The \f[C]dotnet\ add\ reference\f[] command provides a convenient option to add project references to a project. +After running the command, the \f[C]\f[] elements are added to the project file. +.IP +.nf +\f[C] + +\ \ +\ \ +\ \ + +\f[] +.fi +.SS Arguments +.PP +\f[C]PROJECT\f[] +.PP +Specifies the project file. +If not specified, the command searches the current directory for one. +.PP +\f[C]PROJECT_REFERENCES\f[] +.PP +Project\-to\-project (P2P) references to add. +Specify one or more projects. +Glob patterns are supported on Unix/Linux\-based systems. +.SH OPTIONS +.PP +\f[C]\-h|\-\-help\f[] +.PP +Prints out a short help for the command. +.PP +\f[C]\-f|\-\-framework\ \f[] +.PP +Adds project references only when targeting a specific framework. +.SH EXAMPLES +.PP +Add a project reference: +.PP +\f[C]dotnet\ add\ app/app.csproj\ reference\ lib/lib.csproj\f[] +.PP +Add multiple project references to the project in the current directory: +.PP +\f[C]dotnet\ add\ reference\ lib1/lib1.csproj\ lib2/lib2.csproj\f[] +.PP +Add multiple project references using a globbing pattern on Linux/Unix: +.PP +\f[C]dotnet\ add\ app/app.csproj\ reference\ **/*.csproj\f[] +.SH AUTHORS +mairaw. diff --git a/Documentation/manpages/sdk/dotnet-build.1 b/Documentation/manpages/sdk/dotnet-build.1 index 1cbb21fb7..25f1b5d09 100644 --- a/Documentation/manpages/sdk/dotnet-build.1 +++ b/Documentation/manpages/sdk/dotnet-build.1 @@ -1,96 +1,195 @@ -.\" Automatically generated by Pandoc 1.15.1 +.\" Automatically generated by Pandoc 2.1.3 .\" +.TH "dotnet build command \- .NET Core CLI" "1" "" "" ".NET Core" .hy -.TH "DOTNET\-BUILD" "1" "April 2016" "" "" -.SS NAME +.SH dotnet\-build .PP -dotnet\-build \-\- Builds a project and all of its dependencies -.SS SYNOPSIS +.SH NAME .PP -\f[C]dotnet\ build\ [\-\-output]\ \ \ \ \ \ \ [\-\-build\-base\-path]\ [\-\-framework]\ \ \ \ \ \ \ [\-\-configuration]\ \ [\-\-runtime]\ [\-\-version\-suffix]\ \ \ \ \ [\-\-build\-profile]\ \ [\-\-no\-incremental]\ [\-\-no\-dependencies]\ \ \ \ \ []\f[] -.SS DESCRIPTION -.PP -The \f[C]dotnet\ build\f[] command builds multiple source file from a -source project and its dependencies into a binary. -The binary will be in Intermediate Language (IL) by default and will -have a DLL extension. -\f[C]dotnet\ build\f[] will also drop a \f[C]\\*.deps\f[] file which -outlines what the host needs to run the application. -.PP -Building requires the existence of a lock file, which means that you -have to run \f[C]dotnet\ restore\f[] (dotnet-restore.md) prior to -building your code. -.PP -Before any compilation begins, the build verb analyzes the project and -its dependencies for incremental safety checks. -If all checks pass, then build proceeds with incremental compilation of -the project and its dependencies; otherwise, it falls back to -non\-incremental compilation. -Via a profile flag, users can choose to receive additional information -on how they can improve their build times. -.PP -All projects in the dependency graph that need compilation must pass the -following safety checks in order for the compilation process to be -incremental: \- not use pre/post compile scripts \- not load compilation -tools from PATH (for example, resgen, compilers) \- use only known -compilers (csc, vbc, fsc) -.PP -In order to build an executable application, you need a special -configuration section in your project.json file: +\f[C]dotnet\ build\f[] \- Builds a project and all of its dependencies. +.SH SYNOPSIS +.SS .NET Core 2.x .IP .nf \f[C] -{\ -\ \ \ \ "compilerOptions":\ { -\ \ \ \ \ \ "emitEntryPoint":\ true -\ \ \ \ } -} +dotnet\ build\ []\ [\-c|\-\-configuration]\ [\-f|\-\-framework]\ [\-\-force]\ [\-\-no\-dependencies]\ [\-\-no\-incremental] +\ \ \ \ [\-\-no\-restore]\ [\-o|\-\-output]\ [\-r|\-\-runtime]\ [\-v|\-\-verbosity]\ [\-\-version\-suffix] +dotnet\ build\ [\-h|\-\-help] +\f[] +.fi +.SS .NET Core 1.x +.IP +.nf +\f[C] +dotnet\ build\ []\ [\-c|\-\-configuration]\ [\-f|\-\-framework]\ [\-\-no\-dependencies]\ [\-\-no\-incremental]\ [\-o|\-\-output] +\ \ \ \ [\-r|\-\-runtime]\ [\-v|\-\-verbosity]\ [\-\-version\-suffix] +dotnet\ build\ [\-h|\-\-help] \f[] .fi -.SS OPTIONS .PP -\f[C]\-o\f[], \f[C]\-\-output\f[] [DIR] + * * * * * +.SH DESCRIPTION .PP -Directory in which to place the built binaries. +The \f[C]dotnet\ build\f[] command builds the project and its dependencies into a set of binaries. +The binaries include the project's code in Intermediate Language (IL) files with a \f[I].dll\f[] extension and symbol files used for debugging with a \f[I].pdb\f[] extension. +A dependencies JSON file (\f[I]*.deps.json\f[]) is produced that lists the dependencies of the application. +A \f[I]*.runtimeconfig.json\f[] file is produced, which specifies the shared runtime and its version for the application. .PP -\f[C]\-b\f[], \f[C]\-\-build\-base\-path\f[] [DIR] +If the project has third\-party dependencies, such as libraries from NuGet, they're resolved from the NuGet cache and aren't available with the project's built output. +With that in mind, the product of \f[C]dotnet\ build\f[] isn't ready to be transferred to another machine to run. +This is in contrast to the behavior of the .NET Framework in which building an executable project (an application) produces output that's runnable on any machine where the .NET Framework is installed. +To have a similar experience with .NET Core, you need to use the dotnet publish command. +For more information, see .NET Core Application Deployment. .PP -Directory in which to place temporary outputs. +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[]. +If you want to disable implicit restore when running the build command, you can pass the \f[C]\-\-no\-restore\f[] option. .PP -\f[C]\-f\f[], \f[C]\-\-framework\f[] [FRAMEWORK] +.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. +.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. +.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: +.IP +.nf +\f[C] + +\ \ Exe + +\f[] +.fi +.PP +In order to produce a library, omit the \f[C]\f[] property. +The main difference in built output is that the IL DLL for a library doesn't contain entry points and can't be executed. +.SS Arguments +.PP +\f[C]PROJECT\f[] +.PP +The project file to build. +If a project 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[] and uses that file. +.SH OPTIONS +.SS .NET Core 2.x +.PP +\f[C]\-c|\-\-configuration\ {Debug|Release}\f[] +.PP +Defines the build configuration. +The default value is \f[C]Debug\f[]. +.PP +\f[C]\-f|\-\-framework\ \f[] .PP Compiles for a specific framework. -The framework needs to be defined in the project.json file. +The framework must be defined in the project file. .PP -\f[C]\-c\f[], \f[C]\-\-configuration\f[] [Debug|Release] +\f[C]\-\-force\f[] .PP -Defines a configuration under which to build. -If omitted, it defaults to Debug. +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. .PP -\f[C]\-r\f[], \f[C]\-\-runtime\f[] [RUNTIME_IDENTIFIER] +\f[C]\-h|\-\-help\f[] .PP -Target runtime to build for. +Prints out a short help for the command. .PP -\-\-version\-suffix [VERSION_SUFFIX] +\f[C]\-\-no\-dependencies\f[] .PP -Defines what \f[C]*\f[] should be replaced with in the version field in -the project.json file. -The format follows NuGet\[aq]s version guidelines. -.PP -\f[C]\-\-build\-profile\f[] -.PP -Prints out the incremental safety checks that users need to address in -order for incremental compilation to be automatically turned on. +Ignores project\-to\-project (P2P) references and only builds the root project specified to build. .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 dependency graph. +This 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. +.PP +\f[C]\-o|\-\-output\ \f[] +.PP +Directory in which to place the built binaries. +You also need to define \f[C]\-\-framework\f[] when you specify this option. +.PP +\f[C]\-r|\-\-runtime\ \f[] +.PP +Specifies the target runtime. +For a list of Runtime Identifiers (RIDs), see the RID catalog. +.PP +\f[C]\-v|\-\-verbosity\ \f[] +.PP +Sets the verbosity level of the command. +Allowed values are \f[C]q[uiet]\f[], \f[C]m[inimal]\f[], \f[C]n[ormal]\f[], \f[C]d[etailed]\f[], and \f[C]diag[nostic]\f[]. +.PP +\f[C]\-\-version\-suffix\ \f[] +.PP +Defines the version suffix for an asterisk (\f[C]*\f[]) in the version field of the project file. +The format follows NuGet's version guidelines. +.SS .NET Core 1.x +.PP +\f[C]\-c|\-\-configuration\ {Debug|Release}\f[] +.PP +Defines the build configuration. +The default value is \f[C]Debug\f[]. +.PP +\f[C]\-f|\-\-framework\ \f[] +.PP +Compiles for a specific framework. +The framework must be defined in the project file. +.PP +\f[C]\-h|\-\-help\f[] +.PP +Prints out a short help for the command. .PP \f[C]\-\-no\-dependencies\f[] .PP -Ignores project\-to\-project references and only builds the root project -specified to build. +Ignores project\-to\-project (P2P) references and only builds the root project specified to build. +.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. +.PP +\f[C]\-o|\-\-output\ \f[] +.PP +Directory in which to place the built binaries. +You also need to define \f[C]\-\-framework\f[] when you specify this option. +.PP +\f[C]\-r|\-\-runtime\ \f[] +.PP +Specifies the target runtime. +For a list of Runtime Identifiers (RIDs), see the RID catalog. +.PP +\f[C]\-v|\-\-verbosity\ \f[] +.PP +Sets the verbosity level of the command. +Allowed values are \f[C]q[uiet]\f[], \f[C]m[inimal]\f[], \f[C]n[ormal]\f[], \f[C]d[etailed]\f[], and \f[C]diag[nostic]\f[]. +.PP +\f[C]\-\-version\-suffix\ \f[] +.PP +Defines the version suffix for an asterisk (\f[C]*\f[]) in the version field of the project file. +The format follows NuGet's version guidelines. +.PP + * * * * * +.SH EXAMPLES +.PP +Build a project and its dependencies: +.PP +\f[C]dotnet\ build\f[] +.PP +Build a project and its dependencies using Release configuration: +.PP +\f[C]dotnet\ build\ \-\-configuration\ Release\f[] +.PP +Build a project and its dependencies for a specific runtime (in this example, Ubuntu 16.04): +.PP +\f[C]dotnet\ build\ \-\-runtime\ ubuntu.16.04\-x64\f[] +.PP +Build the project and use the specified NuGet package source during the restore operation (.NET Core SDK 2.0 and later versions): +.PP +\f[C]dotnet\ build\ \-\-source\ c:\\packages\\mypackages\f[] .SH AUTHORS -Microsoft Corporation dotnetclifeedback\@microsoft.com. +mairaw. diff --git a/Documentation/manpages/sdk/dotnet-clean.1 b/Documentation/manpages/sdk/dotnet-clean.1 new file mode 100644 index 000000000..a95fbe7b8 --- /dev/null +++ b/Documentation/manpages/sdk/dotnet-clean.1 @@ -0,0 +1,113 @@ +.\" Automatically generated by Pandoc 2.1.3 +.\" +.TH "dotnet clean command \- .NET Core CLI" "1" "" "" ".NET Core" +.hy +.SH dotnet\-clean +.PP +.SH NAME +.PP +\f[C]dotnet\ clean\f[] \- Cleans the output of a project. +.SH SYNOPSIS +.SS .NET Core 2.x +.IP +.nf +\f[C] +dotnet\ clean\ []\ [\-c|\-\-configuration]\ [\-f|\-\-framework]\ [\-o|\-\-output]\ [\-r|\-\-runtime]\ [\-v|\-\-verbosity] +dotnet\ clean\ [\-h|\-\-help] +\f[] +.fi +.SS .NET Core 1.x +.IP +.nf +\f[C] +dotnet\ clean\ []\ [\-c|\-\-configuration]\ [\-f|\-\-framework]\ [\-o|\-\-output]\ [\-v|\-\-verbosity] +dotnet\ clean\ [\-h|\-\-help] +\f[] +.fi +.PP + * * * * * +.SH DESCRIPTION +.PP +The \f[C]dotnet\ clean\f[] command cleans the output of the previous build. +It's implemented as an MSBuild target, so the project is evaluated when the command is run. +Only the outputs created during the build are cleaned. +Both intermediate (\f[I]obj\f[]) and final output (\f[I]bin\f[]) folders are cleaned. +.SS Arguments +.PP +\f[C]PROJECT\f[] +.PP +The MSBuild project to clean. +If a project 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[] and uses that file. +.SH OPTIONS +.SS .NET Core 2.x +.PP +\f[C]\-c|\-\-configuration\ {Debug|Release}\f[] +.PP +Defines the build configuration. +The default value is \f[C]Debug\f[]. +This option is only required when cleaning if you specified it during build time. +.PP +\f[C]\-f|\-\-framework\ \f[] +.PP +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. +.PP +\f[C]\-h|\-\-help\f[] +.PP +Prints out a short help for the command. +.PP +\f[C]\-o|\-\-output\ \f[] +.PP +Directory in which the build outputs are placed. +Specify the \f[C]\-f|\-\-framework\ \f[] switch with the output directory switch if you specified the framework when the project was built. +.PP +\f[C]\-r|\-\-runtime\ \f[] +.PP +Cleans the output folder of the specified runtime. +This is used when a self\-contained deployment was created. +.PP +\f[C]\-v|\-\-verbosity\ \f[] +.PP +Sets the verbosity level of the command. +Allowed levels are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]. +.SS .NET Core 1.x +.PP +\f[C]\-c|\-\-configuration\ {Debug|Release}\f[] +.PP +Defines the build configuration. +The default value is \f[C]Debug\f[]. +This option is only required when cleaning if you specified it during build time. +.PP +\f[C]\-f|\-\-framework\ \f[] +.PP +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. +.PP +\f[C]\-h|\-\-help\f[] +.PP +Prints out a short help for the command. +.PP +\f[C]\-o|\-\-output\ \f[] +.PP +Directory in which the build outputs are placed. +Specify the \f[C]\-f|\-\-framework\ \f[] switch with the output directory switch if you specified the framework when the project was built. +.PP +\f[C]\-v|\-\-verbosity\ \f[] +.PP +Sets the verbosity level of the command. +Allowed levels are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]. +.PP + * * * * * +.SH EXAMPLES +.PP +Clean a default build of the project: +.PP +\f[C]dotnet\ clean\f[] +.PP +Clean a project built using the Release configuration: +.PP +\f[C]dotnet\ clean\ \-\-configuration\ Release\f[] +.SH AUTHORS +mairaw. diff --git a/Documentation/manpages/sdk/dotnet-help.1 b/Documentation/manpages/sdk/dotnet-help.1 new file mode 100644 index 000000000..0a1b4eb6c --- /dev/null +++ b/Documentation/manpages/sdk/dotnet-help.1 @@ -0,0 +1,33 @@ +.\" Automatically generated by Pandoc 2.1.3 +.\" +.TH "dotnet help command \- .NET Core CLI" "1" "" "" ".NET Core" +.hy +.SH dotnet help reference +.PP +.SH NAME +.PP +\f[C]dotnet\ help\f[] \- Shows more detailed documentation online for the specified command. +.SH SYNOPSIS +.PP +\f[C]dotnet\ help\ \ [\-h|\-\-help]\f[] +.SH DESCRIPTION +.PP +The \f[C]dotnet\ help\f[] command opens up the reference page for more detailed information about the specified command at docs.microsoft.com. +.SS Arguments +.PP +\f[C]COMMAND_NAME\f[] +.PP +Name of the .NET Core CLI command. +For a list of the valid CLI commands, see CLI commands. +.SH OPTIONS +.PP +\f[C]\-h|\-\-help\f[] +.PP +Prints out a short help for the command. +.SH EXAMPLES +.PP +Opens the documentation page for the dotnet new command: +.PP +\f[C]dotnet\ help\ new\f[] +.SH AUTHORS +mairaw. diff --git a/Documentation/manpages/sdk/dotnet-install-script.1 b/Documentation/manpages/sdk/dotnet-install-script.1 new file mode 100644 index 000000000..d7717db09 --- /dev/null +++ b/Documentation/manpages/sdk/dotnet-install-script.1 @@ -0,0 +1,175 @@ +.\" Automatically generated by Pandoc 2.1.3 +.\" +.TH "dotnet\-install scripts" "1" "" "" ".NET Core" +.hy +.SH dotnet\-install scripts reference +.SH NAME +.PP +\f[C]dotnet\-install.ps1\f[] | \f[C]dotnet\-install.sh\f[] \- Script used to install the .NET Core CLI tools and the shared runtime. +.SH SYNOPSIS +.PP +Windows: +.PP +\f[C]dotnet\-install.ps1\ [\-Channel]\ [\-Version]\ [\-InstallDir]\ [\-Architecture]\ [\-SharedRuntime]\ [\-DryRun]\ [\-NoPath]\ [\-AzureFeed]\ [\-ProxyAddress]\ [\-\-Verbose]\ [\-\-Help]\f[] +.PP +macOS/Linux: +.PP +\f[C]dotnet\-install.sh\ [\-\-channel]\ [\-\-version]\ [\-\-install\-dir]\ [\-\-architecture]\ [\-\-shared\-runtime]\ [\-\-dry\-run]\ [\-\-no\-path]\ [\-\-azure\-feed]\ [\-\-verbose]\ [\-\-help]\f[] +.SH DESCRIPTION +.PP +The \f[C]dotnet\-install\f[] scripts are used to perform a non\-admin installation of the .NET Core SDK, which includes the .NET Core CLI tools and the shared runtime. +.PP +We recommend that you use the stable version that is hosted on .NET Core main website. +The direct paths to the scripts are: +.IP \[bu] 2 +https://dot.net/v1/dotnet\-install.sh (bash, UNIX) +.IP \[bu] 2 +https://dot.net/v1/dotnet\-install.ps1 (Powershell, Windows) +.PP +The main usefulness of these scripts is in automation scenarios and non\-admin installations. +There are two scripts: One is a PowerShell script that works on Windows. +The other script is a bash script that works on Linux/macOS. +Both scripts have the same behavior. +The bash script also reads PowerShell switches, so you can use PowerShell switches with the script on Linux/macOS systems. +.PP +The installation scripts download the ZIP/tarball file from the CLI build drops and proceed to install it in either the default location or in a location specified by \f[C]\-InstallDir|\-\-install\-dir\f[]. +By default, the installation scripts download the SDK and install it. +If you wish to only obtain the shared runtime, specify the \f[C]\-\-shared\-runtime\f[] argument. +.PP +By default, the script adds the install location to the $PATH for the current session. +Override this default behavior by specifying the \f[C]\-\-no\-path\f[] argument. +.PP +Before running the script, install the required dependencies. +.PP +You can install a specific version using the \f[C]\-\-version\f[] argument. +The version must be specified as a 3\-part version (for example, 1.0.0\-13232). +If omitted, it uses the \f[C]latest\f[] version. +.SH OPTIONS +.PP +\f[C]\-Channel\ \f[] +.PP +Specifies the source channel for the installation. +The possible values are: +.IP \[bu] 2 +\f[C]Current\f[] \- Current release +.IP \[bu] 2 +\f[C]LTS\f[] \- Long\-Term Support channel (current supported release) +.IP \[bu] 2 +Two\-part version in X.Y format representing a specific release (for example, \f[C]2.0\f[] or \f[C]1.0\f[]) +.IP \[bu] 2 +Branch name [for example, \f[C]release/2.0.0\f[], \f[C]release/2.0.0\-preview2\f[], or \f[C]master\f[] for the latest from the \f[C]master\f[] branch (\[lq]bleeding edge\[rq] nightly releases)] +.PP +The default value is \f[C]LTS\f[]. +For more information on .NET support channels, see the .NET Core Support Lifecycle topic. +.PP +\f[C]\-Version\ \f[] +.PP +Represents a specific build version. +The possible values are: +.IP \[bu] 2 +\f[C]latest\f[] \- Latest build on the channel (used with the \f[C]\-Channel\f[] option) +.IP \[bu] 2 +\f[C]coherent\f[] \- Latest coherent build on the channel; uses the latest stable package combination (used with Branch name \f[C]\-Channel\f[] options) +.IP \[bu] 2 +Three\-part version in X.Y.Z format representing a specific build version; supersedes the \f[C]\-Channel\f[] option. +For example: \f[C]2.0.0\-preview2\-006120\f[] +.PP +If omitted, \f[C]\-Version\f[] defaults to \f[C]latest\f[]. +.PP +\f[C]\-InstallDir\ \f[] +.PP +Specifies the installation path. +The directory is created if it doesn't exist. +The default value is \f[I]%LocalAppData%.dotnet\f[]. +Note that binaries are placed directly in the directory. +.PP +\f[C]\-Architecture\ \f[] +.PP +Architecture of the .NET Core binaries to install. +Possible values are \f[C]auto\f[], \f[C]x64\f[], and \f[C]x86\f[]. +The default value is \f[C]auto\f[], which represents the currently running OS architecture. +.PP +\f[C]\-SharedRuntime\f[] +.PP +If set, this switch limits installation to the shared runtime. +The entire SDK isn't installed. +.PP +\f[C]\-DryRun\f[] +.PP +If set, the script won't perform the installation; but instead, it displays what command line to use to consistently install the currently requested version of the .NET Core CLI. +For example if you specify version \f[C]latest\f[], it displays a link with the specific version so that this command can be used deterministically in a build script. +It also displays the binary's location if you prefer to install or download it yourself. +.PP +\f[C]\-NoPath\f[] +.PP +If set, the prefix/installdir are not exported to the path for the current session. +By default, the script will modify the PATH, which makes the CLI tools available immediately after install. +.PP +\f[C]\-AzureFeed\f[] +.PP +Specifies the URL for the Azure feed to the installer. +It isn't recommended that you change this value. +The default is \f[C]https://dotnetcli.azureedge.net/dotnet\f[]. +.PP +\f[C]\-ProxyAddress\f[] +.PP +If set, the installer uses the proxy when making web requests. +(Only valid for Windows) +.PP +\f[C]\-\-verbose\f[] +.PP +Display diagnostics information. +.PP +\f[C]\-\-help\f[] +.PP +Prints out help for the script. +.SH EXAMPLES +.PP +Install the latest long\-term supported (LTS) version to the default location: +.PP +Windows: +.PP +\f[C]\&./dotnet\-install.ps1\ \-Channel\ LTS\f[] +.PP +macOS/Linux: +.PP +\f[C]\&./dotnet\-install.sh\ \-\-channel\ LTS\f[] +.PP +Install the latest version from 2.0 channel to the specified location: +.PP +Windows: +.PP +\f[C]\&./dotnet\-install.ps1\ \-Channel\ 2.0\ \-InstallDir\ C:\\cli\f[] +.PP +macOS/Linux: +.PP +\f[C]\&./dotnet\-install.sh\ \-\-channel\ 2.0\ \-\-install\-dir\ ~/cli\f[] +.PP +Install the 1.1.0 version of the shared runtime: +.PP +Windows: +.PP +\f[C]\&./dotnet\-install.ps1\ \-SharedRuntime\ \-Version\ 1.1.0\f[] +.PP +macOS/Linux: +.PP +\f[C]\&./dotnet\-install.sh\ \-\-shared\-runtime\ \-\-version\ 1.1.0\f[] +.PP +Obtain script and install .NET Core CLI one\-liner examples: +.PP +Windows: +.PP +\f[C]\@powershell\ \-NoProfile\ \-ExecutionPolicy\ unrestricted\ \-Command\ "&([scriptblock]::Create((Invoke\-WebRequest\ \-useb\ \[aq]https://dot.net/v1/dotnet\-install.ps1\[aq])))\ "\f[] +.PP +macOS/Linux: +.PP +\f[C]curl\ \-sSL\ https://dot.net/v1/dotnet\-install.sh\ |\ bash\ /dev/stdin\ \f[] +.SS See also +.PP +\&.NET Core releases +.PD 0 +.P +.PD +\&.NET Core Runtime and SDK download archive +.SH AUTHORS +blackdwarf. diff --git a/Documentation/manpages/sdk/dotnet-list-reference.1 b/Documentation/manpages/sdk/dotnet-list-reference.1 new file mode 100644 index 000000000..0d961002a --- /dev/null +++ b/Documentation/manpages/sdk/dotnet-list-reference.1 @@ -0,0 +1,37 @@ +.\" Automatically generated by Pandoc 2.1.3 +.\" +.TH "dotnet list reference command \- .NET Core CLI" "1" "" "" ".NET Core" +.hy +.SH dotnet list reference +.PP +.SH NAME +.PP +\f[C]dotnet\ list\ reference\f[] \- Lists project to project references. +.SH SYNOPSIS +.PP +\f[C]dotnet\ list\ []\ reference\ [\-h|\-\-help]\f[] +.SH DESCRIPTION +.PP +The \f[C]dotnet\ list\ reference\f[] command provides a convenient option to list project references for a given project. +.SS Arguments +.PP +\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. +.SH OPTIONS +.PP +\f[C]\-h|\-\-help\f[] +.PP +Prints out a short help for the command. +.SH EXAMPLES +.PP +List the project references for the specified project: +.PP +\f[C]dotnet\ list\ app/app.csproj\ reference\f[] +.PP +List the project references for the project in the current directory: +.PP +\f[C]dotnet\ list\ reference\f[] +.SH AUTHORS +mairaw. diff --git a/Documentation/manpages/sdk/dotnet-migrate.1 b/Documentation/manpages/sdk/dotnet-migrate.1 new file mode 100644 index 000000000..dd5de60b1 --- /dev/null +++ b/Documentation/manpages/sdk/dotnet-migrate.1 @@ -0,0 +1,106 @@ +.\" Automatically generated by Pandoc 2.1.3 +.\" +.TH "dotnet migrate command \- .NET Core CLI" "1" "" "" ".NET Core" +.hy +.SH dotnet migrate +.PP +.SH NAME +.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[] +.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. +.PP +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: +.IP \[bu] 2 +A single project by specifying the \f[I]project.json\f[] file to migrate. +.IP \[bu] 2 +All of the directories specified in the \f[I]global.json\f[] file by passing in a path to the \f[I]global.json\f[] file. +.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. +.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. +.PP +By default, the migration operation outputs the state of the migration process to standard output (STDOUT). +If you use the \f[C]\-\-report\-file\ \f[] option, the output is saved to the file specify. +.PP +The \f[C]dotnet\ migrate\f[] command only supports valid Preview 2 \f[I]project.json\f[]\-based projects. +This means that you cannot use it to migrate DNX or Preview 1 \f[I]project.json\f[]\-based projects directly to MSBuild/csproj projects. +You first need to manually migrate the project to a Preview 2 \f[I]project.json\f[]\-based project and then use the \f[C]dotnet\ migrate\f[] command to migrate the project. +.SS Arguments +.PP +\f[C]PROJECT_JSON/GLOBAL_JSON/SOLUTION_FILE/PROJECT_DIR\f[] +.PP +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[]. +.IP \[bu] 2 +a \f[I]solution.sln\f[] file, it will migrate the projects referenced in the solution. +.IP \[bu] 2 +a directory to migrate, it will recursively search for \f[I]project.json\f[] files to migrate. +.PP +Defaults to current directory if nothing is specified. +.SH OPTIONS +.PP +\f[C]\-h|\-\-help\f[] +.PP +Prints out a short help for the command. +.PP +\f[C]\-t|\-\-template\-file\ \f[] +.PP +Template csproj file to use for migration. +By default, the same template as the one dropped by \f[C]dotnet\ new\ console\f[] is used. +.PP +\f[C]\-v|\-\-sdk\-package\-version\ \f[] +.PP +The version of the sdk package that's referenced in the migrated app. +The default is the version of the SDK in \f[C]dotnet\ new\f[]. +.PP +\f[C]\-x|\-\-xproj\-file\ \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: +.PP +\f[C]dotnet\ migrate\f[] +.PP +Migrate all projects that \f[I]global.json\f[] file includes: +.PP +\f[C]dotnet\ migrate\ path/to/global.json\f[] +.PP +Migrate only the current project and no project\-to\-project (P2P) dependencies. +Also, use a specific SDK version: +.PP +\f[C]dotnet\ migrate\ \-s\ \-v\ 1.0.0\-preview4\f[] +.SH AUTHORS +mairaw. diff --git a/Documentation/manpages/sdk/dotnet-msbuild.1 b/Documentation/manpages/sdk/dotnet-msbuild.1 new file mode 100644 index 000000000..7e86576a4 --- /dev/null +++ b/Documentation/manpages/sdk/dotnet-msbuild.1 @@ -0,0 +1,38 @@ +.\" Automatically generated by Pandoc 2.1.3 +.\" +.TH "dotnet msbuild command \- .NET Core CLI" "1" "" "" ".NET Core" +.hy +.SH dotnet msbuild +.PP +.SH NAME +.PP +\f[C]dotnet\ msbuild\f[] \- Builds a project and all of its dependencies. +.SH SYNOPSIS +.PP +\f[C]dotnet\ msbuild\ \ [\-h]\f[] +.SH DESCRIPTION +.PP +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. +.SH EXAMPLES +.PP +Build a project and its dependencies: +.PP +\f[C]dotnet\ msbuild\f[] +.PP +Build a project and its dependencies using Release configuration: +.PP +\f[C]dotnet\ msbuild\ /p:Configuration=Release\f[] +.PP +Run the publish target and publish for the \f[C]osx.10.11\-x64\f[] RID: +.PP +\f[C]dotnet\ msbuild\ /t:Publish\ /p:RuntimeIdentifiers=osx.10.11\-x64\f[] +.PP +See the whole project with all targets included by the SDK: +.PP +\f[C]dotnet\ msbuild\ /pp\f[] +.SH AUTHORS +mairaw. diff --git a/Documentation/manpages/sdk/dotnet-new.1 b/Documentation/manpages/sdk/dotnet-new.1 index 5dfdbd490..29b8af05f 100644 --- a/Documentation/manpages/sdk/dotnet-new.1 +++ b/Documentation/manpages/sdk/dotnet-new.1 @@ -1,81 +1,588 @@ -.\" Automatically generated by Pandoc 1.15.1 +.\"t +.\" Automatically generated by Pandoc 2.1.3 .\" +.TH "dotnet new command \- .NET Core CLI" "1" "" "" ".NET Core" .hy -.TH "DOTNET\-NEW" "1" "June 2016" "" "" -.SS NAME +.SH dotnet new .PP -dotnet\-new \-\- Create a new sample .NET Core project -.SS SYNOPSIS +.SH NAME .PP -dotnet new [\-\-type] [\-\-lang] -.SS DESCRIPTION +\f[C]dotnet\ new\f[] \- Creates a new project, configuration file, or solution based on the specified template. +.SH SYNOPSIS +.SS .NET Core 2.0 +.IP +.nf +\f[C] +dotnet\ new\