fix which manpages are where, add dotnet manpage to host package and rest to sdk package

This commit is contained in:
Bryan Thornbury 2016-03-22 15:14:00 -07:00
parent d709300f6f
commit ab14fb1437
8 changed files with 4 additions and 1 deletions

View file

@ -0,0 +1,125 @@
.\" Automatically generated by Pandoc 1.15.1
.\"
.hy
.TH "dotnet-native" "1" "January 2016" "" ""
.SH NAME
.PP
dotnet\-compile\-native \-\- Compiles IL binaries to native binaries.
.SH SYNOPSIS
.PP
dotnet compile [\-\-appdepsdk] [\-\-configuration] [\-\-ilcargs]
[\-\-linklib] [\-\-logpath] [\-\-mode] [\-\-out] [\-\-reference]
[\-\-temp\-out] [\-\-verbose]
.SH DESCRIPTION
.PP
The \f[C]compile\-native\f[] command compiles IL assemblies to native
machine code.
It is used by \f[C]dotnet\-compile\ \-\-native\f[].
.PP
The output is a native exe that conforms to the architecture of the
underlying operating system (i.e.
running on 64\-bit OS will produce a native 64\-bit exe).
This can be overriden via the \-\-arch switch and specifying the wanted
architecture.
The executable has a default extension of "" on Linux and OS X and
".exe" on Windows.
The source must include a `static void Main(string[] args) entry point
and specify compilationOptions.emitEntryPoint in the project.json.
.PP
Output files are written to the child \f[C]bin\f[] folder, which will be
created if it doesn\[aq]t exist.
Files will be overwritten as needed.
.SH OPTIONS
.PP
\f[C]\-\-appdepsdk\ <SDK_PATH>\f[]
.IP
.nf
\f[C]
Path\ to\ custom\ AppDepSDK
\f[]
.fi
.PP
\f[C]\-c,\ \-\-configuration\ [debug|release]\f[]
.IP
.nf
\f[C]
Build\ configuration.\ Defaults\ to\ `debug`.
\f[]
.fi
.PP
\f[C]\-\-ilcargs\ <args>\f[]
.IP
.nf
\f[C]
Custom\ arguments\ for\ the\ IL\ Compiler.
\f[]
.fi
.PP
\f[C]\-\-ilcpath\ <ILC_PATH>\f[]
.IP
.nf
\f[C]
Path\ to\ a\ custom\ ilc.exe
\f[]
.fi
.PP
\f[C]\-\-linklib\ <LIB_PATH>\f[]
.IP
.nf
\f[C]
Path\ to\ static\ lib\ to\ link
\f[]
.fi
.PP
\f[C]\-\-logpath\ <LOG_PATH>\f[]
.IP
.nf
\f[C]
Enables\ logging\ and\ writes\ native\ compilation\ logs\ to\ the\ given\ path.
\f[]
.fi
.PP
\f[C]\-m,\ \-\-mode\ [cpp|ryujit|custom]\f[]
.IP
.nf
\f[C]
Code\ generation\ mode.\ Defaults\ to\ ryujit.
\f[]
.fi
.PP
\f[C]\-o,\ \-\-out\ directoryname\f[]
.IP
.nf
\f[C]
Output\ directory\ for\ the\ native\ executable.
\f[]
.fi
.PP
\f[C]\-r,\ \-\-reference\f[]
.IP
.nf
\f[C]
Path\ to\ a\ managed\ dll\ reference\ for\ the\ app.
\f[]
.fi
.PP
\f[C]\-t,\ \-\-temp\-out\f[]
.IP
.nf
\f[C]
Specifies\ temporary\ directory\ for\ intermediate\ files.
\f[]
.fi
.PP
\f[C]\-v,\ \-\-verbose\f[]
.IP
.nf
\f[C]
Prints\ verbose\ logging\ information,\ to\ follow\ the\ flow\ of\ execution\ of\ the\ command.
\f[]
.fi
.SH SEE ALSO
.PP
dotnet\-compile(1), dotnet(1), dotnet\-restore(1)
.SH AUTHORS
Zlatko Knezevic zlakne\@microsoft.com.

View file

@ -0,0 +1,157 @@
.\" Automatically generated by Pandoc 1.15.1
.\"
.hy
.TH "dotnet-compiler" "1" "January 2016" "" ""
.SH NAME
.PP
dotnet\-compile \-\- Compiles source files for a single project to a
binary format and saves to a target file.
.SH SYNOPSIS
.PP
dotnet compile [\-\-native] [\-\-output] [\-\-temp\-output]
[\-\-framework] [\-\-configuration] [\-\-output] [\-\-arch] [\-\-cpp]
[\-ilc\-args] [\-\-verbose]
.SH DESCRIPTION
.PP
The compile command compiles source files from a single project to a
binary file, either intermediate language (IL) byte code or native
machine code, depending on the options provided.
The default option is compilation to IL byte code, but may change in the
future.
Users who want to benefit from incremental builds and who want to
compile both the project and its dependencies should use the
dotnet\-build(1) command.
.PP
The result of compilation is by default an executable file that can be
ran.
Output files, are written to the child \f[C]bin\f[] folder, which will
be created if it doesn\[aq]t exist.
Files will be overwritten as needed.
The temporary files that are created during compilation are placed in
the child \f[C]obj\f[] folder.
.PP
The executables also require a special configuration section in
project.json:
.IP
.nf
\f[C]
{\
\ \ \ \ "compilationOptions":\ {
\ \ \ \ \ \ "emitEntryPoint":\ true
\ \ \ \ }
}
\f[]
.fi
.PP
The default native [\-\-native] output is a native exe that conforms to
the architecture of the underlying operating system (i.e.
running on 64\-bit OS will produce a native 64\-bit exe).
This can be overriden via the \-\-arch switch and specifying the wanted
architecture.
The executable has a default extension of "" on Linux and OS X and
".exe" on Windows.
The source must include a static void main entry point, or it is an
error, unless otherwise specified in the project.json.
The dynamic library [dylib] output option has the default extension of
".so" on Linux/UNIX, ".dynlib" on OS X and ".dll" on Windows.
The static library [staticlib] option has the default extension of ".a"
on Linux, UNIX and OS X and ".lib" on Windows.
.PP
This command relies on the following artifacts: source files,
project.json project file and the "lock" file (project.lock.json).
Prior to invoking dotnet\-compile, dotnet\-restore(1) should be run to
restore any dependencies that are needed for the application.
.SH OPTIONS
.PP
\f[C]\-n,\ \-\-native\f[]
.IP
.nf
\f[C]
Compiles\ source\ to\ native\ machine\ code,\ for\ the\ local\ machine.\ The\ default\ is\ a\ native\ executable.\ The\ default\ executable\ extension\ is\ no\ extension\ and\ ".exe"\ on\ Windows.
\f[]
.fi
.PP
\f[C]\-t,\ \-\-temp\-output\ <PATH>\f[]
.IP
.nf
\f[C]
Path\ where\ to\ drop\ the\ temporary\ binaries\ that\ are\ produced\ during\ compile.\ By\ default,\ the\ temporary\ binaries\ are\ dropped\ in\ the\ `obj`\ directory\ in\ the\ directory\ where\ `project.json`\ files\ lives,\ that\ is,\ where\ the\ application\ lives.\ \
\f[]
.fi
.PP
\f[C]\-f,\ \-\-framework\ <FID>\f[]
.IP
.nf
\f[C]
Compile\ the\ application\ for\ the\ specified\ framework.\ If\ the\ framework\ is\ not\ specified,\ one\ specified\ in\ `project.json`\ will\ be\ used.\
\f[]
.fi
.PP
\f[C]\-c,\ \-\-configuration\ <CONFIGURATION>\f[]
.IP
.nf
\f[C]
Compile\ the\ application\ under\ the\ specified\ configuration.\ If\ not\ specified,\ the\ configuration\ will\ default\ to\ "Debug".\ \
\f[]
.fi
.PP
\f[C]\-o,\ \-\-output\ filename\f[]
.IP
.nf
\f[C]
Specifies\ the\ filename\ to\ be\ used.\ By\ default,\ the\ resulting\ filename\ will\ be\ the\ same\ as\ the\ project\ name\ specified\ in\ `project.json`,\ if\ one\ exists,\ or\ the\ directory\ in\ which\ the\ source\ files\ reside.\
\f[]
.fi
.PP
\f[C]\-\-no\-project\-dependencies\f[]
.IP
.nf
\f[C]
Skips\ building\ cross\-project\ references.\ The\ effect\ of\ this\ is\ that\ only\ the\ current\ project\ will\ be\ built.\
\f[]
.fi
.PP
\f[C]\-a,\ \-\-arch\f[]
.IP
.nf
\f[C]
The\ architecture\ for\ which\ to\ compile.\ x64\ only\ currently\ supported.
\f[]
.fi
.PP
\f[C]\-\-ilc\-args\ <ARGS>\f[]
.IP
.nf
\f[C]
Specified\ parameters\ are\ passed\ through\ to\ ILC\ and\ are\ used\ by\ the\ engine\ when\ doing\ native\ compilation.\
\f[]
.fi
.PP
\f[C]\-\-cpp\f[]
.IP
.nf
\f[C]
Specify\ the\ C++\ code\ generator\ to\ do\ native\ compilation\ of\ code\ instead\ of\ the\ default\ RyuJIT.\ \ \ \ \ \ \
\f[]
.fi
.PP
\f[C]\-v,\ \-\-verbose\f[]
.IP
.nf
\f[C]
Prints\ verbose\ logging\ information,\ to\ follow\ the\ flow\ of\ execution\ of\ the\ command.
\f[]
.fi
.PP
\f[C]\-h,\ \-\-help\f[]
.IP
.nf
\f[C]
Show\ short\ help.\
\f[]
.fi
.SH SEE ALSO
.PP
dotnet\-restore(1), dotnet\-publish(1), dotnet(1)
.SH AUTHORS
Zlatko Knezevic zlakne\@microsoft.com.

View file

@ -0,0 +1,38 @@
.\" Automatically generated by Pandoc 1.15.1
.\"
.hy
.TH "dotnet-new" "1" "January 2016" "" ""
.SH NAME
.PP
dotnet\-new \-\- Create a new sample .NET Core project
.SH SYNOPSIS
.PP
dotnet new
.SH DESCRIPTION
.PP
The new command provides a convenient way to initalize a valid .NET Core
project and sample source code to try out the CLI toolset.
.PP
This command is invoked in the context of a directory.
When invoked, the command will result in two main artifacts being
dropped to the directory:
.IP "1." 3
A sample "Hello World" program that exists in \f[C]Program.cs\f[] file.
.IP "2." 3
A valid \f[C]project.json\f[] file
.PP
After this, the project is ready to be compiled and/or edited further.
.SH EXAMPLES
.PP
\f[C]dotnet\ new\f[]
.IP
.nf
\f[C]
Drops\ a\ sample\ in\ the\ current\ directory.
\f[]
.fi
.SH SEE ALSO
.PP
dotnet\-run(1)
.SH AUTHORS
Zlatko Knezevic zlakne\@microsoft.com.

View file

@ -0,0 +1,114 @@
.\" Automatically generated by Pandoc 1.15.1
.\"
.hy
.TH "dotnet-publish" "1" "January 2016" "" ""
.SH NAME
.PP
\f[C]dotnet\-publish\f[] \- packs the application and all of its
dependencies into a folder getting it ready for publishing
.SH SYNOPSIS
.PP
dotnet\-publish [\-\-framework] [\-\-runtime] [\-\-output]
[\-\-configuration]
.PD 0
.P
.PD
[< project >]
.SH DESCRIPTION
.PP
\f[C]dotnet\-publish\f[] will compile the application, read through its
dependencies specified in \f[C]project.json\f[] 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.
.PP
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.
.SH OPTIONS
.PP
\f[C][project]\f[]
.IP
.nf
\f[C]
`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\[aq]s\ files\ to\ the\ published\ location.\ \
\f[]
.fi
.PP
\f[C]\-f\f[], \f[C]\-\-framework\f[] [FID]
.IP
.nf
\f[C]
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.\
\f[]
.fi
.PP
\f[C]\-r\f[], \f[C]\-\-runtime\f[] [RID]
.IP
.nf
\f[C]
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:
\ \ \ \ *\ ubuntu.14.04\-x64
\ \ \ \ *\ win7\-x64
\ \ \ \ *\ osx.10.10\-x64
\f[]
.fi
.PP
\f[C]\-o\f[], \f[C]\-\-output\f[]
.IP
.nf
\f[C]
Specify\ the\ path\ where\ to\ place\ the\ directory.\ If\ not\ specified,\ will\ default\ to\ _./bin/[configuration]/[framework]/[runtime]/_
\f[]
.fi
.PP
\f[C]\-c\f[], \f[C]\-\-configuration\ [Debug|Release]\f[]
.IP
.nf
\f[C]
Configuration\ to\ use\ when\ publishing.\ If\ not\ specified,\ will\ default\ to\ "Debug".
\f[]
.fi
.SH EXAMPLES
.PP
\f[C]dotnet\-publish\f[]
.IP
.nf
\f[C]
Publish\ the\ current\ application\ using\ the\ `project.json`\ framework\ and\ runtime\ for\ the\ current\ operating\ system.\
\f[]
.fi
.PP
\f[C]dotnet\-publish\ ~/projects/app1/project.json\f[]
.IP
.nf
\f[C]
Publish\ the\ application\ using\ the\ specified\ `project.json`;\ also\ use\ framework\ specified\ withing\ and\ runtime\ for\ the\ current\ operating\ system.\
\f[]
.fi
.PP
\f[C]dotnet\-publish\ \-\-framework\ dnxcore50\f[]
.IP
.nf
\f[C]
Publish\ the\ current\ application\ using\ the\ `dnxcore50`\ framework\ and\ runtime\ for\ the\ current\ operating\ system.\
\f[]
.fi
.PP
\f[C]dotnet\-publish\ \-\-framework\ dnxcore50\ \-\-runtime\ osx.10.10\-x64\f[]
.IP
.nf
\f[C]
Publish\ the\ current\ application\ using\ the\ `dnxcore50`\ framework\ and\ runtime\ for\ `OS\ X\ 10.10`
\f[]
.fi
.SH SEE ALSO
.PP
dotnet\-restore(1), dotnet\-compile(1)
.SH AUTHORS
Zlatko Knezevic zlakne\@microsoft.com.

