Merge pull request #354 from chriscool/improve_help_messages

Improve help messages
This commit is contained in:
Juan Batiz-Benet 2014-11-17 14:25:39 -08:00
commit 45cc33b1ff
2 changed files with 3 additions and 3 deletions

View File

@ -100,8 +100,6 @@ const shortHelpFormat = `USAGE:
{{.Indent}}{{template "usage" .}}
{{if .Synopsis}}
SYNOPSIS
{{.Synopsis}}
{{end}}{{if .Description}}
{{.Description}}

View File

@ -26,7 +26,7 @@ var mountCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Mounts IPFS to the filesystem (read-only)",
Synopsis: `
ipfs [-f <ipfs mount path>] [-n <ipns mount path>]
ipfs mount [-f <ipfs mount path>] [-n <ipns mount path>]
`,
ShortDescription: `
Mount ipfs at a read-only mountpoint on the OS (default: /ipfs and /ipns).
@ -37,6 +37,7 @@ You may have to create /ipfs and /ipfs before using 'ipfs mount':
> sudo mkdir /ipfs /ipns
> sudo chown ` + "`" + `whoami` + "`" + ` /ipfs /ipns
> ipfs daemon &
> ipfs mount
`,
LongDescription: `
@ -48,6 +49,7 @@ You may have to create /ipfs and /ipfs before using 'ipfs mount':
> sudo mkdir /ipfs /ipns
> sudo chown ` + "`" + `whoami` + "`" + ` /ipfs /ipns
> ipfs daemon &
> ipfs mount
EXAMPLE: