opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-06-30 18:13:54 +08:00
Code Issues Projects Releases Wiki Activity

docs(pin) help

Browse Source
This commit is contained in:
Brian Tiger Chow
2014-11-07 19:08:27 -08:00
committed by Juan Batiz-Benet
parent 3dcae0e079
commit 101601195c
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
core/commands2/pin.go
View File

@ -10,6 +10,10 @@ import (
)
var pinCmd = &cmds.Command{
// TODO UsageLine: "pin",
// TODO Short: "",
Help: `ipfs pin [add|rm] - object pinning commands
`,
Subcommands: map[string]*cmds.Command{
"add": addPinCmd,
"rm": rmPinCmd,
@ -17,6 +21,13 @@ var pinCmd = &cmds.Command{
}
var addPinCmd = &cmds.Command{
// TODO UsageLine: "add",
// TODO Short: "pin an ipfs object to local storage.",
Help: `ipfs pin add <ipfs-path> - pin ipfs object to local storage.
Retrieves the object named by <ipfs-path> and stores it locally
on disk.
`,
Options: []cmds.Option{
cmds.Option{[]string{"recursive", "r"}, cmds.Bool},
cmds.Option{[]string{"depth", "d"}, cmds.Uint},
@ -47,6 +58,13 @@ var addPinCmd = &cmds.Command{
}
var rmPinCmd = &cmds.Command{
// TODO UsageLine: "rm",
// TODO Short: "unpin an ipfs object from local storage.",
Help: `ipfs pin rm <ipfs-path> - unpin ipfs object from local storage.
Removes the pin from the given object allowing it to be garbage
collected if needed.
`,
Options: []cmds.Option{
cmds.Option{[]string{"recursive", "r"}, cmds.Bool},
},