mirror of
https://github.com/ipfs/kubo.git
synced 2025-08-06 11:31:54 +08:00
Fix punc-caps issues of cli Tagline
License: MIT Signed-off-by: rht <rhtbot@gmail.com>
This commit is contained in:
@ -44,7 +44,7 @@ const (
|
||||
|
||||
var daemonCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Run a network-connected IPFS node",
|
||||
Tagline: "Run a network-connected IPFS node.",
|
||||
ShortDescription: `
|
||||
'ipfs daemon' runs a persistent IPFS daemon that can serve commands
|
||||
over the network. Most applications that use IPFS will do so by
|
||||
|
@ -20,7 +20,7 @@ const nBitsForKeypairDefault = 2048
|
||||
|
||||
var initCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Initializes IPFS config file",
|
||||
Tagline: "Initializes IPFS config file.",
|
||||
ShortDescription: `
|
||||
Initializes IPFS configuration files and generates a new keypair.
|
||||
|
||||
|
@ -26,7 +26,7 @@ func (bs BlockStat) String() string {
|
||||
|
||||
var BlockCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Manipulate raw IPFS blocks",
|
||||
Tagline: "Manipulate raw IPFS blocks.",
|
||||
ShortDescription: `
|
||||
'ipfs block' is a plumbing command used to manipulate raw ipfs blocks.
|
||||
Reads from stdin or writes to stdout, and <key> is a base58 encoded
|
||||
@ -43,7 +43,7 @@ multihash.
|
||||
|
||||
var blockStatCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Print information of a raw IPFS block",
|
||||
Tagline: "Print information of a raw IPFS block.",
|
||||
ShortDescription: `
|
||||
'ipfs block stat' is a plumbing command for retreiving information
|
||||
on raw ipfs blocks. It outputs the following to stdout:
|
||||
@ -80,7 +80,7 @@ on raw ipfs blocks. It outputs the following to stdout:
|
||||
|
||||
var blockGetCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Get a raw IPFS block",
|
||||
Tagline: "Get a raw IPFS block.",
|
||||
ShortDescription: `
|
||||
'ipfs block get' is a plumbing command for retreiving raw ipfs blocks.
|
||||
It outputs to stdout, and <key> is a base58 encoded multihash.
|
||||
@ -103,7 +103,7 @@ It outputs to stdout, and <key> is a base58 encoded multihash.
|
||||
|
||||
var blockPutCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Stores input as an IPFS block",
|
||||
Tagline: "Stores input as an IPFS block.",
|
||||
ShortDescription: `
|
||||
ipfs block put is a plumbing command for storing raw ipfs blocks.
|
||||
It reads from stdin, and <key> is a base58 encoded multihash.
|
||||
|
@ -21,7 +21,7 @@ var peerOptionDesc = "A peer to add to the bootstrap list (in the format '<multi
|
||||
|
||||
var BootstrapCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Show or edit the list of bootstrap peers",
|
||||
Tagline: "Show or edit the list of bootstrap peers.",
|
||||
Synopsis: `
|
||||
ipfs bootstrap list - Show peers in the bootstrap list
|
||||
ipfs bootstrap add <peer>... - Add peers to the bootstrap list
|
||||
@ -45,7 +45,7 @@ Running 'ipfs bootstrap' with no arguments will run 'ipfs bootstrap list'.
|
||||
|
||||
var bootstrapAddCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Add peers to the bootstrap list",
|
||||
Tagline: "Add peers to the bootstrap list.",
|
||||
ShortDescription: `Outputs a list of peers that were added (that weren't already
|
||||
in the bootstrap list).
|
||||
` + bootstrapSecurityWarning,
|
||||
@ -128,7 +128,7 @@ in the bootstrap list).
|
||||
|
||||
var bootstrapRemoveCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Removes peers from the bootstrap list",
|
||||
Tagline: "Removes peers from the bootstrap list.",
|
||||
ShortDescription: `Outputs the list of peers that were removed.
|
||||
` + bootstrapSecurityWarning,
|
||||
},
|
||||
@ -194,7 +194,7 @@ var bootstrapRemoveCmd = &cmds.Command{
|
||||
|
||||
var bootstrapListCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Show peers in the bootstrap list",
|
||||
Tagline: "Show peers in the bootstrap list.",
|
||||
ShortDescription: "Peers are output in the format '<multiaddr>/<peerID>'.",
|
||||
},
|
||||
|
||||
|
@ -15,7 +15,7 @@ const progressBarMinSize = 1024 * 1024 * 8 // show progress bar for outputs > 8M
|
||||
|
||||
var CatCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Show IPFS object data",
|
||||
Tagline: "Show IPFS object data.",
|
||||
ShortDescription: `
|
||||
Retrieves the object named by <ipfs-or-ipns-path> and outputs the data
|
||||
it contains.
|
||||
|
@ -24,7 +24,7 @@ type ConfigField struct {
|
||||
|
||||
var ConfigCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "get and set IPFS config values",
|
||||
Tagline: "get and set IPFS config values.",
|
||||
Synopsis: `
|
||||
ipfs config <key> - Get value of <key>
|
||||
ipfs config <key> <value> - Set value of <key> to <value>
|
||||
@ -133,7 +133,7 @@ Set the value of the 'datastore.path' key:
|
||||
|
||||
var configShowCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Outputs the content of the config file",
|
||||
Tagline: "Outputs the content of the config file.",
|
||||
ShortDescription: `
|
||||
WARNING: Your private key is stored in the config file, and it will be
|
||||
included in the output of this command.
|
||||
@ -158,7 +158,7 @@ included in the output of this command.
|
||||
|
||||
var configEditCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Opens the config file for editing in $EDITOR",
|
||||
Tagline: "Opens the config file for editing in $EDITOR.",
|
||||
ShortDescription: `
|
||||
To use 'ipfs config edit', you must have the $EDITOR environment
|
||||
variable set to your preferred text editor.
|
||||
@ -181,7 +181,7 @@ variable set to your preferred text editor.
|
||||
|
||||
var configReplaceCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Replaces the config with <file>",
|
||||
Tagline: "Replaces the config with <file>.",
|
||||
ShortDescription: `
|
||||
Make sure to back up the config file first if neccessary, this operation
|
||||
can't be undone.
|
||||
|
@ -20,7 +20,7 @@ var ErrNotDHT = errors.New("routing service is not a DHT")
|
||||
|
||||
var DhtCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Issue commands directly through the DHT",
|
||||
Tagline: "Issue commands directly through the DHT.",
|
||||
ShortDescription: ``,
|
||||
},
|
||||
|
||||
@ -35,7 +35,7 @@ var DhtCmd = &cmds.Command{
|
||||
|
||||
var queryDhtCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Run a 'findClosestPeers' query through the DHT",
|
||||
Tagline: "Run a 'findClosestPeers' query through the DHT.",
|
||||
ShortDescription: ``,
|
||||
},
|
||||
|
||||
@ -119,7 +119,7 @@ var queryDhtCmd = &cmds.Command{
|
||||
|
||||
var findProvidersDhtCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Run a 'FindProviders' query through the DHT",
|
||||
Tagline: "Run a 'FindProviders' query through the DHT.",
|
||||
ShortDescription: `
|
||||
FindProviders will return a list of peers who are able to provide the value requested.
|
||||
`,
|
||||
@ -222,7 +222,7 @@ FindProviders will return a list of peers who are able to provide the value requ
|
||||
|
||||
var findPeerDhtCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Run a 'FindPeer' query through the DHT",
|
||||
Tagline: "Run a 'FindPeer' query through the DHT.",
|
||||
ShortDescription: ``,
|
||||
},
|
||||
|
||||
@ -317,7 +317,7 @@ var findPeerDhtCmd = &cmds.Command{
|
||||
|
||||
var getValueDhtCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Run a 'GetValue' query through the DHT",
|
||||
Tagline: "Run a 'GetValue' query through the DHT.",
|
||||
ShortDescription: `
|
||||
GetValue will return the value stored in the dht at the given key.
|
||||
`,
|
||||
@ -420,7 +420,7 @@ GetValue will return the value stored in the dht at the given key.
|
||||
|
||||
var putValueDhtCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Run a 'PutValue' query through the DHT",
|
||||
Tagline: "Run a 'PutValue' query through the DHT.",
|
||||
ShortDescription: `
|
||||
PutValue will store the given key value pair in the dht.
|
||||
`,
|
||||
|
@ -41,7 +41,7 @@ var DefaultDiagnosticTimeout = time.Second * 20
|
||||
|
||||
var DiagCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Generates diagnostic reports",
|
||||
Tagline: "Generates diagnostic reports.",
|
||||
},
|
||||
|
||||
Subcommands: map[string]*cmds.Command{
|
||||
@ -52,7 +52,7 @@ var DiagCmd = &cmds.Command{
|
||||
|
||||
var diagNetCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Generates a network diagnostics report",
|
||||
Tagline: "Generates a network diagnostics report.",
|
||||
ShortDescription: `
|
||||
Sends out a message to each node in the network recursively
|
||||
requesting a listing of data about them including number of
|
||||
|
@ -11,7 +11,7 @@ import (
|
||||
|
||||
var DNSCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "DNS link resolver",
|
||||
Tagline: "DNS link resolver.",
|
||||
ShortDescription: `
|
||||
Multihashes are hard to remember, but domain names are usually easy to
|
||||
remember. To create memorable aliases for multihashes, DNS TXT
|
||||
|
@ -24,7 +24,7 @@ var log = logging.Logger("cmds/files")
|
||||
|
||||
var FilesCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Manipulate unixfs files",
|
||||
Tagline: "Manipulate unixfs files.",
|
||||
ShortDescription: `
|
||||
Files is an API for manipulating ipfs objects as if they were a unix filesystem.
|
||||
`,
|
||||
@ -46,7 +46,7 @@ Files is an API for manipulating ipfs objects as if they were a unix filesystem.
|
||||
|
||||
var FilesStatCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "display file status",
|
||||
Tagline: "Display file status.",
|
||||
},
|
||||
|
||||
Arguments: []cmds.Argument{
|
||||
@ -137,7 +137,7 @@ func statNode(ds dag.DAGService, fsn mfs.FSNode) (*Object, error) {
|
||||
|
||||
var FilesCpCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "copy files into mfs",
|
||||
Tagline: "Copy files into mfs.",
|
||||
},
|
||||
Arguments: []cmds.Argument{
|
||||
cmds.StringArg("source", true, false, "source object to copy"),
|
||||
@ -208,7 +208,7 @@ type FilesLsOutput struct {
|
||||
|
||||
var FilesLsCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "List directories",
|
||||
Tagline: "List directories.",
|
||||
ShortDescription: `
|
||||
List directories.
|
||||
|
||||
@ -310,7 +310,7 @@ Examples:
|
||||
|
||||
var FilesReadCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Read a file in a given mfs",
|
||||
Tagline: "Read a file in a given mfs.",
|
||||
ShortDescription: `
|
||||
Read a specified number of bytes from a file at a given offset. By default, will
|
||||
read the entire file similar to unix cat.
|
||||
@ -400,7 +400,7 @@ Examples:
|
||||
|
||||
var FilesMvCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Move files",
|
||||
Tagline: "Move files.",
|
||||
ShortDescription: `
|
||||
Move files around. Just like traditional unix mv.
|
||||
|
||||
@ -443,7 +443,7 @@ Example:
|
||||
|
||||
var FilesWriteCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Write to a mutable file in a given filesystem",
|
||||
Tagline: "Write to a mutable file in a given filesystem.",
|
||||
ShortDescription: `
|
||||
Write data to a file in a given filesystem. This command allows you to specify
|
||||
a beginning offset to write to. The entire length of the input will be written.
|
||||
@ -566,7 +566,7 @@ Warning:
|
||||
|
||||
var FilesMkdirCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "make directories",
|
||||
Tagline: "Make directories.",
|
||||
ShortDescription: `
|
||||
Create the directory if it does not already exist.
|
||||
|
||||
@ -615,7 +615,7 @@ Examples:
|
||||
|
||||
var FilesRmCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "remove a file",
|
||||
Tagline: "Remove a file.",
|
||||
ShortDescription: `
|
||||
remove files or directories
|
||||
|
||||
|
@ -22,7 +22,7 @@ var ErrInvalidCompressionLevel = errors.New("Compression level must be between 1
|
||||
|
||||
var GetCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Download IPFS objects",
|
||||
Tagline: "Download IPFS objects.",
|
||||
ShortDescription: `
|
||||
Retrieves the object named by <ipfs-or-ipns-path> and stores the data to disk.
|
||||
|
||||
|
@ -36,7 +36,7 @@ type IdOutput struct {
|
||||
|
||||
var IDCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Show IPFS Node ID info",
|
||||
Tagline: "Show IPFS Node ID info.",
|
||||
ShortDescription: `
|
||||
Prints out information about the specified peer,
|
||||
if no peer is specified, prints out local peers info.
|
||||
|
@ -13,7 +13,7 @@ import (
|
||||
|
||||
var IpnsCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Gets the value currently published at an IPNS name",
|
||||
Tagline: "Gets the value currently published at an IPNS name.",
|
||||
ShortDescription: `
|
||||
IPNS is a PKI namespace, where names are the hashes of public keys, and
|
||||
the private key enables publishing new (signed) values. In resolve, the
|
||||
|
@ -16,7 +16,7 @@ var logAllKeyword = "all"
|
||||
|
||||
var LogCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Interact with the daemon log output",
|
||||
Tagline: "Interact with the daemon log output.",
|
||||
ShortDescription: `
|
||||
'ipfs log' contains utility commands to affect or read the logging
|
||||
output of a running daemon.
|
||||
@ -31,7 +31,7 @@ output of a running daemon.
|
||||
|
||||
var logLevelCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Change the logging level",
|
||||
Tagline: "Change the logging level.",
|
||||
ShortDescription: `
|
||||
'ipfs log level' is a utility command used to change the logging
|
||||
output of a running daemon.
|
||||
@ -70,7 +70,7 @@ output of a running daemon.
|
||||
|
||||
var logTailCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Read the logs",
|
||||
Tagline: "Read the logs.",
|
||||
ShortDescription: `
|
||||
'ipfs log tail' is a utility command used to read log output as it is written.
|
||||
`,
|
||||
|
@ -12,7 +12,7 @@ import (
|
||||
|
||||
var MountCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Mounts IPFS to the filesystem (disabled)",
|
||||
Tagline: "Mounts IPFS to the filesystem (disabled).",
|
||||
ShortDescription: `
|
||||
This version of ipfs is compiled without fuse support, which is required
|
||||
for mounting. If you'd like to be able to mount, please use a version of
|
||||
|
@ -35,7 +35,7 @@ var platformFuseChecks = func(*core.IpfsNode) error {
|
||||
|
||||
var MountCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Mounts IPFS to the filesystem (read-only)",
|
||||
Tagline: "Mounts IPFS to the filesystem (read-only).",
|
||||
Synopsis: `
|
||||
ipfs mount [-f <ipfs mount path>] [-n <ipns mount path>]
|
||||
`,
|
||||
|
@ -9,7 +9,7 @@ import (
|
||||
|
||||
var MountCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Not yet implemented on Windows",
|
||||
Tagline: "Not yet implemented on Windows.",
|
||||
ShortDescription: "Not yet implemented on Windows. :(",
|
||||
},
|
||||
|
||||
|
@ -9,7 +9,7 @@ type IpnsEntry struct {
|
||||
|
||||
var NameCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "IPFS namespace (IPNS) tool",
|
||||
Tagline: "IPFS namespace (IPNS) tool.",
|
||||
Synopsis: `
|
||||
ipfs name publish [<name>] <ipfs-path> - Publish an object to IPNS
|
||||
ipfs name resolve [<name>] - Gets the value currently published at an IPNS name
|
||||
|
@ -42,7 +42,7 @@ type Object struct {
|
||||
|
||||
var ObjectCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Interact with ipfs objects",
|
||||
Tagline: "Interact with ipfs objects.",
|
||||
ShortDescription: `
|
||||
'ipfs object' is a plumbing command used to manipulate DAG objects
|
||||
directly.`,
|
||||
@ -70,7 +70,7 @@ ipfs object patch <args> - Create new object from old ones
|
||||
|
||||
var ObjectDataCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Outputs the raw bytes in an IPFS object",
|
||||
Tagline: "Outputs the raw bytes in an IPFS object.",
|
||||
ShortDescription: `
|
||||
'ipfs object data' is a plumbing command for retreiving the raw bytes stored in
|
||||
a DAG node. It outputs to stdout, and <key> is a base58 encoded
|
||||
@ -108,7 +108,7 @@ output is the raw data of the object.
|
||||
|
||||
var ObjectLinksCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Outputs the links pointed to by the specified object",
|
||||
Tagline: "Outputs the links pointed to by the specified object.",
|
||||
ShortDescription: `
|
||||
'ipfs object links' is a plumbing command for retreiving the links from
|
||||
a DAG node. It outputs to stdout, and <key> is a base58 encoded
|
||||
@ -157,7 +157,7 @@ multihash.
|
||||
|
||||
var ObjectGetCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Get and serialize the DAG node named by <key>",
|
||||
Tagline: "Get and serialize the DAG node named by <key>.",
|
||||
ShortDescription: `
|
||||
'ipfs object get' is a plumbing command for retreiving DAG nodes.
|
||||
It serializes the DAG node to the format specified by the "--encoding"
|
||||
@ -228,7 +228,7 @@ This command outputs data in the following encodings:
|
||||
|
||||
var ObjectStatCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Get stats for the DAG node named by <key>",
|
||||
Tagline: "Get stats for the DAG node named by <key>.",
|
||||
ShortDescription: `
|
||||
'ipfs object stat' is a plumbing command to print DAG node statistics.
|
||||
<key> is a base58 encoded multihash. It outputs to stdout:
|
||||
@ -289,7 +289,7 @@ var ObjectStatCmd = &cmds.Command{
|
||||
|
||||
var ObjectPutCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Stores input as a DAG object, outputs its key",
|
||||
Tagline: "Stores input as a DAG object, outputs its key.",
|
||||
ShortDescription: `
|
||||
'ipfs object put' is a plumbing command for storing DAG nodes.
|
||||
It reads from stdin, and the output is a base58 encoded multihash.
|
||||
@ -376,7 +376,7 @@ and then run
|
||||
|
||||
var ObjectNewCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "creates a new object from an ipfs template",
|
||||
Tagline: "Creates a new object from an ipfs template.",
|
||||
ShortDescription: `
|
||||
'ipfs object new' is a plumbing command for creating new DAG nodes.
|
||||
`,
|
||||
|
@ -17,7 +17,7 @@ import (
|
||||
|
||||
var ObjectPatchCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Create a new merkledag object based on an existing one",
|
||||
Tagline: "Create a new merkledag object based on an existing one.",
|
||||
ShortDescription: `
|
||||
'ipfs object patch <root> <cmd> <args>' is a plumbing command used to
|
||||
build custom DAG objects. It mutates objects, creating new objects as a
|
||||
@ -44,7 +44,7 @@ func objectMarshaler(res cmds.Response) (io.Reader, error) {
|
||||
|
||||
var patchAppendDataCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Append data to the data segment of a dag node",
|
||||
Tagline: "Append data to the data segment of a dag node.",
|
||||
ShortDescription: `
|
||||
Append data to what already exists in the data segment in the given object.
|
||||
|
||||
@ -109,7 +109,7 @@ the limit will not be respected by the network.
|
||||
|
||||
var patchSetDataCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "set data field of an ipfs object",
|
||||
Tagline: "Set data field of an ipfs object.",
|
||||
ShortDescription: `
|
||||
Set the data of an ipfs object from stdin or with the contents of a file
|
||||
|
||||
@ -171,7 +171,7 @@ EXAMPLE:
|
||||
|
||||
var patchRmLinkCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "remove a link from an object",
|
||||
Tagline: "Remove a link from an object.",
|
||||
ShortDescription: `
|
||||
removes a link by the given name from root.
|
||||
`,
|
||||
@ -231,7 +231,7 @@ removes a link by the given name from root.
|
||||
|
||||
var patchAddLinkCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "add a link to a given object",
|
||||
Tagline: "Add a link to a given object.",
|
||||
ShortDescription: `
|
||||
Add a merkle-link to the given object and return the hash of the result.
|
||||
|
||||
|
@ -14,7 +14,7 @@ import (
|
||||
|
||||
var PinCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Pin (and unpin) objects to local storage",
|
||||
Tagline: "Pin (and unpin) objects to local storage.",
|
||||
},
|
||||
|
||||
Subcommands: map[string]*cmds.Command{
|
||||
@ -30,7 +30,7 @@ type PinOutput struct {
|
||||
|
||||
var addPinCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Pins objects to local storage",
|
||||
Tagline: "Pins objects to local storage.",
|
||||
ShortDescription: `
|
||||
Retrieves the object named by <ipfs-path> and stores it locally
|
||||
on disk.
|
||||
@ -98,7 +98,7 @@ on disk.
|
||||
|
||||
var rmPinCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Removes the pinned object from local storage. (By default, recursively. Use -r=false for direct pins)",
|
||||
Tagline: "Removes the pinned object from local storage. (By default, recursively. Use -r=false for direct pins).",
|
||||
ShortDescription: `
|
||||
Removes the pin from the given object allowing it to be garbage
|
||||
collected if needed. (By default, recursively. Use -r=false for direct pins)
|
||||
@ -155,7 +155,7 @@ collected if needed. (By default, recursively. Use -r=false for direct pins)
|
||||
|
||||
var listPinCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "List objects pinned to local storage",
|
||||
Tagline: "List objects pinned to local storage.",
|
||||
ShortDescription: `
|
||||
Returns a list of objects that are pinned locally.
|
||||
By default, only recursively pinned returned, but others may be shown via the '--type' flag.
|
||||
|
@ -27,7 +27,7 @@ type PingResult struct {
|
||||
|
||||
var PingCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "send echo request packets to IPFS hosts",
|
||||
Tagline: "Send echo request packets to IPFS hosts.",
|
||||
Synopsis: `
|
||||
Send pings to a peer using the routing system to discover its address
|
||||
`,
|
||||
|
@ -20,7 +20,7 @@ var errNotOnline = errors.New("This command must be run in online mode. Try runn
|
||||
|
||||
var PublishCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Publish an object to IPNS",
|
||||
Tagline: "Publish an object to IPNS.",
|
||||
ShortDescription: `
|
||||
IPNS is a PKI namespace, where names are the hashes of public keys, and
|
||||
the private key enables publishing new (signed) values. In publish, the
|
||||
|
@ -33,7 +33,7 @@ func KeyListTextMarshaler(res cmds.Response) (io.Reader, error) {
|
||||
|
||||
var RefsCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Lists links (references) from an object",
|
||||
Tagline: "Lists links (references) from an object.",
|
||||
ShortDescription: `
|
||||
Retrieves the object named by <ipfs-path> and displays the link
|
||||
hashes it contains, with the following format:
|
||||
@ -150,7 +150,7 @@ Note: list all refs recursively with -r.
|
||||
|
||||
var RefsLocalCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Lists all local references",
|
||||
Tagline: "Lists all local references.",
|
||||
ShortDescription: `
|
||||
Displays the hashes of all local objects.
|
||||
`,
|
||||
|
@ -12,7 +12,7 @@ import (
|
||||
|
||||
var RepoCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Manipulate the IPFS repo",
|
||||
Tagline: "Manipulate the IPFS repo.",
|
||||
ShortDescription: `
|
||||
'ipfs repo' is a plumbing command used to manipulate the repo.
|
||||
`,
|
||||
@ -25,7 +25,7 @@ var RepoCmd = &cmds.Command{
|
||||
|
||||
var repoGcCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Perform a garbage collection sweep on the repo",
|
||||
Tagline: "Perform a garbage collection sweep on the repo.",
|
||||
ShortDescription: `
|
||||
'ipfs repo gc' is a plumbing command that will sweep the local
|
||||
set of stored objects and remove ones that are not pinned in
|
||||
|
@ -16,7 +16,7 @@ type ResolvedPath struct {
|
||||
|
||||
var ResolveCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Resolve the value of names to IPFS",
|
||||
Tagline: "Resolve the value of names to IPFS.",
|
||||
ShortDescription: `
|
||||
There are a number of mutable name protocols that can link among
|
||||
themselves and into IPNS. This command accepts any of these
|
||||
|
@ -24,7 +24,7 @@ const (
|
||||
|
||||
var Root = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "global p2p merkle-dag filesystem",
|
||||
Tagline: "Global p2p merkle-dag filesystem.",
|
||||
Synopsis: `
|
||||
ipfs [<flags>] <command> [<arg>] ...
|
||||
`,
|
||||
|
@ -18,7 +18,7 @@ import (
|
||||
|
||||
var StatsCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Query IPFS statistics",
|
||||
Tagline: "Query IPFS statistics.",
|
||||
ShortDescription: ``,
|
||||
},
|
||||
|
||||
@ -29,7 +29,7 @@ var StatsCmd = &cmds.Command{
|
||||
|
||||
var statBwCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Print ipfs bandwidth information",
|
||||
Tagline: "Print ipfs bandwidth information.",
|
||||
ShortDescription: ``,
|
||||
},
|
||||
Options: []cmds.Option{
|
||||
|
@ -27,7 +27,7 @@ type addrMap struct {
|
||||
|
||||
var SwarmCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "swarm inspection tool",
|
||||
Tagline: "Swarm inspection tool.",
|
||||
Synopsis: `
|
||||
ipfs swarm peers - List peers with open connections
|
||||
ipfs swarm addrs - List known addresses. Useful to debug.
|
||||
@ -52,7 +52,7 @@ ipfs peers in the internet.
|
||||
|
||||
var swarmPeersCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "List peers with open connections",
|
||||
Tagline: "List peers with open connections.",
|
||||
ShortDescription: `
|
||||
ipfs swarm peers lists the set of peers this node is connected to.
|
||||
`,
|
||||
@ -197,7 +197,7 @@ ipfs swarm addrs local lists all local addresses the node is listening on.
|
||||
|
||||
var swarmConnectCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Open connection to a given address",
|
||||
Tagline: "Open connection to a given address.",
|
||||
ShortDescription: `
|
||||
'ipfs swarm connect' opens a new direct connection to a peer address.
|
||||
|
||||
@ -253,7 +253,7 @@ ipfs swarm connect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3
|
||||
|
||||
var swarmDisconnectCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Close connection to a given address",
|
||||
Tagline: "Close connection to a given address.",
|
||||
ShortDescription: `
|
||||
'ipfs swarm disconnect' closes a connection to a peer address. The address format
|
||||
is an ipfs multiaddr:
|
||||
@ -364,7 +364,7 @@ func peersWithAddresses(addrs []string) (pis []peer.PeerInfo, err error) {
|
||||
|
||||
var swarmFiltersCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Manipulate address filters",
|
||||
Tagline: "Manipulate address filters.",
|
||||
ShortDescription: `
|
||||
'ipfs swarm filters' will list out currently applied filters. Its subcommands can be used
|
||||
to add or remove said filters. Filters are specified using the multiaddr-filter format:
|
||||
@ -421,7 +421,7 @@ Filters default to those specified under the "Swarm.AddrFilters" config key.
|
||||
|
||||
var swarmFiltersAddCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "add an address filter",
|
||||
Tagline: "Add an address filter.",
|
||||
ShortDescription: `
|
||||
'ipfs swarm filters add' will add an address filter to the daemons swarm.
|
||||
Filters applied this way will not persist daemon reboots, to acheive that,
|
||||
@ -463,7 +463,7 @@ add your filters to the ipfs config file.
|
||||
|
||||
var swarmFiltersRmCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "remove an address filter",
|
||||
Tagline: "Remove an address filter.",
|
||||
ShortDescription: `
|
||||
'ipfs swarm filters rm' will remove an address filter from the daemons swarm.
|
||||
Filters removed this way will not persist daemon reboots, to acheive that,
|
||||
|
@ -13,7 +13,7 @@ import (
|
||||
|
||||
var TarCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "utility functions for tar files in ipfs",
|
||||
Tagline: "Utility functions for tar files in ipfs.",
|
||||
},
|
||||
|
||||
Subcommands: map[string]*cmds.Command{
|
||||
@ -24,7 +24,7 @@ var TarCmd = &cmds.Command{
|
||||
|
||||
var tarAddCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "import a tar file into ipfs",
|
||||
Tagline: "Import a tar file into ipfs.",
|
||||
ShortDescription: `
|
||||
'ipfs tar add' will parse a tar file and create a merkledag structure to represent it.
|
||||
`,
|
||||
@ -75,7 +75,7 @@ var tarAddCmd = &cmds.Command{
|
||||
|
||||
var tarCatCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "export a tar file from ipfs",
|
||||
Tagline: "Export a tar file from ipfs.",
|
||||
ShortDescription: `
|
||||
'ipfs tar cat' will export a tar file from a previously imported one in ipfs
|
||||
`,
|
||||
|
@ -14,7 +14,7 @@ import (
|
||||
|
||||
var tourCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "An introduction to IPFS",
|
||||
Tagline: "An introduction to IPFS.",
|
||||
ShortDescription: `
|
||||
This is a tour that takes you through various IPFS concepts,
|
||||
features, and tools to make sure you get up to speed with
|
||||
@ -73,7 +73,7 @@ func tourRunFunc(req cmds.Request, res cmds.Response) {
|
||||
|
||||
var cmdIpfsTourNext = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Show the next IPFS Tour topic",
|
||||
Tagline: "Show the next IPFS Tour topic.",
|
||||
},
|
||||
|
||||
Run: func(req cmds.Request, res cmds.Response) {
|
||||
@ -112,7 +112,7 @@ var cmdIpfsTourNext = &cmds.Command{
|
||||
|
||||
var cmdIpfsTourRestart = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Restart the IPFS Tour",
|
||||
Tagline: "Restart the IPFS Tour.",
|
||||
},
|
||||
|
||||
Run: func(req cmds.Request, res cmds.Response) {
|
||||
@ -134,7 +134,7 @@ var cmdIpfsTourRestart = &cmds.Command{
|
||||
|
||||
var cmdIpfsTourList = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Show a list of IPFS Tour topics",
|
||||
Tagline: "Show a list of IPFS Tour topics.",
|
||||
},
|
||||
|
||||
Run: func(req cmds.Request, res cmds.Response) {
|
||||
|
@ -34,7 +34,7 @@ type LsOutput struct {
|
||||
|
||||
var LsCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "List directory contents for Unix-filesystem objects",
|
||||
Tagline: "List directory contents for Unix-filesystem objects.",
|
||||
ShortDescription: `
|
||||
Retrieves the object named by <ipfs-or-ipns-path> and displays the
|
||||
contents.
|
||||
|
@ -4,7 +4,7 @@ import cmds "github.com/ipfs/go-ipfs/commands"
|
||||
|
||||
var UnixFSCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Interact with ipfs objects representing Unix filesystems",
|
||||
Tagline: "Interact with ipfs objects representing Unix filesystems.",
|
||||
ShortDescription: `
|
||||
'ipfs file' provides a familar interface to filesystems represtented
|
||||
by IPFS objects that hides IPFS-implementation details like layout
|
||||
|
@ -18,7 +18,7 @@ type VersionOutput struct {
|
||||
|
||||
var VersionCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Shows ipfs version information",
|
||||
Tagline: "Shows ipfs version information.",
|
||||
ShortDescription: "Returns the current version of ipfs and exits.",
|
||||
},
|
||||
|
||||
|
Reference in New Issue
Block a user