mirror of
https://github.com/rclone/rclone.git
synced 2024-11-22 00:13:49 +01:00
docs: consistent newline of first line in command output
This commit is contained in:
parent
ae9960a4ed
commit
482bfae8fa
@ -46,8 +46,7 @@ func printValue(what string, uv *int64, isSize bool) {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "about remote:",
|
Use: "about remote:",
|
||||||
Short: `Get quota information from the remote.`,
|
Short: `Get quota information from the remote.`,
|
||||||
Long: `
|
Long: `Prints quota information about a remote to standard
|
||||||
` + "`rclone about`" + ` prints quota information about a remote to standard
|
|
||||||
output. The output is typically used, free, quota and trash contents.
|
output. The output is typically used, free, quota and trash contents.
|
||||||
|
|
||||||
E.g. Typical output from ` + "`rclone about remote:`" + ` is:
|
E.g. Typical output from ` + "`rclone about remote:`" + ` is:
|
||||||
|
@ -25,8 +25,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "authorize",
|
Use: "authorize",
|
||||||
Short: `Remote authorization.`,
|
Short: `Remote authorization.`,
|
||||||
Long: `
|
Long: `Remote authorization. Used to authorize a remote or headless
|
||||||
Remote authorization. Used to authorize a remote or headless
|
|
||||||
rclone from a machine with a browser - use as instructed by
|
rclone from a machine with a browser - use as instructed by
|
||||||
rclone config.
|
rclone config.
|
||||||
|
|
||||||
|
@ -31,8 +31,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "backend <command> remote:path [opts] <args>",
|
Use: "backend <command> remote:path [opts] <args>",
|
||||||
Short: `Run a backend-specific command.`,
|
Short: `Run a backend-specific command.`,
|
||||||
Long: `
|
Long: `This runs a backend-specific command. The commands themselves (except
|
||||||
This runs a backend-specific command. The commands themselves (except
|
|
||||||
for "help" and "features") are defined by the backends and you should
|
for "help" and "features") are defined by the backends and you should
|
||||||
see the backend docs for definitions.
|
see the backend docs for definitions.
|
||||||
|
|
||||||
|
@ -20,8 +20,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "cachestats source:",
|
Use: "cachestats source:",
|
||||||
Short: `Print cache stats for a remote`,
|
Short: `Print cache stats for a remote`,
|
||||||
Long: `
|
Long: `Print cache stats for a remote in JSON format
|
||||||
Print cache stats for a remote in JSON format
|
|
||||||
`,
|
`,
|
||||||
Hidden: true,
|
Hidden: true,
|
||||||
Annotations: map[string]string{
|
Annotations: map[string]string{
|
||||||
|
@ -39,8 +39,7 @@ var commandDefinition = &cobra.Command{
|
|||||||
Use: "cat remote:path",
|
Use: "cat remote:path",
|
||||||
Short: `Concatenates any files and sends them to stdout.`,
|
Short: `Concatenates any files and sends them to stdout.`,
|
||||||
// Warning! "|" will be replaced by backticks below
|
// Warning! "|" will be replaced by backticks below
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Sends any files to standard output.
|
||||||
rclone cat sends any files to standard output.
|
|
||||||
|
|
||||||
You can use it like this to output a single file
|
You can use it like this to output a single file
|
||||||
|
|
||||||
|
@ -138,8 +138,7 @@ func GetCheckOpt(fsrc, fdst fs.Fs) (opt *operations.CheckOpt, close func(), err
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "check source:path dest:path",
|
Use: "check source:path dest:path",
|
||||||
Short: `Checks the files in the source and destination match.`,
|
Short: `Checks the files in the source and destination match.`,
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Checks the files in the source and destination match. It compares
|
||||||
Checks the files in the source and destination match. It compares
|
|
||||||
sizes and hashes (MD5 or SHA1) and logs a report of files that don't
|
sizes and hashes (MD5 or SHA1) and logs a report of files that don't
|
||||||
match. It doesn't alter the source or destination.
|
match. It doesn't alter the source or destination.
|
||||||
|
|
||||||
|
@ -26,8 +26,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "checksum <hash> sumfile dst:path",
|
Use: "checksum <hash> sumfile dst:path",
|
||||||
Short: `Checks the files in the destination against a SUM file.`,
|
Short: `Checks the files in the destination against a SUM file.`,
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Checks that hashsums of destination files match the SUM file.
|
||||||
Checks that hashsums of destination files match the SUM file.
|
|
||||||
It compares hashes (MD5, SHA1, etc) and logs a report of files which
|
It compares hashes (MD5, SHA1, etc) and logs a report of files which
|
||||||
don't match. It doesn't alter the file system.
|
don't match. It doesn't alter the file system.
|
||||||
|
|
||||||
|
@ -16,8 +16,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "cleanup remote:path",
|
Use: "cleanup remote:path",
|
||||||
Short: `Clean up the remote if possible.`,
|
Short: `Clean up the remote if possible.`,
|
||||||
Long: `
|
Long: `Clean up the remote if possible. Empty the trash or delete old file
|
||||||
Clean up the remote if possible. Empty the trash or delete old file
|
|
||||||
versions. Not supported by all remotes.
|
versions. Not supported by all remotes.
|
||||||
`,
|
`,
|
||||||
Annotations: map[string]string{
|
Annotations: map[string]string{
|
||||||
|
@ -268,8 +268,7 @@ as a readable demonstration.
|
|||||||
var configCreateCommand = &cobra.Command{
|
var configCreateCommand = &cobra.Command{
|
||||||
Use: "create name type [key value]*",
|
Use: "create name type [key value]*",
|
||||||
Short: `Create a new remote with name, type and options.`,
|
Short: `Create a new remote with name, type and options.`,
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Create a new remote of |name| with |type| and options. The options
|
||||||
Create a new remote of |name| with |type| and options. The options
|
|
||||||
should be passed in pairs of |key| |value| or as |key=value|.
|
should be passed in pairs of |key| |value| or as |key=value|.
|
||||||
|
|
||||||
For example, to make a swift remote of name myremote using auto config
|
For example, to make a swift remote of name myremote using auto config
|
||||||
@ -334,8 +333,7 @@ func init() {
|
|||||||
var configUpdateCommand = &cobra.Command{
|
var configUpdateCommand = &cobra.Command{
|
||||||
Use: "update name [key value]+",
|
Use: "update name [key value]+",
|
||||||
Short: `Update options in an existing remote.`,
|
Short: `Update options in an existing remote.`,
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Update an existing remote's options. The options should be passed in
|
||||||
Update an existing remote's options. The options should be passed in
|
|
||||||
pairs of |key| |value| or as |key=value|.
|
pairs of |key| |value| or as |key=value|.
|
||||||
|
|
||||||
For example, to update the env_auth field of a remote of name myremote
|
For example, to update the env_auth field of a remote of name myremote
|
||||||
@ -379,8 +377,7 @@ var configDeleteCommand = &cobra.Command{
|
|||||||
var configPasswordCommand = &cobra.Command{
|
var configPasswordCommand = &cobra.Command{
|
||||||
Use: "password name [key value]+",
|
Use: "password name [key value]+",
|
||||||
Short: `Update password in an existing remote.`,
|
Short: `Update password in an existing remote.`,
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Update an existing remote's password. The password
|
||||||
Update an existing remote's password. The password
|
|
||||||
should be passed in pairs of |key| |password| or as |key=password|.
|
should be passed in pairs of |key| |password| or as |key=password|.
|
||||||
The |password| should be passed in in clear (unobscured).
|
The |password| should be passed in in clear (unobscured).
|
||||||
|
|
||||||
@ -435,8 +432,7 @@ func argsToMap(args []string) (out rc.Params, err error) {
|
|||||||
var configReconnectCommand = &cobra.Command{
|
var configReconnectCommand = &cobra.Command{
|
||||||
Use: "reconnect remote:",
|
Use: "reconnect remote:",
|
||||||
Short: `Re-authenticates user with remote.`,
|
Short: `Re-authenticates user with remote.`,
|
||||||
Long: `
|
Long: `This reconnects remote: passed in to the cloud storage system.
|
||||||
This reconnects remote: passed in to the cloud storage system.
|
|
||||||
|
|
||||||
To disconnect the remote use "rclone config disconnect".
|
To disconnect the remote use "rclone config disconnect".
|
||||||
|
|
||||||
@ -456,8 +452,7 @@ This normally means going through the interactive oauth flow again.
|
|||||||
var configDisconnectCommand = &cobra.Command{
|
var configDisconnectCommand = &cobra.Command{
|
||||||
Use: "disconnect remote:",
|
Use: "disconnect remote:",
|
||||||
Short: `Disconnects user from remote`,
|
Short: `Disconnects user from remote`,
|
||||||
Long: `
|
Long: `This disconnects the remote: passed in to the cloud storage system.
|
||||||
This disconnects the remote: passed in to the cloud storage system.
|
|
||||||
|
|
||||||
This normally means revoking the oauth token.
|
This normally means revoking the oauth token.
|
||||||
|
|
||||||
@ -489,8 +484,7 @@ func init() {
|
|||||||
var configUserInfoCommand = &cobra.Command{
|
var configUserInfoCommand = &cobra.Command{
|
||||||
Use: "userinfo remote:",
|
Use: "userinfo remote:",
|
||||||
Short: `Prints info about logged in user of remote.`,
|
Short: `Prints info about logged in user of remote.`,
|
||||||
Long: `
|
Long: `This prints the details of the person logged in to the cloud storage
|
||||||
This prints the details of the person logged in to the cloud storage
|
|
||||||
system.
|
system.
|
||||||
`,
|
`,
|
||||||
RunE: func(command *cobra.Command, args []string) error {
|
RunE: func(command *cobra.Command, args []string) error {
|
||||||
|
@ -26,8 +26,7 @@ var commandDefinition = &cobra.Command{
|
|||||||
Use: "copy source:path dest:path",
|
Use: "copy source:path dest:path",
|
||||||
Short: `Copy files from source to dest, skipping identical files.`,
|
Short: `Copy files from source to dest, skipping identical files.`,
|
||||||
// Note: "|" will be replaced by backticks below
|
// Note: "|" will be replaced by backticks below
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Copy the source to the destination. Does not transfer files that are
|
||||||
Copy the source to the destination. Does not transfer files that are
|
|
||||||
identical on source and destination, testing by size and modification
|
identical on source and destination, testing by size and modification
|
||||||
time or MD5SUM. Doesn't delete files from the destination. If you
|
time or MD5SUM. Doesn't delete files from the destination. If you
|
||||||
want to also delete files from destination, to make it match source,
|
want to also delete files from destination, to make it match source,
|
||||||
|
@ -17,8 +17,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "copyto source:path dest:path",
|
Use: "copyto source:path dest:path",
|
||||||
Short: `Copy files from source to dest, skipping identical files.`,
|
Short: `Copy files from source to dest, skipping identical files.`,
|
||||||
Long: `
|
Long: `If source:path is a file or directory then it copies it to a file or
|
||||||
If source:path is a file or directory then it copies it to a file or
|
|
||||||
directory named dest:path.
|
directory named dest:path.
|
||||||
|
|
||||||
This can be used to upload single files to other than their current
|
This can be used to upload single files to other than their current
|
||||||
|
@ -36,8 +36,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "copyurl https://example.com dest:path",
|
Use: "copyurl https://example.com dest:path",
|
||||||
Short: `Copy the contents of the URL supplied content to dest:path.`,
|
Short: `Copy the contents of the URL supplied content to dest:path.`,
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Download a URL's content and copy it to the destination without saving
|
||||||
Download a URL's content and copy it to the destination without saving
|
|
||||||
it in temporary storage.
|
it in temporary storage.
|
||||||
|
|
||||||
Setting |--auto-filename| will attempt to automatically determine the
|
Setting |--auto-filename| will attempt to automatically determine the
|
||||||
|
@ -23,10 +23,9 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "cryptcheck remote:path cryptedremote:path",
|
Use: "cryptcheck remote:path cryptedremote:path",
|
||||||
Short: `Cryptcheck checks the integrity of an encrypted remote.`,
|
Short: `Cryptcheck checks the integrity of an encrypted remote.`,
|
||||||
Long: `
|
Long: `Checks a remote against a [crypted](/crypt/) remote. This is the equivalent
|
||||||
rclone cryptcheck checks a remote against a [crypted](/crypt/) remote.
|
of running rclone [check](/commands/rclone_check/), but able to check the
|
||||||
This is the equivalent of running rclone [check](/commands/rclone_check/),
|
checksums of the encrypted remote.
|
||||||
but able to check the checksums of the encrypted remote.
|
|
||||||
|
|
||||||
For it to work the underlying remote of the cryptedremote must support
|
For it to work the underlying remote of the cryptedremote must support
|
||||||
some kind of checksum.
|
some kind of checksum.
|
||||||
|
@ -26,9 +26,8 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "cryptdecode encryptedremote: encryptedfilename",
|
Use: "cryptdecode encryptedremote: encryptedfilename",
|
||||||
Short: `Cryptdecode returns unencrypted file names.`,
|
Short: `Cryptdecode returns unencrypted file names.`,
|
||||||
Long: `
|
Long: `Returns unencrypted file names when provided with a list of encrypted file
|
||||||
rclone cryptdecode returns unencrypted file names when provided with
|
names. List limit is 10 items.
|
||||||
a list of encrypted file names. List limit is 10 items.
|
|
||||||
|
|
||||||
If you supply the ` + "`--reverse`" + ` flag, it will return encrypted file names.
|
If you supply the ` + "`--reverse`" + ` flag, it will return encrypted file names.
|
||||||
|
|
||||||
|
@ -27,9 +27,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "dedupe [mode] remote:path",
|
Use: "dedupe [mode] remote:path",
|
||||||
Short: `Interactively find duplicate filenames and delete/rename them.`,
|
Short: `Interactively find duplicate filenames and delete/rename them.`,
|
||||||
Long: `
|
Long: `By default ` + "`dedupe`" + ` interactively finds files with duplicate
|
||||||
|
|
||||||
By default ` + "`dedupe`" + ` interactively finds files with duplicate
|
|
||||||
names and offers to delete all but one or rename them to be
|
names and offers to delete all but one or rename them to be
|
||||||
different. This is known as deduping by name.
|
different. This is known as deduping by name.
|
||||||
|
|
||||||
|
@ -25,8 +25,7 @@ var commandDefinition = &cobra.Command{
|
|||||||
Use: "delete remote:path",
|
Use: "delete remote:path",
|
||||||
Short: `Remove the files in path.`,
|
Short: `Remove the files in path.`,
|
||||||
// Warning! "|" will be replaced by backticks below
|
// Warning! "|" will be replaced by backticks below
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Remove the files in path. Unlike [purge](/commands/rclone_purge/) it
|
||||||
Remove the files in path. Unlike [purge](/commands/rclone_purge/) it
|
|
||||||
obeys include/exclude filters so can be used to selectively delete files.
|
obeys include/exclude filters so can be used to selectively delete files.
|
||||||
|
|
||||||
|rclone delete| only deletes files but leaves the directory structure
|
|rclone delete| only deletes files but leaves the directory structure
|
||||||
|
@ -18,8 +18,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "deletefile remote:path",
|
Use: "deletefile remote:path",
|
||||||
Short: `Remove a single file from remote.`,
|
Short: `Remove a single file from remote.`,
|
||||||
Long: `
|
Long: `Remove a single file from remote. Unlike ` + "`" + `delete` + "`" + ` it cannot be used to
|
||||||
Remove a single file from remote. Unlike ` + "`" + `delete` + "`" + ` it cannot be used to
|
|
||||||
remove a directory and it doesn't obey include/exclude filters - if the specified file exists,
|
remove a directory and it doesn't obey include/exclude filters - if the specified file exists,
|
||||||
it will always be removed.
|
it will always be removed.
|
||||||
`,
|
`,
|
||||||
|
@ -13,8 +13,7 @@ func init() {
|
|||||||
var completionDefinition = &cobra.Command{
|
var completionDefinition = &cobra.Command{
|
||||||
Use: "completion [shell]",
|
Use: "completion [shell]",
|
||||||
Short: `Output completion script for a given shell.`,
|
Short: `Output completion script for a given shell.`,
|
||||||
Long: `
|
Long: `Generates a shell completion script for rclone.
|
||||||
Generates a shell completion script for rclone.
|
|
||||||
Run with ` + "`--help`" + ` to list the supported shells.
|
Run with ` + "`--help`" + ` to list the supported shells.
|
||||||
`,
|
`,
|
||||||
Annotations: map[string]string{
|
Annotations: map[string]string{
|
||||||
|
@ -15,8 +15,7 @@ func init() {
|
|||||||
var bashCommandDefinition = &cobra.Command{
|
var bashCommandDefinition = &cobra.Command{
|
||||||
Use: "bash [output_file]",
|
Use: "bash [output_file]",
|
||||||
Short: `Output bash completion script for rclone.`,
|
Short: `Output bash completion script for rclone.`,
|
||||||
Long: `
|
Long: `Generates a bash shell autocompletion script for rclone.
|
||||||
Generates a bash shell autocompletion script for rclone.
|
|
||||||
|
|
||||||
By default, when run without any arguments,
|
By default, when run without any arguments,
|
||||||
|
|
||||||
|
@ -15,8 +15,7 @@ func init() {
|
|||||||
var fishCommandDefinition = &cobra.Command{
|
var fishCommandDefinition = &cobra.Command{
|
||||||
Use: "fish [output_file]",
|
Use: "fish [output_file]",
|
||||||
Short: `Output fish completion script for rclone.`,
|
Short: `Output fish completion script for rclone.`,
|
||||||
Long: `
|
Long: `Generates a fish autocompletion script for rclone.
|
||||||
Generates a fish autocompletion script for rclone.
|
|
||||||
|
|
||||||
This writes to /etc/fish/completions/rclone.fish by default so will
|
This writes to /etc/fish/completions/rclone.fish by default so will
|
||||||
probably need to be run with sudo or as root, e.g.
|
probably need to be run with sudo or as root, e.g.
|
||||||
|
@ -15,8 +15,7 @@ func init() {
|
|||||||
var powershellCommandDefinition = &cobra.Command{
|
var powershellCommandDefinition = &cobra.Command{
|
||||||
Use: "powershell [output_file]",
|
Use: "powershell [output_file]",
|
||||||
Short: `Output powershell completion script for rclone.`,
|
Short: `Output powershell completion script for rclone.`,
|
||||||
Long: `
|
Long: `Generate the autocompletion script for powershell.
|
||||||
Generate the autocompletion script for powershell.
|
|
||||||
|
|
||||||
To load completions in your current shell session:
|
To load completions in your current shell session:
|
||||||
|
|
||||||
|
@ -15,8 +15,7 @@ func init() {
|
|||||||
var zshCommandDefinition = &cobra.Command{
|
var zshCommandDefinition = &cobra.Command{
|
||||||
Use: "zsh [output_file]",
|
Use: "zsh [output_file]",
|
||||||
Short: `Output zsh completion script for rclone.`,
|
Short: `Output zsh completion script for rclone.`,
|
||||||
Long: `
|
Long: `Generates a zsh autocompletion script for rclone.
|
||||||
Generates a zsh autocompletion script for rclone.
|
|
||||||
|
|
||||||
This writes to /usr/share/zsh/vendor-completions/_rclone by default so will
|
This writes to /usr/share/zsh/vendor-completions/_rclone by default so will
|
||||||
probably need to be run with sudo or as root, e.g.
|
probably need to be run with sudo or as root, e.g.
|
||||||
|
@ -53,8 +53,7 @@ aliases:
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "gendocs output_directory",
|
Use: "gendocs output_directory",
|
||||||
Short: `Output markdown docs for rclone to the directory supplied.`,
|
Short: `Output markdown docs for rclone to the directory supplied.`,
|
||||||
Long: `
|
Long: `This produces markdown docs for the rclone commands to the directory
|
||||||
This produces markdown docs for the rclone commands to the directory
|
|
||||||
supplied. These are in a format suitable for hugo to render into the
|
supplied. These are in a format suitable for hugo to render into the
|
||||||
rclone.org website.`,
|
rclone.org website.`,
|
||||||
Annotations: map[string]string{
|
Annotations: map[string]string{
|
||||||
|
@ -84,8 +84,7 @@ func CreateFromStdinArg(ht hash.Type, args []string, startArg int) (bool, error)
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "hashsum [<hash> remote:path]",
|
Use: "hashsum [<hash> remote:path]",
|
||||||
Short: `Produces a hashsum file for all the objects in the path.`,
|
Short: `Produces a hashsum file for all the objects in the path.`,
|
||||||
Long: `
|
Long: `Produces a hash file for all the objects in the path using the hash
|
||||||
Produces a hash file for all the objects in the path using the hash
|
|
||||||
named. The output is in the same format as the standard
|
named. The output is in the same format as the standard
|
||||||
md5sum/sha1sum tool.
|
md5sum/sha1sum tool.
|
||||||
|
|
||||||
|
@ -27,8 +27,7 @@ import (
|
|||||||
var Root = &cobra.Command{
|
var Root = &cobra.Command{
|
||||||
Use: "rclone",
|
Use: "rclone",
|
||||||
Short: "Show help for rclone commands, flags and backends.",
|
Short: "Show help for rclone commands, flags and backends.",
|
||||||
Long: `
|
Long: `Rclone syncs files to and from cloud storage providers as well as
|
||||||
Rclone syncs files to and from cloud storage providers as well as
|
|
||||||
mounting them, listing them in lots of different ways.
|
mounting them, listing them in lots of different ways.
|
||||||
|
|
||||||
See the home page (https://rclone.org/) for installation, usage,
|
See the home page (https://rclone.org/) for installation, usage,
|
||||||
|
@ -27,8 +27,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "link remote:path",
|
Use: "link remote:path",
|
||||||
Short: `Generate public link to file/folder.`,
|
Short: `Generate public link to file/folder.`,
|
||||||
Long: `rclone link will create, retrieve or remove a public link to the given
|
Long: `Create, retrieve or remove a public link to the given file or folder.
|
||||||
file or folder.
|
|
||||||
|
|
||||||
rclone link remote:path/to/file
|
rclone link remote:path/to/file
|
||||||
rclone link remote:path/to/folder/
|
rclone link remote:path/to/folder/
|
||||||
|
@ -115,8 +115,8 @@ var commandDefinition = &cobra.Command{
|
|||||||
Use: "listremotes [<filter>]",
|
Use: "listremotes [<filter>]",
|
||||||
Short: `List all the remotes in the config file and defined in environment variables.`,
|
Short: `List all the remotes in the config file and defined in environment variables.`,
|
||||||
Long: `
|
Long: `
|
||||||
rclone listremotes lists all the available remotes from the config file,
|
Lists all the available remotes from the config file, or the remotes matching
|
||||||
or the remotes matching an optional filter.
|
an optional filter.
|
||||||
|
|
||||||
Prints the result in human-readable format by default, and as a simple list of
|
Prints the result in human-readable format by default, and as a simple list of
|
||||||
remote names, or if used with flag ` + "`--long`" + ` a tabular format including
|
remote names, or if used with flag ` + "`--long`" + ` a tabular format including
|
||||||
|
@ -18,8 +18,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "ls remote:path",
|
Use: "ls remote:path",
|
||||||
Short: `List the objects in the path with size and path.`,
|
Short: `List the objects in the path with size and path.`,
|
||||||
Long: `
|
Long: `Lists the objects in the source path to standard output in a human
|
||||||
Lists the objects in the source path to standard output in a human
|
|
||||||
readable format with size and path. Recurses by default.
|
readable format with size and path. Recurses by default.
|
||||||
|
|
||||||
Eg
|
Eg
|
||||||
|
@ -26,8 +26,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "lsd remote:path",
|
Use: "lsd remote:path",
|
||||||
Short: `List all directories/containers/buckets in the path.`,
|
Short: `List all directories/containers/buckets in the path.`,
|
||||||
Long: `
|
Long: `Lists the directories in the source path to standard output. Does not
|
||||||
Lists the directories in the source path to standard output. Does not
|
|
||||||
recurse by default. Use the ` + "`-R`" + ` flag to recurse.
|
recurse by default. Use the ` + "`-R`" + ` flag to recurse.
|
||||||
|
|
||||||
This command lists the total size of the directory (if known, -1 if
|
This command lists the total size of the directory (if known, -1 if
|
||||||
|
@ -47,8 +47,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "lsf remote:path",
|
Use: "lsf remote:path",
|
||||||
Short: `List directories and objects in remote:path formatted for parsing.`,
|
Short: `List directories and objects in remote:path formatted for parsing.`,
|
||||||
Long: `
|
Long: `List the contents of the source path (directories and objects) to
|
||||||
List the contents of the source path (directories and objects) to
|
|
||||||
standard output in a form which is easy to parse by scripts. By
|
standard output in a form which is easy to parse by scripts. By
|
||||||
default this will just be the names of the objects and directories,
|
default this will just be the names of the objects and directories,
|
||||||
one per line. The directories will have a / suffix.
|
one per line. The directories will have a / suffix.
|
||||||
|
@ -18,8 +18,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "lsl remote:path",
|
Use: "lsl remote:path",
|
||||||
Short: `List the objects in path with modification time, size and path.`,
|
Short: `List the objects in path with modification time, size and path.`,
|
||||||
Long: `
|
Long: `Lists the objects in the source path to standard output in a human
|
||||||
Lists the objects in the source path to standard output in a human
|
|
||||||
readable format with modification time, size and path. Recurses by default.
|
readable format with modification time, size and path. Recurses by default.
|
||||||
|
|
||||||
Eg
|
Eg
|
||||||
|
@ -20,8 +20,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "md5sum remote:path",
|
Use: "md5sum remote:path",
|
||||||
Short: `Produces an md5sum file for all the objects in the path.`,
|
Short: `Produces an md5sum file for all the objects in the path.`,
|
||||||
Long: `
|
Long: `Produces an md5sum file for all the objects in the path. This
|
||||||
Produces an md5sum file for all the objects in the path. This
|
|
||||||
is in the same format as the standard md5sum tool produces.
|
is in the same format as the standard md5sum tool produces.
|
||||||
|
|
||||||
By default, the hash is requested from the remote. If MD5 is
|
By default, the hash is requested from the remote. If MD5 is
|
||||||
|
@ -29,8 +29,7 @@ var commandDefinition = &cobra.Command{
|
|||||||
Use: "move source:path dest:path",
|
Use: "move source:path dest:path",
|
||||||
Short: `Move files from source to dest.`,
|
Short: `Move files from source to dest.`,
|
||||||
// Warning! "|" will be replaced by backticks below
|
// Warning! "|" will be replaced by backticks below
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`Moves the contents of the source directory to the destination
|
||||||
Moves the contents of the source directory to the destination
|
|
||||||
directory. Rclone will error if the source and destination overlap and
|
directory. Rclone will error if the source and destination overlap and
|
||||||
the remote does not support a server-side directory move operation.
|
the remote does not support a server-side directory move operation.
|
||||||
|
|
||||||
|
@ -17,8 +17,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "moveto source:path dest:path",
|
Use: "moveto source:path dest:path",
|
||||||
Short: `Move file or directory from source to dest.`,
|
Short: `Move file or directory from source to dest.`,
|
||||||
Long: `
|
Long: `If source:path is a file or directory then it moves it to a file or
|
||||||
If source:path is a file or directory then it moves it to a file or
|
|
||||||
directory named dest:path.
|
directory named dest:path.
|
||||||
|
|
||||||
This can be used to rename files or upload single files to other than
|
This can be used to rename files or upload single files to other than
|
||||||
|
@ -31,8 +31,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "ncdu remote:path",
|
Use: "ncdu remote:path",
|
||||||
Short: `Explore a remote with a text based user interface.`,
|
Short: `Explore a remote with a text based user interface.`,
|
||||||
Long: `
|
Long: `This displays a text based user interface allowing the navigation of a
|
||||||
This displays a text based user interface allowing the navigation of a
|
|
||||||
remote. It is most useful for answering the question - "What is using
|
remote. It is most useful for answering the question - "What is using
|
||||||
all my disk space?".
|
all my disk space?".
|
||||||
|
|
||||||
|
@ -16,8 +16,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "purge remote:path",
|
Use: "purge remote:path",
|
||||||
Short: `Remove the path and all of its contents.`,
|
Short: `Remove the path and all of its contents.`,
|
||||||
Long: `
|
Long: `Remove the path and all of its contents. Note that this does not obey
|
||||||
Remove the path and all of its contents. Note that this does not obey
|
|
||||||
include/exclude filters - everything will be removed. Use the
|
include/exclude filters - everything will be removed. Use the
|
||||||
[delete](/commands/rclone_delete/) command if you want to selectively
|
[delete](/commands/rclone_delete/) command if you want to selectively
|
||||||
delete files. To delete empty directories only, use command
|
delete files. To delete empty directories only, use command
|
||||||
|
@ -51,9 +51,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "rc commands parameter",
|
Use: "rc commands parameter",
|
||||||
Short: `Run a command against a running rclone.`,
|
Short: `Run a command against a running rclone.`,
|
||||||
Long: strings.ReplaceAll(`
|
Long: strings.ReplaceAll(`This runs a command against a running rclone. Use the |--url| flag to
|
||||||
|
|
||||||
This runs a command against a running rclone. Use the |--url| flag to
|
|
||||||
specify an non default URL to connect on. This can be either a
|
specify an non default URL to connect on. This can be either a
|
||||||
":port" which is taken to mean "http://localhost:port" or a
|
":port" which is taken to mean "http://localhost:port" or a
|
||||||
"host:port" which is taken to mean "http://host:port"
|
"host:port" which is taken to mean "http://host:port"
|
||||||
|
@ -26,9 +26,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "rcat remote:path",
|
Use: "rcat remote:path",
|
||||||
Short: `Copies standard input to file on remote.`,
|
Short: `Copies standard input to file on remote.`,
|
||||||
Long: `
|
Long: `Reads from standard input (stdin) and copies it to a single remote file.
|
||||||
rclone rcat reads from standard input (stdin) and copies it to a
|
|
||||||
single remote file.
|
|
||||||
|
|
||||||
echo "hello world" | rclone rcat remote:path/to/file
|
echo "hello world" | rclone rcat remote:path/to/file
|
||||||
ffmpeg - | rclone rcat remote:path/to/file
|
ffmpeg - | rclone rcat remote:path/to/file
|
||||||
|
@ -16,8 +16,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "rmdir remote:path",
|
Use: "rmdir remote:path",
|
||||||
Short: `Remove the empty directory at path.`,
|
Short: `Remove the empty directory at path.`,
|
||||||
Long: `
|
Long: `This removes empty directory given by path. Will not remove the path if it
|
||||||
This removes empty directory given by path. Will not remove the path if it
|
|
||||||
has any objects in it, not even empty subdirectories. Use
|
has any objects in it, not even empty subdirectories. Use
|
||||||
command [rmdirs](/commands/rclone_rmdirs/) (or [delete](/commands/rclone_delete/)
|
command [rmdirs](/commands/rclone_rmdirs/) (or [delete](/commands/rclone_delete/)
|
||||||
with option ` + "`--rmdirs`" + `) to do that.
|
with option ` + "`--rmdirs`" + `) to do that.
|
||||||
|
@ -21,8 +21,7 @@ func init() {
|
|||||||
var rmdirsCmd = &cobra.Command{
|
var rmdirsCmd = &cobra.Command{
|
||||||
Use: "rmdirs remote:path",
|
Use: "rmdirs remote:path",
|
||||||
Short: `Remove empty directories under the path.`,
|
Short: `Remove empty directories under the path.`,
|
||||||
Long: `
|
Long: `This recursively removes any empty directories (including directories
|
||||||
This recursively removes any empty directories (including directories
|
|
||||||
that only contain empty directories), that it finds under the path.
|
that only contain empty directories), that it finds under the path.
|
||||||
The root path itself will also be removed if it is empty, unless
|
The root path itself will also be removed if it is empty, unless
|
||||||
you supply the ` + "`--leave-root`" + ` flag.
|
you supply the ` + "`--leave-root`" + ` flag.
|
||||||
|
@ -17,10 +17,9 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "settier tier remote:path",
|
Use: "settier tier remote:path",
|
||||||
Short: `Changes storage class/tier of objects in remote.`,
|
Short: `Changes storage class/tier of objects in remote.`,
|
||||||
Long: `
|
Long: `Changes storage tier or class at remote if supported. Few cloud storage
|
||||||
rclone settier changes storage tier or class at remote if supported.
|
services provides different storage classes on objects, for example
|
||||||
Few cloud storage services provides different storage classes on objects,
|
AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive,
|
||||||
for example AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive,
|
|
||||||
Google Cloud Storage, Regional Storage, Nearline, Coldline etc.
|
Google Cloud Storage, Regional Storage, Nearline, Coldline etc.
|
||||||
|
|
||||||
Note that, certain tier changes make objects not available to access immediately.
|
Note that, certain tier changes make objects not available to access immediately.
|
||||||
|
@ -20,8 +20,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "sha1sum remote:path",
|
Use: "sha1sum remote:path",
|
||||||
Short: `Produces an sha1sum file for all the objects in the path.`,
|
Short: `Produces an sha1sum file for all the objects in the path.`,
|
||||||
Long: `
|
Long: `Produces an sha1sum file for all the objects in the path. This
|
||||||
Produces an sha1sum file for all the objects in the path. This
|
|
||||||
is in the same format as the standard sha1sum tool produces.
|
is in the same format as the standard sha1sum tool produces.
|
||||||
|
|
||||||
By default, the hash is requested from the remote. If SHA-1 is
|
By default, the hash is requested from the remote. If SHA-1 is
|
||||||
|
@ -26,8 +26,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "size remote:path",
|
Use: "size remote:path",
|
||||||
Short: `Prints the total size and number of objects in remote:path.`,
|
Short: `Prints the total size and number of objects in remote:path.`,
|
||||||
Long: `
|
Long: `Counts objects in the path and calculates the total size. Prints the
|
||||||
Counts objects in the path and calculates the total size. Prints the
|
|
||||||
result to standard output.
|
result to standard output.
|
||||||
|
|
||||||
By default the output is in human-readable format, but shows values in
|
By default the output is in human-readable format, but shows values in
|
||||||
|
@ -139,8 +139,7 @@ func anyNotBlank(s ...string) bool {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "sync source:path dest:path",
|
Use: "sync source:path dest:path",
|
||||||
Short: `Make source and dest identical, modifying destination only.`,
|
Short: `Make source and dest identical, modifying destination only.`,
|
||||||
Long: `
|
Long: `Sync the source to the destination, changing the destination
|
||||||
Sync the source to the destination, changing the destination
|
|
||||||
only. Doesn't transfer files that are identical on source and
|
only. Doesn't transfer files that are identical on source and
|
||||||
destination, testing by size and modification time or MD5SUM.
|
destination, testing by size and modification time or MD5SUM.
|
||||||
Destination is updated to match source, including deleting files
|
Destination is updated to match source, including deleting files
|
||||||
|
@ -64,10 +64,10 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "info [remote:path]+",
|
Use: "info [remote:path]+",
|
||||||
Short: `Discovers file name or other limitations for paths.`,
|
Short: `Discovers file name or other limitations for paths.`,
|
||||||
Long: `rclone info discovers what filenames and upload methods are possible
|
Long: `Discovers what filenames and upload methods are possible to write to the
|
||||||
to write to the paths passed in and how long they can be. It can take some
|
paths passed in and how long they can be. It can take some time. It will
|
||||||
time. It will write test files into the remote:path passed in. It outputs
|
write test files into the remote:path passed in. It outputs a bit of go
|
||||||
a bit of go code for each one.
|
code for each one.
|
||||||
|
|
||||||
**NB** this can create undeletable files and other hazards - use with care
|
**NB** this can create undeletable files and other hazards - use with care
|
||||||
`,
|
`,
|
||||||
|
@ -43,8 +43,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "touch remote:path",
|
Use: "touch remote:path",
|
||||||
Short: `Create new file or change file modification time.`,
|
Short: `Create new file or change file modification time.`,
|
||||||
Long: `
|
Long: `Set the modification time on file(s) as specified by remote:path to
|
||||||
Set the modification time on file(s) as specified by remote:path to
|
|
||||||
have the current time.
|
have the current time.
|
||||||
|
|
||||||
If remote:path does not exist then a zero sized file will be created,
|
If remote:path does not exist then a zero sized file will be created,
|
||||||
|
@ -69,9 +69,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "tree remote:path",
|
Use: "tree remote:path",
|
||||||
Short: `List the contents of the remote in a tree like fashion.`,
|
Short: `List the contents of the remote in a tree like fashion.`,
|
||||||
Long: `
|
Long: `Lists the contents of a remote in a similar way to the unix tree command.
|
||||||
rclone tree lists the contents of a remote in a similar way to the
|
|
||||||
unix tree command.
|
|
||||||
|
|
||||||
For example
|
For example
|
||||||
|
|
||||||
|
@ -31,8 +31,7 @@ func init() {
|
|||||||
var commandDefinition = &cobra.Command{
|
var commandDefinition = &cobra.Command{
|
||||||
Use: "version",
|
Use: "version",
|
||||||
Short: `Show the version number.`,
|
Short: `Show the version number.`,
|
||||||
Long: `
|
Long: `Show the rclone version number, the go version, the build target
|
||||||
Show the rclone version number, the go version, the build target
|
|
||||||
OS and architecture, the runtime OS and kernel version and bitness,
|
OS and architecture, the runtime OS and kernel version and bitness,
|
||||||
build tags and the type of executable (static or dynamic).
|
build tags and the type of executable (static or dynamic).
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user