wrap-desc: Wrap help descriptions under 80 chars
Wraps the description sections under 80 characters. Updated commit to adhere to requested changes. License: MIT Signed-off-by: Richard Pajerski II <devedge@outlook.com>
devedge committed
Aug 5, 2017 at 18:00 UTC
07d2b645d89d7b67940765c87a1367d718a66453
10 files changed
+39
-28
cmd/ipfs/daemon.go
+13
-13
@@ -67,18 +67,18 @@ The daemon will start listening on ports on the network, which are
67
documented in (and can be modified through) 'ipfs config Addresses'.
68
For example, to change the 'Gateway' port:
69
70
- ipfs config Addresses.Gateway /ip4/127.0.0.1/tcp/8082
70
+ ipfs config Addresses.Gateway /ip4/127.0.0.1/tcp/8082
71
72
The API address can be changed the same way:
73
74
- ipfs config Addresses.API /ip4/127.0.0.1/tcp/5002
74
+ ipfs config Addresses.API /ip4/127.0.0.1/tcp/5002
75
76
Make sure to restart the daemon after changing addresses.
77
78
By default, the gateway is only accessible locally. To expose it to
79
other computers in the network, use 0.0.0.0 as the ip address:
80
81
- ipfs config Addresses.Gateway /ip4/0.0.0.0/tcp/8080
81
+ ipfs config Addresses.Gateway /ip4/0.0.0.0/tcp/8080
82
83
Be careful if you expose the API. It is a security risk, as anyone could
84
control your node remotely. If you need to control the node remotely,
@@ -91,8 +91,8 @@ ipfs supports passing arbitrary headers to the API and Gateway. You can
91
do this by setting headers on the API.HTTPHeaders and Gateway.HTTPHeaders
92
keys:
93
94
- ipfs config --json API.HTTPHeaders.X-Special-Header '["so special :)"]'
95
- ipfs config --json Gateway.HTTPHeaders.X-Special-Header '["so special :)"]'
94
+ ipfs config --json API.HTTPHeaders.X-Special-Header '["so special :)"]'
95
+ ipfs config --json Gateway.HTTPHeaders.X-Special-Header '["so special :)"]'
96
97
Note that the value of the keys is an _array_ of strings. This is because
98
headers can have more than one value, and it is convenient to pass through
@@ -102,9 +102,9 @@ CORS Headers (for API)
102
103
You can setup CORS headers the same way:
104
105
- ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["example.com"]'
106
- ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "GET", "POST"]'
107
- ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials '["true"]'
105
+ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["example.com"]'
106
+ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "GET", "POST"]'
107
+ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials '["true"]'
108
109
Shutdown
110
@@ -119,15 +119,15 @@ ipfs uses a repository in the local file system. By default, the repo is
119
located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
120
environment variable:
121
122
- export IPFS_PATH=/path/to/ipfsrepo
122
+ export IPFS_PATH=/path/to/ipfsrepo
123
124
Routing
125
126
IPFS by default will use a DHT for content routing. There is a highly
127
-experimental alternative that operates the DHT in a 'client only' mode that can
128
-be enabled by running the daemon as:
127
+experimental alternative that operates the DHT in a 'client only' mode that
128
+can be enabled by running the daemon as:
129
130
- ipfs daemon --routing=dhtclient
130
+ ipfs daemon --routing=dhtclient
131
132
This will later be transitioned into a config option once it gets out of the
133
'experimental' stage.
@@ -136,7 +136,7 @@ DEPRECATION NOTICE
136
137
Previously, ipfs used an environment variable as seen below:
138
139
- export API_ORIGIN="http://localhost:8888/"
139
+ export API_ORIGIN="http://localhost:8888/"
140
141
This is deprecated. It is still honored in this version, but will be removed
142
in a future version, along with this notice. Please move to setting the HTTP
core/commands/dag/dag.go
+2
-1
@@ -128,7 +128,8 @@ var DagGetCmd = &cmds.Command{
128
Helptext: cmds.HelpText{
129
Tagline: "Get a dag node from ipfs.",
130
ShortDescription: `
131
-'ipfs dag get' fetches a dag node from ipfs and prints it out in the specifed format.
131
+'ipfs dag get' fetches a dag node from ipfs and prints it out in the specifed
132
+format.
133
`,
134
},
135
Arguments: []cmds.Argument{
core/commands/files/files.go
+2
-1
@@ -557,7 +557,8 @@ var FilesWriteCmd = &cmds.Command{
557
Tagline: "Write to a mutable file in a given filesystem.",
558
ShortDescription: `
559
Write data to a file in a given filesystem. This command allows you to specify
560
-a beginning offset to write to. The entire length of the input will be written.
560
+a beginning offset to write to. The entire length of the input will be
561
+written.
562
563
If the '--create' option is specified, the file will be created if it does not
564
exist. Nonexistant intermediate directories will not be created.
core/commands/ipns.go
+2
-1
@@ -26,7 +26,8 @@ the private key enables publishing new (signed) values. In both publish
26
and resolve, the default name used is the node's own PeerID,
27
which is the hash of its public key.
28
29
-You can use the 'ipfs key' commands to list and generate more names and their respective keys.
29
+You can use the 'ipfs key' commands to list and generate more names and their
30
+respective keys.
31
32
Examples:
33
core/commands/keystore.go
+2
-1
@@ -20,7 +20,8 @@ var KeyCmd = &cmds.Command{
20
Helptext: cmds.HelpText{
21
Tagline: "Create and list IPNS name keypairs",
22
ShortDescription: `
23
-'ipfs key gen' generates a new keypair for usage with IPNS and 'ipfs name publish'.
23
+'ipfs key gen' generates a new keypair for usage with IPNS and 'ipfs name
24
+publish'.
25
26
> ipfs key gen --type=rsa --size=2048 mykey
27
> ipfs name publish --key=mykey QmSomeHash
core/commands/log.go
+2
-1
@@ -35,7 +35,8 @@ var logLevelCmd = &cmds.Command{
35
Helptext: cmds.HelpText{
36
Tagline: "Change the logging level.",
37
ShortDescription: `
38
-Change the verbosity of one or all subsystems log output. This does not affect the event log.
38
+Change the verbosity of one or all subsystems log output. This does not affect
39
+the event log.
40
`,
41
},
42
core/commands/name.go
+2
-1
@@ -22,7 +22,8 @@ the private key enables publishing new (signed) values. In both publish
22
and resolve, the default name used is the node's own PeerID,
23
which is the hash of its public key.
24
25
-You can use the 'ipfs key' commands to list and generate more names and their respective keys.
25
+You can use the 'ipfs key' commands to list and generate more names and their
26
+respective keys.
27
28
Examples:
29
core/commands/p2p.go
+7
-5
@@ -47,7 +47,8 @@ var P2PCmd = &cmds.Command{
47
ShortDescription: `
48
Create and use tunnels to remote peers over libp2p
49
50
-Note: this command is experimental and subject to change as usecases and APIs are refined`,
50
+Note: this command is experimental and subject to change as usecases and APIs
51
+are refined`,
52
},
53
54
Subcommands: map[string]*cmds.Command{
@@ -188,7 +189,8 @@ var p2pListenerListenCmd = &cmds.Command{
189
Helptext: cmds.HelpText{
190
Tagline: "Forward p2p connections to a network multiaddr.",
191
ShortDescription: `
191
-Register a p2p connection handler and forward the connections to a specified address.
192
+Register a p2p connection handler and forward the connections to a specified
193
+address.
194
195
Note that the connections originate from the ipfs daemon process.
196
`,
@@ -237,9 +239,9 @@ var p2pStreamDialCmd = &cmds.Command{
239
ShortDescription: `
240
Establish a new connection to a peer service.
241
240
-When a connection is made to a peer service the ipfs daemon will setup one time
241
-TCP listener and return it's bind port, this way a dialing application can
242
-transparently connect to a p2p service.
242
+When a connection is made to a peer service the ipfs daemon will setup one
243
+time TCP listener and return it's bind port, this way a dialing application
244
+can transparently connect to a p2p service.
245
`,
246
},
247
Arguments: []cmds.Argument{
core/commands/publish.go
+4
-2
@@ -34,7 +34,8 @@ the private key enables publishing new (signed) values. In both publish
34
and resolve, the default name used is the node's own PeerID,
35
which is the hash of its public key.
36
37
-You can use the 'ipfs key' commands to list and generate more names and their respective keys.
37
+You can use the 'ipfs key' commands to list and generate more names and their
38
+respective keys.
39
40
Examples:
41
@@ -49,7 +50,8 @@ Publish an <ipfs-path> with another name, added by an 'ipfs key' command:
50
> ipfs name publish --key=mykey /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
51
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
52
52
-Alternatively, publish an <ipfs-path> using a valid PeerID(as listed by 'ipfs key list -l'):
53
+Alternatively, publish an <ipfs-path> using a valid PeerID (as listed by
54
+'ipfs key list -l'):
55
56
> ipfs name publish --key=QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
57
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
core/commands/root.go
+3
-2
@@ -66,8 +66,9 @@ TOOL COMMANDS
66
67
Use 'ipfs <command> --help' to learn more about each command.
68
69
-ipfs uses a repository in the local file system. By default, the repo is located
70
-at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable:
69
+ipfs uses a repository in the local file system. By default, the repo is
70
+located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
71
+environment variable:
72
73
export IPFS_PATH=/path/to/ipfsrepo
74