docs(pin) help
Brian Tiger Chow committed
Nov 7, 2014 at 19:08 UTC
101601195c87bfae48372f989e7762ef3d63f77a
1 file changed
+18
core/commands2/pin.go
+18
@@ -10,6 +10,10 @@ import (
10
)
11
12
var pinCmd = &cmds.Command{
13
+ // TODO UsageLine: "pin",
14
+ // TODO Short: "",
15
+ Help: `ipfs pin [add|rm] - object pinning commands
16
+ `,
17
Subcommands: map[string]*cmds.Command{
18
"add": addPinCmd,
19
"rm": rmPinCmd,
@@ -17,6 +21,13 @@ var pinCmd = &cmds.Command{
21
}
22
23
var addPinCmd = &cmds.Command{
24
+ // TODO UsageLine: "add",
25
+ // TODO Short: "pin an ipfs object to local storage.",
26
+ Help: `ipfs pin add <ipfs-path> - pin ipfs object to local storage.
27
+
28
+ Retrieves the object named by <ipfs-path> and stores it locally
29
+ on disk.
30
+`,
31
Options: []cmds.Option{
32
cmds.Option{[]string{"recursive", "r"}, cmds.Bool},
33
cmds.Option{[]string{"depth", "d"}, cmds.Uint},
@@ -47,6 +58,13 @@ var addPinCmd = &cmds.Command{
58
}
59
60
var rmPinCmd = &cmds.Command{
61
+ // TODO UsageLine: "rm",
62
+ // TODO Short: "unpin an ipfs object from local storage.",
63
+ Help: `ipfs pin rm <ipfs-path> - unpin ipfs object from local storage.
64
+
65
+ Removes the pin from the given object allowing it to be garbage
66
+ collected if needed.
67
+`,
68
Options: []cmds.Option{
69
cmds.Option{[]string{"recursive", "r"}, cmds.Bool},
70
},