Remove existing synopsis
License: MIT Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
Jakub Sztandera committed
Jun 2, 2016 at 13:55 UTC
adf405210db1c147cb8d1d669862563e1c452a38
6 files changed
+5
-17
core/commands/mount_unix.go
-3
@@ -16,9 +16,6 @@ import (
16
var MountCmd = &cmds.Command{
17
Helptext: cmds.HelpText{
18
Tagline: "Mounts IPFS to the filesystem (read-only).",
19
- Synopsis: `
20
-ipfs mount [-f <ipfs mount path>] [-n <ipns mount path>]
21
-`,
19
ShortDescription: `
20
Mount ipfs at a read-only mountpoint on the OS (default: /ipfs and /ipns).
21
All ipfs objects will be accessible under that directory. Note that the
core/commands/ping.go
+1
-2
@@ -28,8 +28,7 @@ type PingResult struct {
28
29
var PingCmd = &cmds.Command{
30
Helptext: cmds.HelpText{
31
- Tagline: "Send echo request packets to IPFS hosts.",
32
- Synopsis: "ipfs ping <peerId> [--count <int>| -n]",
31
+ Tagline: "Send echo request packets to IPFS hosts.",
32
ShortDescription: `
33
'ipfs ping' is a tool to test sending data to other nodes. It finds nodes
34
via the routing system, sends pings, waits for pongs, and prints out round-
core/commands/root.go
+2
-4
@@ -19,10 +19,8 @@ const (
19
20
var Root = &cmds.Command{
21
Helptext: cmds.HelpText{
22
- Tagline: "Global p2p merkle-dag filesystem.",
23
- Synopsis: `
24
-ipfs [<flags>] <command> [<arg>] ...
25
-`,
22
+ Tagline: "Global p2p merkle-dag filesystem.",
23
+ Synopsis: "ipfs [--config=<config> | -c] [--debug=<debug> | -D] [--help=<help>] [-h=<h>] [--local=<local> | -L] [--api=<api>] <command> ...",
24
Subcommands: `
25
BASIC COMMANDS
26
init Initialize ipfs local configuration
core/commands/stat.go
+1
-5
@@ -18,8 +18,7 @@ import (
18
19
var StatsCmd = &cmds.Command{
20
Helptext: cmds.HelpText{
21
- Tagline: "Query ipfs statistics.",
22
- Synopsis: "ipfs stats <command>",
21
+ Tagline: "Query ipfs statistics.",
22
ShortDescription: `'ipfs stats' is a set of commands to help look at statistics
23
for your ipfs node.
24
`,
@@ -37,9 +36,6 @@ for your ipfs node.`,
36
var statBwCmd = &cmds.Command{
37
Helptext: cmds.HelpText{
38
Tagline: "Print ipfs bandwidth information.",
40
- Synopsis: `ipfs stats bw [--peer <peerId> | -p] [--proto <protocol> | -t] [--poll]
41
-[--interval <timeInterval> | -i]
42
- `,
39
ShortDescription: `'ipfs stats bw' prints bandwidth information for the ipfs daemon.
40
It displays: TotalIn, TotalOut, RateIn, RateOut.
41
`,
core/commands/unixfs/ls.go
-1
@@ -36,7 +36,6 @@ type LsOutput struct {
36
var LsCmd = &cmds.Command{
37
Helptext: cmds.HelpText{
38
Tagline: "List directory contents for Unix filesystem objects.",
39
- Synopsis: "ipfs file ls <path>",
39
ShortDescription: `
40
Displays the contents of an IPFS or IPNS object(s) at the given path.
41
core/commands/unixfs/unixfs.go
+1
-2
@@ -5,13 +5,12 @@ import cmds "github.com/ipfs/go-ipfs/commands"
5
var UnixFSCmd = &cmds.Command{
6
Helptext: cmds.HelpText{
7
Tagline: "Interact with ipfs objects representing Unix filesystems.",
8
- Synopsis: "ipfs file <command>",
8
ShortDescription: `
9
'ipfs file' provides a familiar interface to file systems represented
10
by IPFS objects, which hides IPFS implementation details like layout
11
objects (e.g. fanout and chunking).
12
`,
14
- LongDescription: `
13
+ LongDescription: `
14
'ipfs file' provides a familiar interface to file systems represented
15
by IPFS objects, which hides IPFS implementation details like layout
16
objects (e.g. fanout and chunking).