mirror of
https://github.com/ipfs/kubo.git
synced 2025-10-16 19:24:02 +08:00
Merge pull request #4121 from devedge/doc/help/wrap-desc
wrap-desc: Wrap help descriptions under 80 chars
This commit is contained in:
@ -122,8 +122,8 @@ environment variable:
|
||||
Routing
|
||||
|
||||
IPFS by default will use a DHT for content routing. There is a highly
|
||||
experimental alternative that operates the DHT in a 'client only' mode that can
|
||||
be enabled by running the daemon as:
|
||||
experimental alternative that operates the DHT in a 'client only' mode that
|
||||
can be enabled by running the daemon as:
|
||||
|
||||
ipfs daemon --routing=dhtclient
|
||||
|
||||
|
@ -187,7 +187,8 @@ var DagGetCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Get a dag node from ipfs.",
|
||||
ShortDescription: `
|
||||
'ipfs dag get' fetches a dag node from ipfs and prints it out in the specifed format.
|
||||
'ipfs dag get' fetches a dag node from ipfs and prints it out in the specifed
|
||||
format.
|
||||
`,
|
||||
},
|
||||
Arguments: []cmds.Argument{
|
||||
|
@ -571,7 +571,8 @@ var FilesWriteCmd = &cmds.Command{
|
||||
Tagline: "Write to a mutable file in a given filesystem.",
|
||||
ShortDescription: `
|
||||
Write data to a file in a given filesystem. This command allows you to specify
|
||||
a beginning offset to write to. The entire length of the input will be written.
|
||||
a beginning offset to write to. The entire length of the input will be
|
||||
written.
|
||||
|
||||
If the '--create' option is specified, the file will be created if it does not
|
||||
exist. Nonexistant intermediate directories will not be created.
|
||||
|
@ -26,7 +26,8 @@ the private key enables publishing new (signed) values. In both publish
|
||||
and resolve, the default name used is the node's own PeerID,
|
||||
which is the hash of its public key.
|
||||
|
||||
You can use the 'ipfs key' commands to list and generate more names and their respective keys.
|
||||
You can use the 'ipfs key' commands to list and generate more names and their
|
||||
respective keys.
|
||||
|
||||
Examples:
|
||||
|
||||
|
@ -20,7 +20,8 @@ var KeyCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Create and list IPNS name keypairs",
|
||||
ShortDescription: `
|
||||
'ipfs key gen' generates a new keypair for usage with IPNS and 'ipfs name publish'.
|
||||
'ipfs key gen' generates a new keypair for usage with IPNS and 'ipfs name
|
||||
publish'.
|
||||
|
||||
> ipfs key gen --type=rsa --size=2048 mykey
|
||||
> ipfs name publish --key=mykey QmSomeHash
|
||||
|
@ -35,7 +35,8 @@ var logLevelCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Change the logging level.",
|
||||
ShortDescription: `
|
||||
Change the verbosity of one or all subsystems log output. This does not affect the event log.
|
||||
Change the verbosity of one or all subsystems log output. This does not affect
|
||||
the event log.
|
||||
`,
|
||||
},
|
||||
|
||||
|
@ -22,7 +22,8 @@ the private key enables publishing new (signed) values. In both publish
|
||||
and resolve, the default name used is the node's own PeerID,
|
||||
which is the hash of its public key.
|
||||
|
||||
You can use the 'ipfs key' commands to list and generate more names and their respective keys.
|
||||
You can use the 'ipfs key' commands to list and generate more names and their
|
||||
respective keys.
|
||||
|
||||
Examples:
|
||||
|
||||
|
@ -47,7 +47,8 @@ var P2PCmd = &cmds.Command{
|
||||
ShortDescription: `
|
||||
Create and use tunnels to remote peers over libp2p
|
||||
|
||||
Note: this command is experimental and subject to change as usecases and APIs are refined`,
|
||||
Note: this command is experimental and subject to change as usecases and APIs
|
||||
are refined`,
|
||||
},
|
||||
|
||||
Subcommands: map[string]*cmds.Command{
|
||||
@ -188,7 +189,8 @@ var p2pListenerListenCmd = &cmds.Command{
|
||||
Helptext: cmds.HelpText{
|
||||
Tagline: "Forward p2p connections to a network multiaddr.",
|
||||
ShortDescription: `
|
||||
Register a p2p connection handler and forward the connections to a specified address.
|
||||
Register a p2p connection handler and forward the connections to a specified
|
||||
address.
|
||||
|
||||
Note that the connections originate from the ipfs daemon process.
|
||||
`,
|
||||
@ -237,9 +239,9 @@ var p2pStreamDialCmd = &cmds.Command{
|
||||
ShortDescription: `
|
||||
Establish a new connection to a peer service.
|
||||
|
||||
When a connection is made to a peer service the ipfs daemon will setup one time
|
||||
TCP listener and return it's bind port, this way a dialing application can
|
||||
transparently connect to a p2p service.
|
||||
When a connection is made to a peer service the ipfs daemon will setup one
|
||||
time TCP listener and return it's bind port, this way a dialing application
|
||||
can transparently connect to a p2p service.
|
||||
`,
|
||||
},
|
||||
Arguments: []cmds.Argument{
|
||||
|
@ -34,7 +34,8 @@ the private key enables publishing new (signed) values. In both publish
|
||||
and resolve, the default name used is the node's own PeerID,
|
||||
which is the hash of its public key.
|
||||
|
||||
You can use the 'ipfs key' commands to list and generate more names and their respective keys.
|
||||
You can use the 'ipfs key' commands to list and generate more names and their
|
||||
respective keys.
|
||||
|
||||
Examples:
|
||||
|
||||
@ -49,7 +50,8 @@ Publish an <ipfs-path> with another name, added by an 'ipfs key' command:
|
||||
> ipfs name publish --key=mykey /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
|
||||
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
|
||||
|
||||
Alternatively, publish an <ipfs-path> using a valid PeerID(as listed by 'ipfs key list -l'):
|
||||
Alternatively, publish an <ipfs-path> using a valid PeerID (as listed by
|
||||
'ipfs key list -l'):
|
||||
|
||||
> ipfs name publish --key=QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
|
||||
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
|
||||
|
@ -66,8 +66,9 @@ TOOL COMMANDS
|
||||
|
||||
Use 'ipfs <command> --help' to learn more about each command.
|
||||
|
||||
ipfs uses a repository in the local file system. By default, the repo is located
|
||||
at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable:
|
||||
ipfs uses a repository in the local file system. By default, the repo is
|
||||
located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
|
||||
environment variable:
|
||||
|
||||
export IPFS_PATH=/path/to/ipfsrepo
|
||||
|
||||
|
Reference in New Issue
Block a user