mirror of
https://github.com/minio/minio.git
synced 2025-04-24 04:10:43 -04:00
Update command line docs (#6839)
This commit is contained in:
parent
69bd6df464
commit
a9de303d8b
@ -41,7 +41,7 @@ func init() {
|
|||||||
var (
|
var (
|
||||||
gatewayCmd = cli.Command{
|
gatewayCmd = cli.Command{
|
||||||
Name: "gateway",
|
Name: "gateway",
|
||||||
Usage: "Start object storage gateway.",
|
Usage: "start object storage gateway",
|
||||||
Flags: append(serverFlags, globalFlags...),
|
Flags: append(serverFlags, globalFlags...),
|
||||||
HideHelpCommand: true,
|
HideHelpCommand: true,
|
||||||
}
|
}
|
||||||
|
@ -92,7 +92,7 @@ EXAMPLES:
|
|||||||
`
|
`
|
||||||
minio.RegisterGatewayCommand(cli.Command{
|
minio.RegisterGatewayCommand(cli.Command{
|
||||||
Name: b2Backend,
|
Name: b2Backend,
|
||||||
Usage: "Backblaze B2.",
|
Usage: "Backblaze B2",
|
||||||
Action: b2GatewayMain,
|
Action: b2GatewayMain,
|
||||||
CustomHelpTemplate: b2GatewayTemplate,
|
CustomHelpTemplate: b2GatewayTemplate,
|
||||||
HideHelpCommand: true,
|
HideHelpCommand: true,
|
||||||
|
@ -147,7 +147,7 @@ EXAMPLES:
|
|||||||
|
|
||||||
minio.RegisterGatewayCommand(cli.Command{
|
minio.RegisterGatewayCommand(cli.Command{
|
||||||
Name: gcsBackend,
|
Name: gcsBackend,
|
||||||
Usage: "Google Cloud Storage.",
|
Usage: "Google Cloud Storage",
|
||||||
Action: gcsGatewayMain,
|
Action: gcsGatewayMain,
|
||||||
CustomHelpTemplate: gcsGatewayTemplate,
|
CustomHelpTemplate: gcsGatewayTemplate,
|
||||||
HideHelpCommand: true,
|
HideHelpCommand: true,
|
||||||
|
@ -108,7 +108,7 @@ EXAMPLES:
|
|||||||
|
|
||||||
minio.RegisterGatewayCommand(cli.Command{
|
minio.RegisterGatewayCommand(cli.Command{
|
||||||
Name: mantaBackend,
|
Name: mantaBackend,
|
||||||
Usage: "Manta Object Storage.",
|
Usage: "Manta Object Storage",
|
||||||
Action: mantaGatewayMain,
|
Action: mantaGatewayMain,
|
||||||
CustomHelpTemplate: mantaGatewayTemplate,
|
CustomHelpTemplate: mantaGatewayTemplate,
|
||||||
HideHelpCommand: true,
|
HideHelpCommand: true,
|
||||||
|
@ -74,7 +74,7 @@ EXAMPLES:
|
|||||||
|
|
||||||
minio.RegisterGatewayCommand(cli.Command{
|
minio.RegisterGatewayCommand(cli.Command{
|
||||||
Name: nasBackend,
|
Name: nasBackend,
|
||||||
Usage: "Network-attached storage (NAS).",
|
Usage: "Network-attached storage (NAS)",
|
||||||
Action: nasGatewayMain,
|
Action: nasGatewayMain,
|
||||||
CustomHelpTemplate: nasGatewayTemplate,
|
CustomHelpTemplate: nasGatewayTemplate,
|
||||||
HideHelpCommand: true,
|
HideHelpCommand: true,
|
||||||
|
@ -98,7 +98,7 @@ EXAMPLES:
|
|||||||
|
|
||||||
minio.RegisterGatewayCommand(cli.Command{
|
minio.RegisterGatewayCommand(cli.Command{
|
||||||
Name: "oss",
|
Name: "oss",
|
||||||
Usage: "Alibaba Cloud (Aliyun) Object Storage Service (OSS).",
|
Usage: "Alibaba Cloud (Aliyun) Object Storage Service (OSS)",
|
||||||
Action: ossGatewayMain,
|
Action: ossGatewayMain,
|
||||||
CustomHelpTemplate: ossGatewayTemplate,
|
CustomHelpTemplate: ossGatewayTemplate,
|
||||||
HideHelpCommand: true,
|
HideHelpCommand: true,
|
||||||
|
@ -111,7 +111,7 @@ EXAMPLES:
|
|||||||
|
|
||||||
minio.RegisterGatewayCommand(cli.Command{
|
minio.RegisterGatewayCommand(cli.Command{
|
||||||
Name: s3Backend,
|
Name: s3Backend,
|
||||||
Usage: "Amazon Simple Storage Service (S3).",
|
Usage: "Amazon Simple Storage Service (S3)",
|
||||||
Action: s3GatewayMain,
|
Action: s3GatewayMain,
|
||||||
CustomHelpTemplate: s3GatewayTemplate,
|
CustomHelpTemplate: s3GatewayTemplate,
|
||||||
HideHelpCommand: true,
|
HideHelpCommand: true,
|
||||||
|
@ -97,7 +97,7 @@ EXAMPLES:
|
|||||||
|
|
||||||
minio.RegisterGatewayCommand(cli.Command{
|
minio.RegisterGatewayCommand(cli.Command{
|
||||||
Name: siaBackend,
|
Name: siaBackend,
|
||||||
Usage: "Sia Decentralized Cloud.",
|
Usage: "Sia Decentralized Cloud",
|
||||||
Action: siaGatewayMain,
|
Action: siaGatewayMain,
|
||||||
CustomHelpTemplate: siaGatewayTemplate,
|
CustomHelpTemplate: siaGatewayTemplate,
|
||||||
HideHelpCommand: true,
|
HideHelpCommand: true,
|
||||||
|
@ -41,13 +41,13 @@ var serverFlags = []cli.Flag{
|
|||||||
cli.StringFlag{
|
cli.StringFlag{
|
||||||
Name: "address",
|
Name: "address",
|
||||||
Value: ":" + globalMinioPort,
|
Value: ":" + globalMinioPort,
|
||||||
Usage: "Bind to a specific ADDRESS:PORT, ADDRESS can be an IP or hostname.",
|
Usage: "bind to a specific ADDRESS:PORT, ADDRESS can be an IP or hostname",
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
var serverCmd = cli.Command{
|
var serverCmd = cli.Command{
|
||||||
Name: "server",
|
Name: "server",
|
||||||
Usage: "Start object storage server.",
|
Usage: "start object storage server",
|
||||||
Flags: append(serverFlags, globalFlags...),
|
Flags: append(serverFlags, globalFlags...),
|
||||||
Action: serverMain,
|
Action: serverMain,
|
||||||
CustomHelpTemplate: `NAME:
|
CustomHelpTemplate: `NAME:
|
||||||
@ -112,10 +112,10 @@ EXAMPLES:
|
|||||||
4. Start erasure coded minio server on a node with 64 drives.
|
4. Start erasure coded minio server on a node with 64 drives.
|
||||||
$ {{.HelpName}} /mnt/export{1...64}
|
$ {{.HelpName}} /mnt/export{1...64}
|
||||||
|
|
||||||
5. Start distributed minio server on an 8 node setup with 8 drives each. Run following command on all the 8 nodes.
|
5. Start distributed minio server on an 32 node setup with 32 drives each. Run following command on all the 32 nodes.
|
||||||
$ export MINIO_ACCESS_KEY=minio
|
$ export MINIO_ACCESS_KEY=minio
|
||||||
$ export MINIO_SECRET_KEY=miniostorage
|
$ export MINIO_SECRET_KEY=miniostorage
|
||||||
$ {{.HelpName}} http://node{1...8}.example.com/mnt/export/{1...8}
|
$ {{.HelpName}} http://node{1...32}.example.com/mnt/export/{1...32}
|
||||||
|
|
||||||
6. Start minio server with edge caching enabled.
|
6. Start minio server with edge caching enabled.
|
||||||
$ export MINIO_CACHE_DRIVES="/mnt/drive1;/mnt/drive2;/mnt/drive3;/mnt/drive4"
|
$ export MINIO_CACHE_DRIVES="/mnt/drive1;/mnt/drive2;/mnt/drive3;/mnt/drive4"
|
||||||
|
@ -40,12 +40,12 @@ import (
|
|||||||
// Check for new software updates.
|
// Check for new software updates.
|
||||||
var updateCmd = cli.Command{
|
var updateCmd = cli.Command{
|
||||||
Name: "update",
|
Name: "update",
|
||||||
Usage: "Check for a new software update.",
|
Usage: "update minio to latest release",
|
||||||
Action: mainUpdate,
|
Action: mainUpdate,
|
||||||
Flags: []cli.Flag{
|
Flags: []cli.Flag{
|
||||||
cli.BoolFlag{
|
cli.BoolFlag{
|
||||||
Name: "quiet",
|
Name: "quiet",
|
||||||
Usage: "Disable any update prompt message.",
|
Usage: "disable any update prompt message",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
CustomHelpTemplate: `Name:
|
CustomHelpTemplate: `Name:
|
||||||
|
@ -23,7 +23,7 @@ import (
|
|||||||
|
|
||||||
var versionCmd = cli.Command{
|
var versionCmd = cli.Command{
|
||||||
Name: "version",
|
Name: "version",
|
||||||
Usage: "Print version.",
|
Usage: "print version",
|
||||||
Action: mainVersion,
|
Action: mainVersion,
|
||||||
CustomHelpTemplate: `NAME:
|
CustomHelpTemplate: `NAME:
|
||||||
{{.HelpName}} - {{.Usage}}
|
{{.HelpName}} - {{.Usage}}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user