mirror of
https://github.com/ivuorinen/cheatsheet-tldr.git
synced 2026-01-26 11:33:59 +00:00
30 lines
621 B
Plaintext
30 lines
621 B
Plaintext
---
|
|
syntax: markdown
|
|
tags: [tldr, common]
|
|
source: https://github.com/tldr-pages/tldr.git
|
|
---
|
|
# godoc
|
|
|
|
> View documentation for go packages.
|
|
> More information: <https://pkg.go.dev/golang.org/x/tools/cmd/godoc>.
|
|
|
|
- Display help for a specific package:
|
|
|
|
`godoc {{fmt}}`
|
|
|
|
- Display help for the function "Printf" of "fmt" package:
|
|
|
|
`godoc {{fmt}} {{Printf}}`
|
|
|
|
- Serve documentation as a web server on port 6060:
|
|
|
|
`godoc -http=:{{6060}}`
|
|
|
|
- Create an index file:
|
|
|
|
`godoc -write_index -index_files={{path/to/file}}`
|
|
|
|
- Use the given index file to search the docs:
|
|
|
|
`godoc -http=:{{6060}} -index -index_files={{path/to/file}}`
|