github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/cmd/ls/lshelp/lshelp.go (about)

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