docs: cosmetic fixes of help text

Unfortunately, API docs are genereted from go-ipfs sources
via https://github.com/ipfs/http-api-docs
so it all gets lost when API docs for new version are re-generated.

This re-applies manual fixes from:
https://docs.ipfs.io/reference/http/api/
so the next time http-api-docs are re-generated, those changes stay.

README.md

@@ -288,10 +288,10 @@ Basic proof of 'ipfs working' locally:
 
 SUBCOMMANDS
   BASIC COMMANDS
-    init          Initialize ipfs local configuration
-    add <path>    Add a file to ipfs
-    cat <ref>     Show ipfs object data
-    get <ref>     Download ipfs objects
+    init          Initialize local IPFS configuration
+    add <path>    Add a file to IPFS
+    cat <ref>     Show IPFS object data
+    get <ref>     Download IPFS objects
     ls <ref>      List links from an object
     refs <ref>    List hashes of links from an object
 
@@ -302,7 +302,7 @@ SUBCOMMANDS
 
   ADVANCED COMMANDS
     daemon        Start a long-running daemon process
-    mount         Mount an ipfs read-only mount point
+    mount         Mount an IPFS read-only mount point
     resolve       Resolve any type of name
     name          Publish or resolve IPNS names
     dns           Resolve DNS links
@@ -310,7 +310,7 @@ SUBCOMMANDS
     repo          Manipulate an IPFS repository
 
   NETWORK COMMANDS
-    id            Show info about ipfs peers
+    id            Show info about IPFS peers
     bootstrap     Add or remove bootstrap peers
     swarm         Manage connections to the p2p network
     dht           Query the DHT for values or peers
@@ -319,7 +319,7 @@ SUBCOMMANDS
 
   TOOL COMMANDS
     config        Manage configuration
-    version       Show ipfs version information
+    version       Show IPFS version information
     update        Download and apply go-ipfs updates
     commands      List all available commands
 

core/commands/add.go

@@ -51,13 +51,13 @@ const adderOutChanSize = 8
 
 var AddCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Add a file or directory to ipfs.",
+		Tagline: "Add a file or directory to IPFS.",
 		ShortDescription: `
-Adds contents of <path> to ipfs. Use -r to add directories (recursively).
+Adds contents of <path> to IPFS. Use -r to add directories (recursively).
 `,
 		LongDescription: `
-Adds contents of <path> to ipfs. Use -r to add directories.
-Note that directories are added recursively, to form the ipfs
+Adds contents of <path> to IPFS. Use -r to add directories.
+Note that directories are added recursively, to form the IPFS
 MerkleDAG.
 
 If the daemon is not running, it will just add locally.
@@ -115,7 +115,7 @@ only-hash, and progress/status related flags) will change the final hash.
 	},
 
 	Arguments: []cmds.Argument{
-		cmds.FileArg("path", true, true, "The path to a file to be added to ipfs.").EnableRecursive().EnableStdin(),
+		cmds.FileArg("path", true, true, "The path to a file to be added to IPFS.").EnableRecursive().EnableStdin(),
 	},
 	Options: []cmds.Option{
 		cmds.OptionRecursivePath, // a builtin option that allows recursive paths (-r, --recursive)

core/commands/config.go

@@ -38,10 +38,10 @@ const (
 
 var ConfigCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Get and set ipfs config values.",
+		Tagline: "Get and set IPFS config values.",
 		ShortDescription: `
 'ipfs config' controls configuration variables. It works like 'git config'.
-The configuration values are stored in a config file inside your ipfs
+The configuration values are stored in a config file inside your IPFS_PATH
 repository.`,
 		LongDescription: `
 'ipfs config' controls configuration variables. It works

core/commands/dag/dag.go

