All commands: Align to under 78-ruler width
This is just for the description, for now. License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Jun 1, 2016 at 16:44 UTC
7f61030eb52693203389f2e38cb0525546ab1be9
12 files changed
+70
-45
cmd/ipfs/daemon.go
+6
-4
@@ -110,8 +110,9 @@ second signal.
110
111
IPFS_PATH environment variable
112
113
-ipfs uses a repository in the local file system. By default, the repo is located
114
-at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable:
113
+ipfs uses a repository in the local file system. By default, the repo is
114
+located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
115
+environment variable:
116
117
export IPFS_PATH=/path/to/ipfsrepo
118
@@ -121,8 +122,9 @@ Previously, IPFS used an environment variable as seen below:
122
123
export API_ORIGIN="http://localhost:8888/"
124
124
-This is deprecated. It is still honored in this version, but will be removed in a
125
-future version, along with this notice. Please move to setting the HTTP Headers.
125
+This is deprecated. It is still honored in this version, but will be removed
126
+in a future version, along with this notice. Please move to setting the HTTP
127
+Headers.
128
`,
129
},
130
cmd/ipfs/init.go
+3
-2
@@ -26,8 +26,9 @@ var initCmd = &cmds.Command{
26
ShortDescription: `
27
Initializes IPFS configuration files and generates a new keypair.
28
29
-ipfs uses a repository in the local file system. By default, the repo is located
30
-at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable:
29
+ipfs uses a repository in the local file system. By default, the repo is
30
+located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
31
+environment variable:
32
33
export IPFS_PATH=/path/to/ipfsrepo
34
`,
core/commands/dht.go
+14
-4
@@ -331,7 +331,11 @@ var getValueDhtCmd = &cmds.Command{
331
ShortDescription: `
332
Outputs the best value for the given key.
333
334
-There may be several different values for a given key stored in the DHT; in this context 'best' means the record that is most desirable. There is no one metric for 'best': it depends entirely on the key type. For IPNS, 'best' is the record that is both valid and has the highest sequence number (freshest). Different key types can specify other 'best' rules.
334
+There may be several different values for a given key stored in the DHT; in
335
+this context 'best' means the record that is most desirable. There is no one
336
+metric for 'best': it depends entirely on the key type. For IPNS, 'best' is
337
+the record that is both valid and has the highest sequence number (freshest).
338
+Different key types can specify other 'best' rules.
339
`,
340
},
341
@@ -434,11 +438,17 @@ var putValueDhtCmd = &cmds.Command{
438
Helptext: cmds.HelpText{
439
Tagline: "Write a key/value pair to the DHT.",
440
ShortDescription: `
437
-Given a key of the form /foo/bar and a value of any form, this will write that value to the DHT with that key.
441
+Given a key of the form /foo/bar and a value of any form, this will write that
442
+value to the DHT with that key.
443
439
-Keys have two parts: a keytype (foo) and the key name (bar). IPNS uses the /ipns keytype, and expects the key name to be a Peer ID. IPNS entries are specifically formatted (protocol buffer).
444
+Keys have two parts: a keytype (foo) and the key name (bar). IPNS uses the
445
+/ipns keytype, and expects the key name to be a Peer ID. IPNS entries are
446
+specifically formatted (protocol buffer).
447
441
-You may only use keytypes that are supported in your ipfs binary: currently this is only /ipns. Unless you have a relatively deep understanding of the go-ipfs DHT internals, you likely want to be using 'ipfs name publish' instead of this.
448
+You may only use keytypes that are supported in your ipfs binary: currently
449
+this is only /ipns. Unless you have a relatively deep understanding of the
450
+go-ipfs DHT internals, you likely want to be using 'ipfs name publish' instead
451
+of this.
452
453
Value is arbitrary text. Standard input can be used to provide value.
454
core/commands/files/files.go
+5
-5
@@ -381,8 +381,8 @@ var FilesReadCmd = &cmds.Command{
381
Helptext: cmds.HelpText{
382
Tagline: "Read a file in a given mfs.",
383
ShortDescription: `
384
-Read a specified number of bytes from a file at a given offset. By default, will
385
-read the entire file similar to unix cat.
384
+Read a specified number of bytes from a file at a given offset. By default,
385
+will read the entire file similar to unix cat.
386
387
Examples:
388
@@ -553,9 +553,9 @@ EXAMPLE:
553
554
WARNING:
555
556
- Usage of the '--flush=false' option does not guarantee data durability until
557
- the tree has been flushed. This can be accomplished by running 'ipfs files stat'
558
- on the file or any of its ancestors.
556
+Usage of the '--flush=false' option does not guarantee data durability until
557
+the tree has been flushed. This can be accomplished by running 'ipfs files
558
+stat' on the file or any of its ancestors.
559
`,
560
},
561
Arguments: []cmds.Argument{
core/commands/get.go
+2
-2
@@ -26,8 +26,8 @@ var GetCmd = &cmds.Command{
26
ShortDescription: `
27
Stores to disk the data contained an IPFS or IPNS object(s) at the given path.
28
29
-By default, the output will be stored at './<ipfs-path>', but an alternate path
30
-can be specified with '--output=<path>' or '-o=<path>'.
29
+By default, the output will be stored at './<ipfs-path>', but an alternate
30
+path can be specified with '--output=<path>' or '-o=<path>'.
31
32
To output a TAR archive instead of unpacked files, use '--archive' or '-a'.
33
core/commands/ls.go
+2
-1
@@ -33,7 +33,8 @@ var LsCmd = &cmds.Command{
33
Helptext: cmds.HelpText{
34
Tagline: "List links from an object.",
35
ShortDescription: `
36
-Displays the links an IPFS or IPNS object(s) contains, with the following format:
36
+Displays the links an IPFS or IPNS object(s) contains, with the following
37
+format:
38
39
<link base58 hash> <link size in bytes> <link name>
40
`,
core/commands/object/object.go
+8
-10
@@ -65,17 +65,15 @@ var ObjectDataCmd = &cmds.Command{
65
Helptext: cmds.HelpText{
66
Tagline: "Outputs the raw bytes in an IPFS object.",
67
ShortDescription: `
68
-'ipfs object data' is a plumbing command for retrieving the raw bytes stored in
69
-a DAG node. It outputs to stdout, and <key> is a base58 encoded
70
-multihash.
68
+'ipfs object data' is a plumbing command for retrieving the raw bytes stored
69
+in a DAG node. It outputs to stdout, and <key> is a base58 encoded multihash.
70
`,
71
LongDescription: `
73
-'ipfs object data' is a plumbing command for retrieving the raw bytes stored in
74
-a DAG node. It outputs to stdout, and <key> is a base58 encoded
75
-multihash.
72
+'ipfs object data' is a plumbing command for retrieving the raw bytes stored
73
+in a DAG node. It outputs to stdout, and <key> is a base58 encoded multihash.
74
77
-Note that the "--encoding" option does not affect the output, since the
78
-output is the raw data of the object.
75
+Note that the "--encoding" option does not affect the output, since the output
76
+is the raw data of the object.
77
`,
78
},
79
@@ -313,8 +311,8 @@ Examples:
311
312
$ echo '{ "Data": "abc" }' | ipfs object put
313
316
-This creates a node with the data 'abc' and no links. For an object with links,
317
-create a file named 'node.json' with the contents:
314
+This creates a node with the data 'abc' and no links. For an object with
315
+links, create a file named 'node.json' with the contents:
316
317
{
318
"Data": "another",
core/commands/object/patch.go
+2
-2
@@ -241,8 +241,8 @@ Example:
241
$ BAR=$(echo "bar" | ipfs add -q)
242
$ ipfs object patch $EMPTY_DIR add-link foo $BAR
243
244
-This takes an empty directory, and adds a link named 'foo' under it, pointing to
245
-a file containing 'bar', and returns the hash of the new object.
244
+This takes an empty directory, and adds a link named 'foo' under it, pointing
245
+to a file containing 'bar', and returns the hash of the new object.
246
`,
247
},
248
Arguments: []cmds.Argument{
core/commands/pin.go
+13
-6
@@ -152,20 +152,27 @@ var listPinCmd = &cmds.Command{
152
Tagline: "List objects pinned to local storage.",
153
ShortDescription: `
154
Returns a list of objects that are pinned locally.
155
-By default, all pinned objects are returned, but the '--type' flag or arguments can restrict that to a specific pin type or to some specific objects respectively.
155
+By default, all pinned objects are returned, but the '--type' flag or
156
+arguments can restrict that to a specific pin type or to some specific objects
157
+respectively.
158
`,
159
LongDescription: `
160
Returns a list of objects that are pinned locally.
159
-By default, all pinned objects are returned, but the '--type' flag or arguments can restrict that to a specific pin type or to some specific objects respectively.
161
+By default, all pinned objects are returned, but the '--type' flag or
162
+arguments can restrict that to a specific pin type or to some specific objects
163
+respectively.
164
161
-Use --type=<type> to specify the type of pinned keys to list. Valid values are:
165
+Use --type=<type> to specify the type of pinned keys to list.
166
+Valid values are:
167
* "direct": pin that specific object.
163
- * "recursive": pin that specific object, and indirectly pin all its decendants
168
+ * "recursive": pin that specific object, and indirectly pin all its
169
+ descendants
170
* "indirect": pinned indirectly by an ancestor (like a refcount)
171
* "all"
172
167
-With arguments, the command fails if any of the arguments is not a pinned object.
168
-And if --type=<type> is additionally used, the command will also fail if any of the arguments is not of the specified type.
173
+With arguments, the command fails if any of the arguments is not a pinned
174
+object. And if --type=<type> is additionally used, the command will also fail
175
+if any of the arguments is not of the specified type.
176
177
Example:
178
$ echo "hello" | ipfs add -q
core/commands/stat.go
+5
-2
@@ -20,8 +20,11 @@ var StatsCmd = &cmds.Command{
20
Helptext: cmds.HelpText{
21
Tagline: "Query ipfs statistics.",
22
Synopsis: "ipfs stats <command>",
23
- ShortDescription: `'ipfs stats' is a set of commands to help look at statistics for your ipfs node.`,
24
- LongDescription: `'ipfs stats' is a set of commands to help look at statistics for your ipfs node.`,
23
+ ShortDescription: `'ipfs stats' is a set of commands to help look at statistics
24
+for your ipfs node.
25
+`,
26
+ LongDescription: `'ipfs stats' is a set of commands to help look at statistics
27
+for your ipfs node.`,
28
},
29
30
Subcommands: map[string]*cmds.Command{
core/commands/swarm.go
+8
-6
@@ -260,12 +260,13 @@ var swarmDisconnectCmd = &cmds.Command{
260
Helptext: cmds.HelpText{
261
Tagline: "Close connection to a given address.",
262
ShortDescription: `
263
-'ipfs swarm disconnect' closes a connection to a peer address. The address format
264
-is an ipfs multiaddr:
263
+'ipfs swarm disconnect' closes a connection to a peer address. The address
264
+format is an ipfs multiaddr:
265
266
ipfs swarm disconnect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
267
268
-The disconnect is not permanent; if ipfs needs to talk to that address later, it will reconnect.
268
+The disconnect is not permanent; if ipfs needs to talk to that address later,
269
+it will reconnect.
270
`,
271
},
272
Arguments: []cmds.Argument{
@@ -373,10 +374,11 @@ var swarmFiltersCmd = &cmds.Command{
374
Helptext: cmds.HelpText{
375
Tagline: "Manipulate address filters.",
376
ShortDescription: `
376
-'ipfs swarm filters' will list out currently applied filters. Its subcommands can be used
377
-to add or remove said filters. Filters are specified using the multiaddr-filter format:
377
+'ipfs swarm filters' will list out currently applied filters. Its subcommands
378
+can be used to add or remove said filters. Filters are specified using the
379
+multiaddr-filter format:
380
379
-example:
381
+Example:
382
383
/ip4/192.168.0.0/ipcidr/16
384
core/commands/tar.go
+2
-1
@@ -26,7 +26,8 @@ var tarAddCmd = &cmds.Command{
26
Helptext: cmds.HelpText{
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.
29
+'ipfs tar add' will parse a tar file and create a merkledag structure to
30
+represent it.
31
`,
32
},
33