View file

@ -0,0 +1,46 @@
.\" Automatically generated by Pandoc 1.15.1
.\"
.hy
.TH "dotnet-run" "1" "January 2016" "" ""
.SH NAME
.PP
dotnet\-run \-\- Runs source code \[aq]in\-place\[aq] without any
explicit compile or launch commands.
.SH SYNOPSIS
.PP
\f[C]dotnet\ run\ [\-\-verbose]\f[]
.SH DESCRIPTION
.PP
The run command provides a convenient option to run source code with one
command.
It compiles source code, generates an output program and then runs that
program.
This command is useful for fast iterative development and can also be
used to run a source\-distributed program (e.g.
website).
.PP
This command relies on \f[C]dotnet\-compile(1)\f[] to compile source
inputs to a .NET assembly, before launching the program.
The requirements for and handling of source inputs for this command are
all inherited from the compile command.
The documentation for the compile command provides more information on
those requirements.
.PP
Output files, are written to the child \f[C]bin\f[] folder, which will
be created if it doesn\[aq]t exist.
Files will be overwritten as needed.
Temporary files are written to the child \f[C]obj\f[] folder.
.SH OPTIONS
.PP
\-v, \-\-verbose
.IP
.nf
\f[C]
Prints\ verbose\ logging\ information,\ to\ follow\ the\ flow\ of\ execution\ of\ the\ command.
\f[]
.fi
.SH SEE ALSO
.PP
dotnet\-compile(1), dotnet\-publish(1)
.SH AUTHORS
Zlatko Knezevic zlakne\@microsoft.com.