@@ -24,9 +24,9 @@ const (
 // DagCmd provides a subset of commands for interacting with ipld dag objects
 var DagCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Interact with ipld dag objects.",
+		Tagline: "Interact with IPLD DAG objects.",
 		ShortDescription: `
-'ipfs dag' is used for creating and manipulating dag objects/hierarchies.
+'ipfs dag' is used for creating and manipulating DAG objects/hierarchies.
 
 This subcommand is currently an experimental feature, but it is intended
 to deprecate and replace the existing 'ipfs object' command moving forward.
@@ -67,7 +67,7 @@ type RootMeta struct {
 // DagPutCmd is a command for adding a dag node
 var DagPutCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Add a dag node to ipfs.",
+		Tagline: "Add a DAG node to IPFS.",
 		ShortDescription: `
 'ipfs dag put' accepts input from a file or stdin and parses it
 into an object of the specified format.
@@ -99,9 +99,9 @@ into an object of the specified format.
 // DagGetCmd is a command for getting a dag node from IPFS
 var DagGetCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Get a dag node from ipfs.",
+		Tagline: "Get a DAG node from IPFS.",
 		ShortDescription: `
-'ipfs dag get' fetches a dag node from ipfs and prints it out in the specified
+'ipfs dag get' fetches a DAG node from IPFS and prints it out in the specified
 format.
 `,
 	},
@@ -114,9 +114,9 @@ format.
 // DagResolveCmd returns address of highest block within a path and a path remainder
 var DagResolveCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Resolve ipld block",
