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

71 lines
3 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-PUBLISH(1)
% Zlatko Knezevic
% 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
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-publish` - packs the application and all of its dependencies into a folder getting it ready for publishing
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
# 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
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-publish [--framework]
[--runtime] [--output]
[--configuration]
[< project >]
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
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-publish` will compile the application, read through its dependencies specified in `project.json` and publish the resulting set of files to a directory.
This directory will contain the assemblies, the runtime as well as the executable version of the application. This directory can then be moved to a different machine and the application will be able to run regardless of existence of any other 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
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
The native dependencies of the runtime are not packaged with the application. This means that the target machine needs to have the native dependencies installed in order for the application to run.
Update formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +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
Update dotnet-publish README.md Update the README.md for dotnet-publish and add the information about the Microsoft.NETCore.Runtime dependency. Fixes #289 /cc @brthor @Sridhar-MS
2015-12-21 20:23:46 +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
`[project]`
`dotnet-publish` needs access to `project.json` to work. If it is not specified on invocation via [project], `project.json` in the current directory will be the default. If no `project.json` can be found, `dotnet-publish` will error out. `dotnet-publish` command also requires certain dependencies in the `project.json` to work. Namely the `Microsoft.NETCore.Runtime` package must be referenced as a dependency in order for the command to copy the runtime files as well as the application's files to the published location.
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 formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +00:00
`-f`, `--framework` [FID]
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
Publish the application for a given framework identifier (FID). If not specified, FID is read from `project.json`. In case of no valid framework found, the command will error out. In case of multiple valid frameworks found, the command will publish for all valid frameworks.
Update formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +00:00
`-r`, `--runtime` [RID]
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
Publish the application for a given runtime. If the option is not specified, the command will default to the runtime for the current operationg system. Supported values for the option at this time are:
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
* ubuntu.14.04-x64
* win7-x64
* osx.10.10-x64
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 formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +00:00
`-o`, `--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
Specify the path where to place the directory. If not specified, will default to _./bin/[configuration]/[framework]/[runtime]/_
Update formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +00:00
`-c`, `--configuration [Debug|Release]`
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
Configuration to use when publishing. If not specified, will default to "Debug".
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
# EXAMPLES
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 formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +00:00
`dotnet-publish`
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
Publish the current application using the `project.json` framework and runtime for the current operating system.
Update formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +00:00
`dotnet-publish ~/projects/app1/project.json`
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
Publish the application using the specified `project.json`; also use framework specified withing and runtime for the current operating system.
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 formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +00:00
`dotnet-publish --framework dnxcore50`
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
Publish the current application using the `dnxcore50` framework and runtime for the current operating system.
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 formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +00:00
`dotnet-publish --framework dnxcore50 --runtime osx.10.10-x64`
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
Publish the current application using the `dnxcore50` framework and runtime for `OS X 10.10`
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
Update formatting on Publish/Readme.md Line breaks where they were missing (after headings and before lists). Commands in `code` format. Filenames and paths in _italics_ Indenting done with using the &gt; (as white space is ignored)
2015-12-02 22:37:37 +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
dotnet-restore(1), dotnet-compile(1)
Reference in a new issue Copy permalink