Add help to remote chooser in rclone config - fixes #43

amazonclouddrive/amazonclouddrive.go

@@ -64,6 +64,7 @@ var (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "amazon cloud drive",
+		Description: "Amazon Cloud Drive",
 		NewFs:       NewFs,
 		Config: func(name string) {
 			err := oauthutil.Config("amazon cloud drive", name, acdConfig)

b2/b2.go

@@ -41,6 +41,7 @@ const (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "b2",
+		Description: "Backblaze B2",
 		NewFs:       NewFs,
 		Options: []fs.Option{{
 			Name: "account",

drive/drive.go

@@ -86,6 +86,7 @@ var (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "drive",
+		Description: "Google Drive",
 		NewFs:       NewFs,
 		Config: func(name string) {
 			err := oauthutil.Config("drive", name, driveConfig)

dropbox/dropbox.go

@@ -46,6 +46,7 @@ var (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "dropbox",
+		Description: "Dropbox",
 		NewFs:       NewFs,
 		Config:      configHelper,
 		Options: []fs.Option{{

fs/config.go

@@ -673,14 +673,26 @@ func ChooseOption(o *Option) string {
 	return ReadLine()
 }
 
+// fsOption returns an Option describing the possible remotes
+func fsOption() *Option {
+	o := &Option{
+		Name: "Storage",
+		Help: "Type of storage to configure.",
+	}
+	for _, item := range fsRegistry {
+		example := OptionExample{
+			Value: item.Name,
+			Help:  item.Description,
+		}
+		o.Examples = append(o.Examples, example)
+	}
+	o.Examples.Sort()
+	return o
+}
+
 // NewRemote make a new remote from its name
 func NewRemote(name string) {
-	fmt.Printf("What type of source is it?\n")
-	types := []string{}
-	for _, item := range fsRegistry {
-		types = append(types, item.Name)
-	}
-	newType := Choose("type", types, nil, false)
+	newType := ChooseOption(fsOption())
 	ConfigFile.SetValue(name, "type", newType)
 	fs, err := Find(newType)
 	if err != nil {

fs/fs.go

@@ -7,6 +7,7 @@ import (
 	"log"
 	"path/filepath"
 	"regexp"
+	"sort"
 	"time"
 )
 
@@ -36,6 +37,8 @@ var (
 type RegInfo struct {
 	// Name of this fs
 	Name string
+	// Description of this fs - defaults to Name
+	Description string
 	// Create a new file system.  If root refers to an existing
 	// object, then it should return a Fs which only returns that
 	// object.
@@ -51,9 +54,24 @@ type Option struct {
 	Name     string
 	Help     string
 	Optional bool
-	Examples []OptionExample
+	Examples OptionExamples
 }
 
+// OptionExamples is a slice of examples
+type OptionExamples []OptionExample
+
+// Len is part of sort.Interface.
+func (os OptionExamples) Len() int { return len(os) }
+
+// Swap is part of sort.Interface.
+func (os OptionExamples) Swap(i, j int) { os[i], os[j] = os[j], os[i] }
+
+// Less is part of sort.Interface.
+func (os OptionExamples) Less(i, j int) bool { return os[i].Help < os[j].Help }
+
+// Sort sorts an OptionExamples
+func (os OptionExamples) Sort() { sort.Sort(os) }
+
 // OptionExample describes an example for an Option
 type OptionExample struct {
 	Value string

googlecloudstorage/googlecloudstorage.go

@@ -57,6 +57,7 @@ var (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "google cloud storage",
+		Description: "Google Cloud Storage (this is not Google Drive)",
 		NewFs:       NewFs,
 		Config: func(name string) {
 			err := oauthutil.Config("google cloud storage", name, storageConfig)

hubic/hubic.go

@@ -46,6 +46,7 @@ var (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "hubic",
+		Description: "Hubic",
 		NewFs:       NewFs,
 		Config: func(name string) {
 			err := oauthutil.Config("hubic", name, oauthConfig)

local/local.go

@@ -21,6 +21,7 @@ import (
 func init() {
 	fsi := &fs.RegInfo{
 		Name:        "local",
+		Description: "Local Disk",
 		NewFs:       NewFs,
 		Options: []fs.Option{fs.Option{
 			Name:     "nounc",

onedrive/onedrive.go

@@ -57,6 +57,7 @@ var (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "onedrive",
+		Description: "Microsoft OneDrive",
 		NewFs:       NewFs,
 		Config: func(name string) {
 			err := oauthutil.Config("onedrive", name, oauthConfig)

s3/s3.go

@@ -42,6 +42,7 @@ import (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "s3",
+		Description: "Amazon S3 (also Dreamhost, Ceph)",
 		NewFs:       NewFs,
 		// AWS endpoints: http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region
 		Options: []fs.Option{{
@@ -94,10 +95,10 @@ func init() {
 				Help:  "South America (Sao Paulo) Region\nNeeds location constraint sa-east-1.",
 			}, {
 				Value: "other-v2-signature",
-				Help:  "If using an S3 clone that only understands v2 signatures - eg Ceph - set this and make sure you set the endpoint.",
+				Help:  "If using an S3 clone that only understands v2 signatures\neg Ceph/Dreamhost\nset this and make sure you set the endpoint.",
 			}, {
 				Value: "other-v4-signature",
-				Help:  "If using an S3 clone that understands v4 signatures set this and make sure you set the endpoint.",
+				Help:  "If using an S3 clone that understands v4 signatures set this\nand make sure you set the endpoint.",
 			}},
 		}, {
 			Name: "endpoint",

swift/swift.go

@@ -31,6 +31,7 @@ var (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "swift",
+		Description: "Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)",
 		NewFs:       NewFs,
 		Options: []fs.Option{{
 			Name: "user",

yandex/yandex.go

@@ -43,6 +43,7 @@ var (
 func init() {
 	fs.Register(&fs.RegInfo{
 		Name:        "yandex",
+		Description: "Yandex Disk",
 		NewFs:       NewFs,
 		Config: func(name string) {
 			err := oauthutil.Config("yandex", name, oauthConfig)