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

94 lines
2.2 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
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
% January 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
Add manual pages for current commands Convert the existing README.md from command directories into man pages. This was done using pandoc. Some commands still don't have READMEs so they are not present here. Fix #3
2015-12-29 19:06:10 +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
dotnet -- general driver for running the command-line commands
Add manual pages for current commands Convert the existing README.md from command directories into man pages. This was done using pandoc. Some commands still don't have READMEs so they are not present here. Fix #3
2015-12-29 19:06:10 +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
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
dotnet [--version] [--info] [--help] [--verbose] < 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
Add manual pages for current commands Convert the existing README.md from command directories into man pages. This was done using pandoc. Some commands still don't have READMEs so they are not present here. Fix #3
2015-12-29 19:06:10 +00:00
# DESCRIPTION
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
dotnet is a generic driver for the CLI toolchain. Invoked on its own, it will give out brief usage instructions.
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
Each specific feature is implemented as a command. In order to use the feature, it is specified after dotnet, i.e. `dotnet compile`. All of the arguments following the command are command's 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
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
# OPTIONS
`-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
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
Enable 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
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
Print out the version of the CLI tooling
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`
Print out information about 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
`-h, --help`
Print out a short help and a list of current commands.
# DOTNET COMMANDS
The following commands exist for dotnet.
`dotnet-compile(1)`
Fix a couple of typos in the .md/doc files
2016-03-18 04:27:33 +00:00
Compile the application to either an intermediate language (IL) or to a native binary.
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(1)`
Restores the dependencies for a given application.
`dotnet-run(1)`
Runs the application from source.
`dotnet-publish(1)`
Publishes a flat directory that contains the application and its dependencies, including the runtime binaries.
`dotnet-test(1)`
Runs tests using a test runner specified in project.json.
`dotnet-new(1)`
Initializes a sample .NET Core console application.
# EXAMPLES
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
Initializes a sample .NET Core console application that can be compiled and ran.
`dotnet restore`
Restores dependencies for a given application.
`dotnet compile`
Compiles the application in a given directory.
# ENVIRONMENT
`DOTNET_PACKAGES`
The primary package cache. If not set, defaults to $HOME/.nuget/packages on Unix or %LOCALAPPDATA%\NuGet\Packages (TBD) on Windows.
`DOTNET_PACKAGES_CACHE`
The secondary cache. This is used by shared hosters (such as Azure) to provide a cache of pre-downloaded common packages on a faster disk. If not set it is not used.
`DOTNET_SERVICING`
Specifies the location of the servicing index to use by the shared host when loading the runtime.
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
Add manual pages for current commands Convert the existing README.md from command directories into man pages. This was done using pandoc. Some commands still don't have READMEs so they are not present here. Fix #3
2015-12-29 19:06:10 +00:00
# SEE ALSO
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(1), dotnet-run(1), dotnet-publish(1), dotnet-restore(1)
Reference in a new issue Copy permalink