add more help text for ipfs diag net
Jeromy committed
Jan 27, 2015 at 09:05 UTC
c50d7637272ee7fe1277f7950f653687bfa14826
1 file changed
+20
core/commands/diag.go
+20
@@ -56,6 +56,26 @@ var diagNetCmd = &cmds.Command{
56
Sends out a message to each node in the network recursively
57
requesting a listing of data about them including number of
58
connected peers and latencies between them.
59
+
60
+The given timeout will be stepped down for each peer the
61
+request is sent to, to ensure that all peers return in an
62
+order that will result in the most responses to the initiator.
63
+The default timeout is 20 seconds.
64
+
65
+The 'vis' option may be used to change the output format.
66
+Currently, two alternate formats are supported, d3, and json.
67
+The d3 format will output a json object ready to be consumed by
68
+the chord network viewer, available at the following hash:
69
+
70
+ QmbesKpGyQGd5jtJFUGEB1ByPjNFpukhnKZDnkfxUiKn38
71
+
72
+To view your diag output, 'ipfs add' the d3 vis output, and
73
+open the following link:
74
+
75
+ http://gateway.ipfs.io/ipfs/QmbesKpGyQGd5jtJFUGEB1ByPjNFpukhnKZDnkfxUiKn38/chord#<your hash>
76
+
77
+The json option for vis output can also be used for other
78
+programs that want to consume diagnostic output.
79
`,
80
},
81