Update documentation (#3549)
* Updating README.md files as well as man pages This aligns with the latest changes in the official documentation. It also aligns dotnet test readme.md to official docs and introduces a new doc in the "Documentation" directory that deals with dotnet test protocols.
This commit is contained in:
parent
18c8a2724a
commit
4da4f95e21
16 changed files with 971 additions and 404 deletions
97
Documentation/manpages/sdk/dotnet-restore.1
Normal file
97
Documentation/manpages/sdk/dotnet-restore.1
Normal file
|
@ -0,0 +1,97 @@
|
|||
.\" Automatically generated by Pandoc 1.15.1
|
||||
.\"
|
||||
.hy
|
||||
.TH "DOTNET\-RESTORE" "1" "June 2016" "" ""
|
||||
.SS NAME
|
||||
.PP
|
||||
\f[C]dotnet\-restore\f[] \- Restores the dependencies and tools of a
|
||||
project
|
||||
.SS SYNOPSIS
|
||||
.PP
|
||||
\f[C]dotnet\ restore\ [\-\-source]\ \ \ \ \ \ \ [\-\-packages]\ [\-\-disable\-parallel]\ \ \ \ \ \ \ [\-\-fallbacksource]\ [\-\-configfile]\ [\-\-verbosity]\ \ \ \ \ [<root>]\f[]
|
||||
.SS DESCRIPTION
|
||||
.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.
|
||||
.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.
|
||||
.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
|
||||
.PP
|
||||
\f[C][root]\f[]
|
||||
.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.
|
||||
.PP
|
||||
\f[C]\-s\f[], \f[C]\-\-source\f[] [SOURCE]
|
||||
.PP
|
||||
Specifies a source to use during the restore operation.
|
||||
This overrides all of the sources specified in the NuGet.config file(s).
|
||||
.PP
|
||||
\f[C]\-\-packages\f[] [DIR]
|
||||
.PP
|
||||
Specifies the directory to place the restored packages in.
|
||||
.PP
|
||||
\f[C]\-\-disable\-parallel\f[]
|
||||
.PP
|
||||
Disables restoring multiple projects in parallel.
|
||||
.PP
|
||||
\f[C]\-f\f[], \f[C]\-\-fallbacksource\f[] [FEED]
|
||||
.PP
|
||||
Specifies a fallback source that will be used in the restore operation
|
||||
if all other sources fail.
|
||||
All valid feed formats are allowed.
|
||||
.PP
|
||||
\f[C]\-\-configfile\f[] [FILE]
|
||||
.PP
|
||||
Configuration file (NuGet.config) to use for the restore operation.
|
||||
.PP
|
||||
\f[C]\-\-verbosity\f[] [LEVEL]
|
||||
.PP
|
||||
The verbosity of logging to use.
|
||||
Allowed values: Debug, Verbose, Information, Minimal, Warning, or Error.
|
||||
.SS EXAMPLES
|
||||
.PP
|
||||
\f[C]dotnet\ restore\f[]
|
||||
.PP
|
||||
Restores dependencies and tools for the project in the current
|
||||
directory.
|
||||
.PP
|
||||
\f[C]dotnet\ restore\ ~/projects/app1/project.json\f[]
|
||||
.PP
|
||||
Restores dependencies and tools for the \f[C]app1\f[] project found in
|
||||
the given path.
|
||||
.PP
|
||||
\f[C]dotnet\ restore\ \-\-f\ 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.
|
||||
.PP
|
||||
\f[C]dotnet\ restore\ \-\-verbosity\ Error\f[]
|
||||
.PP
|
||||
Restores dependencies and tools for the project in the current directory
|
||||
and shows only errors in the output.
|
||||
.SH AUTHORS
|
||||
Microsoft Corporation dotnetclifeedback\@microsoft.com.
|
Loading…
Add table
Add a link
Reference in a new issue