ls* commands: update docs and add defaults into options for lsf

cmd/ls/ls.go

@@ -4,6 +4,7 @@ import (
 	"os"
 
 	"github.com/ncw/rclone/cmd"
+	"github.com/ncw/rclone/cmd/ls/lshelp"
 	"github.com/ncw/rclone/fs"
 	"github.com/spf13/cobra"
 )
@@ -14,7 +15,11 @@ func init() {
 
 var commandDefintion = &cobra.Command{
 	Use:   "ls remote:path",
-	Short: `List all the objects in the path with size and path.`,
+	Short: `List the objects in the path with size and path.`,
+	Long: `
+Lists the objects in the source path to standard output in a human
+readable format with size and path. Recurses by default.
+` + lshelp.Help,
 	Run: func(command *cobra.Command, args []string) {
 		cmd.CheckArgs(1, 1, command, args)
 		fsrc := cmd.NewFsSrc(args)

cmd/ls/lshelp/lshelp.go

@@ -0,0 +1,22 @@
+package lshelp
+
+// Help describes the common help for all the list commands
+var Help = `
+Any of the filtering options can be applied to this commmand.
+
+There are several related list commands
+
+  * ` + "`ls`" + ` to list size and path of objects only
+  * ` + "`lsl`" + ` to list modification time, size and path of objects only
+  * ` + "`lsd`" + ` to list directories only
+  * ` + "`lsf`" + ` to list objects and directories in easy to parse format
+  * ` + "`lsjson`" + ` to list objects and directories in JSON format
+
+` + "`ls`,`lsl`,`lsd`" + ` are designed to be human readable.
+` + "`lsf`" + ` is designed to be human and machine readable.
+` + "`lsjson`" + ` is designed to be machine readable.
+
+Note that ` + "`ls`,`lsl`,`lsd`" + ` all recurse by default - use "--max-depth 1" to stop the recursion.
+
+The other list commands ` + "`lsf`,`lsjson`" + ` do not recurse by default - use "-R" to make them recurse.
+`