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
This commit is contained in:
Zlatko Knezevic 2015-12-29 11:06:10 -08:00
parent 8bccd0b93b
commit 2f51091785
13 changed files with 432 additions and 29 deletions

View file

@ -1,28 +1,28 @@
dotnet
======
**NAME**
# NAME
dotnet -- general driver for running the command-line commands
**SYNOPSIS**
# SYNOPSIS
dotnet [common-options] [command] [arguments]
**DESCRIPTION**
# DESCRIPTION
dotnet is a generic driver for the CLI toolchain. Invoked on its own, it will give out brief usage instructions.
Each specific feature is implemented as a command. In order to use the feautre, it is specified after dotnet, i.e. dotnet compile. All of the arguments following the command are command's own arguments.
**Arguments**
# Arguments
-v, --verbose
Enable verbose output
--version
Print out the version of the CLI tooling
**Commands**
# Commands
There are many possible commands that you can use. The few main ones are:
* run - run your code from source
@ -30,7 +30,7 @@ There are many possible commands that you can use. The few main ones are:
* publish - publish
**SEE ALSO**
# SEE ALSO
dotnet-compile
dotnet-run
dotnet-publish

View file

@ -1,13 +1,13 @@
dotnet-compile
===========
**NAME**
# NAME
dotnet-compile -- Compiles source files to a binary format and saves to a target file.
**SYNOPSIS**
# SYNOPSIS
dotnet compile [options]
**DESCRIPTION**
# DESCRIPTION
The compile command compiles source files to a binary file, either 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.
The default IL [--il] output is a PE32 exe [exe], with the default extension of ".exe" on all OSes. The exe must include a public static void or public static int main entry point, or it is an error. The dll [dll] output option has the default extension of ".dll".
@ -36,7 +36,7 @@ The compile command relies on NuGet dependencies for compilation, as references.
Output files, are written to the child `bin` folder, which will be created if it doesn't exist. Files will be overwritten as needed. The temporary files that are created during compilation are placed in the child `obj` folder.
**Options**
# Options
-n, --native [exe | dynlib | lib]
Compiles source to native machine code, for the local machine. The default is a native executable. The default exe extension is no extension and ".exe" on Windows. The default dynlib extension is ".a", ".dynlib" on OS X and ".dll" on Windows.

View file

@ -1,20 +1,20 @@
dotnet-compile
===========
**NAME**
# NAME
dotnet-compile-native -- Compiles IL binaries to native binaries.
**SYNOPSIS**
# SYNOPSIS
dotnet compile [options]
**DESCRIPTION**
# DESCRIPTION
The `compile-native` command compiles IL assemblies to native machine code. It is used by `dotnet-compile --native`.
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 compilerOptions.emitEntryPoint in the project.json.
Output files are written to the child `bin` folder, which will be created if it doesn't exist. Files will be overwritten as needed.
**Options**
# Options
--appdepsdk <SDK_PATH>
Path to custom AppDepSDK

View file

@ -1,13 +1,13 @@
dotnet-compile
===========
**NAME**
# NAME
dotnet-compile -- Compiles source files for a single project to a binary format and saves to a target file.
**SYNOPSIS**
# SYNOPSIS
dotnet compile [options]
**DESCRIPTION**
# DESCRIPTION
The compile command compiles source files from a single project to a binary file, either 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 Build command.
@ -38,7 +38,7 @@ The compile command relies on NuGet dependencies for compilation, as references.
Output files, are written to the child `bin` folder, which will be created if it doesn't exist. Files will be overwritten as needed. The temporary files that are created during compilation are placed in the child `obj` folder.
**Options**
# Options
-n, --native [exe | dynlib | lib]
Compiles source to native machine code, for the local machine. The default is a native executable. The default exe extension is no extension and ".exe" on Windows. The default dynlib extension is ".a", ".dynlib" on OS X and ".dll" on Windows.
@ -50,4 +50,4 @@ Compiles source to IL byte code, which is (typically) portable across machine ty
Specifies the filename to be used. It is an error not to specify an output filename. If no extension is provided, the default one is provided for the output type.
-v, --verbose
Prints verbose logging information, to follow the flow of execution of the command.
Prints verbose logging information, to follow the flow of execution of the command.

View file

@ -0,0 +1,26 @@
dotnet-new
===========
# NAME
dotnet-new -- Create a new sample project
# SYNOPSIS
dotnet new
# DESCRIPTION
The new command provides a convenient way to initalize a valid .NET Core project and sample source code to try out the CLI toolset.
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:
1. A sample "Hello World" program that exists in `Program.cs` file.
2. A valid `project.json` file
After this, the project is ready to be compiled and/or edited further.
# EXAMPLES
`dotnet new`
Drops a sample in the current directory.
# SEE ALSO
dotnet-run(1)

View file

@ -1,16 +1,16 @@
dotnet-publish
==============
**NAME**
# NAME
`dotnet-publish`
> packs the application and all of its dependencies into a folder getting it ready for publishing
**SYNOPSIS**
# SYNOPSIS
`dotnet-publish [options] [project]`
**DESCRIPTION**
# DESCRIPTION
`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 contains the assemblies, the runtime as well as the runnable version of the application.
@ -27,7 +27,7 @@ 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.
**Options**
# Options
`-f`, `--framework` [FID]
@ -55,7 +55,7 @@ If not specified, will default to "Debug".
**EXAMPLES**
# EXAMPLES
`dotnet-publish`
>Publish the current application using the _project.json_ framework and runtime for the current operating system.
@ -69,6 +69,6 @@ If not specified, will default to "Debug".
`dotnet-publish --framework dnxcore50 --runtime osx.10.10-x64`
>Publish the current application using the `dnxcore50` framework and runtime for `OS X 10.10`
**SEE ALSO**
# SEE ALSO
`dotnet-restore`

View file

@ -1,20 +1,20 @@
dotnet-run
===========
**NAME**
# NAME
dotnet-run -- Runs source code 'in-place' without any explicit compile or launch commands.
**SYNOPSIS**
# SYNOPSIS
dotnet run [options]
**DESCRIPTION**
# DESCRIPTION
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).
This command relies on the [compile command](https://github.com/dotnet/cli/issues/48) 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 inhereted from the compile command. The documentation for the compile command provides more information on those requirements.
Output files, are written to the child `bin` folder, which will be created if it doesn't exist. Files will be overwritten as needed. Temporary files are written to the child `obj` folder.
**Options**
# Options
-v, --verbose
Prints verbose logging information, to follow the flow of execution of the command.