@cryptotaxi247 / kubo / commits / 21e39240a

Fix punc-caps issues of cli Tagline

License: MIT Signed-off-by: rht <rhtbot@gmail.com>

rht committed Jan 22, 2016 at 02:14 UTC 21e39240abaff2b8dadbb543fd8ba56d663702e8
34 files changed +86 -86
cmd/ipfs/daemon.go
+1 -1
@@ -44,7 +44,7 @@ const (
44
45 var daemonCmd = &cmds.Command{
46 Helptext: cmds.HelpText{
47 - Tagline: "Run a network-connected IPFS node",
47 + Tagline: "Run a network-connected IPFS node.",
48 ShortDescription: `
49 'ipfs daemon' runs a persistent IPFS daemon that can serve commands
50 over the network. Most applications that use IPFS will do so by
cmd/ipfs/init.go
+1 -1
@@ -20,7 +20,7 @@ const nBitsForKeypairDefault = 2048
20
21 var initCmd = &cmds.Command{
22 Helptext: cmds.HelpText{
23 - Tagline: "Initializes IPFS config file",
23 + Tagline: "Initializes IPFS config file.",
24 ShortDescription: `
25 Initializes IPFS configuration files and generates a new keypair.
26
core/commands/block.go
+4 -4
@@ -26,7 +26,7 @@ func (bs BlockStat) String() string {
26
27 var BlockCmd = &cmds.Command{
28 Helptext: cmds.HelpText{
29 - Tagline: "Manipulate raw IPFS blocks",
29 + Tagline: "Manipulate raw IPFS blocks.",
30 ShortDescription: `
31 'ipfs block' is a plumbing command used to manipulate raw ipfs blocks.
32 Reads from stdin or writes to stdout, and <key> is a base58 encoded
@@ -43,7 +43,7 @@ multihash.
43
44 var blockStatCmd = &cmds.Command{
45 Helptext: cmds.HelpText{
46 - Tagline: "Print information of a raw IPFS block",
46 + Tagline: "Print information of a raw IPFS block.",
47 ShortDescription: `
48 'ipfs block stat' is a plumbing command for retreiving information
49 on raw ipfs blocks. It outputs the following to stdout:
@@ -80,7 +80,7 @@ on raw ipfs blocks. It outputs the following to stdout:
80
81 var blockGetCmd = &cmds.Command{
82 Helptext: cmds.HelpText{
83 - Tagline: "Get a raw IPFS block",
83 + Tagline: "Get a raw IPFS block.",
84 ShortDescription: `
85 'ipfs block get' is a plumbing command for retreiving raw ipfs blocks.
86 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.
103
104 var blockPutCmd = &cmds.Command{
105 Helptext: cmds.HelpText{
106 - Tagline: "Stores input as an IPFS block",
106 + Tagline: "Stores input as an IPFS block.",
107 ShortDescription: `
108 ipfs block put is a plumbing command for storing raw ipfs blocks.
109 It reads from stdin, and <key> is a base58 encoded multihash.
core/commands/bootstrap.go
+4 -4
@@ -21,7 +21,7 @@ var peerOptionDesc = "A peer to add to the bootstrap list (in the format '<multi
21
22 var BootstrapCmd = &cmds.Command{
23 Helptext: cmds.HelpText{
24 - Tagline: "Show or edit the list of bootstrap peers",
24 + Tagline: "Show or edit the list of bootstrap peers.",
25 Synopsis: `
26 ipfs bootstrap list - Show peers in the bootstrap list
27 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'.
45
46 var bootstrapAddCmd = &cmds.Command{
47 Helptext: cmds.HelpText{
48 - Tagline: "Add peers to the bootstrap list",
48 + Tagline: "Add peers to the bootstrap list.",
49 ShortDescription: `Outputs a list of peers that were added (that weren't already
50 in the bootstrap list).
51 ` + bootstrapSecurityWarning,
@@ -128,7 +128,7 @@ in the bootstrap list).
128
129 var bootstrapRemoveCmd = &cmds.Command{
130 Helptext: cmds.HelpText{
131 - Tagline: "Removes peers from the bootstrap list",
131 + Tagline: "Removes peers from the bootstrap list.",
132 ShortDescription: `Outputs the list of peers that were removed.
133 ` + bootstrapSecurityWarning,
134 },
@@ -194,7 +194,7 @@ var bootstrapRemoveCmd = &cmds.Command{
194
195 var bootstrapListCmd = &cmds.Command{
196 Helptext: cmds.HelpText{
197 - Tagline: "Show peers in the bootstrap list",
197 + Tagline: "Show peers in the bootstrap list.",
198 ShortDescription: "Peers are output in the format '<multiaddr>/<peerID>'.",
199 },
200
core/commands/cat.go
+1 -1
@@ -15,7 +15,7 @@ const progressBarMinSize = 1024 * 1024 * 8 // show progress bar for outputs > 8M
15
16 var CatCmd = &cmds.Command{
17 Helptext: cmds.HelpText{
18 - Tagline: "Show IPFS object data",
18 + Tagline: "Show IPFS object data.",
19 ShortDescription: `
20 Retrieves the object named by <ipfs-or-ipns-path> and outputs the data
21 it contains.
core/commands/config.go
+4 -4
@@ -24,7 +24,7 @@ type ConfigField struct {
24
25 var ConfigCmd = &cmds.Command{
26 Helptext: cmds.HelpText{
27 - Tagline: "get and set IPFS config values",
27 + Tagline: "get and set IPFS config values.",
28 Synopsis: `
29 ipfs config <key> - Get value of <key>
30 ipfs config <key> <value> - Set value of <key> to <value>
@@ -133,7 +133,7 @@ Set the value of the 'datastore.path' key:
133
134 var configShowCmd = &cmds.Command{
135 Helptext: cmds.HelpText{
136 - Tagline: "Outputs the content of the config file",
136 + Tagline: "Outputs the content of the config file.",
137 ShortDescription: `
138 WARNING: Your private key is stored in the config file, and it will be
139 included in the output of this command.
@@ -158,7 +158,7 @@ included in the output of this command.
158
159 var configEditCmd = &cmds.Command{
160 Helptext: cmds.HelpText{
161 - Tagline: "Opens the config file for editing in $EDITOR",
161 + Tagline: "Opens the config file for editing in $EDITOR.",
162 ShortDescription: `
163 To use 'ipfs config edit', you must have the $EDITOR environment
164 variable set to your preferred text editor.
@@ -181,7 +181,7 @@ variable set to your preferred text editor.
181
182 var configReplaceCmd = &cmds.Command{
183 Helptext: cmds.HelpText{
184 - Tagline: "Replaces the config with <file>",
184 + Tagline: "Replaces the config with <file>.",
185 ShortDescription: `
186 Make sure to back up the config file first if neccessary, this operation
187 can't be undone.
core/commands/dht.go
+6 -6
@@ -20,7 +20,7 @@ var ErrNotDHT = errors.New("routing service is not a DHT")
20
21 var DhtCmd = &cmds.Command{
22 Helptext: cmds.HelpText{
23 - Tagline: "Issue commands directly through the DHT",
23 + Tagline: "Issue commands directly through the DHT.",
24 ShortDescription: ``,
25 },
26
@@ -35,7 +35,7 @@ var DhtCmd = &cmds.Command{
35
36 var queryDhtCmd = &cmds.Command{
37 Helptext: cmds.HelpText{
38 - Tagline: "Run a 'findClosestPeers' query through the DHT",
38 + Tagline: "Run a 'findClosestPeers' query through the DHT.",
39 ShortDescription: ``,
40 },
41
@@ -119,7 +119,7 @@ var queryDhtCmd = &cmds.Command{
119
120 var findProvidersDhtCmd = &cmds.Command{
121 Helptext: cmds.HelpText{
122 - Tagline: "Run a 'FindProviders' query through the DHT",
122 + Tagline: "Run a 'FindProviders' query through the DHT.",
123 ShortDescription: `
124 FindProviders will return a list of peers who are able to provide the value requested.
125 `,
@@ -222,7 +222,7 @@ FindProviders will return a list of peers who are able to provide the value requ
222
223 var findPeerDhtCmd = &cmds.Command{
224 Helptext: cmds.HelpText{
225 - Tagline: "Run a 'FindPeer' query through the DHT",
225 + Tagline: "Run a 'FindPeer' query through the DHT.",
226 ShortDescription: ``,
227 },
228
@@ -317,7 +317,7 @@ var findPeerDhtCmd = &cmds.Command{
317
318 var getValueDhtCmd = &cmds.Command{
319 Helptext: cmds.HelpText{
320 - Tagline: "Run a 'GetValue' query through the DHT",
320 + Tagline: "Run a 'GetValue' query through the DHT.",
321 ShortDescription: `
322 GetValue will return the value stored in the dht at the given key.
323 `,
@@ -420,7 +420,7 @@ GetValue will return the value stored in the dht at the given key.
420
421 var putValueDhtCmd = &cmds.Command{
422 Helptext: cmds.HelpText{
423 - Tagline: "Run a 'PutValue' query through the DHT",
423 + Tagline: "Run a 'PutValue' query through the DHT.",
424 ShortDescription: `
425 PutValue will store the given key value pair in the dht.
426 `,
core/commands/diag.go
+2 -2
@@ -41,7 +41,7 @@ var DefaultDiagnosticTimeout = time.Second * 20
41
42 var DiagCmd = &cmds.Command{
43 Helptext: cmds.HelpText{
44 - Tagline: "Generates diagnostic reports",
44 + Tagline: "Generates diagnostic reports.",
45 },
46
47 Subcommands: map[string]*cmds.Command{
@@ -52,7 +52,7 @@ var DiagCmd = &cmds.Command{
52
53 var diagNetCmd = &cmds.Command{
54 Helptext: cmds.HelpText{
55 - Tagline: "Generates a network diagnostics report",
55 + Tagline: "Generates a network diagnostics report.",
56 ShortDescription: `
57 Sends out a message to each node in the network recursively
58 requesting a listing of data about them including number of
core/commands/dns.go
+1 -1
@@ -11,7 +11,7 @@ import (
11
12 var DNSCmd = &cmds.Command{
13 Helptext: cmds.HelpText{
14 - Tagline: "DNS link resolver",
14 + Tagline: "DNS link resolver.",
15 ShortDescription: `
16 Multihashes are hard to remember, but domain names are usually easy to
17 remember. To create memorable aliases for multihashes, DNS TXT
core/commands/files/files.go
+9 -9
@@ -24,7 +24,7 @@ var log = logging.Logger("cmds/files")
24
25 var FilesCmd = &cmds.Command{
26 Helptext: cmds.HelpText{
27 - Tagline: "Manipulate unixfs files",
27 + Tagline: "Manipulate unixfs files.",
28 ShortDescription: `
29 Files is an API for manipulating ipfs objects as if they were a unix filesystem.
30 `,
@@ -46,7 +46,7 @@ Files is an API for manipulating ipfs objects as if they were a unix filesystem.
46
47 var FilesStatCmd = &cmds.Command{
48 Helptext: cmds.HelpText{
49 - Tagline: "display file status",
49 + Tagline: "Display file status.",
50 },
51
52 Arguments: []cmds.Argument{
@@ -137,7 +137,7 @@ func statNode(ds dag.DAGService, fsn mfs.FSNode) (*Object, error) {
137
138 var FilesCpCmd = &cmds.Command{
139 Helptext: cmds.HelpText{
140 - Tagline: "copy files into mfs",
140 + Tagline: "Copy files into mfs.",
141 },
142 Arguments: []cmds.Argument{
143 cmds.StringArg("source", true, false, "source object to copy"),
@@ -208,7 +208,7 @@ type FilesLsOutput struct {
208
209 var FilesLsCmd = &cmds.Command{
210 Helptext: cmds.HelpText{
211 - Tagline: "List directories",
211 + Tagline: "List directories.",
212 ShortDescription: `
213 List directories.
214
@@ -310,7 +310,7 @@ Examples:
310
311 var FilesReadCmd = &cmds.Command{
312 Helptext: cmds.HelpText{
313 - Tagline: "Read a file in a given mfs",
313 + Tagline: "Read a file in a given mfs.",
314 ShortDescription: `
315 Read a specified number of bytes from a file at a given offset. By default, will
316 read the entire file similar to unix cat.
@@ -400,7 +400,7 @@ Examples:
400
401 var FilesMvCmd = &cmds.Command{
402 Helptext: cmds.HelpText{
403 - Tagline: "Move files",
403 + Tagline: "Move files.",
404 ShortDescription: `
405 Move files around. Just like traditional unix mv.
406
@@ -443,7 +443,7 @@ Example:
443
444 var FilesWriteCmd = &cmds.Command{
445 Helptext: cmds.HelpText{
446 - Tagline: "Write to a mutable file in a given filesystem",
446 + Tagline: "Write to a mutable file in a given filesystem.",
447 ShortDescription: `
448 Write data to a file in a given filesystem. This command allows you to specify
449 a beginning offset to write to. The entire length of the input will be written.
@@ -566,7 +566,7 @@ Warning:
566
567 var FilesMkdirCmd = &cmds.Command{
568 Helptext: cmds.HelpText{
569 - Tagline: "make directories",
569 + Tagline: "Make directories.",
570 ShortDescription: `
571 Create the directory if it does not already exist.
572
@@ -615,7 +615,7 @@ Examples:
615
616 var FilesRmCmd = &cmds.Command{
617 Helptext: cmds.HelpText{
618 - Tagline: "remove a file",
618 + Tagline: "Remove a file.",
619 ShortDescription: `
620 remove files or directories
621
core/commands/get.go
+1 -1
@@ -22,7 +22,7 @@ var ErrInvalidCompressionLevel = errors.New("Compression level must be between 1
22
23 var GetCmd = &cmds.Command{
24 Helptext: cmds.HelpText{
25 - Tagline: "Download IPFS objects",
25 + Tagline: "Download IPFS objects.",
26 ShortDescription: `
27 Retrieves the object named by <ipfs-or-ipns-path> and stores the data to disk.
28
core/commands/id.go
+1 -1
@@ -36,7 +36,7 @@ type IdOutput struct {
36
37 var IDCmd = &cmds.Command{
38 Helptext: cmds.HelpText{
39 - Tagline: "Show IPFS Node ID info",
39 + Tagline: "Show IPFS Node ID info.",
40 ShortDescription: `
41 Prints out information about the specified peer,
42 if no peer is specified, prints out local peers info.
core/commands/ipns.go
+1 -1
@@ -13,7 +13,7 @@ import (
13
14 var IpnsCmd = &cmds.Command{
15 Helptext: cmds.HelpText{
16 - Tagline: "Gets the value currently published at an IPNS name",
16 + Tagline: "Gets the value currently published at an IPNS name.",
17 ShortDescription: `
18 IPNS is a PKI namespace, where names are the hashes of public keys, and
19 the private key enables publishing new (signed) values. In resolve, the
core/commands/log.go
+3 -3
@@ -16,7 +16,7 @@ var logAllKeyword = "all"
16
17 var LogCmd = &cmds.Command{
18 Helptext: cmds.HelpText{
19 - Tagline: "Interact with the daemon log output",
19 + Tagline: "Interact with the daemon log output.",
20 ShortDescription: `
21 'ipfs log' contains utility commands to affect or read the logging
22 output of a running daemon.
@@ -31,7 +31,7 @@ output of a running daemon.
31
32 var logLevelCmd = &cmds.Command{
33 Helptext: cmds.HelpText{
34 - Tagline: "Change the logging level",
34 + Tagline: "Change the logging level.",
35 ShortDescription: `
36 'ipfs log level' is a utility command used to change the logging
37 output of a running daemon.
@@ -70,7 +70,7 @@ output of a running daemon.
70
71 var logTailCmd = &cmds.Command{
72 Helptext: cmds.HelpText{
73 - Tagline: "Read the logs",
73 + Tagline: "Read the logs.",
74 ShortDescription: `
75 'ipfs log tail' is a utility command used to read log output as it is written.
76 `,
core/commands/mount_nofuse.go
+1 -1
@@ -12,7 +12,7 @@ import (
12
13 var MountCmd = &cmds.Command{
14 Helptext: cmds.HelpText{
15 - Tagline: "Mounts IPFS to the filesystem (disabled)",
15 + Tagline: "Mounts IPFS to the filesystem (disabled).",
16 ShortDescription: `
17 This version of ipfs is compiled without fuse support, which is required
18 for mounting. If you'd like to be able to mount, please use a version of
core/commands/mount_unix.go
+1 -1
@@ -35,7 +35,7 @@ var platformFuseChecks = func(*core.IpfsNode) error {
35
36 var MountCmd = &cmds.Command{
37 Helptext: cmds.HelpText{
38 - Tagline: "Mounts IPFS to the filesystem (read-only)",
38 + Tagline: "Mounts IPFS to the filesystem (read-only).",
39 Synopsis: `
40 ipfs mount [-f <ipfs mount path>] [-n <ipns mount path>]
41 `,
core/commands/mount_windows.go
+1 -1
@@ -9,7 +9,7 @@ import (
9
10 var MountCmd = &cmds.Command{
11 Helptext: cmds.HelpText{
12 - Tagline: "Not yet implemented on Windows",
12 + Tagline: "Not yet implemented on Windows.",
13 ShortDescription: "Not yet implemented on Windows. :(",
14 },
15
core/commands/name.go
+1 -1
@@ -9,7 +9,7 @@ type IpnsEntry struct {
9
10 var NameCmd = &cmds.Command{
11 Helptext: cmds.HelpText{
12 - Tagline: "IPFS namespace (IPNS) tool",
12 + Tagline: "IPFS namespace (IPNS) tool.",
13 Synopsis: `
14 ipfs name publish [<name>] <ipfs-path> - Publish an object to IPNS
15 ipfs name resolve [<name>] - Gets the value currently published at an IPNS name
core/commands/object/object.go
+7 -7
@@ -42,7 +42,7 @@ type Object struct {
42
43 var ObjectCmd = &cmds.Command{
44 Helptext: cmds.HelpText{
45 - Tagline: "Interact with ipfs objects",
45 + Tagline: "Interact with ipfs objects.",
46 ShortDescription: `
47 'ipfs object' is a plumbing command used to manipulate DAG objects
48 directly.`,
@@ -70,7 +70,7 @@ ipfs object patch <args> - Create new object from old ones
70
71 var ObjectDataCmd = &cmds.Command{
72 Helptext: cmds.HelpText{
73 - Tagline: "Outputs the raw bytes in an IPFS object",
73 + Tagline: "Outputs the raw bytes in an IPFS object.",
74 ShortDescription: `
75 'ipfs object data' is a plumbing command for retreiving the raw bytes stored in
76 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.
108
109 var ObjectLinksCmd = &cmds.Command{
110 Helptext: cmds.HelpText{
111 - Tagline: "Outputs the links pointed to by the specified object",
111 + Tagline: "Outputs the links pointed to by the specified object.",
112 ShortDescription: `
113 'ipfs object links' is a plumbing command for retreiving the links from
114 a DAG node. It outputs to stdout, and <key> is a base58 encoded
@@ -157,7 +157,7 @@ multihash.
157
158 var ObjectGetCmd = &cmds.Command{
159 Helptext: cmds.HelpText{
160 - Tagline: "Get and serialize the DAG node named by <key>",
160 + Tagline: "Get and serialize the DAG node named by <key>.",
161 ShortDescription: `
162 'ipfs object get' is a plumbing command for retreiving DAG nodes.
163 It serializes the DAG node to the format specified by the "--encoding"
@@ -228,7 +228,7 @@ This command outputs data in the following encodings:
228
229 var ObjectStatCmd = &cmds.Command{
230 Helptext: cmds.HelpText{
231 - Tagline: "Get stats for the DAG node named by <key>",
231 + Tagline: "Get stats for the DAG node named by <key>.",
232 ShortDescription: `
233 'ipfs object stat' is a plumbing command to print DAG node statistics.
234 <key> is a base58 encoded multihash. It outputs to stdout:
@@ -289,7 +289,7 @@ var ObjectStatCmd = &cmds.Command{
289
290 var ObjectPutCmd = &cmds.Command{
291 Helptext: cmds.HelpText{
292 - Tagline: "Stores input as a DAG object, outputs its key",
292 + Tagline: "Stores input as a DAG object, outputs its key.",
293 ShortDescription: `
294 'ipfs object put' is a plumbing command for storing DAG nodes.
295 It reads from stdin, and the output is a base58 encoded multihash.
@@ -376,7 +376,7 @@ and then run
376
377 var ObjectNewCmd = &cmds.Command{
378 Helptext: cmds.HelpText{
379 - Tagline: "creates a new object from an ipfs template",
379 + Tagline: "Creates a new object from an ipfs template.",
380 ShortDescription: `
381 'ipfs object new' is a plumbing command for creating new DAG nodes.
382 `,
core/commands/object/patch.go
+5 -5
@@ -17,7 +17,7 @@ import (
17
18 var ObjectPatchCmd = &cmds.Command{
19 Helptext: cmds.HelpText{
20 - Tagline: "Create a new merkledag object based on an existing one",
20 + Tagline: "Create a new merkledag object based on an existing one.",
21 ShortDescription: `
22 'ipfs object patch <root> <cmd> <args>' is a plumbing command used to
23 build custom DAG objects. It mutates objects, creating new objects as a
@@ -44,7 +44,7 @@ func objectMarshaler(res cmds.Response) (io.Reader, error) {
44
45 var patchAppendDataCmd = &cmds.Command{
46 Helptext: cmds.HelpText{
47 - Tagline: "Append data to the data segment of a dag node",
47 + Tagline: "Append data to the data segment of a dag node.",
48 ShortDescription: `
49 Append data to what already exists in the data segment in the given object.
50
@@ -109,7 +109,7 @@ the limit will not be respected by the network.
109
110 var patchSetDataCmd = &cmds.Command{
111 Helptext: cmds.HelpText{
112 - Tagline: "set data field of an ipfs object",
112 + Tagline: "Set data field of an ipfs object.",
113 ShortDescription: `
114 Set the data of an ipfs object from stdin or with the contents of a file
115
@@ -171,7 +171,7 @@ EXAMPLE:
171
172 var patchRmLinkCmd = &cmds.Command{
173 Helptext: cmds.HelpText{
174 - Tagline: "remove a link from an object",
174 + Tagline: "Remove a link from an object.",
175 ShortDescription: `
176 removes a link by the given name from root.
177 `,
@@ -231,7 +231,7 @@ removes a link by the given name from root.
231
232 var patchAddLinkCmd = &cmds.Command{
233 Helptext: cmds.HelpText{
234 - Tagline: "add a link to a given object",
234 + Tagline: "Add a link to a given object.",
235 ShortDescription: `
236 Add a merkle-link to the given object and return the hash of the result.
237
core/commands/pin.go
+4 -4
@@ -14,7 +14,7 @@ import (
14
15 var PinCmd = &cmds.Command{
16 Helptext: cmds.HelpText{
17 - Tagline: "Pin (and unpin) objects to local storage",
17 + Tagline: "Pin (and unpin) objects to local storage.",
18 },
19
20 Subcommands: map[string]*cmds.Command{
@@ -30,7 +30,7 @@ type PinOutput struct {
30
31 var addPinCmd = &cmds.Command{
32 Helptext: cmds.HelpText{
33 - Tagline: "Pins objects to local storage",
33 + Tagline: "Pins objects to local storage.",
34 ShortDescription: `
35 Retrieves the object named by <ipfs-path> and stores it locally
36 on disk.
@@ -98,7 +98,7 @@ on disk.
98
99 var rmPinCmd = &cmds.Command{
100 Helptext: cmds.HelpText{
101 - Tagline: "Removes the pinned object from local storage. (By default, recursively. Use -r=false for direct pins)",
101 + Tagline: "Removes the pinned object from local storage. (By default, recursively. Use -r=false for direct pins).",
102 ShortDescription: `
103 Removes the pin from the given object allowing it to be garbage
104 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)
155
156 var listPinCmd = &cmds.Command{
157 Helptext: cmds.HelpText{
158 - Tagline: "List objects pinned to local storage",
158 + Tagline: "List objects pinned to local storage.",
159 ShortDescription: `
160 Returns a list of objects that are pinned locally.
161 By default, only recursively pinned returned, but others may be shown via the '--type' flag.
core/commands/ping.go
+1 -1
@@ -27,7 +27,7 @@ type PingResult struct {
27
28 var PingCmd = &cmds.Command{
29 Helptext: cmds.HelpText{
30 - Tagline: "send echo request packets to IPFS hosts",
30 + Tagline: "Send echo request packets to IPFS hosts.",
31 Synopsis: `
32 Send pings to a peer using the routing system to discover its address
33 `,
core/commands/publish.go
+1 -1
@@ -20,7 +20,7 @@ var errNotOnline = errors.New("This command must be run in online mode. Try runn
20
21 var PublishCmd = &cmds.Command{
22 Helptext: cmds.HelpText{
23 - Tagline: "Publish an object to IPNS",
23 + Tagline: "Publish an object to IPNS.",
24 ShortDescription: `
25 IPNS is a PKI namespace, where names are the hashes of public keys, and
26 the private key enables publishing new (signed) values. In publish, the
core/commands/refs.go
+2 -2
@@ -33,7 +33,7 @@ func KeyListTextMarshaler(res cmds.Response) (io.Reader, error) {
33
34 var RefsCmd = &cmds.Command{
35 Helptext: cmds.HelpText{
36 - Tagline: "Lists links (references) from an object",
36 + Tagline: "Lists links (references) from an object.",
37 ShortDescription: `
38 Retrieves the object named by <ipfs-path> and displays the link
39 hashes it contains, with the following format:
@@ -150,7 +150,7 @@ Note: list all refs recursively with -r.
150
151 var RefsLocalCmd = &cmds.Command{
152 Helptext: cmds.HelpText{
153 - Tagline: "Lists all local references",
153 + Tagline: "Lists all local references.",
154 ShortDescription: `
155 Displays the hashes of all local objects.
156 `,
core/commands/repo.go
+2 -2
@@ -12,7 +12,7 @@ import (
12
13 var RepoCmd = &cmds.Command{
14 Helptext: cmds.HelpText{
15 - Tagline: "Manipulate the IPFS repo",
15 + Tagline: "Manipulate the IPFS repo.",
16 ShortDescription: `
17 'ipfs repo' is a plumbing command used to manipulate the repo.
18 `,
@@ -25,7 +25,7 @@ var RepoCmd = &cmds.Command{
25
26 var repoGcCmd = &cmds.Command{
27 Helptext: cmds.HelpText{
28 - Tagline: "Perform a garbage collection sweep on the repo",
28 + Tagline: "Perform a garbage collection sweep on the repo.",
29 ShortDescription: `
30 'ipfs repo gc' is a plumbing command that will sweep the local
31 set of stored objects and remove ones that are not pinned in
core/commands/resolve.go
+1 -1
@@ -16,7 +16,7 @@ type ResolvedPath struct {
16
17 var ResolveCmd = &cmds.Command{
18 Helptext: cmds.HelpText{
19 - Tagline: "Resolve the value of names to IPFS",
19 + Tagline: "Resolve the value of names to IPFS.",
20 ShortDescription: `
21 There are a number of mutable name protocols that can link among
22 themselves and into IPNS. This command accepts any of these
core/commands/root.go
+1 -1
@@ -24,7 +24,7 @@ const (
24
25 var Root = &cmds.Command{
26 Helptext: cmds.HelpText{
27 - Tagline: "global p2p merkle-dag filesystem",
27 + Tagline: "Global p2p merkle-dag filesystem.",
28 Synopsis: `
29 ipfs [<flags>] <command> [<arg>] ...
30 `,
core/commands/stat.go
+2 -2
@@ -18,7 +18,7 @@ import (
18
19 var StatsCmd = &cmds.Command{
20 Helptext: cmds.HelpText{
21 - Tagline: "Query IPFS statistics",
21 + Tagline: "Query IPFS statistics.",
22 ShortDescription: ``,
23 },
24
@@ -29,7 +29,7 @@ var StatsCmd = &cmds.Command{
29
30 var statBwCmd = &cmds.Command{
31 Helptext: cmds.HelpText{
32 - Tagline: "Print ipfs bandwidth information",
32 + Tagline: "Print ipfs bandwidth information.",
33 ShortDescription: ``,
34 },
35 Options: []cmds.Option{
core/commands/swarm.go
+7 -7
@@ -27,7 +27,7 @@ type addrMap struct {
27
28 var SwarmCmd = &cmds.Command{
29 Helptext: cmds.HelpText{
30 - Tagline: "swarm inspection tool",
30 + Tagline: "Swarm inspection tool.",
31 Synopsis: `
32 ipfs swarm peers - List peers with open connections
33 ipfs swarm addrs - List known addresses. Useful to debug.
@@ -52,7 +52,7 @@ ipfs peers in the internet.
52
53 var swarmPeersCmd = &cmds.Command{
54 Helptext: cmds.HelpText{
55 - Tagline: "List peers with open connections",
55 + Tagline: "List peers with open connections.",
56 ShortDescription: `
57 ipfs swarm peers lists the set of peers this node is connected to.
58 `,
@@ -197,7 +197,7 @@ ipfs swarm addrs local lists all local addresses the node is listening on.
197
198 var swarmConnectCmd = &cmds.Command{
199 Helptext: cmds.HelpText{
200 - Tagline: "Open connection to a given address",
200 + Tagline: "Open connection to a given address.",
201 ShortDescription: `
202 'ipfs swarm connect' opens a new direct connection to a peer address.
203
@@ -253,7 +253,7 @@ ipfs swarm connect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3
253
254 var swarmDisconnectCmd = &cmds.Command{
255 Helptext: cmds.HelpText{
256 - Tagline: "Close connection to a given address",
256 + Tagline: "Close connection to a given address.",
257 ShortDescription: `
258 'ipfs swarm disconnect' closes a connection to a peer address. The address format
259 is an ipfs multiaddr:
@@ -364,7 +364,7 @@ func peersWithAddresses(addrs []string) (pis []peer.PeerInfo, err error) {
364
365 var swarmFiltersCmd = &cmds.Command{
366 Helptext: cmds.HelpText{
367 - Tagline: "Manipulate address filters",
367 + Tagline: "Manipulate address filters.",
368 ShortDescription: `
369 'ipfs swarm filters' will list out currently applied filters. Its subcommands can be used
370 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.
421
422 var swarmFiltersAddCmd = &cmds.Command{
423 Helptext: cmds.HelpText{
424 - Tagline: "add an address filter",
424 + Tagline: "Add an address filter.",
425 ShortDescription: `
426 'ipfs swarm filters add' will add an address filter to the daemons swarm.
427 Filters applied this way will not persist daemon reboots, to acheive that,
@@ -463,7 +463,7 @@ add your filters to the ipfs config file.
463
464 var swarmFiltersRmCmd = &cmds.Command{
465 Helptext: cmds.HelpText{
466 - Tagline: "remove an address filter",
466 + Tagline: "Remove an address filter.",
467 ShortDescription: `
468 'ipfs swarm filters rm' will remove an address filter from the daemons swarm.
469 Filters removed this way will not persist daemon reboots, to acheive that,
core/commands/tar.go
+3 -3
@@ -13,7 +13,7 @@ import (
13
14 var TarCmd = &cmds.Command{
15 Helptext: cmds.HelpText{
16 - Tagline: "utility functions for tar files in ipfs",
16 + Tagline: "Utility functions for tar files in ipfs.",
17 },
18
19 Subcommands: map[string]*cmds.Command{
@@ -24,7 +24,7 @@ var TarCmd = &cmds.Command{
24
25 var tarAddCmd = &cmds.Command{
26 Helptext: cmds.HelpText{
27 - Tagline: "import a tar file into ipfs",
27 + Tagline: "Import a tar file into ipfs.",
28 ShortDescription: `
29 'ipfs tar add' will parse a tar file and create a merkledag structure to represent it.
30 `,
@@ -75,7 +75,7 @@ var tarAddCmd = &cmds.Command{
75
76 var tarCatCmd = &cmds.Command{
77 Helptext: cmds.HelpText{
78 - Tagline: "export a tar file from ipfs",
78 + Tagline: "Export a tar file from ipfs.",
79 ShortDescription: `
80 'ipfs tar cat' will export a tar file from a previously imported one in ipfs
81 `,
core/commands/tour.go
+4 -4
@@ -14,7 +14,7 @@ import (
14
15 var tourCmd = &cmds.Command{
16 Helptext: cmds.HelpText{
17 - Tagline: "An introduction to IPFS",
17 + Tagline: "An introduction to IPFS.",
18 ShortDescription: `
19 This is a tour that takes you through various IPFS concepts,
20 features, and tools to make sure you get up to speed with
@@ -73,7 +73,7 @@ func tourRunFunc(req cmds.Request, res cmds.Response) {
73
74 var cmdIpfsTourNext = &cmds.Command{
75 Helptext: cmds.HelpText{
76 - Tagline: "Show the next IPFS Tour topic",
76 + Tagline: "Show the next IPFS Tour topic.",
77 },
78
79 Run: func(req cmds.Request, res cmds.Response) {
@@ -112,7 +112,7 @@ var cmdIpfsTourNext = &cmds.Command{
112
113 var cmdIpfsTourRestart = &cmds.Command{
114 Helptext: cmds.HelpText{
115 - Tagline: "Restart the IPFS Tour",
115 + Tagline: "Restart the IPFS Tour.",
116 },
117
118 Run: func(req cmds.Request, res cmds.Response) {
@@ -134,7 +134,7 @@ var cmdIpfsTourRestart = &cmds.Command{
134
135 var cmdIpfsTourList = &cmds.Command{
136 Helptext: cmds.HelpText{
137 - Tagline: "Show a list of IPFS Tour topics",
137 + Tagline: "Show a list of IPFS Tour topics.",
138 },
139
140 Run: func(req cmds.Request, res cmds.Response) {
core/commands/unixfs/ls.go
+1 -1
@@ -34,7 +34,7 @@ type LsOutput struct {
34
35 var LsCmd = &cmds.Command{
36 Helptext: cmds.HelpText{
37 - Tagline: "List directory contents for Unix-filesystem objects",
37 + Tagline: "List directory contents for Unix-filesystem objects.",
38 ShortDescription: `
39 Retrieves the object named by <ipfs-or-ipns-path> and displays the
40 contents.
core/commands/unixfs/unixfs.go
+1 -1
@@ -4,7 +4,7 @@ import cmds "github.com/ipfs/go-ipfs/commands"
4
5 var UnixFSCmd = &cmds.Command{
6 Helptext: cmds.HelpText{
7 - Tagline: "Interact with ipfs objects representing Unix filesystems",
7 + Tagline: "Interact with ipfs objects representing Unix filesystems.",
8 ShortDescription: `
9 'ipfs file' provides a familar interface to filesystems represtented
10 by IPFS objects that hides IPFS-implementation details like layout
core/commands/version.go
+1 -1
@@ -18,7 +18,7 @@ type VersionOutput struct {
18
19 var VersionCmd = &cmds.Command{
20 Helptext: cmds.HelpText{
21 - Tagline: "Shows ipfs version information",
21 + Tagline: "Shows ipfs version information.",
22 ShortDescription: "Returns the current version of ipfs and exits.",
23 },
24