mirror of
https://github.com/golang/go
synced 2024-11-21 21:04:41 -07:00
b73046407f
Compare and explain go, go cmd, and go tool cmd. The situation is not concisely explained elsewhere in the main docs. R=golang-dev, bradfitz CC=golang-dev https://golang.org/cl/5906043
118 lines
3.1 KiB
HTML
118 lines
3.1 KiB
HTML
<!--{
|
|
"Title": "Command Documentation",
|
|
"Path": "/ref/cmd"
|
|
}-->
|
|
|
|
<p>
|
|
There is a suite of programs to build and process Go source code.
|
|
Instead of being run directly, programs in the suite are usually invoked
|
|
by the <a href="/cmd/go/">go</a> program.
|
|
</p>
|
|
|
|
<p>
|
|
The most common way to run these programs is as a subcommand of the go
|
|
program,
|
|
for instance as "go fmt". Run like this, the command operates on complete
|
|
packages of Go source code, with the go program invoking the underlying binary
|
|
with arguments appropriate to package-level processing.
|
|
</p>
|
|
|
|
<p>
|
|
The programs can also be run as stand-alone binaries, with unmodified arguments,
|
|
using the go tool subcommand, such as "go tool fmt".
|
|
This style of invocation allows, for instance, reformatting a single source file rather than
|
|
an entire package: "go tool fmt myprogram.go" as compared to
|
|
"go fmt mypackage".
|
|
Some of the commands, such as prof and yacc, are accessible
|
|
only through the go tool subcommand.
|
|
</p>
|
|
|
|
<p>
|
|
Finally, two of the commands, fmt and
|
|
doc, are also installed as regular binaries called
|
|
gofmt and godoc
|
|
because they are so often referenced.
|
|
</p>
|
|
|
|
<p>
|
|
Click on the links for more documentation, invocation methods, and usage details.
|
|
</p>
|
|
|
|
<table class="dir">
|
|
<tr>
|
|
<th>Name</th>
|
|
<th> </th>
|
|
<th>Synopsis</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><a href="/cmd/go/">go</a></td>
|
|
<td> </td>
|
|
<td>
|
|
The <code>go</code> program manages Go source code and runs the other
|
|
commands listed here.
|
|
See the command docs for usage
|
|
details.
|
|
<br><br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><a href="/cmd/cgo/">cgo</a></td>
|
|
<td> </td>
|
|
<td>Cgo enables the creation of Go packages that call C code.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><a href="/cmd/cov/">cov</a></td>
|
|
<td> </td>
|
|
<td>Cov is a rudimentary code coverage tool.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><a href="/cmd/fix/">fix</a></td>
|
|
<td> </td>
|
|
<td>Fix finds Go programs that use old features of the language and libraries
|
|
and rewrites them to use newer ones.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><a href="/cmd/go/">doc</a></td>
|
|
<td> </td>
|
|
<td>Doc extracts and generates documentation for Go packages, it is also available as
|
|
an independent <a href="/cmd/godoc/">godoc</a> command with more general options.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><a href="/cmd/go/">fmt</a></td>
|
|
<td> </td>
|
|
<td>Fmt formats Go packages, it is also available as an independent <a href="/cmd/gofmt/">
|
|
gofmt</a> command with more general options.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><a href="/cmd/prof/">prof</a></td>
|
|
<td> </td>
|
|
<td>Prof is a rudimentary real-time profiler.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><a href="/cmd/vet/">vet</a></td>
|
|
<td> </td>
|
|
<td>Vet examines Go source code and reports suspicious constructs, such as Printf
|
|
calls whose arguments do not align with the format string.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><a href="/cmd/yacc/">yacc</a></td>
|
|
<td> </td>
|
|
<td>Yacc is a version of yacc that generates parsers implemented in Go.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<p>
|
|
This is an abridged list. See the <a href="/cmd/">full command reference</a>
|
|
for documentation of the compilers and more.
|
|
</p>
|