github.com/xhghs/rclone@v1.51.1-0.20200430155106-e186a28cced8/cmd/ls/lshelp/lshelp.go (about)

     1  package lshelp
     2  
     3  // Help describes the common help for all the list commands
     4  var Help = `
     5  Any of the filtering options can be applied to this command.
     6  
     7  There are several related list commands
     8  
     9    * ` + "`ls`" + ` to list size and path of objects only
    10    * ` + "`lsl`" + ` to list modification time, size and path of objects only
    11    * ` + "`lsd`" + ` to list directories only
    12    * ` + "`lsf`" + ` to list objects and directories in easy to parse format
    13    * ` + "`lsjson`" + ` to list objects and directories in JSON format
    14  
    15  ` + "`ls`,`lsl`,`lsd`" + ` are designed to be human readable.
    16  ` + "`lsf`" + ` is designed to be human and machine readable.
    17  ` + "`lsjson`" + ` is designed to be machine readable.
    18  
    19  Note that ` + "`ls` and `lsl`" + ` recurse by default - use "--max-depth 1" to stop the recursion.
    20  
    21  The other list commands ` + "`lsd`,`lsf`,`lsjson`" + ` do not recurse by default - use "-R" to make them recurse.
    22  
    23  Listing a non existent directory will produce an error except for
    24  remotes which can't have empty directories (eg s3, swift, gcs, etc -
    25  the bucket based remotes).
    26  `