LEFT | RIGHT |
1 // Copyright 2009 The Go Authors. All rights reserved. | 1 // Copyright 2009 The Go Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style | 2 // Use of this source code is governed by a BSD-style |
3 // license that can be found in the LICENSE file. | 3 // license that can be found in the LICENSE file. |
4 | 4 |
5 /* | 5 /* |
6 | 6 |
7 Godoc extracts and generates documentation for Go programs. | 7 Godoc extracts and generates documentation for Go programs. |
8 | 8 |
9 It has two modes. | 9 It has two modes. |
10 | 10 |
(...skipping 30 matching lines...) Expand all Loading... |
41 arguments are considered search queries: a legal query is a | 41 arguments are considered search queries: a legal query is a |
42 single identifier (such as ToLower) or a qualified identifier | 42 single identifier (such as ToLower) or a qualified identifier |
43 (such as math.Sin). | 43 (such as math.Sin). |
44 -src | 44 -src |
45 print (exported) source in command-line mode | 45 print (exported) source in command-line mode |
46 -tabwidth=4 | 46 -tabwidth=4 |
47 width of tabs in units of spaces | 47 width of tabs in units of spaces |
48 -timestamps=true | 48 -timestamps=true |
49 show timestamps with directory listings | 49 show timestamps with directory listings |
50 -fulltext=false | 50 -fulltext=false |
51 » » build full text index for search queries | 51 » » build full text index for regular expression queries |
52 » -regexp=false | |
53 » » interpret queries as regular expressions for full text search | |
54 -path="" | 52 -path="" |
55 additional package directories (colon-separated) | 53 additional package directories (colon-separated) |
56 -html | 54 -html |
57 print HTML in command-line mode | 55 print HTML in command-line mode |
58 -goroot=$GOROOT | 56 -goroot=$GOROOT |
59 Go root directory | 57 Go root directory |
60 -http=addr | 58 -http=addr |
61 HTTP service address (e.g., '127.0.0.1:6060' or just ':6060') | 59 HTTP service address (e.g., '127.0.0.1:6060' or just ':6060') |
62 -server=addr | 60 -server=addr |
63 webserver address for command line searches | 61 webserver address for command line searches |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
100 | 98 |
101 If the sync exit status is 1, godoc assumes that it succeeded without errors | 99 If the sync exit status is 1, godoc assumes that it succeeded without errors |
102 but that no files changed; the index is not updated in this case. | 100 but that no files changed; the index is not updated in this case. |
103 | 101 |
104 In all other cases, sync is assumed to have failed and godoc backs off running | 102 In all other cases, sync is assumed to have failed and godoc backs off running |
105 sync exponentially (up to 1 day). As soon as sync succeeds again (exit status 0 | 103 sync exponentially (up to 1 day). As soon as sync succeeds again (exit status 0 |
106 or 1), the normal sync rhythm is re-established. | 104 or 1), the normal sync rhythm is re-established. |
107 | 105 |
108 */ | 106 */ |
109 package documentation | 107 package documentation |
LEFT | RIGHT |