Update dotnet manpages for Unix
This commit is contained in:
kasper
parent
2e9c0b7b06
commit
b828418021
24 changed files with 3294 additions and 537 deletions
|
|
@ -1,97 +1,198 @@
|
|||
.\" Automatically generated by Pandoc 1.15.1
|
||||
.\" Automatically generated by Pandoc 2.1.3
|
||||
.\"
|
||||
.TH "dotnet restore command \- .NET Core CLI" "1" "" "" ".NET Core"
|
||||
.hy
|
||||
.TH "DOTNET\-RESTORE" "1" "June 2016" "" ""
|
||||
.SS NAME
|
||||
.SH dotnet restore
|
||||
.PP
|
||||
\f[C]dotnet\-restore\f[] \- Restores the dependencies and tools of a
|
||||
project
|
||||
.SS SYNOPSIS
|
||||
.SH NAME
|
||||
.PP
|
||||
\f[C]dotnet\ restore\ [\-\-source]\ \ \ \ \ \ \ [\-\-packages]\ [\-\-disable\-parallel]\ \ \ \ \ \ \ [\-\-fallbacksource]\ [\-\-configfile]\ [\-\-verbosity]\ \ \ \ \ [<root>]\f[]
|
||||
.SS DESCRIPTION
|
||||
\f[C]dotnet\ restore\f[] \- Restores the dependencies and tools of a project.
|
||||
.SH SYNOPSIS
|
||||
.SS .NET Core 2.x
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
dotnet\ restore\ [<ROOT>]\ [\-\-configfile]\ [\-\-disable\-parallel]\ [\-\-force]\ [\-\-ignore\-failed\-sources]\ [\-\-no\-cache]\ [\-\-no\-dependencies]\ [\-\-packages]\ [\-r|\-\-runtime]\ [\-s|\-\-source]\ [\-v|\-\-verbosity]
|
||||
dotnet\ restore\ [\-h|\-\-help]
|
||||
\f[]
|
||||
.fi
|
||||
.SS .NET Core 1.x
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
dotnet\ restore\ [<ROOT>]\ [\-\-configfile]\ [\-\-disable\-parallel]\ [\-\-ignore\-failed\-sources]\ [\-\-no\-cache]\ [\-\-no\-dependencies]\ [\-\-packages]\ [\-r|\-\-runtime]\ [\-s|\-\-source]\ [\-v|\-\-verbosity]
|
||||
dotnet\ restore\ [\-h|\-\-help]
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
The \f[C]dotnet\ restore\f[] command uses NuGet to restore dependencies
|
||||
as well as project\-specific tools that are specified in the
|
||||
project.json file.
|
||||
By default, the restoration of dependencies and tools are done in
|
||||
parallel.
|
||||
* * * * *
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
In order to restore the dependencies, NuGet needs the feeds where the
|
||||
packages are located.
|
||||
Feeds are usually provided via the NuGet.config configuration file; a
|
||||
default one is present when the CLI tools are installed.
|
||||
You can specify more feeds by creating your own NuGet.config file in the
|
||||
project directory.
|
||||
Feeds can also be specified per invocation on the command line.
|
||||
The \f[C]dotnet\ restore\f[] command uses NuGet to restore dependencies as well as project\-specific tools that are specified in the project file.
|
||||
By default, the restoration of dependencies and tools are performed in parallel.
|
||||
.PP
|
||||
For dependencies, you can specify where the restored packages are placed
|
||||
during the restore operation using the \f[C]\-\-packages\f[] argument.
|
||||
If not specified, the default NuGet package cache is used.
|
||||
It is found in the \f[C]\&.nuget/packages\f[] directory in the
|
||||
user\[aq]s home directory on all operating systems (for example,
|
||||
\f[C]/home/user1\f[] on Linux or \f[C]C:\\Users\\user1\f[] on Windows).
|
||||
.PP
|
||||
For project\-specific tooling, \f[C]dotnet\ restore\f[] first restores
|
||||
the package in which the tool is packed, and then proceeds to restore
|
||||
the tool\[aq]s dependencies as specified in its project.json.
|
||||
.SS OPTIONS
|
||||
In order to restore the dependencies, NuGet needs the feeds where the packages are located.
|
||||
Feeds are usually provided via the \f[I]NuGet.config\f[] configuration file.
|
||||
A default configuration file is provided when the CLI tools are installed.
|
||||
You specify additional feeds by creating your own \f[I]NuGet.config\f[] file in the project directory.
|
||||
You also specify additional feeds per invocation at a command prompt.
|
||||
.PP
|
||||
\f[C][root]\f[]
|
||||
For dependencies, you specify where the restored packages are placed during the restore operation using the \f[C]\-\-packages\f[] argument.
|
||||
If not specified, the default NuGet package cache is used, which is found in the \f[C]\&.nuget/packages\f[] directory in the user's home directory on all operating systems (for example, \f[I]/home/user1\f[] on Linux or \f[I]C:1\f[] on Windows).
|
||||
.PP
|
||||
A list of projects or project folders to restore.
|
||||
The list can contain either a path to a \f[C]project.json\f[] file, or a
|
||||
path to \f[C]global.json\f[] file or folder.
|
||||
The restore operation runs recursively for all subdirectories and
|
||||
restores for each given project.json file it finds.
|
||||
For project\-specific tooling, \f[C]dotnet\ restore\f[] first restores the package in which the tool is packed, and then proceeds to restore the tool's dependencies as specified in its project file.
|
||||
.PP
|
||||
\f[C]\-s\f[], \f[C]\-\-source\f[] [SOURCE]
|
||||
The behavior of the \f[C]dotnet\ restore\f[] command is affected by some of the settings in the \f[I]Nuget.Config\f[] file, if present.
|
||||
For example, setting the \f[C]globalPackagesFolder\f[] in \f[I]NuGet.Config\f[] places the restored NuGet packages in the specified folder.
|
||||
This is an alternative to specifying the \f[C]\-\-packages\f[] option on the \f[C]dotnet\ restore\f[] command.
|
||||
For more information, see the NuGet.Config reference.
|
||||
.SS Implicit \f[C]dotnet\ restore\f[]
|
||||
.PP
|
||||
Specifies a source to use during the restore operation.
|
||||
This overrides all of the sources specified in the NuGet.config file(s).
|
||||
Starting with .NET Core 2.0, \f[C]dotnet\ restore\f[] is run implicitly if necessary when you issue the following commands:
|
||||
.IP \[bu] 2
|
||||
\f[C]dotnet\ new\f[]
|
||||
.IP \[bu] 2
|
||||
\f[C]dotnet\ build\f[]
|
||||
.IP \[bu] 2
|
||||
\f[C]dotnet\ run\f[]
|
||||
.IP \[bu] 2
|
||||
\f[C]dotnet\ test\f[]
|
||||
.IP \[bu] 2
|
||||
\f[C]dotnet\ publish\f[]
|
||||
.IP \[bu] 2
|
||||
\f[C]dotnet\ pack\f[]
|
||||
.PP
|
||||
\f[C]\-\-packages\f[] [DIR]
|
||||
In most cases, you no longer need to explicitly use the \f[C]dotnet\ restore\f[] command.
|
||||
.PP
|
||||
Specifies the directory to place the restored packages in.
|
||||
In some cases, it is inconvenient for \f[C]dotnet\ restore\f[] to run implicitly.
|
||||
For example, some automated systems, such as build systems, need to call \f[C]dotnet\ restore\f[] explicitly to control when the restore occurs so that they can control network usage.
|
||||
To prevent \f[C]dotnet\ restore\f[] from running implicitly, you can use the \f[C]\-\-no\-restore\f[] switch with any of these commands to disable implicit restore.
|
||||
.SS Arguments
|
||||
.PP
|
||||
\f[C]ROOT\f[]
|
||||
.PP
|
||||
Optional path to the project file to restore.
|
||||
.SH OPTIONS
|
||||
.SS .NET Core 2.x
|
||||
.PP
|
||||
\f[C]\-\-configfile\ <FILE>\f[]
|
||||
.PP
|
||||
The NuGet configuration file (\f[I]NuGet.config\f[]) to use for the restore operation.
|
||||
.PP
|
||||
\f[C]\-\-disable\-parallel\f[]
|
||||
.PP
|
||||
Disables restoring multiple projects in parallel.
|
||||
.PP
|
||||
\f[C]\-f\f[], \f[C]\-\-fallbacksource\f[] [FEED]
|
||||
\f[C]\-\-force\f[]
|
||||
.PP
|
||||
Specifies a fallback source that will be used in the restore operation
|
||||
if all other sources fail.
|
||||
All valid feed formats are allowed.
|
||||
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]\-\-configfile\f[] [FILE]
|
||||
\f[C]\-h|\-\-help\f[]
|
||||
.PP
|
||||
Configuration file (NuGet.config) to use for the restore operation.
|
||||
Prints out a short help for the command.
|
||||
.PP
|
||||
\f[C]\-\-verbosity\f[] [LEVEL]
|
||||
\f[C]\-\-ignore\-failed\-sources\f[]
|
||||
.PP
|
||||
The verbosity of logging to use.
|
||||
Allowed values: Debug, Verbose, Information, Minimal, Warning, or Error.
|
||||
.SS EXAMPLES
|
||||
Only warn about failed sources if there are packages meeting the version requirement.
|
||||
.PP
|
||||
\f[C]\-\-no\-cache\f[]
|
||||
.PP
|
||||
Specifies to not cache packages and HTTP requests.
|
||||
.PP
|
||||
\f[C]\-\-no\-dependencies\f[]
|
||||
.PP
|
||||
When restoring a project with project\-to\-project (P2P) references, restores the root project and not the references.
|
||||
.PP
|
||||
\f[C]\-\-packages\ <PACKAGES_DIRECTORY>\f[]
|
||||
.PP
|
||||
Specifies the directory for restored packages.
|
||||
.PP
|
||||
\f[C]\-r|\-\-runtime\ <RUNTIME_IDENTIFIER>\f[]
|
||||
.PP
|
||||
Specifies a runtime for the package restore.
|
||||
This is used to restore packages for runtimes not explicitly listed in the \f[C]<RuntimeIdentifiers>\f[] tag in the \f[I].csproj\f[] file.
|
||||
For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
||||
Provide multiple RIDs by specifying this option multiple times.
|
||||
.PP
|
||||
\f[C]\-s|\-\-source\ <SOURCE>\f[]
|
||||
.PP
|
||||
Specifies a NuGet package source to use during the restore operation.
|
||||
This overrides all of the sources specified in the \f[I]NuGet.config\f[] files.
|
||||
Multiple sources can be provided by specifying this option multiple times.
|
||||
.PP
|
||||
\f[C]\-\-verbosity\ <LEVEL>\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[].
|
||||
.SS .NET Core 1.x
|
||||
.PP
|
||||
\f[C]\-\-configfile\ <FILE>\f[]
|
||||
.PP
|
||||
The NuGet configuration file (\f[I]NuGet.config\f[]) to use for the restore operation.
|
||||
.PP
|
||||
\f[C]\-\-disable\-parallel\f[]
|
||||
.PP
|
||||
Disables restoring multiple projects in parallel.
|
||||
.PP
|
||||
\f[C]\-h|\-\-help\f[]
|
||||
.PP
|
||||
Prints out a short help for the command.
|
||||
.PP
|
||||
\f[C]\-\-ignore\-failed\-sources\f[]
|
||||
.PP
|
||||
Only warn about failed sources if there are packages meeting the version requirement.
|
||||
.PP
|
||||
\f[C]\-\-no\-cache\f[]
|
||||
.PP
|
||||
Specifies to not cache packages and HTTP requests.
|
||||
.PP
|
||||
\f[C]\-\-no\-dependencies\f[]
|
||||
.PP
|
||||
When restoring a project with project\-to\-project (P2P) references, restores the root project and not the references.
|
||||
.PP
|
||||
\f[C]\-\-packages\ <PACKAGES_DIRECTORY>\f[]
|
||||
.PP
|
||||
Specifies the directory for restored packages.
|
||||
.PP
|
||||
\f[C]\-r|\-\-runtime\ <RUNTIME_IDENTIFIER>\f[]
|
||||
.PP
|
||||
Specifies a runtime for the package restore.
|
||||
This is used to restore packages for runtimes not explicitly listed in the \f[C]<RuntimeIdentifiers>\f[] tag in the \f[I].csproj\f[] file.
|
||||
For a list of Runtime Identifiers (RIDs), see the RID catalog.
|
||||
Provide multiple RIDs by specifying this option multiple times.
|
||||
.PP
|
||||
\f[C]\-s|\-\-source\ <SOURCE>\f[]
|
||||
.PP
|
||||
Specifies a NuGet package source to use during the restore operation.
|
||||
This overrides all of the sources specified in the \f[I]NuGet.config\f[] files.
|
||||
Multiple sources can be provided by specifying this option multiple times.
|
||||
.PP
|
||||
\f[C]\-\-verbosity\ <LEVEL>\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[].
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Restore dependencies and tools for the project in the current directory:
|
||||
.PP
|
||||
\f[C]dotnet\ restore\f[]
|
||||
.PP
|
||||
Restores dependencies and tools for the project in the current
|
||||
directory.
|
||||
Restore dependencies and tools for the \f[C]app1\f[] project found in the given path:
|
||||
.PP
|
||||
\f[C]dotnet\ restore\ ~/projects/app1/project.json\f[]
|
||||
\f[C]dotnet\ restore\ ~/projects/app1/app1.csproj\f[]
|
||||
.PP
|
||||
Restores dependencies and tools for the \f[C]app1\f[] project found in
|
||||
the given path.
|
||||
Restore the dependencies and tools for the project in the current directory using the file path provided as the source:
|
||||
.PP
|
||||
\f[C]dotnet\ restore\ \-\-f\ c:\\packages\\mypackages\f[]
|
||||
\f[C]dotnet\ restore\ \-s\ c:\\packages\\mypackages\f[]
|
||||
.PP
|
||||
Restores the dependencies and tools for the project in the current
|
||||
directory using the file path provided as the fallback source.
|
||||
Restore the dependencies and tools for the project in the current directory using the two file paths provided as sources:
|
||||
.PP
|
||||
\f[C]dotnet\ restore\ \-\-verbosity\ Error\f[]
|
||||
\f[C]dotnet\ restore\ \-s\ c:\\packages\\mypackages\ \-s\ c:\\packages\\myotherpackages\f[]
|
||||
.PP
|
||||
Restores dependencies and tools for the project in the current directory
|
||||
and shows only errors in the output.
|
||||
Restore dependencies and tools for the project in the current directory and shows only minimal output:
|
||||
.PP
|
||||
\f[C]dotnet\ restore\ \-\-verbosity\ minimal\f[]
|
||||
.SH AUTHORS
|
||||
Microsoft Corporation dotnetclifeedback\@microsoft.com.
|
||||
mairaw.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue