mirrors/dotnet-installer
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
dotnet-installer/src/dotnet/README.md

87 lines
2.6 KiB
Markdown
Raw Normal View History

Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
% DOTNET(1)
Add and modify commands' README files (#2338) * Add and modify commands' README files Update those READMEs that are outdated. Add READMEs for dotnet pack and dotnet restore as well. * Removing private info, adding feedback alias
2016-04-15 17:36:31 +00:00
% Microsoft Corporation dotnetclifeedback@microsoft.com
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.
2016-06-14 13:42:21 +00:00
% June 2016
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
## NAME
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
dotnet -- General driver for running the command-line commands
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
## SYNOPSIS
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
`dotnet [--version] [--help] [--verbose] [--info] <command> [<args>]`
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
## DESCRIPTION
`dotnet` is a generic driver for the Command Line Interface (CLI) toolchain. Invoked on its own, it will give out brief usage instructions.
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
Each specific feature is implemented as a command. In order to use the feature, the command is specified after `dotnet`, such as [`dotnet build`](dotnet-build.md). All of the arguments following the command are its own arguments.
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
The only time `dotnet` is used as a command on its own is to run portable apps. Just specify a portable application DLL after the `dotnet` verb to execute the application.
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
## OPTIONS
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
`-v, --verbose`
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
Enables verbose output.
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
`--version`
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
Prints out the version of the CLI tooling.
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
Changing --version in the CLI `dotnet --version` returns just the version number. This helps tools get this information without having to parse the full info. Introduce a new argument `--info` that returns the current "long form". With this, we also change the long form to say "RID" instead of "Runtime ID" simply because that would avoid any future localization issues and thus make the parsing easier. Fix #1607 #1882
2016-03-24 20:36:58 +00:00
`--info`
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.
2016-06-14 13:42:21 +00:00
Prints out more detailed information about the CLI tooling, such as the current operating system, commit SHA for the version, etc.
Changing --version in the CLI `dotnet --version` returns just the version number. This helps tools get this information without having to parse the full info. Introduce a new argument `--info` that returns the current "long form". With this, we also change the long form to say "RID" instead of "Runtime ID" simply because that would avoid any future localization issues and thus make the parsing easier. Fix #1607 #1882
2016-03-24 20:36:58 +00:00
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
`-h, --help`
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.
2016-06-14 13:42:21 +00:00
Prints out a short help and a list of current commands.
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
## DOTNET COMMANDS
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
The following commands exist for dotnet:
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
* [dotnet-new](dotnet-new.md)
* Initializes a C# or F# console application project.
* [dotnet-restore](dotnet-restore.md)
* Restores the dependencies for a given application.
* [dotnet-build](dotnet-build.md)
* Builds a .NET Core application.
* [dotnet-publish](dotnet-publish.md)
* Publishes a .NET portable or self-contained application.
* [dotnet-run](dotnet-run.md)
* Runs the application from source.
* [dotnet-test](dotnet-test.md)
* Runs tests using a test runner specified in the project.json.
* [dotnet-pack](dotnet-pack.md)
* Creates a NuGet package of your code.
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
## EXAMPLES
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
Fix a couple of typos in the .md/doc files
2016-03-18 04:27:33 +00:00
`dotnet new`
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
Initializes a sample .NET Core console application that can be compiled and run.
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
`dotnet restore`
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.
2016-06-14 13:42:21 +00:00
Restores dependencies for a given application.
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
`dotnet compile`
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.
2016-06-14 13:42:21 +00:00
Compiles the application in a given directory.
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
`dotnet myapp.dll`
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
Runs a portable app named `myapp.dll`.
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
## ENVIRONMENT
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
`DOTNET_PACKAGES`
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
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.
2016-06-14 13:42:21 +00:00
The primary package cache. If not set, it defaults to $HOME/.nuget/packages on Unix or %HOME%\NuGet\Packages on Windows.
Fix README.md files to be like man pages Change the SYNOPSIS section. Add ENVIRONMENT section where needed. Change the driver's man page to include all of the current commands. The MD files now conform to the man pages outline. The manpages are updated as well. Fix #673
2016-01-05 02:25:15 +00:00
`DOTNET_SERVICING`
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.
2016-06-14 13:42:21 +00:00
Specifies the location of the servicing index to use by the shared host when loading the runtime.
`DOTNET_CLI_TELEMETRY_OPTOUT`
Add MD files per command and documentation directory Add README.md files with the contents of the "man pages" per directory that implements all or part of the command. This way, we will enable easier perusal of our repo as well as have an initial set of documentation published. Add "documentation" directory as well for future work.
2015-11-16 14:37:00 +00:00
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.
2016-06-14 13:42:21 +00:00
Specifies whether data about the .NET Core tools usage is collected and sent to Microsoft. **true** to opt-out of the telemetry feature (values true, 1 or yes accepted); otherwise, **false** (values false, 0 or no accepted). If not set, it defaults to **false**, that is, the telemetry feature is on.
Reference in a new issue Copy permalink