updated help for block commands
Henry committed
Oct 14, 2014 at 09:55 UTC
f613af438c9048f1103ef4f2009f351f682c45fa
1 file changed
+19
-8
cmd/ipfs/block.go
+19
-8
@@ -8,12 +8,15 @@ import (
8
9
var cmdIpfsBlock = &commander.Command{
10
UsageLine: "block",
11
- Short: "get/put **raw** ipfs blocks",
12
- Long: `ipfs block (get|put) - get/put **raw** ipfs blocks.
11
+ Short: "manipulate raw ipfs blocks",
12
+ Long: `ipfs block - manipulate raw ipfs blocks
13
14
- ipfs block get <key> > valfile - get block of <key> and write it to valfile
15
- ipfs block put < valfile - saves the conents of valfile and returns it's <key>
16
-`,
14
+ ipfs block get <key> - get and output block named by <key>
15
+ ipfs block put - store stdin as a block, outputs <key>
16
+
17
+ipfs block is a plumbing command used to manipulate raw ipfs blocks.
18
+Reads from stdin or writes to stdout, and <key> is a base58 encoded
19
+multihash.`,
20
// Run: blockGetCmd,
21
Subcommands: []*commander.Command{
22
cmdIpfsBlockGet,
@@ -23,8 +26,12 @@ var cmdIpfsBlock = &commander.Command{
26
}
27
28
var cmdIpfsBlockGet = &commander.Command{
26
- UsageLine: "get",
27
- Short: "get a raw ipfs block",
29
+ UsageLine: "get <key>",
30
+ Short: "get and output block named by <key>",
31
+ Long: `ipfs get <key> - get and output block named by <key>
32
+
33
+ipfs block get is a plumbing command for retreiving raw ipfs blocks.
34
+It outputs to stdout, and <key> is a base58 encoded multihash.`,
35
Run: makeCommand(command{
36
name: "blockGet",
37
args: 1,
@@ -36,7 +43,11 @@ var cmdIpfsBlockGet = &commander.Command{
43
44
var cmdIpfsBlockPut = &commander.Command{
45
UsageLine: "put",
39
- Short: "put a raw ipfs block",
46
+ Short: "store stdin as a block, outputs <key>",
47
+ Long: `ipfs put - store stdin as a block, outputs <key>
48
+
49
+ipfs block put is a plumbing command for storing raw ipfs blocks.
50
+It reads from stding, and <key> is a base58 encoded multihash.`,
51
Run: makeCommand(command{
52
name: "blockPut",
53
args: 0,