mirror of
https://github.com/ipfs/kubo.git
synced 2025-06-17 08:33:44 +08:00
Make all Taglines use imperative mood
License: MIT Signed-off-by: Jesse Weinstein <jesse@wefu.org>
This commit is contained in:
@ -16,7 +16,7 @@ import (
|
||||
|
||||
var BitswapCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "A set of commands to manipulate the bitswap agent.",
|
||||
Tagline: "Interact with the bitswap agent.",
|
||||
ShortDescription: ``,
|
||||
},
|
||||
Subcommands: map[string]*cmds.Command{
|
||||
|
@ -26,7 +26,7 @@ func (bs BlockStat) String() string {
|
||||
|
||||
var BlockCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Manipulate raw IPFS blocks.",
|
||||
Tagline: "Interact with 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
|
||||
@ -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: "Store 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.
|
||||
|
@ -181,7 +181,7 @@ in the bootstrap list).`,
|
||||
|
||||
var bootstrapRemoveCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Removes peers from the bootstrap list.",
|
||||
Tagline: "Remove peers from the bootstrap list.",
|
||||
ShortDescription: `Outputs the list of peers that were removed.
|
||||
` + bootstrapSecurityWarning,
|
||||
},
|
||||
@ -250,7 +250,7 @@ var bootstrapRemoveCmd = &cmds.Command{
|
||||
|
||||
var bootstrapRemoveAllCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Removes all peers from the bootstrap list.",
|
||||
Tagline: "Remove all peers from the bootstrap list.",
|
||||
ShortDescription: `Outputs the list of peers that were removed.`,
|
||||
},
|
||||
|
||||
|
@ -135,7 +135,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: "Output config file contents.",
|
||||
ShortDescription: `
|
||||
WARNING: Your private key is stored in the config file, and it will be
|
||||
included in the output of this command.
|
||||
@ -182,7 +182,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: "Open 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.
|
||||
@ -205,7 +205,7 @@ variable set to your preferred text editor.
|
||||
|
||||
var configReplaceCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Replaces the config with <file>.",
|
||||
Tagline: "Replace the config with <file>.",
|
||||
ShortDescription: `
|
||||
Make sure to back up the config file first if neccessary, as this operation
|
||||
can't be undone.
|
||||
|
@ -42,7 +42,7 @@ var DefaultDiagnosticTimeout = time.Second * 20
|
||||
|
||||
var DiagCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Generates diagnostic reports.",
|
||||
Tagline: "Generate diagnostic reports.",
|
||||
},
|
||||
|
||||
Subcommands: map[string]*cmds.Command{
|
||||
@ -54,7 +54,7 @@ var DiagCmd = &cmds.Command{
|
||||
|
||||
var diagNetCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Generates a network diagnostics report.",
|
||||
Tagline: "Generate 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: "Resolve DNS links.",
|
||||
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: "Interact with unixfs files.",
|
||||
ShortDescription: `
|
||||
Files is an API for manipulating IPFS objects as if they were a unix
|
||||
filesystem.
|
||||
|
@ -13,7 +13,7 @@ import (
|
||||
|
||||
var IpnsCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Gets the value currently published at an IPNS name.",
|
||||
Tagline: "Get 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
|
||||
|
@ -9,7 +9,7 @@ import (
|
||||
|
||||
var MountCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Mounts IPFS to the filesystem (disabled).",
|
||||
Tagline: "Mount 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
|
||||
|
@ -15,7 +15,7 @@ import (
|
||||
|
||||
var MountCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Mounts IPFS to the filesystem (read-only).",
|
||||
Tagline: "Mount IPFS to the filesystem (read-only).",
|
||||
ShortDescription: `
|
||||
Mount ipfs at a read-only mountpoint on the OS (default: /ipfs and /ipns).
|
||||
All ipfs objects will be accessible under that directory. Note that the
|
||||
|
@ -9,7 +9,7 @@ type IpnsEntry struct {
|
||||
|
||||
var NameCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "IPFS namespace (IPNS) tool.",
|
||||
Tagline: "Interact with the IPFS namespace (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 both publish
|
||||
|
@ -17,7 +17,7 @@ type Changes struct {
|
||||
|
||||
var ObjectDiffCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Takes a diff of the two given objects.",
|
||||
Tagline: "Display the diff between two ipfs objects.",
|
||||
ShortDescription: `
|
||||
'ipfs object diff' is a command used to show the differences between
|
||||
two ipfs objects.`,
|
||||
|
@ -63,7 +63,7 @@ directly.`,
|
||||
|
||||
var ObjectDataCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Outputs the raw bytes in an IPFS object.",
|
||||
Tagline: "Output the raw bytes of an IPFS object.",
|
||||
ShortDescription: `
|
||||
'ipfs object data' is a plumbing command for retrieving the raw bytes stored
|
||||
in a DAG node. It outputs to stdout, and <key> is a base58 encoded multihash.
|
||||
@ -99,7 +99,7 @@ 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: "Output the links pointed to by the specified object.",
|
||||
ShortDescription: `
|
||||
'ipfs object links' is a plumbing command for retrieving the links from
|
||||
a DAG node. It outputs to stdout, and <key> is a base58 encoded
|
||||
@ -293,7 +293,7 @@ var ObjectStatCmd = &cmds.Command{
|
||||
|
||||
var ObjectPutCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Stores input as a DAG object, outputs its key.",
|
||||
Tagline: "Store input as a DAG object, print 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.
|
||||
@ -384,7 +384,7 @@ And then run:
|
||||
|
||||
var ObjectNewCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Creates a new object from an ipfs template.",
|
||||
Tagline: "Create a new object from an ipfs template.",
|
||||
ShortDescription: `
|
||||
'ipfs object new' is a plumbing command for creating new DAG nodes.
|
||||
`,
|
||||
|
@ -34,7 +34,7 @@ type PinOutput struct {
|
||||
|
||||
var addPinCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Pins objects to local storage.",
|
||||
Tagline: "Pin objects to local storage.",
|
||||
ShortDescription: "Stores an IPFS object(s) from a given path locally to disk.",
|
||||
},
|
||||
|
||||
@ -95,7 +95,7 @@ var addPinCmd = &cmds.Command{
|
||||
|
||||
var rmPinCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Removes the pinned object from local storage.",
|
||||
Tagline: "Remove pinned objects from local storage.",
|
||||
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)
|
||||
|
@ -32,7 +32,7 @@ func KeyListTextMarshaler(res cmds.Response) (io.Reader, error) {
|
||||
|
||||
var RefsCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Lists links (references) from an object.",
|
||||
Tagline: "List links (references) from an object.",
|
||||
ShortDescription: `
|
||||
Lists the hashes of all the links an IPFS or IPNS object(s) contains,
|
||||
with the following format:
|
||||
@ -130,7 +130,7 @@ NOTE: List all references recursively by using the flag '-r'.
|
||||
|
||||
var RefsLocalCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Lists all local references.",
|
||||
Tagline: "List all local references.",
|
||||
ShortDescription: `
|
||||
Displays the hashes of all local objects.
|
||||
`,
|
||||
|
@ -24,7 +24,7 @@ type RepoVersion struct {
|
||||
|
||||
var RepoCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Manipulate the IPFS repo.",
|
||||
Tagline: "Interact with the IPFS repo.",
|
||||
ShortDescription: `
|
||||
'ipfs repo' is a plumbing command used to manipulate the repo.
|
||||
`,
|
||||
@ -172,7 +172,7 @@ Version string The repo version.
|
||||
|
||||
var RepoFsckCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Removes repo lockfiles.",
|
||||
Tagline: "Remove repo lockfiles.",
|
||||
ShortDescription: `
|
||||
'ipfs repo fsck' is a plumbing command that will remove repo and level db
|
||||
lockfiles, as well as the api file. This command can only run when no ipfs
|
||||
|
@ -30,7 +30,7 @@ type addrMap struct {
|
||||
|
||||
var SwarmCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Swarm inspection tool.",
|
||||
Tagline: "Interact with the swarm.",
|
||||
ShortDescription: `
|
||||
'ipfs swarm' is a tool to manipulate the network swarm. The swarm is the
|
||||
component that opens, listens for, and maintains connections to other
|
||||
|
@ -14,7 +14,7 @@ import (
|
||||
|
||||
var sysDiagCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Prints out system diagnostic information.",
|
||||
Tagline: "Print system diagnostic information.",
|
||||
ShortDescription: `
|
||||
Prints out information about your computer to aid in easier debugging.
|
||||
`,
|
||||
|
@ -13,7 +13,7 @@ import (
|
||||
|
||||
var TarCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Utility functions for tar files in IPFS.",
|
||||
Tagline: "Interact with tar files in IPFS.",
|
||||
},
|
||||
|
||||
Subcommands: map[string]*cmds.Command{
|
||||
|
@ -14,7 +14,7 @@ import (
|
||||
|
||||
var tourCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "An introduction to IPFS.",
|
||||
Tagline: "Provide 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
|
||||
|
@ -21,7 +21,7 @@ type VersionOutput struct {
|
||||
|
||||
var VersionCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Shows ipfs version information.",
|
||||
Tagline: "Show ipfs version information.",
|
||||
ShortDescription: "Returns the current version of ipfs and exits.",
|
||||
},
|
||||
|
||||
|
Reference in New Issue
Block a user