2018-01-07 01:00:20 +08:00
|
|
|
package lshelp
|
|
|
|
|
|
2020-05-25 15:50:20 +08:00
|
|
|
import (
|
|
|
|
|
"strings"
|
|
|
|
|
)
|
|
|
|
|
|
2018-01-07 01:00:20 +08:00
|
|
|
// Help describes the common help for all the list commands
|
2020-05-25 15:50:20 +08:00
|
|
|
// Warning! "|" will be replaced by backticks below
|
|
|
|
|
var Help = strings.ReplaceAll(`
|
2019-04-30 20:06:24 +08:00
|
|
|
Any of the filtering options can be applied to this command.
|
2018-01-07 01:00:20 +08:00
|
|
|
|
|
|
|
|
There are several related list commands
|
|
|
|
|
|
2020-05-25 15:50:20 +08:00
|
|
|
* |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
|
2018-01-07 01:00:20 +08:00
|
|
|
|
2020-05-25 15:50:20 +08:00
|
|
|
|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.
|
2018-01-07 01:00:20 +08:00
|
|
|
|
2020-05-25 15:50:20 +08:00
|
|
|
Note that |ls| and |lsl| recurse by default - use |--max-depth 1| to stop the recursion.
|
2018-01-07 01:00:20 +08:00
|
|
|
|
2020-05-25 15:50:20 +08:00
|
|
|
The other list commands |lsd|,|lsf|,|lsjson| do not recurse by default - use |-R| to make them recurse.
|
2018-04-21 06:06:51 +08:00
|
|
|
|
|
|
|
|
Listing a non existent directory will produce an error except for
|
2020-10-14 06:03:04 +08:00
|
|
|
remotes which can't have empty directories (e.g. s3, swift, or gcs -
|
2018-04-21 06:06:51 +08:00
|
|
|
the bucket based remotes).
|
2020-05-25 15:50:20 +08:00
|
|
|
`, "|", "`")
|