+		Tagline: "Resolve IPLD block.",
 		ShortDescription: `
-'ipfs dag resolve' fetches a dag node from ipfs, prints its address and remaining path.
+'ipfs dag resolve' fetches a DAG node from IPFS, prints its address and remaining path.
 `,
 	},
 	Arguments: []cmds.Argument{
@@ -230,7 +230,7 @@ var DagExportCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
 		Tagline: "Streams the selected DAG as a .car stream on stdout.",
 		ShortDescription: `
-'ipfs dag export' fetches a dag and streams it out as a well-formed .car file.
+'ipfs dag export' fetches a DAG and streams it out as a well-formed .car file.
 Note that at present only single root selections / .car files are supported.
 The output of blocks happens in strict DAG-traversal, first-seen, order.
 `,
@@ -260,9 +260,9 @@ func (s *DagStat) String() string {
 // DagStatCmd is a command for getting size information about an ipfs-stored dag
 var DagStatCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Gets stats for a DAG",
+		Tagline: "Gets stats for a DAG.",
 		ShortDescription: `
-'ipfs dag stat' fetches a dag and returns various statistics about the DAG.
+'ipfs dag stat' fetches a DAG and returns various statistics about it.
 Statistics include size and number of blocks.
 
 Note: This command skips duplicate blocks in reporting both size and the number of blocks

core/commands/files.go

@@ -10,10 +10,10 @@ import (
 	"sort"
 	"strings"
 
+	humanize "github.com/dustin/go-humanize"
 	"github.com/ipfs/go-ipfs/core"
 	"github.com/ipfs/go-ipfs/core/commands/cmdenv"
 
-	"github.com/dustin/go-humanize"
 	bservice "github.com/ipfs/go-blockservice"
 	cid "github.com/ipfs/go-cid"
 	cidenc "github.com/ipfs/go-cidutil/cidenc"
@@ -22,7 +22,7 @@ import (
 	ipld "github.com/ipfs/go-ipld-format"
 	logging "github.com/ipfs/go-log"
 	dag "github.com/ipfs/go-merkledag"
-	"github.com/ipfs/go-mfs"
+	mfs "github.com/ipfs/go-mfs"
 	ft "github.com/ipfs/go-unixfs"
 	iface "github.com/ipfs/interface-go-ipfs-core"
 	path "github.com/ipfs/interface-go-ipfs-core/path"
@@ -943,9 +943,9 @@ are run with the '--flush=false'.
 
 var filesChcidCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Change the cid version or hash function of the root node of a given path.",
+		Tagline: "Change the CID version or hash function of the root node of a given path.",
 		ShortDescription: `
-Change the cid version or hash function of the root node of a given path.
+Change the CID version or hash function of the root node of a given path.
 `,
 	},
 	Arguments: []cmds.Argument{

core/commands/id.go

@@ -48,7 +48,7 @@ const (
 
 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 information for local peers.

core/commands/keystore.go

@@ -300,7 +300,7 @@ var keyImportCmd = &cmds.Command{
 
 var keyListCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "List all local keypairs",
+		Tagline: "List all local keypairs.",
 	},
 	Options: []cmds.Option{
 		cmds.BoolOption("l", "Show extra information about keys."),
@@ -345,7 +345,7 @@ const (
 
 var keyRenameCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Rename a keypair",
+		Tagline: "Rename a keypair.",
 	},
 	Arguments: []cmds.Argument{
 		cmds.StringArg("name", true, false, "name of key to rename"),
@@ -396,7 +396,7 @@ var keyRenameCmd = &cmds.Command{
 
 var keyRmCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Remove a keypair",
+		Tagline: "Remove a keypair.",
 	},
 	Arguments: []cmds.Argument{
 		cmds.StringArg("name", true, true, "names of keys to remove").EnableStdin(),
@@ -440,7 +440,7 @@ var keyRmCmd = &cmds.Command{
 
 var keyRotateCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Rotates the ipfs identity.",
+		Tagline: "Rotates the IPFS identity.",
 		ShortDescription: `
 Generates a new ipfs identity and saves it to the ipfs config file.
 Your existing identity key will be backed up in the Keystore.

core/commands/name/ipnsps.go

@@ -43,7 +43,7 @@ Note: this command is experimental and subject to change as the system is refine
 
 var ipnspsStateCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Query the state of IPNS pubsub",
+		Tagline: "Query the state of IPNS pubsub.",
 	},
 	Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
 		n, err := cmdenv.GetNode(env)
@@ -71,7 +71,7 @@ var ipnspsStateCmd = &cmds.Command{
 
 var ipnspsSubsCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Show current name subscriptions",
+		Tagline: "Show current name subscriptions.",
 	},
 	Options: []cmds.Option{
 		ke.OptionIPNSBase,
@@ -115,7 +115,7 @@ var ipnspsSubsCmd = &cmds.Command{
 
 var ipnspsCancelCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Cancel a name subscription",
+		Tagline: "Cancel a name subscription.",
 	},
 	Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
 		n, err := cmdenv.GetNode(env)

core/commands/object/diff.go

@@ -21,7 +21,7 @@ type Changes struct {
 
 var ObjectDiffCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Display the diff between two ipfs 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.`,

core/commands/object/object.go

@@ -8,11 +8,11 @@ import (
 	"io/ioutil"
 	"text/tabwriter"
 
+	cmds "github.com/ipfs/go-ipfs-cmds"
 	"github.com/ipfs/go-ipfs/core/commands/cmdenv"
 
 	humanize "github.com/dustin/go-humanize"
 	"github.com/ipfs/go-cid"
-	"github.com/ipfs/go-ipfs-cmds"
 	ipld "github.com/ipfs/go-ipld-format"
 	dag "github.com/ipfs/go-merkledag"
 	"github.com/ipfs/interface-go-ipfs-core/options"
@@ -466,7 +466,7 @@ And then run:
 // ObjectNewCmd object new command
 var ObjectNewCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Create 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.
 `,

core/commands/object/patch.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 	"io"
 
+	cmds "github.com/ipfs/go-ipfs-cmds"
 	"github.com/ipfs/go-ipfs/core/commands/cmdenv"
 
-	"github.com/ipfs/go-ipfs-cmds"
 	"github.com/ipfs/interface-go-ipfs-core/options"
 	"github.com/ipfs/interface-go-ipfs-core/path"
 )
@@ -31,7 +31,7 @@ result. This is the Merkle-DAG version of modifying an object.
 
 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.
 

core/commands/p2p.go

@@ -79,7 +79,7 @@ are refined`,
 
 var p2pForwardCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Forward connections to libp2p service",
+		Tagline: "Forward connections to libp2p service.",
 		ShortDescription: `
 Forward connections made to <listen-address> to <target-address>.
 
@@ -180,7 +180,7 @@ func parseIpfsAddr(addr string) (*peer.AddrInfo, error) {
 
 var p2pListenCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Create libp2p service",
+		Tagline: "Create libp2p service.",
 		ShortDescription: `
 Create libp2p service and forward connections made to <target-address>.
 

core/commands/pin/pin.go

@@ -523,7 +523,7 @@ const (
 
 var updatePinCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Update a recursive pin",
+		Tagline: "Update a recursive pin.",
 		ShortDescription: `
 Efficiently pins a new object based on differences from an existing one and,
 by default, removes the old pin.

core/commands/root.go

@@ -68,7 +68,7 @@ NETWORK COMMANDS
 
 TOOL COMMANDS
   config        Manage configuration
-  version       Show ipfs version information
+  version       Show IPFS version information
   update        Download and apply go-ipfs updates
   commands      List all available commands
   cid           Convert and discover properties of CIDs

core/commands/shutdown.go

@@ -1,14 +1,13 @@
 package commands
 
 import (
+	cmds "github.com/ipfs/go-ipfs-cmds"
 	cmdenv "github.com/ipfs/go-ipfs/core/commands/cmdenv"
-
-	"github.com/ipfs/go-ipfs-cmds"
 )
 
 var daemonShutdownCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Shut down the ipfs daemon",
+		Tagline: "Shut down the IPFS daemon.",
 	},
 	Run: func(req *cmds.Request, re cmds.ResponseEmitter, env cmds.Environment) error {
 		nd, err := cmdenv.GetNode(env)

core/commands/stat.go

@@ -42,7 +42,7 @@ const (
 
 var statBwCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Print ipfs bandwidth information.",
+		Tagline: "Print IPFS bandwidth information.",
 		ShortDescription: `'ipfs stats bw' prints bandwidth information for the ipfs daemon.
 It displays: TotalIn, TotalOut, RateIn, RateOut.
 		`,

core/commands/stat_dht.go

@@ -35,7 +35,7 @@ type dhtBucket struct {
 
 var statDhtCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Returns statistics about the node's DHT(s)",
+		Tagline: "Returns statistics about the node's DHT(s).",
 		ShortDescription: `
 Returns statistics about the DHT(s) the node is participating in.
 

core/commands/tar.go

@@ -4,10 +4,10 @@ import (
 	"fmt"
 	"io"
 
+	cmds "github.com/ipfs/go-ipfs-cmds"
 	"github.com/ipfs/go-ipfs/core/commands/cmdenv"
 	tar "github.com/ipfs/go-ipfs/tar"
 
-	"github.com/ipfs/go-ipfs-cmds"
 	dag "github.com/ipfs/go-merkledag"
 	path "github.com/ipfs/interface-go-ipfs-core/path"
 )
@@ -25,7 +25,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.

core/commands/version.go

@@ -30,8 +30,8 @@ const (
 
 var VersionCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline:          "Show ipfs version information.",
-		ShortDescription: "Returns the current version of ipfs and exits.",
+		Tagline:          "Show IPFS version information.",
+		ShortDescription: "Returns the current version of IPFS and exits.",
 	},
 	Subcommands: map[string]*cmds.Command{
 		"deps": depsVersionCommand,
@@ -105,7 +105,7 @@ const pkgVersionFmt = "%s@%s"
 
 var depsVersionCommand = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Shows information about dependencies used for build",
+		Tagline: "Shows information about dependencies used for build.",
 		ShortDescription: `
 Print out all dependencies and their versions.`,
 	},